babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Nullable } from "babylonjs/types";
  9538. import { Scene } from "babylonjs/scene";
  9539. import { ActionManager } from "babylonjs/Actions/actionManager";
  9540. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9541. import { Node } from "babylonjs/node";
  9542. /**
  9543. * Interface used to define Action
  9544. */
  9545. export interface IAction {
  9546. /**
  9547. * Trigger for the action
  9548. */
  9549. trigger: number;
  9550. /** Options of the trigger */
  9551. triggerOptions: any;
  9552. /**
  9553. * Gets the trigger parameters
  9554. * @returns the trigger parameters
  9555. */
  9556. getTriggerParameter(): any;
  9557. /**
  9558. * Internal only - executes current action event
  9559. * @hidden
  9560. */
  9561. _executeCurrent(evt?: ActionEvent): void;
  9562. /**
  9563. * Serialize placeholder for child classes
  9564. * @param parent of child
  9565. * @returns the serialized object
  9566. */
  9567. serialize(parent: any): any;
  9568. /**
  9569. * Internal only
  9570. * @hidden
  9571. */
  9572. _prepare(): void;
  9573. /**
  9574. * Internal only - manager for action
  9575. * @hidden
  9576. */
  9577. _actionManager: Nullable<AbstractActionManager>;
  9578. /**
  9579. * Adds action to chain of actions, may be a DoNothingAction
  9580. * @param action defines the next action to execute
  9581. * @returns The action passed in
  9582. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9583. */
  9584. then(action: IAction): IAction;
  9585. }
  9586. /**
  9587. * The action to be carried out following a trigger
  9588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9589. */
  9590. export class Action implements IAction {
  9591. /** the trigger, with or without parameters, for the action */
  9592. triggerOptions: any;
  9593. /**
  9594. * Trigger for the action
  9595. */
  9596. trigger: number;
  9597. /**
  9598. * Internal only - manager for action
  9599. * @hidden
  9600. */
  9601. _actionManager: ActionManager;
  9602. private _nextActiveAction;
  9603. private _child;
  9604. private _condition?;
  9605. private _triggerParameter;
  9606. /**
  9607. * An event triggered prior to action being executed.
  9608. */
  9609. onBeforeExecuteObservable: Observable<Action>;
  9610. /**
  9611. * Creates a new Action
  9612. * @param triggerOptions the trigger, with or without parameters, for the action
  9613. * @param condition an optional determinant of action
  9614. */
  9615. constructor(
  9616. /** the trigger, with or without parameters, for the action */
  9617. triggerOptions: any, condition?: Condition);
  9618. /**
  9619. * Internal only
  9620. * @hidden
  9621. */
  9622. _prepare(): void;
  9623. /**
  9624. * Gets the trigger parameters
  9625. * @returns the trigger parameters
  9626. */
  9627. getTriggerParameter(): any;
  9628. /**
  9629. * Internal only - executes current action event
  9630. * @hidden
  9631. */
  9632. _executeCurrent(evt?: ActionEvent): void;
  9633. /**
  9634. * Execute placeholder for child classes
  9635. * @param evt optional action event
  9636. */
  9637. execute(evt?: ActionEvent): void;
  9638. /**
  9639. * Skips to next active action
  9640. */
  9641. skipToNextActiveAction(): void;
  9642. /**
  9643. * Adds action to chain of actions, may be a DoNothingAction
  9644. * @param action defines the next action to execute
  9645. * @returns The action passed in
  9646. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9647. */
  9648. then(action: Action): Action;
  9649. /**
  9650. * Internal only
  9651. * @hidden
  9652. */
  9653. _getProperty(propertyPath: string): string;
  9654. /**
  9655. * Internal only
  9656. * @hidden
  9657. */
  9658. _getEffectiveTarget(target: any, propertyPath: string): any;
  9659. /**
  9660. * Serialize placeholder for child classes
  9661. * @param parent of child
  9662. * @returns the serialized object
  9663. */
  9664. serialize(parent: any): any;
  9665. /**
  9666. * Internal only called by serialize
  9667. * @hidden
  9668. */
  9669. protected _serialize(serializedAction: any, parent?: any): any;
  9670. /**
  9671. * Internal only
  9672. * @hidden
  9673. */
  9674. static _SerializeValueAsString: (value: any) => string;
  9675. /**
  9676. * Internal only
  9677. * @hidden
  9678. */
  9679. static _GetTargetProperty: (target: Scene | Node) => {
  9680. name: string;
  9681. targetType: string;
  9682. value: string;
  9683. };
  9684. }
  9685. }
  9686. declare module "babylonjs/Actions/condition" {
  9687. import { ActionManager } from "babylonjs/Actions/actionManager";
  9688. /**
  9689. * A Condition applied to an Action
  9690. */
  9691. export class Condition {
  9692. /**
  9693. * Internal only - manager for action
  9694. * @hidden
  9695. */
  9696. _actionManager: ActionManager;
  9697. /**
  9698. * Internal only
  9699. * @hidden
  9700. */
  9701. _evaluationId: number;
  9702. /**
  9703. * Internal only
  9704. * @hidden
  9705. */
  9706. _currentResult: boolean;
  9707. /**
  9708. * Creates a new Condition
  9709. * @param actionManager the manager of the action the condition is applied to
  9710. */
  9711. constructor(actionManager: ActionManager);
  9712. /**
  9713. * Check if the current condition is valid
  9714. * @returns a boolean
  9715. */
  9716. isValid(): boolean;
  9717. /**
  9718. * Internal only
  9719. * @hidden
  9720. */
  9721. _getProperty(propertyPath: string): string;
  9722. /**
  9723. * Internal only
  9724. * @hidden
  9725. */
  9726. _getEffectiveTarget(target: any, propertyPath: string): any;
  9727. /**
  9728. * Serialize placeholder for child classes
  9729. * @returns the serialized object
  9730. */
  9731. serialize(): any;
  9732. /**
  9733. * Internal only
  9734. * @hidden
  9735. */
  9736. protected _serialize(serializedCondition: any): any;
  9737. }
  9738. /**
  9739. * Defines specific conditional operators as extensions of Condition
  9740. */
  9741. export class ValueCondition extends Condition {
  9742. /** path to specify the property of the target the conditional operator uses */
  9743. propertyPath: string;
  9744. /** the value compared by the conditional operator against the current value of the property */
  9745. value: any;
  9746. /** the conditional operator, default ValueCondition.IsEqual */
  9747. operator: number;
  9748. /**
  9749. * Internal only
  9750. * @hidden
  9751. */
  9752. private static _IsEqual;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. private static _IsDifferent;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. private static _IsGreater;
  9763. /**
  9764. * Internal only
  9765. * @hidden
  9766. */
  9767. private static _IsLesser;
  9768. /**
  9769. * returns the number for IsEqual
  9770. */
  9771. static get IsEqual(): number;
  9772. /**
  9773. * Returns the number for IsDifferent
  9774. */
  9775. static get IsDifferent(): number;
  9776. /**
  9777. * Returns the number for IsGreater
  9778. */
  9779. static get IsGreater(): number;
  9780. /**
  9781. * Returns the number for IsLesser
  9782. */
  9783. static get IsLesser(): number;
  9784. /**
  9785. * Internal only The action manager for the condition
  9786. * @hidden
  9787. */
  9788. _actionManager: ActionManager;
  9789. /**
  9790. * Internal only
  9791. * @hidden
  9792. */
  9793. private _target;
  9794. /**
  9795. * Internal only
  9796. * @hidden
  9797. */
  9798. private _effectiveTarget;
  9799. /**
  9800. * Internal only
  9801. * @hidden
  9802. */
  9803. private _property;
  9804. /**
  9805. * Creates a new ValueCondition
  9806. * @param actionManager manager for the action the condition applies to
  9807. * @param target for the action
  9808. * @param propertyPath path to specify the property of the target the conditional operator uses
  9809. * @param value the value compared by the conditional operator against the current value of the property
  9810. * @param operator the conditional operator, default ValueCondition.IsEqual
  9811. */
  9812. constructor(actionManager: ActionManager, target: any,
  9813. /** path to specify the property of the target the conditional operator uses */
  9814. propertyPath: string,
  9815. /** the value compared by the conditional operator against the current value of the property */
  9816. value: any,
  9817. /** the conditional operator, default ValueCondition.IsEqual */
  9818. operator?: number);
  9819. /**
  9820. * Compares the given value with the property value for the specified conditional operator
  9821. * @returns the result of the comparison
  9822. */
  9823. isValid(): boolean;
  9824. /**
  9825. * Serialize the ValueCondition into a JSON compatible object
  9826. * @returns serialization object
  9827. */
  9828. serialize(): any;
  9829. /**
  9830. * Gets the name of the conditional operator for the ValueCondition
  9831. * @param operator the conditional operator
  9832. * @returns the name
  9833. */
  9834. static GetOperatorName(operator: number): string;
  9835. }
  9836. /**
  9837. * Defines a predicate condition as an extension of Condition
  9838. */
  9839. export class PredicateCondition extends Condition {
  9840. /** defines the predicate function used to validate the condition */
  9841. predicate: () => boolean;
  9842. /**
  9843. * Internal only - manager for action
  9844. * @hidden
  9845. */
  9846. _actionManager: ActionManager;
  9847. /**
  9848. * Creates a new PredicateCondition
  9849. * @param actionManager manager for the action the condition applies to
  9850. * @param predicate defines the predicate function used to validate the condition
  9851. */
  9852. constructor(actionManager: ActionManager,
  9853. /** defines the predicate function used to validate the condition */
  9854. predicate: () => boolean);
  9855. /**
  9856. * @returns the validity of the predicate condition
  9857. */
  9858. isValid(): boolean;
  9859. }
  9860. /**
  9861. * Defines a state condition as an extension of Condition
  9862. */
  9863. export class StateCondition extends Condition {
  9864. /** Value to compare with target state */
  9865. value: string;
  9866. /**
  9867. * Internal only - manager for action
  9868. * @hidden
  9869. */
  9870. _actionManager: ActionManager;
  9871. /**
  9872. * Internal only
  9873. * @hidden
  9874. */
  9875. private _target;
  9876. /**
  9877. * Creates a new StateCondition
  9878. * @param actionManager manager for the action the condition applies to
  9879. * @param target of the condition
  9880. * @param value to compare with target state
  9881. */
  9882. constructor(actionManager: ActionManager, target: any,
  9883. /** Value to compare with target state */
  9884. value: string);
  9885. /**
  9886. * Gets a boolean indicating if the current condition is met
  9887. * @returns the validity of the state
  9888. */
  9889. isValid(): boolean;
  9890. /**
  9891. * Serialize the StateCondition into a JSON compatible object
  9892. * @returns serialization object
  9893. */
  9894. serialize(): any;
  9895. }
  9896. }
  9897. declare module "babylonjs/Actions/directActions" {
  9898. import { Action } from "babylonjs/Actions/action";
  9899. import { Condition } from "babylonjs/Actions/condition";
  9900. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9901. /**
  9902. * This defines an action responsible to toggle a boolean once triggered.
  9903. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9904. */
  9905. export class SwitchBooleanAction extends Action {
  9906. /**
  9907. * The path to the boolean property in the target object
  9908. */
  9909. propertyPath: string;
  9910. private _target;
  9911. private _effectiveTarget;
  9912. private _property;
  9913. /**
  9914. * Instantiate the action
  9915. * @param triggerOptions defines the trigger options
  9916. * @param target defines the object containing the boolean
  9917. * @param propertyPath defines the path to the boolean property in the target object
  9918. * @param condition defines the trigger related conditions
  9919. */
  9920. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9921. /** @hidden */
  9922. _prepare(): void;
  9923. /**
  9924. * Execute the action toggle the boolean value.
  9925. */
  9926. execute(): void;
  9927. /**
  9928. * Serializes the actions and its related information.
  9929. * @param parent defines the object to serialize in
  9930. * @returns the serialized object
  9931. */
  9932. serialize(parent: any): any;
  9933. }
  9934. /**
  9935. * This defines an action responsible to set a the state field of the target
  9936. * to a desired value once triggered.
  9937. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9938. */
  9939. export class SetStateAction extends Action {
  9940. /**
  9941. * The value to store in the state field.
  9942. */
  9943. value: string;
  9944. private _target;
  9945. /**
  9946. * Instantiate the action
  9947. * @param triggerOptions defines the trigger options
  9948. * @param target defines the object containing the state property
  9949. * @param value defines the value to store in the state field
  9950. * @param condition defines the trigger related conditions
  9951. */
  9952. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9953. /**
  9954. * Execute the action and store the value on the target state property.
  9955. */
  9956. execute(): void;
  9957. /**
  9958. * Serializes the actions and its related information.
  9959. * @param parent defines the object to serialize in
  9960. * @returns the serialized object
  9961. */
  9962. serialize(parent: any): any;
  9963. }
  9964. /**
  9965. * This defines an action responsible to set a property of the target
  9966. * to a desired value once triggered.
  9967. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9968. */
  9969. export class SetValueAction extends Action {
  9970. /**
  9971. * The path of the property to set in the target.
  9972. */
  9973. propertyPath: string;
  9974. /**
  9975. * The value to set in the property
  9976. */
  9977. value: any;
  9978. private _target;
  9979. private _effectiveTarget;
  9980. private _property;
  9981. /**
  9982. * Instantiate the action
  9983. * @param triggerOptions defines the trigger options
  9984. * @param target defines the object containing the property
  9985. * @param propertyPath defines the path of the property to set in the target
  9986. * @param value defines the value to set in the property
  9987. * @param condition defines the trigger related conditions
  9988. */
  9989. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9990. /** @hidden */
  9991. _prepare(): void;
  9992. /**
  9993. * Execute the action and set the targetted property to the desired value.
  9994. */
  9995. execute(): void;
  9996. /**
  9997. * Serializes the actions and its related information.
  9998. * @param parent defines the object to serialize in
  9999. * @returns the serialized object
  10000. */
  10001. serialize(parent: any): any;
  10002. }
  10003. /**
  10004. * This defines an action responsible to increment the target value
  10005. * to a desired value once triggered.
  10006. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10007. */
  10008. export class IncrementValueAction extends Action {
  10009. /**
  10010. * The path of the property to increment in the target.
  10011. */
  10012. propertyPath: string;
  10013. /**
  10014. * The value we should increment the property by.
  10015. */
  10016. value: any;
  10017. private _target;
  10018. private _effectiveTarget;
  10019. private _property;
  10020. /**
  10021. * Instantiate the action
  10022. * @param triggerOptions defines the trigger options
  10023. * @param target defines the object containing the property
  10024. * @param propertyPath defines the path of the property to increment in the target
  10025. * @param value defines the value value we should increment the property by
  10026. * @param condition defines the trigger related conditions
  10027. */
  10028. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10029. /** @hidden */
  10030. _prepare(): void;
  10031. /**
  10032. * Execute the action and increment the target of the value amount.
  10033. */
  10034. execute(): void;
  10035. /**
  10036. * Serializes the actions and its related information.
  10037. * @param parent defines the object to serialize in
  10038. * @returns the serialized object
  10039. */
  10040. serialize(parent: any): any;
  10041. }
  10042. /**
  10043. * This defines an action responsible to start an animation once triggered.
  10044. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10045. */
  10046. export class PlayAnimationAction extends Action {
  10047. /**
  10048. * Where the animation should start (animation frame)
  10049. */
  10050. from: number;
  10051. /**
  10052. * Where the animation should stop (animation frame)
  10053. */
  10054. to: number;
  10055. /**
  10056. * Define if the animation should loop or stop after the first play.
  10057. */
  10058. loop?: boolean;
  10059. private _target;
  10060. /**
  10061. * Instantiate the action
  10062. * @param triggerOptions defines the trigger options
  10063. * @param target defines the target animation or animation name
  10064. * @param from defines from where the animation should start (animation frame)
  10065. * @param end defines where the animation should stop (animation frame)
  10066. * @param loop defines if the animation should loop or stop after the first play
  10067. * @param condition defines the trigger related conditions
  10068. */
  10069. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10070. /** @hidden */
  10071. _prepare(): void;
  10072. /**
  10073. * Execute the action and play the animation.
  10074. */
  10075. execute(): void;
  10076. /**
  10077. * Serializes the actions and its related information.
  10078. * @param parent defines the object to serialize in
  10079. * @returns the serialized object
  10080. */
  10081. serialize(parent: any): any;
  10082. }
  10083. /**
  10084. * This defines an action responsible to stop an animation once triggered.
  10085. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10086. */
  10087. export class StopAnimationAction extends Action {
  10088. private _target;
  10089. /**
  10090. * Instantiate the action
  10091. * @param triggerOptions defines the trigger options
  10092. * @param target defines the target animation or animation name
  10093. * @param condition defines the trigger related conditions
  10094. */
  10095. constructor(triggerOptions: any, target: any, condition?: Condition);
  10096. /** @hidden */
  10097. _prepare(): void;
  10098. /**
  10099. * Execute the action and stop the animation.
  10100. */
  10101. execute(): void;
  10102. /**
  10103. * Serializes the actions and its related information.
  10104. * @param parent defines the object to serialize in
  10105. * @returns the serialized object
  10106. */
  10107. serialize(parent: any): any;
  10108. }
  10109. /**
  10110. * This defines an action responsible that does nothing once triggered.
  10111. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10112. */
  10113. export class DoNothingAction extends Action {
  10114. /**
  10115. * Instantiate the action
  10116. * @param triggerOptions defines the trigger options
  10117. * @param condition defines the trigger related conditions
  10118. */
  10119. constructor(triggerOptions?: any, condition?: Condition);
  10120. /**
  10121. * Execute the action and do nothing.
  10122. */
  10123. execute(): void;
  10124. /**
  10125. * Serializes the actions and its related information.
  10126. * @param parent defines the object to serialize in
  10127. * @returns the serialized object
  10128. */
  10129. serialize(parent: any): any;
  10130. }
  10131. /**
  10132. * This defines an action responsible to trigger several actions once triggered.
  10133. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10134. */
  10135. export class CombineAction extends Action {
  10136. /**
  10137. * The list of aggregated animations to run.
  10138. */
  10139. children: Action[];
  10140. /**
  10141. * Instantiate the action
  10142. * @param triggerOptions defines the trigger options
  10143. * @param children defines the list of aggregated animations to run
  10144. * @param condition defines the trigger related conditions
  10145. */
  10146. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10147. /** @hidden */
  10148. _prepare(): void;
  10149. /**
  10150. * Execute the action and executes all the aggregated actions.
  10151. */
  10152. execute(evt: ActionEvent): void;
  10153. /**
  10154. * Serializes the actions and its related information.
  10155. * @param parent defines the object to serialize in
  10156. * @returns the serialized object
  10157. */
  10158. serialize(parent: any): any;
  10159. }
  10160. /**
  10161. * This defines an action responsible to run code (external event) once triggered.
  10162. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10163. */
  10164. export class ExecuteCodeAction extends Action {
  10165. /**
  10166. * The callback function to run.
  10167. */
  10168. func: (evt: ActionEvent) => void;
  10169. /**
  10170. * Instantiate the action
  10171. * @param triggerOptions defines the trigger options
  10172. * @param func defines the callback function to run
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10176. /**
  10177. * Execute the action and run the attached code.
  10178. */
  10179. execute(evt: ActionEvent): void;
  10180. }
  10181. /**
  10182. * This defines an action responsible to set the parent property of the target once triggered.
  10183. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10184. */
  10185. export class SetParentAction extends Action {
  10186. private _parent;
  10187. private _target;
  10188. /**
  10189. * Instantiate the action
  10190. * @param triggerOptions defines the trigger options
  10191. * @param target defines the target containing the parent property
  10192. * @param parent defines from where the animation should start (animation frame)
  10193. * @param condition defines the trigger related conditions
  10194. */
  10195. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10196. /** @hidden */
  10197. _prepare(): void;
  10198. /**
  10199. * Execute the action and set the parent property.
  10200. */
  10201. execute(): void;
  10202. /**
  10203. * Serializes the actions and its related information.
  10204. * @param parent defines the object to serialize in
  10205. * @returns the serialized object
  10206. */
  10207. serialize(parent: any): any;
  10208. }
  10209. }
  10210. declare module "babylonjs/Actions/actionManager" {
  10211. import { Nullable } from "babylonjs/types";
  10212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10213. import { Scene } from "babylonjs/scene";
  10214. import { IAction } from "babylonjs/Actions/action";
  10215. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10216. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10217. /**
  10218. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10219. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10220. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10221. */
  10222. export class ActionManager extends AbstractActionManager {
  10223. /**
  10224. * Nothing
  10225. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10226. */
  10227. static readonly NothingTrigger: number;
  10228. /**
  10229. * On pick
  10230. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10231. */
  10232. static readonly OnPickTrigger: number;
  10233. /**
  10234. * On left pick
  10235. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10236. */
  10237. static readonly OnLeftPickTrigger: number;
  10238. /**
  10239. * On right pick
  10240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10241. */
  10242. static readonly OnRightPickTrigger: number;
  10243. /**
  10244. * On center pick
  10245. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10246. */
  10247. static readonly OnCenterPickTrigger: number;
  10248. /**
  10249. * On pick down
  10250. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10251. */
  10252. static readonly OnPickDownTrigger: number;
  10253. /**
  10254. * On double pick
  10255. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10256. */
  10257. static readonly OnDoublePickTrigger: number;
  10258. /**
  10259. * On pick up
  10260. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10261. */
  10262. static readonly OnPickUpTrigger: number;
  10263. /**
  10264. * On pick out.
  10265. * This trigger will only be raised if you also declared a OnPickDown
  10266. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10267. */
  10268. static readonly OnPickOutTrigger: number;
  10269. /**
  10270. * On long press
  10271. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10272. */
  10273. static readonly OnLongPressTrigger: number;
  10274. /**
  10275. * On pointer over
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10277. */
  10278. static readonly OnPointerOverTrigger: number;
  10279. /**
  10280. * On pointer out
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly OnPointerOutTrigger: number;
  10284. /**
  10285. * On every frame
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnEveryFrameTrigger: number;
  10289. /**
  10290. * On intersection enter
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnIntersectionEnterTrigger: number;
  10294. /**
  10295. * On intersection exit
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnIntersectionExitTrigger: number;
  10299. /**
  10300. * On key down
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnKeyDownTrigger: number;
  10304. /**
  10305. * On key up
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnKeyUpTrigger: number;
  10309. private _scene;
  10310. /**
  10311. * Creates a new action manager
  10312. * @param scene defines the hosting scene
  10313. */
  10314. constructor(scene: Scene);
  10315. /**
  10316. * Releases all associated resources
  10317. */
  10318. dispose(): void;
  10319. /**
  10320. * Gets hosting scene
  10321. * @returns the hosting scene
  10322. */
  10323. getScene(): Scene;
  10324. /**
  10325. * Does this action manager handles actions of any of the given triggers
  10326. * @param triggers defines the triggers to be tested
  10327. * @return a boolean indicating whether one (or more) of the triggers is handled
  10328. */
  10329. hasSpecificTriggers(triggers: number[]): boolean;
  10330. /**
  10331. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10332. * speed.
  10333. * @param triggerA defines the trigger to be tested
  10334. * @param triggerB defines the trigger to be tested
  10335. * @return a boolean indicating whether one (or more) of the triggers is handled
  10336. */
  10337. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10338. /**
  10339. * Does this action manager handles actions of a given trigger
  10340. * @param trigger defines the trigger to be tested
  10341. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10342. * @return whether the trigger is handled
  10343. */
  10344. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10345. /**
  10346. * Does this action manager has pointer triggers
  10347. */
  10348. get hasPointerTriggers(): boolean;
  10349. /**
  10350. * Does this action manager has pick triggers
  10351. */
  10352. get hasPickTriggers(): boolean;
  10353. /**
  10354. * Registers an action to this action manager
  10355. * @param action defines the action to be registered
  10356. * @return the action amended (prepared) after registration
  10357. */
  10358. registerAction(action: IAction): Nullable<IAction>;
  10359. /**
  10360. * Unregisters an action to this action manager
  10361. * @param action defines the action to be unregistered
  10362. * @return a boolean indicating whether the action has been unregistered
  10363. */
  10364. unregisterAction(action: IAction): Boolean;
  10365. /**
  10366. * Process a specific trigger
  10367. * @param trigger defines the trigger to process
  10368. * @param evt defines the event details to be processed
  10369. */
  10370. processTrigger(trigger: number, evt?: IActionEvent): void;
  10371. /** @hidden */
  10372. _getEffectiveTarget(target: any, propertyPath: string): any;
  10373. /** @hidden */
  10374. _getProperty(propertyPath: string): string;
  10375. /**
  10376. * Serialize this manager to a JSON object
  10377. * @param name defines the property name to store this manager
  10378. * @returns a JSON representation of this manager
  10379. */
  10380. serialize(name: string): any;
  10381. /**
  10382. * Creates a new ActionManager from a JSON data
  10383. * @param parsedActions defines the JSON data to read from
  10384. * @param object defines the hosting mesh
  10385. * @param scene defines the hosting scene
  10386. */
  10387. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10388. /**
  10389. * Get a trigger name by index
  10390. * @param trigger defines the trigger index
  10391. * @returns a trigger name
  10392. */
  10393. static GetTriggerName(trigger: number): string;
  10394. }
  10395. }
  10396. declare module "babylonjs/Sprites/sprite" {
  10397. import { Vector3 } from "babylonjs/Maths/math.vector";
  10398. import { Nullable } from "babylonjs/types";
  10399. import { ActionManager } from "babylonjs/Actions/actionManager";
  10400. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10401. import { Color4 } from "babylonjs/Maths/math.color";
  10402. import { Observable } from "babylonjs/Misc/observable";
  10403. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10404. import { Animation } from "babylonjs/Animations/animation";
  10405. /**
  10406. * Class used to represent a sprite
  10407. * @see https://doc.babylonjs.com/babylon101/sprites
  10408. */
  10409. export class Sprite implements IAnimatable {
  10410. /** defines the name */
  10411. name: string;
  10412. /** Gets or sets the current world position */
  10413. position: Vector3;
  10414. /** Gets or sets the main color */
  10415. color: Color4;
  10416. /** Gets or sets the width */
  10417. width: number;
  10418. /** Gets or sets the height */
  10419. height: number;
  10420. /** Gets or sets rotation angle */
  10421. angle: number;
  10422. /** Gets or sets the cell index in the sprite sheet */
  10423. cellIndex: number;
  10424. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10425. cellRef: string;
  10426. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10427. invertU: boolean;
  10428. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10429. invertV: boolean;
  10430. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10431. disposeWhenFinishedAnimating: boolean;
  10432. /** Gets the list of attached animations */
  10433. animations: Nullable<Array<Animation>>;
  10434. /** Gets or sets a boolean indicating if the sprite can be picked */
  10435. isPickable: boolean;
  10436. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10437. useAlphaForPicking: boolean;
  10438. /** @hidden */
  10439. _xOffset: number;
  10440. /** @hidden */
  10441. _yOffset: number;
  10442. /** @hidden */
  10443. _xSize: number;
  10444. /** @hidden */
  10445. _ySize: number;
  10446. /**
  10447. * Gets or sets the associated action manager
  10448. */
  10449. actionManager: Nullable<ActionManager>;
  10450. /**
  10451. * An event triggered when the control has been disposed
  10452. */
  10453. onDisposeObservable: Observable<Sprite>;
  10454. private _animationStarted;
  10455. private _loopAnimation;
  10456. private _fromIndex;
  10457. private _toIndex;
  10458. private _delay;
  10459. private _direction;
  10460. private _manager;
  10461. private _time;
  10462. private _onAnimationEnd;
  10463. /**
  10464. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10465. */
  10466. isVisible: boolean;
  10467. /**
  10468. * Gets or sets the sprite size
  10469. */
  10470. get size(): number;
  10471. set size(value: number);
  10472. /**
  10473. * Returns a boolean indicating if the animation is started
  10474. */
  10475. get animationStarted(): boolean;
  10476. /**
  10477. * Gets or sets the unique id of the sprite
  10478. */
  10479. uniqueId: number;
  10480. /**
  10481. * Gets the manager of this sprite
  10482. */
  10483. get manager(): ISpriteManager;
  10484. /**
  10485. * Creates a new Sprite
  10486. * @param name defines the name
  10487. * @param manager defines the manager
  10488. */
  10489. constructor(
  10490. /** defines the name */
  10491. name: string, manager: ISpriteManager);
  10492. /**
  10493. * Returns the string "Sprite"
  10494. * @returns "Sprite"
  10495. */
  10496. getClassName(): string;
  10497. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10498. get fromIndex(): number;
  10499. set fromIndex(value: number);
  10500. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10501. get toIndex(): number;
  10502. set toIndex(value: number);
  10503. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10504. get loopAnimation(): boolean;
  10505. set loopAnimation(value: boolean);
  10506. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10507. get delay(): number;
  10508. set delay(value: number);
  10509. /**
  10510. * Starts an animation
  10511. * @param from defines the initial key
  10512. * @param to defines the end key
  10513. * @param loop defines if the animation must loop
  10514. * @param delay defines the start delay (in ms)
  10515. * @param onAnimationEnd defines a callback to call when animation ends
  10516. */
  10517. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10518. /** Stops current animation (if any) */
  10519. stopAnimation(): void;
  10520. /** @hidden */
  10521. _animate(deltaTime: number): void;
  10522. /** Release associated resources */
  10523. dispose(): void;
  10524. /**
  10525. * Serializes the sprite to a JSON object
  10526. * @returns the JSON object
  10527. */
  10528. serialize(): any;
  10529. /**
  10530. * Parses a JSON object to create a new sprite
  10531. * @param parsedSprite The JSON object to parse
  10532. * @param manager defines the hosting manager
  10533. * @returns the new sprite
  10534. */
  10535. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10536. }
  10537. }
  10538. declare module "babylonjs/Collisions/pickingInfo" {
  10539. import { Nullable } from "babylonjs/types";
  10540. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10541. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10542. import { Sprite } from "babylonjs/Sprites/sprite";
  10543. import { Ray } from "babylonjs/Culling/ray";
  10544. /**
  10545. * Information about the result of picking within a scene
  10546. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10547. */
  10548. export class PickingInfo {
  10549. /** @hidden */
  10550. _pickingUnavailable: boolean;
  10551. /**
  10552. * If the pick collided with an object
  10553. */
  10554. hit: boolean;
  10555. /**
  10556. * Distance away where the pick collided
  10557. */
  10558. distance: number;
  10559. /**
  10560. * The location of pick collision
  10561. */
  10562. pickedPoint: Nullable<Vector3>;
  10563. /**
  10564. * The mesh corresponding the the pick collision
  10565. */
  10566. pickedMesh: Nullable<AbstractMesh>;
  10567. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10568. bu: number;
  10569. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10570. bv: number;
  10571. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10572. faceId: number;
  10573. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10574. subMeshFaceId: number;
  10575. /** Id of the the submesh that was picked */
  10576. subMeshId: number;
  10577. /** If a sprite was picked, this will be the sprite the pick collided with */
  10578. pickedSprite: Nullable<Sprite>;
  10579. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10580. thinInstanceIndex: number;
  10581. /**
  10582. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10583. */
  10584. originMesh: Nullable<AbstractMesh>;
  10585. /**
  10586. * The ray that was used to perform the picking.
  10587. */
  10588. ray: Nullable<Ray>;
  10589. /**
  10590. * Gets the normal correspodning to the face the pick collided with
  10591. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10592. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10593. * @returns The normal correspodning to the face the pick collided with
  10594. */
  10595. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10596. /**
  10597. * Gets the texture coordinates of where the pick occured
  10598. * @returns the vector containing the coordnates of the texture
  10599. */
  10600. getTextureCoordinates(): Nullable<Vector2>;
  10601. }
  10602. }
  10603. declare module "babylonjs/Culling/ray" {
  10604. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10605. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10607. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10608. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10609. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10610. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10611. import { Plane } from "babylonjs/Maths/math.plane";
  10612. /**
  10613. * Class representing a ray with position and direction
  10614. */
  10615. export class Ray {
  10616. /** origin point */
  10617. origin: Vector3;
  10618. /** direction */
  10619. direction: Vector3;
  10620. /** length of the ray */
  10621. length: number;
  10622. private static readonly _TmpVector3;
  10623. private _tmpRay;
  10624. /**
  10625. * Creates a new ray
  10626. * @param origin origin point
  10627. * @param direction direction
  10628. * @param length length of the ray
  10629. */
  10630. constructor(
  10631. /** origin point */
  10632. origin: Vector3,
  10633. /** direction */
  10634. direction: Vector3,
  10635. /** length of the ray */
  10636. length?: number);
  10637. /**
  10638. * Checks if the ray intersects a box
  10639. * This does not account for the ray lenght by design to improve perfs.
  10640. * @param minimum bound of the box
  10641. * @param maximum bound of the box
  10642. * @param intersectionTreshold extra extend to be added to the box in all direction
  10643. * @returns if the box was hit
  10644. */
  10645. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10646. /**
  10647. * Checks if the ray intersects a box
  10648. * This does not account for the ray lenght by design to improve perfs.
  10649. * @param box the bounding box to check
  10650. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10651. * @returns if the box was hit
  10652. */
  10653. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10654. /**
  10655. * If the ray hits a sphere
  10656. * @param sphere the bounding sphere to check
  10657. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10658. * @returns true if it hits the sphere
  10659. */
  10660. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10661. /**
  10662. * If the ray hits a triange
  10663. * @param vertex0 triangle vertex
  10664. * @param vertex1 triangle vertex
  10665. * @param vertex2 triangle vertex
  10666. * @returns intersection information if hit
  10667. */
  10668. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10669. /**
  10670. * Checks if ray intersects a plane
  10671. * @param plane the plane to check
  10672. * @returns the distance away it was hit
  10673. */
  10674. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10675. /**
  10676. * Calculate the intercept of a ray on a given axis
  10677. * @param axis to check 'x' | 'y' | 'z'
  10678. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10679. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10680. */
  10681. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10682. /**
  10683. * Checks if ray intersects a mesh
  10684. * @param mesh the mesh to check
  10685. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10686. * @returns picking info of the intersecton
  10687. */
  10688. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10689. /**
  10690. * Checks if ray intersects a mesh
  10691. * @param meshes the meshes to check
  10692. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10693. * @param results array to store result in
  10694. * @returns Array of picking infos
  10695. */
  10696. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10697. private _comparePickingInfo;
  10698. private static smallnum;
  10699. private static rayl;
  10700. /**
  10701. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10702. * @param sega the first point of the segment to test the intersection against
  10703. * @param segb the second point of the segment to test the intersection against
  10704. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10705. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10706. */
  10707. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10708. /**
  10709. * Update the ray from viewport position
  10710. * @param x position
  10711. * @param y y position
  10712. * @param viewportWidth viewport width
  10713. * @param viewportHeight viewport height
  10714. * @param world world matrix
  10715. * @param view view matrix
  10716. * @param projection projection matrix
  10717. * @returns this ray updated
  10718. */
  10719. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10720. /**
  10721. * Creates a ray with origin and direction of 0,0,0
  10722. * @returns the new ray
  10723. */
  10724. static Zero(): Ray;
  10725. /**
  10726. * Creates a new ray from screen space and viewport
  10727. * @param x position
  10728. * @param y y position
  10729. * @param viewportWidth viewport width
  10730. * @param viewportHeight viewport height
  10731. * @param world world matrix
  10732. * @param view view matrix
  10733. * @param projection projection matrix
  10734. * @returns new ray
  10735. */
  10736. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10737. /**
  10738. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  10739. * transformed to the given world matrix.
  10740. * @param origin The origin point
  10741. * @param end The end point
  10742. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10743. * @returns the new ray
  10744. */
  10745. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10746. /**
  10747. * Transforms a ray by a matrix
  10748. * @param ray ray to transform
  10749. * @param matrix matrix to apply
  10750. * @returns the resulting new ray
  10751. */
  10752. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10753. /**
  10754. * Transforms a ray by a matrix
  10755. * @param ray ray to transform
  10756. * @param matrix matrix to apply
  10757. * @param result ray to store result in
  10758. */
  10759. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10760. /**
  10761. * Unproject a ray from screen space to object space
  10762. * @param sourceX defines the screen space x coordinate to use
  10763. * @param sourceY defines the screen space y coordinate to use
  10764. * @param viewportWidth defines the current width of the viewport
  10765. * @param viewportHeight defines the current height of the viewport
  10766. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10767. * @param view defines the view matrix to use
  10768. * @param projection defines the projection matrix to use
  10769. */
  10770. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10771. }
  10772. /**
  10773. * Type used to define predicate used to select faces when a mesh intersection is detected
  10774. */
  10775. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10776. module "babylonjs/scene" {
  10777. interface Scene {
  10778. /** @hidden */
  10779. _tempPickingRay: Nullable<Ray>;
  10780. /** @hidden */
  10781. _cachedRayForTransform: Ray;
  10782. /** @hidden */
  10783. _pickWithRayInverseMatrix: Matrix;
  10784. /** @hidden */
  10785. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10786. /** @hidden */
  10787. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10788. /** @hidden */
  10789. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10790. }
  10791. }
  10792. }
  10793. declare module "babylonjs/sceneComponent" {
  10794. import { Scene } from "babylonjs/scene";
  10795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10796. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10797. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10798. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10799. import { Nullable } from "babylonjs/types";
  10800. import { Camera } from "babylonjs/Cameras/camera";
  10801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10802. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10803. import { AbstractScene } from "babylonjs/abstractScene";
  10804. import { Mesh } from "babylonjs/Meshes/mesh";
  10805. /**
  10806. * Groups all the scene component constants in one place to ease maintenance.
  10807. * @hidden
  10808. */
  10809. export class SceneComponentConstants {
  10810. static readonly NAME_EFFECTLAYER: string;
  10811. static readonly NAME_LAYER: string;
  10812. static readonly NAME_LENSFLARESYSTEM: string;
  10813. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10814. static readonly NAME_PARTICLESYSTEM: string;
  10815. static readonly NAME_GAMEPAD: string;
  10816. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10817. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10818. static readonly NAME_PREPASSRENDERER: string;
  10819. static readonly NAME_DEPTHRENDERER: string;
  10820. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10821. static readonly NAME_SPRITE: string;
  10822. static readonly NAME_OUTLINERENDERER: string;
  10823. static readonly NAME_PROCEDURALTEXTURE: string;
  10824. static readonly NAME_SHADOWGENERATOR: string;
  10825. static readonly NAME_OCTREE: string;
  10826. static readonly NAME_PHYSICSENGINE: string;
  10827. static readonly NAME_AUDIO: string;
  10828. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10829. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10832. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10835. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10836. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10837. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10840. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10842. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10843. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10844. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10846. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10847. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10848. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10849. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10850. static readonly STEP_AFTERRENDER_AUDIO: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10854. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10855. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10856. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10857. static readonly STEP_POINTERMOVE_SPRITE: number;
  10858. static readonly STEP_POINTERDOWN_SPRITE: number;
  10859. static readonly STEP_POINTERUP_SPRITE: number;
  10860. }
  10861. /**
  10862. * This represents a scene component.
  10863. *
  10864. * This is used to decouple the dependency the scene is having on the different workloads like
  10865. * layers, post processes...
  10866. */
  10867. export interface ISceneComponent {
  10868. /**
  10869. * The name of the component. Each component must have a unique name.
  10870. */
  10871. name: string;
  10872. /**
  10873. * The scene the component belongs to.
  10874. */
  10875. scene: Scene;
  10876. /**
  10877. * Register the component to one instance of a scene.
  10878. */
  10879. register(): void;
  10880. /**
  10881. * Rebuilds the elements related to this component in case of
  10882. * context lost for instance.
  10883. */
  10884. rebuild(): void;
  10885. /**
  10886. * Disposes the component and the associated ressources.
  10887. */
  10888. dispose(): void;
  10889. }
  10890. /**
  10891. * This represents a SERIALIZABLE scene component.
  10892. *
  10893. * This extends Scene Component to add Serialization methods on top.
  10894. */
  10895. export interface ISceneSerializableComponent extends ISceneComponent {
  10896. /**
  10897. * Adds all the elements from the container to the scene
  10898. * @param container the container holding the elements
  10899. */
  10900. addFromContainer(container: AbstractScene): void;
  10901. /**
  10902. * Removes all the elements in the container from the scene
  10903. * @param container contains the elements to remove
  10904. * @param dispose if the removed element should be disposed (default: false)
  10905. */
  10906. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10907. /**
  10908. * Serializes the component data to the specified json object
  10909. * @param serializationObject The object to serialize to
  10910. */
  10911. serialize(serializationObject: any): void;
  10912. }
  10913. /**
  10914. * Strong typing of a Mesh related stage step action
  10915. */
  10916. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10917. /**
  10918. * Strong typing of a Evaluate Sub Mesh related stage step action
  10919. */
  10920. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10921. /**
  10922. * Strong typing of a Active Mesh related stage step action
  10923. */
  10924. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10925. /**
  10926. * Strong typing of a Camera related stage step action
  10927. */
  10928. export type CameraStageAction = (camera: Camera) => void;
  10929. /**
  10930. * Strong typing of a Camera Frame buffer related stage step action
  10931. */
  10932. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10933. /**
  10934. * Strong typing of a Render Target related stage step action
  10935. */
  10936. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10937. /**
  10938. * Strong typing of a RenderingGroup related stage step action
  10939. */
  10940. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10941. /**
  10942. * Strong typing of a Mesh Render related stage step action
  10943. */
  10944. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10945. /**
  10946. * Strong typing of a simple stage step action
  10947. */
  10948. export type SimpleStageAction = () => void;
  10949. /**
  10950. * Strong typing of a render target action.
  10951. */
  10952. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10953. /**
  10954. * Strong typing of a pointer move action.
  10955. */
  10956. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10957. /**
  10958. * Strong typing of a pointer up/down action.
  10959. */
  10960. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10961. /**
  10962. * Representation of a stage in the scene (Basically a list of ordered steps)
  10963. * @hidden
  10964. */
  10965. export class Stage<T extends Function> extends Array<{
  10966. index: number;
  10967. component: ISceneComponent;
  10968. action: T;
  10969. }> {
  10970. /**
  10971. * Hide ctor from the rest of the world.
  10972. * @param items The items to add.
  10973. */
  10974. private constructor();
  10975. /**
  10976. * Creates a new Stage.
  10977. * @returns A new instance of a Stage
  10978. */
  10979. static Create<T extends Function>(): Stage<T>;
  10980. /**
  10981. * Registers a step in an ordered way in the targeted stage.
  10982. * @param index Defines the position to register the step in
  10983. * @param component Defines the component attached to the step
  10984. * @param action Defines the action to launch during the step
  10985. */
  10986. registerStep(index: number, component: ISceneComponent, action: T): void;
  10987. /**
  10988. * Clears all the steps from the stage.
  10989. */
  10990. clear(): void;
  10991. }
  10992. }
  10993. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10994. import { Nullable } from "babylonjs/types";
  10995. import { Observable } from "babylonjs/Misc/observable";
  10996. import { Scene } from "babylonjs/scene";
  10997. import { Sprite } from "babylonjs/Sprites/sprite";
  10998. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10999. import { Ray } from "babylonjs/Culling/ray";
  11000. import { Camera } from "babylonjs/Cameras/camera";
  11001. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11002. import { ISceneComponent } from "babylonjs/sceneComponent";
  11003. module "babylonjs/scene" {
  11004. interface Scene {
  11005. /** @hidden */
  11006. _pointerOverSprite: Nullable<Sprite>;
  11007. /** @hidden */
  11008. _pickedDownSprite: Nullable<Sprite>;
  11009. /** @hidden */
  11010. _tempSpritePickingRay: Nullable<Ray>;
  11011. /**
  11012. * All of the sprite managers added to this scene
  11013. * @see https://doc.babylonjs.com/babylon101/sprites
  11014. */
  11015. spriteManagers: Array<ISpriteManager>;
  11016. /**
  11017. * An event triggered when sprites rendering is about to start
  11018. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11019. */
  11020. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11021. /**
  11022. * An event triggered when sprites rendering is done
  11023. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11024. */
  11025. onAfterSpritesRenderingObservable: Observable<Scene>;
  11026. /** @hidden */
  11027. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11028. /** Launch a ray to try to pick a sprite in the scene
  11029. * @param x position on screen
  11030. * @param y position on screen
  11031. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11032. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11033. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11034. * @returns a PickingInfo
  11035. */
  11036. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11037. /** Use the given ray to pick a sprite in the scene
  11038. * @param ray The ray (in world space) to use to pick meshes
  11039. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11040. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11041. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11042. * @returns a PickingInfo
  11043. */
  11044. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11045. /** @hidden */
  11046. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11047. /** Launch a ray to try to pick sprites in the scene
  11048. * @param x position on screen
  11049. * @param y position on screen
  11050. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11051. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11052. * @returns a PickingInfo array
  11053. */
  11054. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11055. /** Use the given ray to pick sprites in the scene
  11056. * @param ray The ray (in world space) to use to pick meshes
  11057. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11058. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11059. * @returns a PickingInfo array
  11060. */
  11061. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11062. /**
  11063. * Force the sprite under the pointer
  11064. * @param sprite defines the sprite to use
  11065. */
  11066. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11067. /**
  11068. * Gets the sprite under the pointer
  11069. * @returns a Sprite or null if no sprite is under the pointer
  11070. */
  11071. getPointerOverSprite(): Nullable<Sprite>;
  11072. }
  11073. }
  11074. /**
  11075. * Defines the sprite scene component responsible to manage sprites
  11076. * in a given scene.
  11077. */
  11078. export class SpriteSceneComponent implements ISceneComponent {
  11079. /**
  11080. * The component name helpfull to identify the component in the list of scene components.
  11081. */
  11082. readonly name: string;
  11083. /**
  11084. * The scene the component belongs to.
  11085. */
  11086. scene: Scene;
  11087. /** @hidden */
  11088. private _spritePredicate;
  11089. /**
  11090. * Creates a new instance of the component for the given scene
  11091. * @param scene Defines the scene to register the component in
  11092. */
  11093. constructor(scene: Scene);
  11094. /**
  11095. * Registers the component in a given scene
  11096. */
  11097. register(): void;
  11098. /**
  11099. * Rebuilds the elements related to this component in case of
  11100. * context lost for instance.
  11101. */
  11102. rebuild(): void;
  11103. /**
  11104. * Disposes the component and the associated ressources.
  11105. */
  11106. dispose(): void;
  11107. private _pickSpriteButKeepRay;
  11108. private _pointerMove;
  11109. private _pointerDown;
  11110. private _pointerUp;
  11111. }
  11112. }
  11113. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11114. /** @hidden */
  11115. export var fogFragmentDeclaration: {
  11116. name: string;
  11117. shader: string;
  11118. };
  11119. }
  11120. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11121. /** @hidden */
  11122. export var fogFragment: {
  11123. name: string;
  11124. shader: string;
  11125. };
  11126. }
  11127. declare module "babylonjs/Shaders/sprites.fragment" {
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11129. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11130. /** @hidden */
  11131. export var spritesPixelShader: {
  11132. name: string;
  11133. shader: string;
  11134. };
  11135. }
  11136. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11137. /** @hidden */
  11138. export var fogVertexDeclaration: {
  11139. name: string;
  11140. shader: string;
  11141. };
  11142. }
  11143. declare module "babylonjs/Shaders/sprites.vertex" {
  11144. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11145. /** @hidden */
  11146. export var spritesVertexShader: {
  11147. name: string;
  11148. shader: string;
  11149. };
  11150. }
  11151. declare module "babylonjs/Sprites/spriteManager" {
  11152. import { IDisposable, Scene } from "babylonjs/scene";
  11153. import { Nullable } from "babylonjs/types";
  11154. import { Observable } from "babylonjs/Misc/observable";
  11155. import { Sprite } from "babylonjs/Sprites/sprite";
  11156. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11157. import { Camera } from "babylonjs/Cameras/camera";
  11158. import { Texture } from "babylonjs/Materials/Textures/texture";
  11159. import "babylonjs/Shaders/sprites.fragment";
  11160. import "babylonjs/Shaders/sprites.vertex";
  11161. import { Ray } from "babylonjs/Culling/ray";
  11162. /**
  11163. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11164. */
  11165. export interface ISpriteManager extends IDisposable {
  11166. /**
  11167. * Gets manager's name
  11168. */
  11169. name: string;
  11170. /**
  11171. * Restricts the camera to viewing objects with the same layerMask.
  11172. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11173. */
  11174. layerMask: number;
  11175. /**
  11176. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11177. */
  11178. isPickable: boolean;
  11179. /**
  11180. * Gets the hosting scene
  11181. */
  11182. scene: Scene;
  11183. /**
  11184. * Specifies the rendering group id for this mesh (0 by default)
  11185. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11186. */
  11187. renderingGroupId: number;
  11188. /**
  11189. * Defines the list of sprites managed by the manager.
  11190. */
  11191. sprites: Array<Sprite>;
  11192. /**
  11193. * Gets or sets the spritesheet texture
  11194. */
  11195. texture: Texture;
  11196. /** Defines the default width of a cell in the spritesheet */
  11197. cellWidth: number;
  11198. /** Defines the default height of a cell in the spritesheet */
  11199. cellHeight: number;
  11200. /**
  11201. * Tests the intersection of a sprite with a specific ray.
  11202. * @param ray The ray we are sending to test the collision
  11203. * @param camera The camera space we are sending rays in
  11204. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11205. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11206. * @returns picking info or null.
  11207. */
  11208. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11209. /**
  11210. * Intersects the sprites with a ray
  11211. * @param ray defines the ray to intersect with
  11212. * @param camera defines the current active camera
  11213. * @param predicate defines a predicate used to select candidate sprites
  11214. * @returns null if no hit or a PickingInfo array
  11215. */
  11216. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11217. /**
  11218. * Renders the list of sprites on screen.
  11219. */
  11220. render(): void;
  11221. }
  11222. /**
  11223. * Class used to manage multiple sprites on the same spritesheet
  11224. * @see https://doc.babylonjs.com/babylon101/sprites
  11225. */
  11226. export class SpriteManager implements ISpriteManager {
  11227. /** defines the manager's name */
  11228. name: string;
  11229. /** Define the Url to load snippets */
  11230. static SnippetUrl: string;
  11231. /** Snippet ID if the manager was created from the snippet server */
  11232. snippetId: string;
  11233. /** Gets the list of sprites */
  11234. sprites: Sprite[];
  11235. /** Gets or sets the rendering group id (0 by default) */
  11236. renderingGroupId: number;
  11237. /** Gets or sets camera layer mask */
  11238. layerMask: number;
  11239. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11240. fogEnabled: boolean;
  11241. /** Gets or sets a boolean indicating if the sprites are pickable */
  11242. isPickable: boolean;
  11243. /** Defines the default width of a cell in the spritesheet */
  11244. cellWidth: number;
  11245. /** Defines the default height of a cell in the spritesheet */
  11246. cellHeight: number;
  11247. /** Associative array from JSON sprite data file */
  11248. private _cellData;
  11249. /** Array of sprite names from JSON sprite data file */
  11250. private _spriteMap;
  11251. /** True when packed cell data from JSON file is ready*/
  11252. private _packedAndReady;
  11253. private _textureContent;
  11254. private _useInstancing;
  11255. /**
  11256. * An event triggered when the manager is disposed.
  11257. */
  11258. onDisposeObservable: Observable<SpriteManager>;
  11259. private _onDisposeObserver;
  11260. /**
  11261. * Callback called when the manager is disposed
  11262. */
  11263. set onDispose(callback: () => void);
  11264. private _capacity;
  11265. private _fromPacked;
  11266. private _spriteTexture;
  11267. private _epsilon;
  11268. private _scene;
  11269. private _vertexData;
  11270. private _buffer;
  11271. private _vertexBuffers;
  11272. private _spriteBuffer;
  11273. private _indexBuffer;
  11274. private _effectBase;
  11275. private _effectFog;
  11276. private _vertexBufferSize;
  11277. /**
  11278. * Gets or sets the unique id of the sprite
  11279. */
  11280. uniqueId: number;
  11281. /**
  11282. * Gets the array of sprites
  11283. */
  11284. get children(): Sprite[];
  11285. /**
  11286. * Gets the hosting scene
  11287. */
  11288. get scene(): Scene;
  11289. /**
  11290. * Gets the capacity of the manager
  11291. */
  11292. get capacity(): number;
  11293. /**
  11294. * Gets or sets the spritesheet texture
  11295. */
  11296. get texture(): Texture;
  11297. set texture(value: Texture);
  11298. private _blendMode;
  11299. /**
  11300. * Blend mode use to render the particle, it can be any of
  11301. * the static Constants.ALPHA_x properties provided in this class.
  11302. * Default value is Constants.ALPHA_COMBINE
  11303. */
  11304. get blendMode(): number;
  11305. set blendMode(blendMode: number);
  11306. /** Disables writing to the depth buffer when rendering the sprites.
  11307. * It can be handy to disable depth writing when using textures without alpha channel
  11308. * and setting some specific blend modes.
  11309. */
  11310. disableDepthWrite: boolean;
  11311. /**
  11312. * Creates a new sprite manager
  11313. * @param name defines the manager's name
  11314. * @param imgUrl defines the sprite sheet url
  11315. * @param capacity defines the maximum allowed number of sprites
  11316. * @param cellSize defines the size of a sprite cell
  11317. * @param scene defines the hosting scene
  11318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11319. * @param samplingMode defines the smapling mode to use with spritesheet
  11320. * @param fromPacked set to false; do not alter
  11321. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11322. */
  11323. constructor(
  11324. /** defines the manager's name */
  11325. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11326. /**
  11327. * Returns the string "SpriteManager"
  11328. * @returns "SpriteManager"
  11329. */
  11330. getClassName(): string;
  11331. private _makePacked;
  11332. private _appendSpriteVertex;
  11333. private _checkTextureAlpha;
  11334. /**
  11335. * Intersects the sprites with a ray
  11336. * @param ray defines the ray to intersect with
  11337. * @param camera defines the current active camera
  11338. * @param predicate defines a predicate used to select candidate sprites
  11339. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11340. * @returns null if no hit or a PickingInfo
  11341. */
  11342. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11343. /**
  11344. * Intersects the sprites with a ray
  11345. * @param ray defines the ray to intersect with
  11346. * @param camera defines the current active camera
  11347. * @param predicate defines a predicate used to select candidate sprites
  11348. * @returns null if no hit or a PickingInfo array
  11349. */
  11350. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11351. /**
  11352. * Render all child sprites
  11353. */
  11354. render(): void;
  11355. /**
  11356. * Release associated resources
  11357. */
  11358. dispose(): void;
  11359. /**
  11360. * Serializes the sprite manager to a JSON object
  11361. * @param serializeTexture defines if the texture must be serialized as well
  11362. * @returns the JSON object
  11363. */
  11364. serialize(serializeTexture?: boolean): any;
  11365. /**
  11366. * Parses a JSON object to create a new sprite manager.
  11367. * @param parsedManager The JSON object to parse
  11368. * @param scene The scene to create the sprite managerin
  11369. * @param rootUrl The root url to use to load external dependencies like texture
  11370. * @returns the new sprite manager
  11371. */
  11372. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11373. /**
  11374. * Creates a sprite manager from a snippet saved in a remote file
  11375. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11376. * @param url defines the url to load from
  11377. * @param scene defines the hosting scene
  11378. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11379. * @returns a promise that will resolve to the new sprite manager
  11380. */
  11381. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11382. /**
  11383. * Creates a sprite manager from a snippet saved by the sprite editor
  11384. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11385. * @param scene defines the hosting scene
  11386. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11387. * @returns a promise that will resolve to the new sprite manager
  11388. */
  11389. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11390. }
  11391. }
  11392. declare module "babylonjs/Misc/gradients" {
  11393. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11394. /** Interface used by value gradients (color, factor, ...) */
  11395. export interface IValueGradient {
  11396. /**
  11397. * Gets or sets the gradient value (between 0 and 1)
  11398. */
  11399. gradient: number;
  11400. }
  11401. /** Class used to store color4 gradient */
  11402. export class ColorGradient implements IValueGradient {
  11403. /**
  11404. * Gets or sets the gradient value (between 0 and 1)
  11405. */
  11406. gradient: number;
  11407. /**
  11408. * Gets or sets first associated color
  11409. */
  11410. color1: Color4;
  11411. /**
  11412. * Gets or sets second associated color
  11413. */
  11414. color2?: Color4 | undefined;
  11415. /**
  11416. * Creates a new color4 gradient
  11417. * @param gradient gets or sets the gradient value (between 0 and 1)
  11418. * @param color1 gets or sets first associated color
  11419. * @param color2 gets or sets first second color
  11420. */
  11421. constructor(
  11422. /**
  11423. * Gets or sets the gradient value (between 0 and 1)
  11424. */
  11425. gradient: number,
  11426. /**
  11427. * Gets or sets first associated color
  11428. */
  11429. color1: Color4,
  11430. /**
  11431. * Gets or sets second associated color
  11432. */
  11433. color2?: Color4 | undefined);
  11434. /**
  11435. * Will get a color picked randomly between color1 and color2.
  11436. * If color2 is undefined then color1 will be used
  11437. * @param result defines the target Color4 to store the result in
  11438. */
  11439. getColorToRef(result: Color4): void;
  11440. }
  11441. /** Class used to store color 3 gradient */
  11442. export class Color3Gradient implements IValueGradient {
  11443. /**
  11444. * Gets or sets the gradient value (between 0 and 1)
  11445. */
  11446. gradient: number;
  11447. /**
  11448. * Gets or sets the associated color
  11449. */
  11450. color: Color3;
  11451. /**
  11452. * Creates a new color3 gradient
  11453. * @param gradient gets or sets the gradient value (between 0 and 1)
  11454. * @param color gets or sets associated color
  11455. */
  11456. constructor(
  11457. /**
  11458. * Gets or sets the gradient value (between 0 and 1)
  11459. */
  11460. gradient: number,
  11461. /**
  11462. * Gets or sets the associated color
  11463. */
  11464. color: Color3);
  11465. }
  11466. /** Class used to store factor gradient */
  11467. export class FactorGradient implements IValueGradient {
  11468. /**
  11469. * Gets or sets the gradient value (between 0 and 1)
  11470. */
  11471. gradient: number;
  11472. /**
  11473. * Gets or sets first associated factor
  11474. */
  11475. factor1: number;
  11476. /**
  11477. * Gets or sets second associated factor
  11478. */
  11479. factor2?: number | undefined;
  11480. /**
  11481. * Creates a new factor gradient
  11482. * @param gradient gets or sets the gradient value (between 0 and 1)
  11483. * @param factor1 gets or sets first associated factor
  11484. * @param factor2 gets or sets second associated factor
  11485. */
  11486. constructor(
  11487. /**
  11488. * Gets or sets the gradient value (between 0 and 1)
  11489. */
  11490. gradient: number,
  11491. /**
  11492. * Gets or sets first associated factor
  11493. */
  11494. factor1: number,
  11495. /**
  11496. * Gets or sets second associated factor
  11497. */
  11498. factor2?: number | undefined);
  11499. /**
  11500. * Will get a number picked randomly between factor1 and factor2.
  11501. * If factor2 is undefined then factor1 will be used
  11502. * @returns the picked number
  11503. */
  11504. getFactor(): number;
  11505. }
  11506. /**
  11507. * Helper used to simplify some generic gradient tasks
  11508. */
  11509. export class GradientHelper {
  11510. /**
  11511. * Gets the current gradient from an array of IValueGradient
  11512. * @param ratio defines the current ratio to get
  11513. * @param gradients defines the array of IValueGradient
  11514. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11515. */
  11516. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11517. }
  11518. }
  11519. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11520. import { Nullable } from "babylonjs/types";
  11521. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11522. import { Scene } from "babylonjs/scene";
  11523. module "babylonjs/Engines/thinEngine" {
  11524. interface ThinEngine {
  11525. /**
  11526. * Creates a raw texture
  11527. * @param data defines the data to store in the texture
  11528. * @param width defines the width of the texture
  11529. * @param height defines the height of the texture
  11530. * @param format defines the format of the data
  11531. * @param generateMipMaps defines if the engine should generate the mip levels
  11532. * @param invertY defines if data must be stored with Y axis inverted
  11533. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11534. * @param compression defines the compression used (null by default)
  11535. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11536. * @returns the raw texture inside an InternalTexture
  11537. */
  11538. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11539. /**
  11540. * Update a raw texture
  11541. * @param texture defines the texture to update
  11542. * @param data defines the data to store in the texture
  11543. * @param format defines the format of the data
  11544. * @param invertY defines if data must be stored with Y axis inverted
  11545. */
  11546. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11547. /**
  11548. * Update a raw texture
  11549. * @param texture defines the texture to update
  11550. * @param data defines the data to store in the texture
  11551. * @param format defines the format of the data
  11552. * @param invertY defines if data must be stored with Y axis inverted
  11553. * @param compression defines the compression used (null by default)
  11554. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11555. */
  11556. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11557. /**
  11558. * Creates a new raw cube texture
  11559. * @param data defines the array of data to use to create each face
  11560. * @param size defines the size of the textures
  11561. * @param format defines the format of the data
  11562. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11563. * @param generateMipMaps defines if the engine should generate the mip levels
  11564. * @param invertY defines if data must be stored with Y axis inverted
  11565. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11566. * @param compression defines the compression used (null by default)
  11567. * @returns the cube texture as an InternalTexture
  11568. */
  11569. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11570. /**
  11571. * Update a raw cube texture
  11572. * @param texture defines the texture to udpdate
  11573. * @param data defines the data to store
  11574. * @param format defines the data format
  11575. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11576. * @param invertY defines if data must be stored with Y axis inverted
  11577. */
  11578. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11579. /**
  11580. * Update a raw cube texture
  11581. * @param texture defines the texture to udpdate
  11582. * @param data defines the data to store
  11583. * @param format defines the data format
  11584. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11585. * @param invertY defines if data must be stored with Y axis inverted
  11586. * @param compression defines the compression used (null by default)
  11587. */
  11588. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11589. /**
  11590. * Update a raw cube texture
  11591. * @param texture defines the texture to udpdate
  11592. * @param data defines the data to store
  11593. * @param format defines the data format
  11594. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11595. * @param invertY defines if data must be stored with Y axis inverted
  11596. * @param compression defines the compression used (null by default)
  11597. * @param level defines which level of the texture to update
  11598. */
  11599. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11600. /**
  11601. * Creates a new raw cube texture from a specified url
  11602. * @param url defines the url where the data is located
  11603. * @param scene defines the current scene
  11604. * @param size defines the size of the textures
  11605. * @param format defines the format of the data
  11606. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11607. * @param noMipmap defines if the engine should avoid generating the mip levels
  11608. * @param callback defines a callback used to extract texture data from loaded data
  11609. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11610. * @param onLoad defines a callback called when texture is loaded
  11611. * @param onError defines a callback called if there is an error
  11612. * @returns the cube texture as an InternalTexture
  11613. */
  11614. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  11615. /**
  11616. * Creates a new raw cube texture from a specified url
  11617. * @param url defines the url where the data is located
  11618. * @param scene defines the current scene
  11619. * @param size defines the size of the textures
  11620. * @param format defines the format of the data
  11621. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11622. * @param noMipmap defines if the engine should avoid generating the mip levels
  11623. * @param callback defines a callback used to extract texture data from loaded data
  11624. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11625. * @param onLoad defines a callback called when texture is loaded
  11626. * @param onError defines a callback called if there is an error
  11627. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11628. * @param invertY defines if data must be stored with Y axis inverted
  11629. * @returns the cube texture as an InternalTexture
  11630. */
  11631. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  11632. /**
  11633. * Creates a new raw 3D texture
  11634. * @param data defines the data used to create the texture
  11635. * @param width defines the width of the texture
  11636. * @param height defines the height of the texture
  11637. * @param depth defines the depth of the texture
  11638. * @param format defines the format of the texture
  11639. * @param generateMipMaps defines if the engine must generate mip levels
  11640. * @param invertY defines if data must be stored with Y axis inverted
  11641. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11642. * @param compression defines the compressed used (can be null)
  11643. * @param textureType defines the compressed used (can be null)
  11644. * @returns a new raw 3D texture (stored in an InternalTexture)
  11645. */
  11646. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11647. /**
  11648. * Update a raw 3D texture
  11649. * @param texture defines the texture to update
  11650. * @param data defines the data to store
  11651. * @param format defines the data format
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. */
  11654. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11655. /**
  11656. * Update a raw 3D texture
  11657. * @param texture defines the texture to update
  11658. * @param data defines the data to store
  11659. * @param format defines the data format
  11660. * @param invertY defines if data must be stored with Y axis inverted
  11661. * @param compression defines the used compression (can be null)
  11662. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11663. */
  11664. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11665. /**
  11666. * Creates a new raw 2D array texture
  11667. * @param data defines the data used to create the texture
  11668. * @param width defines the width of the texture
  11669. * @param height defines the height of the texture
  11670. * @param depth defines the number of layers of the texture
  11671. * @param format defines the format of the texture
  11672. * @param generateMipMaps defines if the engine must generate mip levels
  11673. * @param invertY defines if data must be stored with Y axis inverted
  11674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11675. * @param compression defines the compressed used (can be null)
  11676. * @param textureType defines the compressed used (can be null)
  11677. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11678. */
  11679. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11680. /**
  11681. * Update a raw 2D array texture
  11682. * @param texture defines the texture to update
  11683. * @param data defines the data to store
  11684. * @param format defines the data format
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. */
  11687. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11688. /**
  11689. * Update a raw 2D array texture
  11690. * @param texture defines the texture to update
  11691. * @param data defines the data to store
  11692. * @param format defines the data format
  11693. * @param invertY defines if data must be stored with Y axis inverted
  11694. * @param compression defines the used compression (can be null)
  11695. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11696. */
  11697. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11698. }
  11699. }
  11700. }
  11701. declare module "babylonjs/Materials/Textures/rawTexture" {
  11702. import { Texture } from "babylonjs/Materials/Textures/texture";
  11703. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11704. import { Nullable } from "babylonjs/types";
  11705. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11706. import { Scene } from "babylonjs/scene";
  11707. /**
  11708. * Raw texture can help creating a texture directly from an array of data.
  11709. * This can be super useful if you either get the data from an uncompressed source or
  11710. * if you wish to create your texture pixel by pixel.
  11711. */
  11712. export class RawTexture extends Texture {
  11713. /**
  11714. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11715. */
  11716. format: number;
  11717. /**
  11718. * Instantiates a new RawTexture.
  11719. * Raw texture can help creating a texture directly from an array of data.
  11720. * This can be super useful if you either get the data from an uncompressed source or
  11721. * if you wish to create your texture pixel by pixel.
  11722. * @param data define the array of data to use to create the texture
  11723. * @param width define the width of the texture
  11724. * @param height define the height of the texture
  11725. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11726. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11727. * @param generateMipMaps define whether mip maps should be generated or not
  11728. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11729. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11730. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11731. */
  11732. constructor(data: ArrayBufferView, width: number, height: number,
  11733. /**
  11734. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11735. */
  11736. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11737. /**
  11738. * Updates the texture underlying data.
  11739. * @param data Define the new data of the texture
  11740. */
  11741. update(data: ArrayBufferView): void;
  11742. /**
  11743. * Creates a luminance texture from some data.
  11744. * @param data Define the texture data
  11745. * @param width Define the width of the texture
  11746. * @param height Define the height of the texture
  11747. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11748. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11749. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11750. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11751. * @returns the luminance texture
  11752. */
  11753. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11754. /**
  11755. * Creates a luminance alpha texture from some data.
  11756. * @param data Define the texture data
  11757. * @param width Define the width of the texture
  11758. * @param height Define the height of the texture
  11759. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11760. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11761. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11762. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11763. * @returns the luminance alpha texture
  11764. */
  11765. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11766. /**
  11767. * Creates an alpha texture from some data.
  11768. * @param data Define the texture data
  11769. * @param width Define the width of the texture
  11770. * @param height Define the height of the texture
  11771. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11772. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11773. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11774. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11775. * @returns the alpha texture
  11776. */
  11777. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11778. /**
  11779. * Creates a RGB texture from some data.
  11780. * @param data Define the texture data
  11781. * @param width Define the width of the texture
  11782. * @param height Define the height of the texture
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. * @returns the RGB alpha texture
  11789. */
  11790. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11791. /**
  11792. * Creates a RGBA texture from some data.
  11793. * @param data Define the texture data
  11794. * @param width Define the width of the texture
  11795. * @param height Define the height of the texture
  11796. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11797. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11798. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11799. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11800. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11801. * @returns the RGBA texture
  11802. */
  11803. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11804. /**
  11805. * Creates a R texture from some data.
  11806. * @param data Define the texture data
  11807. * @param width Define the width of the texture
  11808. * @param height Define the height of the texture
  11809. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11810. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11811. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11812. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11813. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11814. * @returns the R texture
  11815. */
  11816. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11817. }
  11818. }
  11819. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11820. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11821. import { IndicesArray, DataArray } from "babylonjs/types";
  11822. module "babylonjs/Engines/thinEngine" {
  11823. interface ThinEngine {
  11824. /**
  11825. * Update a dynamic index buffer
  11826. * @param indexBuffer defines the target index buffer
  11827. * @param indices defines the data to update
  11828. * @param offset defines the offset in the target index buffer where update should start
  11829. */
  11830. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11831. /**
  11832. * Updates a dynamic vertex buffer.
  11833. * @param vertexBuffer the vertex buffer to update
  11834. * @param data the data used to update the vertex buffer
  11835. * @param byteOffset the byte offset of the data
  11836. * @param byteLength the byte length of the data
  11837. */
  11838. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11839. }
  11840. }
  11841. }
  11842. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11843. import { Scene } from "babylonjs/scene";
  11844. import { ISceneComponent } from "babylonjs/sceneComponent";
  11845. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11846. module "babylonjs/abstractScene" {
  11847. interface AbstractScene {
  11848. /**
  11849. * The list of procedural textures added to the scene
  11850. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11851. */
  11852. proceduralTextures: Array<ProceduralTexture>;
  11853. }
  11854. }
  11855. /**
  11856. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11857. * in a given scene.
  11858. */
  11859. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11860. /**
  11861. * The component name helpfull to identify the component in the list of scene components.
  11862. */
  11863. readonly name: string;
  11864. /**
  11865. * The scene the component belongs to.
  11866. */
  11867. scene: Scene;
  11868. /**
  11869. * Creates a new instance of the component for the given scene
  11870. * @param scene Defines the scene to register the component in
  11871. */
  11872. constructor(scene: Scene);
  11873. /**
  11874. * Registers the component in a given scene
  11875. */
  11876. register(): void;
  11877. /**
  11878. * Rebuilds the elements related to this component in case of
  11879. * context lost for instance.
  11880. */
  11881. rebuild(): void;
  11882. /**
  11883. * Disposes the component and the associated ressources.
  11884. */
  11885. dispose(): void;
  11886. private _beforeClear;
  11887. }
  11888. }
  11889. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11890. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11891. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11892. module "babylonjs/Engines/thinEngine" {
  11893. interface ThinEngine {
  11894. /**
  11895. * Creates a new render target cube texture
  11896. * @param size defines the size of the texture
  11897. * @param options defines the options used to create the texture
  11898. * @returns a new render target cube texture stored in an InternalTexture
  11899. */
  11900. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11901. }
  11902. }
  11903. }
  11904. declare module "babylonjs/Shaders/procedural.vertex" {
  11905. /** @hidden */
  11906. export var proceduralVertexShader: {
  11907. name: string;
  11908. shader: string;
  11909. };
  11910. }
  11911. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11912. import { Observable } from "babylonjs/Misc/observable";
  11913. import { Nullable } from "babylonjs/types";
  11914. import { Scene } from "babylonjs/scene";
  11915. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11916. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11917. import { Effect } from "babylonjs/Materials/effect";
  11918. import { Texture } from "babylonjs/Materials/Textures/texture";
  11919. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11920. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11921. import "babylonjs/Shaders/procedural.vertex";
  11922. /**
  11923. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  11924. * This is the base class of any Procedural texture and contains most of the shareable code.
  11925. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11926. */
  11927. export class ProceduralTexture extends Texture {
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  12937. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. protected _postMultiplyPivotMatrix: boolean;
  15088. protected _isWorldMatrixFrozen: boolean;
  15089. /** @hidden */
  15090. _indexInSceneTransformNodesArray: number;
  15091. /**
  15092. * An event triggered after the world matrix is updated
  15093. */
  15094. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15095. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15096. /**
  15097. * Gets a string identifying the name of the class
  15098. * @returns "TransformNode" string
  15099. */
  15100. getClassName(): string;
  15101. /**
  15102. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15103. */
  15104. get position(): Vector3;
  15105. set position(newPosition: Vector3);
  15106. /**
  15107. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15108. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15109. */
  15110. get rotation(): Vector3;
  15111. set rotation(newRotation: Vector3);
  15112. /**
  15113. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15114. */
  15115. get scaling(): Vector3;
  15116. set scaling(newScaling: Vector3);
  15117. /**
  15118. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  15119. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15120. */
  15121. get rotationQuaternion(): Nullable<Quaternion>;
  15122. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15123. /**
  15124. * The forward direction of that transform in world space.
  15125. */
  15126. get forward(): Vector3;
  15127. /**
  15128. * The up direction of that transform in world space.
  15129. */
  15130. get up(): Vector3;
  15131. /**
  15132. * The right direction of that transform in world space.
  15133. */
  15134. get right(): Vector3;
  15135. /**
  15136. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15137. * @param matrix the matrix to copy the pose from
  15138. * @returns this TransformNode.
  15139. */
  15140. updatePoseMatrix(matrix: Matrix): TransformNode;
  15141. /**
  15142. * Returns the mesh Pose matrix.
  15143. * @returns the pose matrix
  15144. */
  15145. getPoseMatrix(): Matrix;
  15146. /** @hidden */
  15147. _isSynchronized(): boolean;
  15148. /** @hidden */
  15149. _initCache(): void;
  15150. /**
  15151. * Flag the transform node as dirty (Forcing it to update everything)
  15152. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15153. * @returns this transform node
  15154. */
  15155. markAsDirty(property: string): TransformNode;
  15156. /**
  15157. * Returns the current mesh absolute position.
  15158. * Returns a Vector3.
  15159. */
  15160. get absolutePosition(): Vector3;
  15161. /**
  15162. * Returns the current mesh absolute scaling.
  15163. * Returns a Vector3.
  15164. */
  15165. get absoluteScaling(): Vector3;
  15166. /**
  15167. * Returns the current mesh absolute rotation.
  15168. * Returns a Quaternion.
  15169. */
  15170. get absoluteRotationQuaternion(): Quaternion;
  15171. /**
  15172. * Sets a new matrix to apply before all other transformation
  15173. * @param matrix defines the transform matrix
  15174. * @returns the current TransformNode
  15175. */
  15176. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15177. /**
  15178. * Sets a new pivot matrix to the current node
  15179. * @param matrix defines the new pivot matrix to use
  15180. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  15181. * @returns the current TransformNode
  15182. */
  15183. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15184. /**
  15185. * Returns the mesh pivot matrix.
  15186. * Default : Identity.
  15187. * @returns the matrix
  15188. */
  15189. getPivotMatrix(): Matrix;
  15190. /**
  15191. * Instantiate (when possible) or clone that node with its hierarchy
  15192. * @param newParent defines the new parent to use for the instance (or clone)
  15193. * @param options defines options to configure how copy is done
  15194. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15195. * @returns an instance (or a clone) of the current node with its hiearchy
  15196. */
  15197. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15198. doNotInstantiate: boolean;
  15199. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15200. /**
  15201. * Prevents the World matrix to be computed any longer
  15202. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15203. * @returns the TransformNode.
  15204. */
  15205. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15206. /**
  15207. * Allows back the World matrix computation.
  15208. * @returns the TransformNode.
  15209. */
  15210. unfreezeWorldMatrix(): this;
  15211. /**
  15212. * True if the World matrix has been frozen.
  15213. */
  15214. get isWorldMatrixFrozen(): boolean;
  15215. /**
  15216. * Retuns the mesh absolute position in the World.
  15217. * @returns a Vector3.
  15218. */
  15219. getAbsolutePosition(): Vector3;
  15220. /**
  15221. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15222. * @param absolutePosition the absolute position to set
  15223. * @returns the TransformNode.
  15224. */
  15225. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15226. /**
  15227. * Sets the mesh position in its local space.
  15228. * @param vector3 the position to set in localspace
  15229. * @returns the TransformNode.
  15230. */
  15231. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15232. /**
  15233. * Returns the mesh position in the local space from the current World matrix values.
  15234. * @returns a new Vector3.
  15235. */
  15236. getPositionExpressedInLocalSpace(): Vector3;
  15237. /**
  15238. * Translates the mesh along the passed Vector3 in its local space.
  15239. * @param vector3 the distance to translate in localspace
  15240. * @returns the TransformNode.
  15241. */
  15242. locallyTranslate(vector3: Vector3): TransformNode;
  15243. private static _lookAtVectorCache;
  15244. /**
  15245. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15246. * @param targetPoint the position (must be in same space as current mesh) to look at
  15247. * @param yawCor optional yaw (y-axis) correction in radians
  15248. * @param pitchCor optional pitch (x-axis) correction in radians
  15249. * @param rollCor optional roll (z-axis) correction in radians
  15250. * @param space the choosen space of the target
  15251. * @returns the TransformNode.
  15252. */
  15253. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15254. /**
  15255. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15256. * This Vector3 is expressed in the World space.
  15257. * @param localAxis axis to rotate
  15258. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15259. */
  15260. getDirection(localAxis: Vector3): Vector3;
  15261. /**
  15262. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15263. * localAxis is expressed in the mesh local space.
  15264. * result is computed in the Wordl space from the mesh World matrix.
  15265. * @param localAxis axis to rotate
  15266. * @param result the resulting transformnode
  15267. * @returns this TransformNode.
  15268. */
  15269. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15270. /**
  15271. * Sets this transform node rotation to the given local axis.
  15272. * @param localAxis the axis in local space
  15273. * @param yawCor optional yaw (y-axis) correction in radians
  15274. * @param pitchCor optional pitch (x-axis) correction in radians
  15275. * @param rollCor optional roll (z-axis) correction in radians
  15276. * @returns this TransformNode
  15277. */
  15278. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15279. /**
  15280. * Sets a new pivot point to the current node
  15281. * @param point defines the new pivot point to use
  15282. * @param space defines if the point is in world or local space (local by default)
  15283. * @returns the current TransformNode
  15284. */
  15285. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15286. /**
  15287. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15288. * @returns the pivot point
  15289. */
  15290. getPivotPoint(): Vector3;
  15291. /**
  15292. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15293. * @param result the vector3 to store the result
  15294. * @returns this TransformNode.
  15295. */
  15296. getPivotPointToRef(result: Vector3): TransformNode;
  15297. /**
  15298. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15299. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. */
  15301. getAbsolutePivotPoint(): Vector3;
  15302. /**
  15303. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15304. * @param result vector3 to store the result
  15305. * @returns this TransformNode.
  15306. */
  15307. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15308. /**
  15309. * Defines the passed node as the parent of the current node.
  15310. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15311. * @see https://doc.babylonjs.com/how_to/parenting
  15312. * @param node the node ot set as the parent
  15313. * @returns this TransformNode.
  15314. */
  15315. setParent(node: Nullable<Node>): TransformNode;
  15316. private _nonUniformScaling;
  15317. /**
  15318. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15319. */
  15320. get nonUniformScaling(): boolean;
  15321. /** @hidden */
  15322. _updateNonUniformScalingState(value: boolean): boolean;
  15323. /**
  15324. * Attach the current TransformNode to another TransformNode associated with a bone
  15325. * @param bone Bone affecting the TransformNode
  15326. * @param affectedTransformNode TransformNode associated with the bone
  15327. * @returns this object
  15328. */
  15329. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15330. /**
  15331. * Detach the transform node if its associated with a bone
  15332. * @returns this object
  15333. */
  15334. detachFromBone(): TransformNode;
  15335. private static _rotationAxisCache;
  15336. /**
  15337. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15338. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15339. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15340. * The passed axis is also normalized.
  15341. * @param axis the axis to rotate around
  15342. * @param amount the amount to rotate in radians
  15343. * @param space Space to rotate in (Default: local)
  15344. * @returns the TransformNode.
  15345. */
  15346. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15347. /**
  15348. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15349. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15350. * The passed axis is also normalized. .
  15351. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15352. * @param point the point to rotate around
  15353. * @param axis the axis to rotate around
  15354. * @param amount the amount to rotate in radians
  15355. * @returns the TransformNode
  15356. */
  15357. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15358. /**
  15359. * Translates the mesh along the axis vector for the passed distance in the given space.
  15360. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15361. * @param axis the axis to translate in
  15362. * @param distance the distance to translate
  15363. * @param space Space to rotate in (Default: local)
  15364. * @returns the TransformNode.
  15365. */
  15366. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15367. /**
  15368. * Adds a rotation step to the mesh current rotation.
  15369. * x, y, z are Euler angles expressed in radians.
  15370. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15371. * This means this rotation is made in the mesh local space only.
  15372. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15373. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15374. * ```javascript
  15375. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15376. * ```
  15377. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15378. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  15379. * @param x Rotation to add
  15380. * @param y Rotation to add
  15381. * @param z Rotation to add
  15382. * @returns the TransformNode.
  15383. */
  15384. addRotation(x: number, y: number, z: number): TransformNode;
  15385. /**
  15386. * @hidden
  15387. */
  15388. protected _getEffectiveParent(): Nullable<Node>;
  15389. /**
  15390. * Computes the world matrix of the node
  15391. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15392. * @returns the world matrix
  15393. */
  15394. computeWorldMatrix(force?: boolean): Matrix;
  15395. /**
  15396. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15397. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15398. */
  15399. resetLocalMatrix(independentOfChildren?: boolean): void;
  15400. protected _afterComputeWorldMatrix(): void;
  15401. /**
  15402. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15403. * @param func callback function to add
  15404. *
  15405. * @returns the TransformNode.
  15406. */
  15407. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15408. /**
  15409. * Removes a registered callback function.
  15410. * @param func callback function to remove
  15411. * @returns the TransformNode.
  15412. */
  15413. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15414. /**
  15415. * Gets the position of the current mesh in camera space
  15416. * @param camera defines the camera to use
  15417. * @returns a position
  15418. */
  15419. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15420. /**
  15421. * Returns the distance from the mesh to the active camera
  15422. * @param camera defines the camera to use
  15423. * @returns the distance
  15424. */
  15425. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15426. /**
  15427. * Clone the current transform node
  15428. * @param name Name of the new clone
  15429. * @param newParent New parent for the clone
  15430. * @param doNotCloneChildren Do not clone children hierarchy
  15431. * @returns the new transform node
  15432. */
  15433. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15434. /**
  15435. * Serializes the objects information.
  15436. * @param currentSerializationObject defines the object to serialize in
  15437. * @returns the serialized object
  15438. */
  15439. serialize(currentSerializationObject?: any): any;
  15440. /**
  15441. * Returns a new TransformNode object parsed from the source provided.
  15442. * @param parsedTransformNode is the source.
  15443. * @param scene the scne the object belongs to
  15444. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15445. * @returns a new TransformNode object parsed from the source provided.
  15446. */
  15447. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15448. /**
  15449. * Get all child-transformNodes of this node
  15450. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  15451. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  15452. * @returns an array of TransformNode
  15453. */
  15454. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15455. /**
  15456. * Releases resources associated with this transform node.
  15457. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15458. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15459. */
  15460. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15461. /**
  15462. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15463. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15464. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15465. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15466. * @returns the current mesh
  15467. */
  15468. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15469. private _syncAbsoluteScalingAndRotation;
  15470. }
  15471. }
  15472. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15473. /**
  15474. * Class used to override all child animations of a given target
  15475. */
  15476. export class AnimationPropertiesOverride {
  15477. /**
  15478. * Gets or sets a value indicating if animation blending must be used
  15479. */
  15480. enableBlending: boolean;
  15481. /**
  15482. * Gets or sets the blending speed to use when enableBlending is true
  15483. */
  15484. blendingSpeed: number;
  15485. /**
  15486. * Gets or sets the default loop mode to use
  15487. */
  15488. loopMode: number;
  15489. }
  15490. }
  15491. declare module "babylonjs/Bones/bone" {
  15492. import { Skeleton } from "babylonjs/Bones/skeleton";
  15493. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15494. import { Nullable } from "babylonjs/types";
  15495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15497. import { Node } from "babylonjs/node";
  15498. import { Space } from "babylonjs/Maths/math.axis";
  15499. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15500. /**
  15501. * Class used to store bone information
  15502. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15503. */
  15504. export class Bone extends Node {
  15505. /**
  15506. * defines the bone name
  15507. */
  15508. name: string;
  15509. private static _tmpVecs;
  15510. private static _tmpQuat;
  15511. private static _tmpMats;
  15512. /**
  15513. * Gets the list of child bones
  15514. */
  15515. children: Bone[];
  15516. /** Gets the animations associated with this bone */
  15517. animations: import("babylonjs/Animations/animation").Animation[];
  15518. /**
  15519. * Gets or sets bone length
  15520. */
  15521. length: number;
  15522. /**
  15523. * @hidden Internal only
  15524. * Set this value to map this bone to a different index in the transform matrices
  15525. * Set this value to -1 to exclude the bone from the transform matrices
  15526. */
  15527. _index: Nullable<number>;
  15528. private _skeleton;
  15529. private _localMatrix;
  15530. private _restPose;
  15531. private _bindPose;
  15532. private _baseMatrix;
  15533. private _absoluteTransform;
  15534. private _invertedAbsoluteTransform;
  15535. private _parent;
  15536. private _scalingDeterminant;
  15537. private _worldTransform;
  15538. private _localScaling;
  15539. private _localRotation;
  15540. private _localPosition;
  15541. private _needToDecompose;
  15542. private _needToCompose;
  15543. /** @hidden */
  15544. _linkedTransformNode: Nullable<TransformNode>;
  15545. /** @hidden */
  15546. _waitingTransformNodeId: Nullable<string>;
  15547. /** @hidden */
  15548. get _matrix(): Matrix;
  15549. /** @hidden */
  15550. set _matrix(value: Matrix);
  15551. /**
  15552. * Create a new bone
  15553. * @param name defines the bone name
  15554. * @param skeleton defines the parent skeleton
  15555. * @param parentBone defines the parent (can be null if the bone is the root)
  15556. * @param localMatrix defines the local matrix
  15557. * @param restPose defines the rest pose matrix
  15558. * @param baseMatrix defines the base matrix
  15559. * @param index defines index of the bone in the hiearchy
  15560. */
  15561. constructor(
  15562. /**
  15563. * defines the bone name
  15564. */
  15565. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15566. /**
  15567. * Gets the current object class name.
  15568. * @return the class name
  15569. */
  15570. getClassName(): string;
  15571. /**
  15572. * Gets the parent skeleton
  15573. * @returns a skeleton
  15574. */
  15575. getSkeleton(): Skeleton;
  15576. /**
  15577. * Gets parent bone
  15578. * @returns a bone or null if the bone is the root of the bone hierarchy
  15579. */
  15580. getParent(): Nullable<Bone>;
  15581. /**
  15582. * Returns an array containing the root bones
  15583. * @returns an array containing the root bones
  15584. */
  15585. getChildren(): Array<Bone>;
  15586. /**
  15587. * Gets the node index in matrix array generated for rendering
  15588. * @returns the node index
  15589. */
  15590. getIndex(): number;
  15591. /**
  15592. * Sets the parent bone
  15593. * @param parent defines the parent (can be null if the bone is the root)
  15594. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15595. */
  15596. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15597. /**
  15598. * Gets the local matrix
  15599. * @returns a matrix
  15600. */
  15601. getLocalMatrix(): Matrix;
  15602. /**
  15603. * Gets the base matrix (initial matrix which remains unchanged)
  15604. * @returns a matrix
  15605. */
  15606. getBaseMatrix(): Matrix;
  15607. /**
  15608. * Gets the rest pose matrix
  15609. * @returns a matrix
  15610. */
  15611. getRestPose(): Matrix;
  15612. /**
  15613. * Sets the rest pose matrix
  15614. * @param matrix the local-space rest pose to set for this bone
  15615. */
  15616. setRestPose(matrix: Matrix): void;
  15617. /**
  15618. * Gets the bind pose matrix
  15619. * @returns the bind pose matrix
  15620. */
  15621. getBindPose(): Matrix;
  15622. /**
  15623. * Sets the bind pose matrix
  15624. * @param matrix the local-space bind pose to set for this bone
  15625. */
  15626. setBindPose(matrix: Matrix): void;
  15627. /**
  15628. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15629. */
  15630. getWorldMatrix(): Matrix;
  15631. /**
  15632. * Sets the local matrix to rest pose matrix
  15633. */
  15634. returnToRest(): void;
  15635. /**
  15636. * Gets the inverse of the absolute transform matrix.
  15637. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15638. * @returns a matrix
  15639. */
  15640. getInvertedAbsoluteTransform(): Matrix;
  15641. /**
  15642. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15643. * @returns a matrix
  15644. */
  15645. getAbsoluteTransform(): Matrix;
  15646. /**
  15647. * Links with the given transform node.
  15648. * The local matrix of this bone is copied from the transform node every frame.
  15649. * @param transformNode defines the transform node to link to
  15650. */
  15651. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15652. /**
  15653. * Gets the node used to drive the bone's transformation
  15654. * @returns a transform node or null
  15655. */
  15656. getTransformNode(): Nullable<TransformNode>;
  15657. /** Gets or sets current position (in local space) */
  15658. get position(): Vector3;
  15659. set position(newPosition: Vector3);
  15660. /** Gets or sets current rotation (in local space) */
  15661. get rotation(): Vector3;
  15662. set rotation(newRotation: Vector3);
  15663. /** Gets or sets current rotation quaternion (in local space) */
  15664. get rotationQuaternion(): Quaternion;
  15665. set rotationQuaternion(newRotation: Quaternion);
  15666. /** Gets or sets current scaling (in local space) */
  15667. get scaling(): Vector3;
  15668. set scaling(newScaling: Vector3);
  15669. /**
  15670. * Gets the animation properties override
  15671. */
  15672. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15673. private _decompose;
  15674. private _compose;
  15675. /**
  15676. * Update the base and local matrices
  15677. * @param matrix defines the new base or local matrix
  15678. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15679. * @param updateLocalMatrix defines if the local matrix should be updated
  15680. */
  15681. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15682. /** @hidden */
  15683. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15684. /**
  15685. * Flag the bone as dirty (Forcing it to update everything)
  15686. */
  15687. markAsDirty(): void;
  15688. /** @hidden */
  15689. _markAsDirtyAndCompose(): void;
  15690. private _markAsDirtyAndDecompose;
  15691. /**
  15692. * Translate the bone in local or world space
  15693. * @param vec The amount to translate the bone
  15694. * @param space The space that the translation is in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. */
  15697. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15698. /**
  15699. * Set the postion of the bone in local or world space
  15700. * @param position The position to set the bone
  15701. * @param space The space that the position is in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. */
  15704. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15705. /**
  15706. * Set the absolute position of the bone (world space)
  15707. * @param position The position to set the bone
  15708. * @param mesh The mesh that this bone is attached to
  15709. */
  15710. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15711. /**
  15712. * Scale the bone on the x, y and z axes (in local space)
  15713. * @param x The amount to scale the bone on the x axis
  15714. * @param y The amount to scale the bone on the y axis
  15715. * @param z The amount to scale the bone on the z axis
  15716. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15717. */
  15718. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15719. /**
  15720. * Set the bone scaling in local space
  15721. * @param scale defines the scaling vector
  15722. */
  15723. setScale(scale: Vector3): void;
  15724. /**
  15725. * Gets the current scaling in local space
  15726. * @returns the current scaling vector
  15727. */
  15728. getScale(): Vector3;
  15729. /**
  15730. * Gets the current scaling in local space and stores it in a target vector
  15731. * @param result defines the target vector
  15732. */
  15733. getScaleToRef(result: Vector3): void;
  15734. /**
  15735. * Set the yaw, pitch, and roll of the bone in local or world space
  15736. * @param yaw The rotation of the bone on the y axis
  15737. * @param pitch The rotation of the bone on the x axis
  15738. * @param roll The rotation of the bone on the z axis
  15739. * @param space The space that the axes of rotation are in
  15740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15741. */
  15742. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15743. /**
  15744. * Add a rotation to the bone on an axis in local or world space
  15745. * @param axis The axis to rotate the bone on
  15746. * @param amount The amount to rotate the bone
  15747. * @param space The space that the axis is in
  15748. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15749. */
  15750. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15751. /**
  15752. * Set the rotation of the bone to a particular axis angle in local or world space
  15753. * @param axis The axis to rotate the bone on
  15754. * @param angle The angle that the bone should be rotated to
  15755. * @param space The space that the axis is in
  15756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15757. */
  15758. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15759. /**
  15760. * Set the euler rotation of the bone in local of world space
  15761. * @param rotation The euler rotation that the bone should be set to
  15762. * @param space The space that the rotation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the quaternion rotation of the bone in local of world space
  15768. * @param quat The quaternion rotation that the bone should be set to
  15769. * @param space The space that the rotation is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the rotation matrix of the bone in local of world space
  15775. * @param rotMat The rotation matrix that the bone should be set to
  15776. * @param space The space that the rotation is in
  15777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15778. */
  15779. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15780. private _rotateWithMatrix;
  15781. private _getNegativeRotationToRef;
  15782. /**
  15783. * Get the position of the bone in local or world space
  15784. * @param space The space that the returned position is in
  15785. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15786. * @returns The position of the bone
  15787. */
  15788. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15789. /**
  15790. * Copy the position of the bone to a vector3 in local or world space
  15791. * @param space The space that the returned position is in
  15792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15793. * @param result The vector3 to copy the position to
  15794. */
  15795. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15796. /**
  15797. * Get the absolute position of the bone (world space)
  15798. * @param mesh The mesh that this bone is attached to
  15799. * @returns The absolute position of the bone
  15800. */
  15801. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15802. /**
  15803. * Copy the absolute position of the bone (world space) to the result param
  15804. * @param mesh The mesh that this bone is attached to
  15805. * @param result The vector3 to copy the absolute position to
  15806. */
  15807. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15808. /**
  15809. * Compute the absolute transforms of this bone and its children
  15810. */
  15811. computeAbsoluteTransforms(): void;
  15812. /**
  15813. * Get the world direction from an axis that is in the local space of the bone
  15814. * @param localAxis The local direction that is used to compute the world direction
  15815. * @param mesh The mesh that this bone is attached to
  15816. * @returns The world direction
  15817. */
  15818. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15819. /**
  15820. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15821. * @param localAxis The local direction that is used to compute the world direction
  15822. * @param mesh The mesh that this bone is attached to
  15823. * @param result The vector3 that the world direction will be copied to
  15824. */
  15825. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15826. /**
  15827. * Get the euler rotation of the bone in local or world space
  15828. * @param space The space that the rotation should be in
  15829. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15830. * @returns The euler rotation
  15831. */
  15832. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15833. /**
  15834. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15835. * @param space The space that the rotation should be in
  15836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15837. * @param result The vector3 that the rotation should be copied to
  15838. */
  15839. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15840. /**
  15841. * Get the quaternion rotation of the bone in either local or world space
  15842. * @param space The space that the rotation should be in
  15843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15844. * @returns The quaternion rotation
  15845. */
  15846. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15847. /**
  15848. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15849. * @param space The space that the rotation should be in
  15850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15851. * @param result The quaternion that the rotation should be copied to
  15852. */
  15853. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15854. /**
  15855. * Get the rotation matrix of the bone in local or world space
  15856. * @param space The space that the rotation should be in
  15857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15858. * @returns The rotation matrix
  15859. */
  15860. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15861. /**
  15862. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15863. * @param space The space that the rotation should be in
  15864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15865. * @param result The quaternion that the rotation should be copied to
  15866. */
  15867. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15868. /**
  15869. * Get the world position of a point that is in the local space of the bone
  15870. * @param position The local position
  15871. * @param mesh The mesh that this bone is attached to
  15872. * @returns The world position
  15873. */
  15874. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15875. /**
  15876. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15877. * @param position The local position
  15878. * @param mesh The mesh that this bone is attached to
  15879. * @param result The vector3 that the world position should be copied to
  15880. */
  15881. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15882. /**
  15883. * Get the local position of a point that is in world space
  15884. * @param position The world position
  15885. * @param mesh The mesh that this bone is attached to
  15886. * @returns The local position
  15887. */
  15888. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15889. /**
  15890. * Get the local position of a point that is in world space and copy it to the result param
  15891. * @param position The world position
  15892. * @param mesh The mesh that this bone is attached to
  15893. * @param result The vector3 that the local position should be copied to
  15894. */
  15895. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15896. }
  15897. }
  15898. declare module "babylonjs/Animations/runtimeAnimation" {
  15899. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15900. import { Animatable } from "babylonjs/Animations/animatable";
  15901. import { Scene } from "babylonjs/scene";
  15902. /**
  15903. * Defines a runtime animation
  15904. */
  15905. export class RuntimeAnimation {
  15906. private _events;
  15907. /**
  15908. * The current frame of the runtime animation
  15909. */
  15910. private _currentFrame;
  15911. /**
  15912. * The animation used by the runtime animation
  15913. */
  15914. private _animation;
  15915. /**
  15916. * The target of the runtime animation
  15917. */
  15918. private _target;
  15919. /**
  15920. * The initiating animatable
  15921. */
  15922. private _host;
  15923. /**
  15924. * The original value of the runtime animation
  15925. */
  15926. private _originalValue;
  15927. /**
  15928. * The original blend value of the runtime animation
  15929. */
  15930. private _originalBlendValue;
  15931. /**
  15932. * The offsets cache of the runtime animation
  15933. */
  15934. private _offsetsCache;
  15935. /**
  15936. * The high limits cache of the runtime animation
  15937. */
  15938. private _highLimitsCache;
  15939. /**
  15940. * Specifies if the runtime animation has been stopped
  15941. */
  15942. private _stopped;
  15943. /**
  15944. * The blending factor of the runtime animation
  15945. */
  15946. private _blendingFactor;
  15947. /**
  15948. * The BabylonJS scene
  15949. */
  15950. private _scene;
  15951. /**
  15952. * The current value of the runtime animation
  15953. */
  15954. private _currentValue;
  15955. /** @hidden */
  15956. _animationState: _IAnimationState;
  15957. /**
  15958. * The active target of the runtime animation
  15959. */
  15960. private _activeTargets;
  15961. private _currentActiveTarget;
  15962. private _directTarget;
  15963. /**
  15964. * The target path of the runtime animation
  15965. */
  15966. private _targetPath;
  15967. /**
  15968. * The weight of the runtime animation
  15969. */
  15970. private _weight;
  15971. /**
  15972. * The ratio offset of the runtime animation
  15973. */
  15974. private _ratioOffset;
  15975. /**
  15976. * The previous delay of the runtime animation
  15977. */
  15978. private _previousDelay;
  15979. /**
  15980. * The previous ratio of the runtime animation
  15981. */
  15982. private _previousRatio;
  15983. private _enableBlending;
  15984. private _keys;
  15985. private _minFrame;
  15986. private _maxFrame;
  15987. private _minValue;
  15988. private _maxValue;
  15989. private _targetIsArray;
  15990. /**
  15991. * Gets the current frame of the runtime animation
  15992. */
  15993. get currentFrame(): number;
  15994. /**
  15995. * Gets the weight of the runtime animation
  15996. */
  15997. get weight(): number;
  15998. /**
  15999. * Gets the current value of the runtime animation
  16000. */
  16001. get currentValue(): any;
  16002. /**
  16003. * Gets the target path of the runtime animation
  16004. */
  16005. get targetPath(): string;
  16006. /**
  16007. * Gets the actual target of the runtime animation
  16008. */
  16009. get target(): any;
  16010. /**
  16011. * Gets the additive state of the runtime animation
  16012. */
  16013. get isAdditive(): boolean;
  16014. /** @hidden */
  16015. _onLoop: () => void;
  16016. /**
  16017. * Create a new RuntimeAnimation object
  16018. * @param target defines the target of the animation
  16019. * @param animation defines the source animation object
  16020. * @param scene defines the hosting scene
  16021. * @param host defines the initiating Animatable
  16022. */
  16023. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16024. private _preparePath;
  16025. /**
  16026. * Gets the animation from the runtime animation
  16027. */
  16028. get animation(): Animation;
  16029. /**
  16030. * Resets the runtime animation to the beginning
  16031. * @param restoreOriginal defines whether to restore the target property to the original value
  16032. */
  16033. reset(restoreOriginal?: boolean): void;
  16034. /**
  16035. * Specifies if the runtime animation is stopped
  16036. * @returns Boolean specifying if the runtime animation is stopped
  16037. */
  16038. isStopped(): boolean;
  16039. /**
  16040. * Disposes of the runtime animation
  16041. */
  16042. dispose(): void;
  16043. /**
  16044. * Apply the interpolated value to the target
  16045. * @param currentValue defines the value computed by the animation
  16046. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16047. */
  16048. setValue(currentValue: any, weight: number): void;
  16049. private _getOriginalValues;
  16050. private _setValue;
  16051. /**
  16052. * Gets the loop pmode of the runtime animation
  16053. * @returns Loop Mode
  16054. */
  16055. private _getCorrectLoopMode;
  16056. /**
  16057. * Move the current animation to a given frame
  16058. * @param frame defines the frame to move to
  16059. */
  16060. goToFrame(frame: number): void;
  16061. /**
  16062. * @hidden Internal use only
  16063. */
  16064. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16065. /**
  16066. * Execute the current animation
  16067. * @param delay defines the delay to add to the current frame
  16068. * @param from defines the lower bound of the animation range
  16069. * @param to defines the upper bound of the animation range
  16070. * @param loop defines if the current animation must loop
  16071. * @param speedRatio defines the current speed ratio
  16072. * @param weight defines the weight of the animation (default is -1 so no weight)
  16073. * @param onLoop optional callback called when animation loops
  16074. * @returns a boolean indicating if the animation is running
  16075. */
  16076. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16077. }
  16078. }
  16079. declare module "babylonjs/Animations/animatable" {
  16080. import { Animation } from "babylonjs/Animations/animation";
  16081. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16082. import { Nullable } from "babylonjs/types";
  16083. import { Observable } from "babylonjs/Misc/observable";
  16084. import { Scene } from "babylonjs/scene";
  16085. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16086. import { Node } from "babylonjs/node";
  16087. /**
  16088. * Class used to store an actual running animation
  16089. */
  16090. export class Animatable {
  16091. /** defines the target object */
  16092. target: any;
  16093. /** defines the starting frame number (default is 0) */
  16094. fromFrame: number;
  16095. /** defines the ending frame number (default is 100) */
  16096. toFrame: number;
  16097. /** defines if the animation must loop (default is false) */
  16098. loopAnimation: boolean;
  16099. /** defines a callback to call when animation ends if it is not looping */
  16100. onAnimationEnd?: (() => void) | null | undefined;
  16101. /** defines a callback to call when animation loops */
  16102. onAnimationLoop?: (() => void) | null | undefined;
  16103. /** defines whether the animation should be evaluated additively */
  16104. isAdditive: boolean;
  16105. private _localDelayOffset;
  16106. private _pausedDelay;
  16107. private _runtimeAnimations;
  16108. private _paused;
  16109. private _scene;
  16110. private _speedRatio;
  16111. private _weight;
  16112. private _syncRoot;
  16113. /**
  16114. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16115. * This will only apply for non looping animation (default is true)
  16116. */
  16117. disposeOnEnd: boolean;
  16118. /**
  16119. * Gets a boolean indicating if the animation has started
  16120. */
  16121. animationStarted: boolean;
  16122. /**
  16123. * Observer raised when the animation ends
  16124. */
  16125. onAnimationEndObservable: Observable<Animatable>;
  16126. /**
  16127. * Observer raised when the animation loops
  16128. */
  16129. onAnimationLoopObservable: Observable<Animatable>;
  16130. /**
  16131. * Gets the root Animatable used to synchronize and normalize animations
  16132. */
  16133. get syncRoot(): Nullable<Animatable>;
  16134. /**
  16135. * Gets the current frame of the first RuntimeAnimation
  16136. * Used to synchronize Animatables
  16137. */
  16138. get masterFrame(): number;
  16139. /**
  16140. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16141. */
  16142. get weight(): number;
  16143. set weight(value: number);
  16144. /**
  16145. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16146. */
  16147. get speedRatio(): number;
  16148. set speedRatio(value: number);
  16149. /**
  16150. * Creates a new Animatable
  16151. * @param scene defines the hosting scene
  16152. * @param target defines the target object
  16153. * @param fromFrame defines the starting frame number (default is 0)
  16154. * @param toFrame defines the ending frame number (default is 100)
  16155. * @param loopAnimation defines if the animation must loop (default is false)
  16156. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16157. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16158. * @param animations defines a group of animation to add to the new Animatable
  16159. * @param onAnimationLoop defines a callback to call when animation loops
  16160. * @param isAdditive defines whether the animation should be evaluated additively
  16161. */
  16162. constructor(scene: Scene,
  16163. /** defines the target object */
  16164. target: any,
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame?: number,
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame?: number,
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation?: boolean, speedRatio?: number,
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined,
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive?: boolean);
  16177. /**
  16178. * Synchronize and normalize current Animatable with a source Animatable
  16179. * This is useful when using animation weights and when animations are not of the same length
  16180. * @param root defines the root Animatable to synchronize with
  16181. * @returns the current Animatable
  16182. */
  16183. syncWith(root: Animatable): Animatable;
  16184. /**
  16185. * Gets the list of runtime animations
  16186. * @returns an array of RuntimeAnimation
  16187. */
  16188. getAnimations(): RuntimeAnimation[];
  16189. /**
  16190. * Adds more animations to the current animatable
  16191. * @param target defines the target of the animations
  16192. * @param animations defines the new animations to add
  16193. */
  16194. appendAnimations(target: any, animations: Animation[]): void;
  16195. /**
  16196. * Gets the source animation for a specific property
  16197. * @param property defines the propertyu to look for
  16198. * @returns null or the source animation for the given property
  16199. */
  16200. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16201. /**
  16202. * Gets the runtime animation for a specific property
  16203. * @param property defines the propertyu to look for
  16204. * @returns null or the runtime animation for the given property
  16205. */
  16206. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16207. /**
  16208. * Resets the animatable to its original state
  16209. */
  16210. reset(): void;
  16211. /**
  16212. * Allows the animatable to blend with current running animations
  16213. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16214. * @param blendingSpeed defines the blending speed to use
  16215. */
  16216. enableBlending(blendingSpeed: number): void;
  16217. /**
  16218. * Disable animation blending
  16219. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16220. */
  16221. disableBlending(): void;
  16222. /**
  16223. * Jump directly to a given frame
  16224. * @param frame defines the frame to jump to
  16225. */
  16226. goToFrame(frame: number): void;
  16227. /**
  16228. * Pause the animation
  16229. */
  16230. pause(): void;
  16231. /**
  16232. * Restart the animation
  16233. */
  16234. restart(): void;
  16235. private _raiseOnAnimationEnd;
  16236. /**
  16237. * Stop and delete the current animation
  16238. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16239. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  16240. */
  16241. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16242. /**
  16243. * Wait asynchronously for the animation to end
  16244. * @returns a promise which will be fullfilled when the animation ends
  16245. */
  16246. waitAsync(): Promise<Animatable>;
  16247. /** @hidden */
  16248. _animate(delay: number): boolean;
  16249. }
  16250. module "babylonjs/scene" {
  16251. interface Scene {
  16252. /** @hidden */
  16253. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16254. /** @hidden */
  16255. _processLateAnimationBindingsForMatrices(holder: {
  16256. totalWeight: number;
  16257. totalAdditiveWeight: number;
  16258. animations: RuntimeAnimation[];
  16259. additiveAnimations: RuntimeAnimation[];
  16260. originalValue: Matrix;
  16261. }): any;
  16262. /** @hidden */
  16263. _processLateAnimationBindingsForQuaternions(holder: {
  16264. totalWeight: number;
  16265. totalAdditiveWeight: number;
  16266. animations: RuntimeAnimation[];
  16267. additiveAnimations: RuntimeAnimation[];
  16268. originalValue: Quaternion;
  16269. }, refQuaternion: Quaternion): Quaternion;
  16270. /** @hidden */
  16271. _processLateAnimationBindings(): void;
  16272. /**
  16273. * Will start the animation sequence of a given target
  16274. * @param target defines the target
  16275. * @param from defines from which frame should animation start
  16276. * @param to defines until which frame should animation run.
  16277. * @param weight defines the weight to apply to the animation (1.0 by default)
  16278. * @param loop defines if the animation loops
  16279. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16280. * @param onAnimationEnd defines the function to be executed when the animation ends
  16281. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16282. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16283. * @param onAnimationLoop defines the callback to call when an animation loops
  16284. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16285. * @returns the animatable object created for this animation
  16286. */
  16287. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16288. /**
  16289. * Will start the animation sequence of a given target
  16290. * @param target defines the target
  16291. * @param from defines from which frame should animation start
  16292. * @param to defines until which frame should animation run.
  16293. * @param loop defines if the animation loops
  16294. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16295. * @param onAnimationEnd defines the function to be executed when the animation ends
  16296. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16297. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16298. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16299. * @param onAnimationLoop defines the callback to call when an animation loops
  16300. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16301. * @returns the animatable object created for this animation
  16302. */
  16303. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16304. /**
  16305. * Will start the animation sequence of a given target and its hierarchy
  16306. * @param target defines the target
  16307. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16308. * @param from defines from which frame should animation start
  16309. * @param to defines until which frame should animation run.
  16310. * @param loop defines if the animation loops
  16311. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16312. * @param onAnimationEnd defines the function to be executed when the animation ends
  16313. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16314. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16315. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16316. * @param onAnimationLoop defines the callback to call when an animation loops
  16317. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16318. * @returns the list of created animatables
  16319. */
  16320. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16321. /**
  16322. * Begin a new animation on a given node
  16323. * @param target defines the target where the animation will take place
  16324. * @param animations defines the list of animations to start
  16325. * @param from defines the initial value
  16326. * @param to defines the final value
  16327. * @param loop defines if you want animation to loop (off by default)
  16328. * @param speedRatio defines the speed ratio to apply to all animations
  16329. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16330. * @param onAnimationLoop defines the callback to call when an animation loops
  16331. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16332. * @returns the list of created animatables
  16333. */
  16334. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16335. /**
  16336. * Begin a new animation on a given node and its hierarchy
  16337. * @param target defines the root node where the animation will take place
  16338. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16339. * @param animations defines the list of animations to start
  16340. * @param from defines the initial value
  16341. * @param to defines the final value
  16342. * @param loop defines if you want animation to loop (off by default)
  16343. * @param speedRatio defines the speed ratio to apply to all animations
  16344. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16345. * @param onAnimationLoop defines the callback to call when an animation loops
  16346. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16347. * @returns the list of animatables created for all nodes
  16348. */
  16349. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16350. /**
  16351. * Gets the animatable associated with a specific target
  16352. * @param target defines the target of the animatable
  16353. * @returns the required animatable if found
  16354. */
  16355. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16356. /**
  16357. * Gets all animatables associated with a given target
  16358. * @param target defines the target to look animatables for
  16359. * @returns an array of Animatables
  16360. */
  16361. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16362. /**
  16363. * Stops and removes all animations that have been applied to the scene
  16364. */
  16365. stopAllAnimations(): void;
  16366. /**
  16367. * Gets the current delta time used by animation engine
  16368. */
  16369. deltaTime: number;
  16370. }
  16371. }
  16372. module "babylonjs/Bones/bone" {
  16373. interface Bone {
  16374. /**
  16375. * Copy an animation range from another bone
  16376. * @param source defines the source bone
  16377. * @param rangeName defines the range name to copy
  16378. * @param frameOffset defines the frame offset
  16379. * @param rescaleAsRequired defines if rescaling must be applied if required
  16380. * @param skelDimensionsRatio defines the scaling ratio
  16381. * @returns true if operation was successful
  16382. */
  16383. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16384. }
  16385. }
  16386. }
  16387. declare module "babylonjs/Bones/skeleton" {
  16388. import { Bone } from "babylonjs/Bones/bone";
  16389. import { Observable } from "babylonjs/Misc/observable";
  16390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16391. import { Scene } from "babylonjs/scene";
  16392. import { Nullable } from "babylonjs/types";
  16393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16394. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16395. import { Animatable } from "babylonjs/Animations/animatable";
  16396. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16397. import { Animation } from "babylonjs/Animations/animation";
  16398. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16399. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16400. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16401. /**
  16402. * Class used to handle skinning animations
  16403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16404. */
  16405. export class Skeleton implements IAnimatable {
  16406. /** defines the skeleton name */
  16407. name: string;
  16408. /** defines the skeleton Id */
  16409. id: string;
  16410. /**
  16411. * Defines the list of child bones
  16412. */
  16413. bones: Bone[];
  16414. /**
  16415. * Defines an estimate of the dimension of the skeleton at rest
  16416. */
  16417. dimensionsAtRest: Vector3;
  16418. /**
  16419. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16420. */
  16421. needInitialSkinMatrix: boolean;
  16422. /**
  16423. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16424. */
  16425. overrideMesh: Nullable<AbstractMesh>;
  16426. /**
  16427. * Gets the list of animations attached to this skeleton
  16428. */
  16429. animations: Array<Animation>;
  16430. private _scene;
  16431. private _isDirty;
  16432. private _transformMatrices;
  16433. private _transformMatrixTexture;
  16434. private _meshesWithPoseMatrix;
  16435. private _animatables;
  16436. private _identity;
  16437. private _synchronizedWithMesh;
  16438. private _ranges;
  16439. private _lastAbsoluteTransformsUpdateId;
  16440. private _canUseTextureForBones;
  16441. private _uniqueId;
  16442. /** @hidden */
  16443. _numBonesWithLinkedTransformNode: number;
  16444. /** @hidden */
  16445. _hasWaitingData: Nullable<boolean>;
  16446. /** @hidden */
  16447. _waitingOverrideMeshId: Nullable<string>;
  16448. /**
  16449. * Specifies if the skeleton should be serialized
  16450. */
  16451. doNotSerialize: boolean;
  16452. private _useTextureToStoreBoneMatrices;
  16453. /**
  16454. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16455. * Please note that this option is not available if the hardware does not support it
  16456. */
  16457. get useTextureToStoreBoneMatrices(): boolean;
  16458. set useTextureToStoreBoneMatrices(value: boolean);
  16459. private _animationPropertiesOverride;
  16460. /**
  16461. * Gets or sets the animation properties override
  16462. */
  16463. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16464. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16465. /**
  16466. * List of inspectable custom properties (used by the Inspector)
  16467. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16468. */
  16469. inspectableCustomProperties: IInspectable[];
  16470. /**
  16471. * An observable triggered before computing the skeleton's matrices
  16472. */
  16473. onBeforeComputeObservable: Observable<Skeleton>;
  16474. /**
  16475. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16476. */
  16477. get isUsingTextureForMatrices(): boolean;
  16478. /**
  16479. * Gets the unique ID of this skeleton
  16480. */
  16481. get uniqueId(): number;
  16482. /**
  16483. * Creates a new skeleton
  16484. * @param name defines the skeleton name
  16485. * @param id defines the skeleton Id
  16486. * @param scene defines the hosting scene
  16487. */
  16488. constructor(
  16489. /** defines the skeleton name */
  16490. name: string,
  16491. /** defines the skeleton Id */
  16492. id: string, scene: Scene);
  16493. /**
  16494. * Gets the current object class name.
  16495. * @return the class name
  16496. */
  16497. getClassName(): string;
  16498. /**
  16499. * Returns an array containing the root bones
  16500. * @returns an array containing the root bones
  16501. */
  16502. getChildren(): Array<Bone>;
  16503. /**
  16504. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16505. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16506. * @returns a Float32Array containing matrices data
  16507. */
  16508. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16509. /**
  16510. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16511. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16512. * @returns a raw texture containing the data
  16513. */
  16514. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16515. /**
  16516. * Gets the current hosting scene
  16517. * @returns a scene object
  16518. */
  16519. getScene(): Scene;
  16520. /**
  16521. * Gets a string representing the current skeleton data
  16522. * @param fullDetails defines a boolean indicating if we want a verbose version
  16523. * @returns a string representing the current skeleton data
  16524. */
  16525. toString(fullDetails?: boolean): string;
  16526. /**
  16527. * Get bone's index searching by name
  16528. * @param name defines bone's name to search for
  16529. * @return the indice of the bone. Returns -1 if not found
  16530. */
  16531. getBoneIndexByName(name: string): number;
  16532. /**
  16533. * Creater a new animation range
  16534. * @param name defines the name of the range
  16535. * @param from defines the start key
  16536. * @param to defines the end key
  16537. */
  16538. createAnimationRange(name: string, from: number, to: number): void;
  16539. /**
  16540. * Delete a specific animation range
  16541. * @param name defines the name of the range
  16542. * @param deleteFrames defines if frames must be removed as well
  16543. */
  16544. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16545. /**
  16546. * Gets a specific animation range
  16547. * @param name defines the name of the range to look for
  16548. * @returns the requested animation range or null if not found
  16549. */
  16550. getAnimationRange(name: string): Nullable<AnimationRange>;
  16551. /**
  16552. * Gets the list of all animation ranges defined on this skeleton
  16553. * @returns an array
  16554. */
  16555. getAnimationRanges(): Nullable<AnimationRange>[];
  16556. /**
  16557. * Copy animation range from a source skeleton.
  16558. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16559. * @param source defines the source skeleton
  16560. * @param name defines the name of the range to copy
  16561. * @param rescaleAsRequired defines if rescaling must be applied if required
  16562. * @returns true if operation was successful
  16563. */
  16564. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16565. /**
  16566. * Forces the skeleton to go to rest pose
  16567. */
  16568. returnToRest(): void;
  16569. private _getHighestAnimationFrame;
  16570. /**
  16571. * Begin a specific animation range
  16572. * @param name defines the name of the range to start
  16573. * @param loop defines if looping must be turned on (false by default)
  16574. * @param speedRatio defines the speed ratio to apply (1 by default)
  16575. * @param onAnimationEnd defines a callback which will be called when animation will end
  16576. * @returns a new animatable
  16577. */
  16578. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16579. /**
  16580. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16581. * @param skeleton defines the Skeleton containing the animation range to convert
  16582. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16583. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16584. * @returns the original skeleton
  16585. */
  16586. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16587. /** @hidden */
  16588. _markAsDirty(): void;
  16589. /** @hidden */
  16590. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. /** @hidden */
  16592. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16593. private _computeTransformMatrices;
  16594. /**
  16595. * Build all resources required to render a skeleton
  16596. */
  16597. prepare(): void;
  16598. /**
  16599. * Gets the list of animatables currently running for this skeleton
  16600. * @returns an array of animatables
  16601. */
  16602. getAnimatables(): IAnimatable[];
  16603. /**
  16604. * Clone the current skeleton
  16605. * @param name defines the name of the new skeleton
  16606. * @param id defines the id of the new skeleton
  16607. * @returns the new skeleton
  16608. */
  16609. clone(name: string, id?: string): Skeleton;
  16610. /**
  16611. * Enable animation blending for this skeleton
  16612. * @param blendingSpeed defines the blending speed to apply
  16613. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16614. */
  16615. enableBlending(blendingSpeed?: number): void;
  16616. /**
  16617. * Releases all resources associated with the current skeleton
  16618. */
  16619. dispose(): void;
  16620. /**
  16621. * Serialize the skeleton in a JSON object
  16622. * @returns a JSON object
  16623. */
  16624. serialize(): any;
  16625. /**
  16626. * Creates a new skeleton from serialized data
  16627. * @param parsedSkeleton defines the serialized data
  16628. * @param scene defines the hosting scene
  16629. * @returns a new skeleton
  16630. */
  16631. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16632. /**
  16633. * Compute all node absolute transforms
  16634. * @param forceUpdate defines if computation must be done even if cache is up to date
  16635. */
  16636. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16637. /**
  16638. * Gets the root pose matrix
  16639. * @returns a matrix
  16640. */
  16641. getPoseMatrix(): Nullable<Matrix>;
  16642. /**
  16643. * Sorts bones per internal index
  16644. */
  16645. sortBones(): void;
  16646. private _sortBones;
  16647. }
  16648. }
  16649. declare module "babylonjs/Meshes/instancedMesh" {
  16650. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16651. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16652. import { Camera } from "babylonjs/Cameras/camera";
  16653. import { Node } from "babylonjs/node";
  16654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16655. import { Mesh } from "babylonjs/Meshes/mesh";
  16656. import { Material } from "babylonjs/Materials/material";
  16657. import { Skeleton } from "babylonjs/Bones/skeleton";
  16658. import { Light } from "babylonjs/Lights/light";
  16659. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16660. /**
  16661. * Creates an instance based on a source mesh.
  16662. */
  16663. export class InstancedMesh extends AbstractMesh {
  16664. private _sourceMesh;
  16665. private _currentLOD;
  16666. /** @hidden */
  16667. _indexInSourceMeshInstanceArray: number;
  16668. constructor(name: string, source: Mesh);
  16669. /**
  16670. * Returns the string "InstancedMesh".
  16671. */
  16672. getClassName(): string;
  16673. /** Gets the list of lights affecting that mesh */
  16674. get lightSources(): Light[];
  16675. _resyncLightSources(): void;
  16676. _resyncLightSource(light: Light): void;
  16677. _removeLightSource(light: Light, dispose: boolean): void;
  16678. /**
  16679. * If the source mesh receives shadows
  16680. */
  16681. get receiveShadows(): boolean;
  16682. /**
  16683. * The material of the source mesh
  16684. */
  16685. get material(): Nullable<Material>;
  16686. /**
  16687. * Visibility of the source mesh
  16688. */
  16689. get visibility(): number;
  16690. /**
  16691. * Skeleton of the source mesh
  16692. */
  16693. get skeleton(): Nullable<Skeleton>;
  16694. /**
  16695. * Rendering ground id of the source mesh
  16696. */
  16697. get renderingGroupId(): number;
  16698. set renderingGroupId(value: number);
  16699. /**
  16700. * Returns the total number of vertices (integer).
  16701. */
  16702. getTotalVertices(): number;
  16703. /**
  16704. * Returns a positive integer : the total number of indices in this mesh geometry.
  16705. * @returns the numner of indices or zero if the mesh has no geometry.
  16706. */
  16707. getTotalIndices(): number;
  16708. /**
  16709. * The source mesh of the instance
  16710. */
  16711. get sourceMesh(): Mesh;
  16712. /**
  16713. * Creates a new InstancedMesh object from the mesh model.
  16714. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16715. * @param name defines the name of the new instance
  16716. * @returns a new InstancedMesh
  16717. */
  16718. createInstance(name: string): InstancedMesh;
  16719. /**
  16720. * Is this node ready to be used/rendered
  16721. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16722. * @return {boolean} is it ready
  16723. */
  16724. isReady(completeCheck?: boolean): boolean;
  16725. /**
  16726. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16727. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16728. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  16729. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16730. */
  16731. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16732. /**
  16733. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16734. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16735. * The `data` are either a numeric array either a Float32Array.
  16736. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16737. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  16738. * Note that a new underlying VertexBuffer object is created each call.
  16739. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16740. *
  16741. * Possible `kind` values :
  16742. * - VertexBuffer.PositionKind
  16743. * - VertexBuffer.UVKind
  16744. * - VertexBuffer.UV2Kind
  16745. * - VertexBuffer.UV3Kind
  16746. * - VertexBuffer.UV4Kind
  16747. * - VertexBuffer.UV5Kind
  16748. * - VertexBuffer.UV6Kind
  16749. * - VertexBuffer.ColorKind
  16750. * - VertexBuffer.MatricesIndicesKind
  16751. * - VertexBuffer.MatricesIndicesExtraKind
  16752. * - VertexBuffer.MatricesWeightsKind
  16753. * - VertexBuffer.MatricesWeightsExtraKind
  16754. *
  16755. * Returns the Mesh.
  16756. */
  16757. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16758. /**
  16759. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16760. * If the mesh has no geometry, it is simply returned as it is.
  16761. * The `data` are either a numeric array either a Float32Array.
  16762. * No new underlying VertexBuffer object is created.
  16763. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16764. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16765. *
  16766. * Possible `kind` values :
  16767. * - VertexBuffer.PositionKind
  16768. * - VertexBuffer.UVKind
  16769. * - VertexBuffer.UV2Kind
  16770. * - VertexBuffer.UV3Kind
  16771. * - VertexBuffer.UV4Kind
  16772. * - VertexBuffer.UV5Kind
  16773. * - VertexBuffer.UV6Kind
  16774. * - VertexBuffer.ColorKind
  16775. * - VertexBuffer.MatricesIndicesKind
  16776. * - VertexBuffer.MatricesIndicesExtraKind
  16777. * - VertexBuffer.MatricesWeightsKind
  16778. * - VertexBuffer.MatricesWeightsExtraKind
  16779. *
  16780. * Returns the Mesh.
  16781. */
  16782. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16783. /**
  16784. * Sets the mesh indices.
  16785. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16786. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16787. * This method creates a new index buffer each call.
  16788. * Returns the Mesh.
  16789. */
  16790. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16791. /**
  16792. * Boolean : True if the mesh owns the requested kind of data.
  16793. */
  16794. isVerticesDataPresent(kind: string): boolean;
  16795. /**
  16796. * Returns an array of indices (IndicesArray).
  16797. */
  16798. getIndices(): Nullable<IndicesArray>;
  16799. get _positions(): Nullable<Vector3[]>;
  16800. /**
  16801. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16802. * This means the mesh underlying bounding box and sphere are recomputed.
  16803. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16804. * @returns the current mesh
  16805. */
  16806. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16807. /** @hidden */
  16808. _preActivate(): InstancedMesh;
  16809. /** @hidden */
  16810. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16811. /** @hidden */
  16812. _postActivate(): void;
  16813. getWorldMatrix(): Matrix;
  16814. get isAnInstance(): boolean;
  16815. /**
  16816. * Returns the current associated LOD AbstractMesh.
  16817. */
  16818. getLOD(camera: Camera): AbstractMesh;
  16819. /** @hidden */
  16820. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16821. /** @hidden */
  16822. _syncSubMeshes(): InstancedMesh;
  16823. /** @hidden */
  16824. _generatePointsArray(): boolean;
  16825. /** @hidden */
  16826. _updateBoundingInfo(): AbstractMesh;
  16827. /**
  16828. * Creates a new InstancedMesh from the current mesh.
  16829. * - name (string) : the cloned mesh name
  16830. * - newParent (optional Node) : the optional Node to parent the clone to.
  16831. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16832. *
  16833. * Returns the clone.
  16834. */
  16835. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16836. /**
  16837. * Disposes the InstancedMesh.
  16838. * Returns nothing.
  16839. */
  16840. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16841. }
  16842. module "babylonjs/Meshes/mesh" {
  16843. interface Mesh {
  16844. /**
  16845. * Register a custom buffer that will be instanced
  16846. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16847. * @param kind defines the buffer kind
  16848. * @param stride defines the stride in floats
  16849. */
  16850. registerInstancedBuffer(kind: string, stride: number): void;
  16851. /**
  16852. * true to use the edge renderer for all instances of this mesh
  16853. */
  16854. edgesShareWithInstances: boolean;
  16855. /** @hidden */
  16856. _userInstancedBuffersStorage: {
  16857. data: {
  16858. [key: string]: Float32Array;
  16859. };
  16860. sizes: {
  16861. [key: string]: number;
  16862. };
  16863. vertexBuffers: {
  16864. [key: string]: Nullable<VertexBuffer>;
  16865. };
  16866. strides: {
  16867. [key: string]: number;
  16868. };
  16869. };
  16870. }
  16871. }
  16872. module "babylonjs/Meshes/abstractMesh" {
  16873. interface AbstractMesh {
  16874. /**
  16875. * Object used to store instanced buffers defined by user
  16876. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16877. */
  16878. instancedBuffers: {
  16879. [key: string]: any;
  16880. };
  16881. }
  16882. }
  16883. }
  16884. declare module "babylonjs/Materials/shaderMaterial" {
  16885. import { Nullable } from "babylonjs/types";
  16886. import { Scene } from "babylonjs/scene";
  16887. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16888. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16889. import { Mesh } from "babylonjs/Meshes/mesh";
  16890. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16891. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16892. import { Effect } from "babylonjs/Materials/effect";
  16893. import { Material } from "babylonjs/Materials/material";
  16894. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16895. /**
  16896. * Defines the options associated with the creation of a shader material.
  16897. */
  16898. export interface IShaderMaterialOptions {
  16899. /**
  16900. * Does the material work in alpha blend mode
  16901. */
  16902. needAlphaBlending: boolean;
  16903. /**
  16904. * Does the material work in alpha test mode
  16905. */
  16906. needAlphaTesting: boolean;
  16907. /**
  16908. * The list of attribute names used in the shader
  16909. */
  16910. attributes: string[];
  16911. /**
  16912. * The list of unifrom names used in the shader
  16913. */
  16914. uniforms: string[];
  16915. /**
  16916. * The list of UBO names used in the shader
  16917. */
  16918. uniformBuffers: string[];
  16919. /**
  16920. * The list of sampler names used in the shader
  16921. */
  16922. samplers: string[];
  16923. /**
  16924. * The list of defines used in the shader
  16925. */
  16926. defines: string[];
  16927. }
  16928. /**
  16929. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16930. *
  16931. * This returned material effects how the mesh will look based on the code in the shaders.
  16932. *
  16933. * @see https://doc.babylonjs.com/how_to/shader_material
  16934. */
  16935. export class ShaderMaterial extends Material {
  16936. private _shaderPath;
  16937. private _options;
  16938. private _textures;
  16939. private _textureArrays;
  16940. private _floats;
  16941. private _ints;
  16942. private _floatsArrays;
  16943. private _colors3;
  16944. private _colors3Arrays;
  16945. private _colors4;
  16946. private _colors4Arrays;
  16947. private _vectors2;
  16948. private _vectors3;
  16949. private _vectors4;
  16950. private _matrices;
  16951. private _matrixArrays;
  16952. private _matrices3x3;
  16953. private _matrices2x2;
  16954. private _vectors2Arrays;
  16955. private _vectors3Arrays;
  16956. private _vectors4Arrays;
  16957. private _cachedWorldViewMatrix;
  16958. private _cachedWorldViewProjectionMatrix;
  16959. private _renderId;
  16960. private _multiview;
  16961. private _cachedDefines;
  16962. /** Define the Url to load snippets */
  16963. static SnippetUrl: string;
  16964. /** Snippet ID if the material was created from the snippet server */
  16965. snippetId: string;
  16966. /**
  16967. * Instantiate a new shader material.
  16968. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16969. * This returned material effects how the mesh will look based on the code in the shaders.
  16970. * @see https://doc.babylonjs.com/how_to/shader_material
  16971. * @param name Define the name of the material in the scene
  16972. * @param scene Define the scene the material belongs to
  16973. * @param shaderPath Defines the route to the shader code in one of three ways:
  16974. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16975. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16976. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16977. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16978. * @param options Define the options used to create the shader
  16979. */
  16980. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16981. /**
  16982. * Gets the shader path used to define the shader code
  16983. * It can be modified to trigger a new compilation
  16984. */
  16985. get shaderPath(): any;
  16986. /**
  16987. * Sets the shader path used to define the shader code
  16988. * It can be modified to trigger a new compilation
  16989. */
  16990. set shaderPath(shaderPath: any);
  16991. /**
  16992. * Gets the options used to compile the shader.
  16993. * They can be modified to trigger a new compilation
  16994. */
  16995. get options(): IShaderMaterialOptions;
  16996. /**
  16997. * Gets the current class name of the material e.g. "ShaderMaterial"
  16998. * Mainly use in serialization.
  16999. * @returns the class name
  17000. */
  17001. getClassName(): string;
  17002. /**
  17003. * Specifies if the material will require alpha blending
  17004. * @returns a boolean specifying if alpha blending is needed
  17005. */
  17006. needAlphaBlending(): boolean;
  17007. /**
  17008. * Specifies if this material should be rendered in alpha test mode
  17009. * @returns a boolean specifying if an alpha test is needed.
  17010. */
  17011. needAlphaTesting(): boolean;
  17012. private _checkUniform;
  17013. /**
  17014. * Set a texture in the shader.
  17015. * @param name Define the name of the uniform samplers as defined in the shader
  17016. * @param texture Define the texture to bind to this sampler
  17017. * @return the material itself allowing "fluent" like uniform updates
  17018. */
  17019. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17020. /**
  17021. * Set a texture array in the shader.
  17022. * @param name Define the name of the uniform sampler array as defined in the shader
  17023. * @param textures Define the list of textures to bind to this sampler
  17024. * @return the material itself allowing "fluent" like uniform updates
  17025. */
  17026. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17027. /**
  17028. * Set a float in the shader.
  17029. * @param name Define the name of the uniform as defined in the shader
  17030. * @param value Define the value to give to the uniform
  17031. * @return the material itself allowing "fluent" like uniform updates
  17032. */
  17033. setFloat(name: string, value: number): ShaderMaterial;
  17034. /**
  17035. * Set a int in the shader.
  17036. * @param name Define the name of the uniform as defined in the shader
  17037. * @param value Define the value to give to the uniform
  17038. * @return the material itself allowing "fluent" like uniform updates
  17039. */
  17040. setInt(name: string, value: number): ShaderMaterial;
  17041. /**
  17042. * Set an array of floats in the shader.
  17043. * @param name Define the name of the uniform as defined in the shader
  17044. * @param value Define the value to give to the uniform
  17045. * @return the material itself allowing "fluent" like uniform updates
  17046. */
  17047. setFloats(name: string, value: number[]): ShaderMaterial;
  17048. /**
  17049. * Set a vec3 in the shader from a Color3.
  17050. * @param name Define the name of the uniform as defined in the shader
  17051. * @param value Define the value to give to the uniform
  17052. * @return the material itself allowing "fluent" like uniform updates
  17053. */
  17054. setColor3(name: string, value: Color3): ShaderMaterial;
  17055. /**
  17056. * Set a vec3 array in the shader from a Color3 array.
  17057. * @param name Define the name of the uniform as defined in the shader
  17058. * @param value Define the value to give to the uniform
  17059. * @return the material itself allowing "fluent" like uniform updates
  17060. */
  17061. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17062. /**
  17063. * Set a vec4 in the shader from a Color4.
  17064. * @param name Define the name of the uniform as defined in the shader
  17065. * @param value Define the value to give to the uniform
  17066. * @return the material itself allowing "fluent" like uniform updates
  17067. */
  17068. setColor4(name: string, value: Color4): ShaderMaterial;
  17069. /**
  17070. * Set a vec4 array in the shader from a Color4 array.
  17071. * @param name Define the name of the uniform as defined in the shader
  17072. * @param value Define the value to give to the uniform
  17073. * @return the material itself allowing "fluent" like uniform updates
  17074. */
  17075. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17076. /**
  17077. * Set a vec2 in the shader from a Vector2.
  17078. * @param name Define the name of the uniform as defined in the shader
  17079. * @param value Define the value to give to the uniform
  17080. * @return the material itself allowing "fluent" like uniform updates
  17081. */
  17082. setVector2(name: string, value: Vector2): ShaderMaterial;
  17083. /**
  17084. * Set a vec3 in the shader from a Vector3.
  17085. * @param name Define the name of the uniform as defined in the shader
  17086. * @param value Define the value to give to the uniform
  17087. * @return the material itself allowing "fluent" like uniform updates
  17088. */
  17089. setVector3(name: string, value: Vector3): ShaderMaterial;
  17090. /**
  17091. * Set a vec4 in the shader from a Vector4.
  17092. * @param name Define the name of the uniform as defined in the shader
  17093. * @param value Define the value to give to the uniform
  17094. * @return the material itself allowing "fluent" like uniform updates
  17095. */
  17096. setVector4(name: string, value: Vector4): ShaderMaterial;
  17097. /**
  17098. * Set a mat4 in the shader from a Matrix.
  17099. * @param name Define the name of the uniform as defined in the shader
  17100. * @param value Define the value to give to the uniform
  17101. * @return the material itself allowing "fluent" like uniform updates
  17102. */
  17103. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17104. /**
  17105. * Set a float32Array in the shader from a matrix array.
  17106. * @param name Define the name of the uniform as defined in the shader
  17107. * @param value Define the value to give to the uniform
  17108. * @return the material itself allowing "fluent" like uniform updates
  17109. */
  17110. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17111. /**
  17112. * Set a mat3 in the shader from a Float32Array.
  17113. * @param name Define the name of the uniform as defined in the shader
  17114. * @param value Define the value to give to the uniform
  17115. * @return the material itself allowing "fluent" like uniform updates
  17116. */
  17117. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17118. /**
  17119. * Set a mat2 in the shader from a Float32Array.
  17120. * @param name Define the name of the uniform as defined in the shader
  17121. * @param value Define the value to give to the uniform
  17122. * @return the material itself allowing "fluent" like uniform updates
  17123. */
  17124. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17125. /**
  17126. * Set a vec2 array in the shader from a number array.
  17127. * @param name Define the name of the uniform as defined in the shader
  17128. * @param value Define the value to give to the uniform
  17129. * @return the material itself allowing "fluent" like uniform updates
  17130. */
  17131. setArray2(name: string, value: number[]): ShaderMaterial;
  17132. /**
  17133. * Set a vec3 array in the shader from a number array.
  17134. * @param name Define the name of the uniform as defined in the shader
  17135. * @param value Define the value to give to the uniform
  17136. * @return the material itself allowing "fluent" like uniform updates
  17137. */
  17138. setArray3(name: string, value: number[]): ShaderMaterial;
  17139. /**
  17140. * Set a vec4 array in the shader from a number array.
  17141. * @param name Define the name of the uniform as defined in the shader
  17142. * @param value Define the value to give to the uniform
  17143. * @return the material itself allowing "fluent" like uniform updates
  17144. */
  17145. setArray4(name: string, value: number[]): ShaderMaterial;
  17146. private _checkCache;
  17147. /**
  17148. * Specifies that the submesh is ready to be used
  17149. * @param mesh defines the mesh to check
  17150. * @param subMesh defines which submesh to check
  17151. * @param useInstances specifies that instances should be used
  17152. * @returns a boolean indicating that the submesh is ready or not
  17153. */
  17154. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17155. /**
  17156. * Checks if the material is ready to render the requested mesh
  17157. * @param mesh Define the mesh to render
  17158. * @param useInstances Define whether or not the material is used with instances
  17159. * @returns true if ready, otherwise false
  17160. */
  17161. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17162. /**
  17163. * Binds the world matrix to the material
  17164. * @param world defines the world transformation matrix
  17165. * @param effectOverride - If provided, use this effect instead of internal effect
  17166. */
  17167. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17168. /**
  17169. * Binds the submesh to this material by preparing the effect and shader to draw
  17170. * @param world defines the world transformation matrix
  17171. * @param mesh defines the mesh containing the submesh
  17172. * @param subMesh defines the submesh to bind the material to
  17173. */
  17174. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17175. /**
  17176. * Binds the material to the mesh
  17177. * @param world defines the world transformation matrix
  17178. * @param mesh defines the mesh to bind the material to
  17179. * @param effectOverride - If provided, use this effect instead of internal effect
  17180. */
  17181. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17182. protected _afterBind(mesh?: Mesh): void;
  17183. /**
  17184. * Gets the active textures from the material
  17185. * @returns an array of textures
  17186. */
  17187. getActiveTextures(): BaseTexture[];
  17188. /**
  17189. * Specifies if the material uses a texture
  17190. * @param texture defines the texture to check against the material
  17191. * @returns a boolean specifying if the material uses the texture
  17192. */
  17193. hasTexture(texture: BaseTexture): boolean;
  17194. /**
  17195. * Makes a duplicate of the material, and gives it a new name
  17196. * @param name defines the new name for the duplicated material
  17197. * @returns the cloned material
  17198. */
  17199. clone(name: string): ShaderMaterial;
  17200. /**
  17201. * Disposes the material
  17202. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17203. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17204. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17205. */
  17206. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17207. /**
  17208. * Serializes this material in a JSON representation
  17209. * @returns the serialized material object
  17210. */
  17211. serialize(): any;
  17212. /**
  17213. * Creates a shader material from parsed shader material data
  17214. * @param source defines the JSON represnetation of the material
  17215. * @param scene defines the hosting scene
  17216. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17217. * @returns a new material
  17218. */
  17219. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17220. /**
  17221. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17222. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17223. * @param url defines the url to load from
  17224. * @param scene defines the hosting scene
  17225. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17226. * @returns a promise that will resolve to the new ShaderMaterial
  17227. */
  17228. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17229. /**
  17230. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17231. * @param snippetId defines the snippet to load
  17232. * @param scene defines the hosting scene
  17233. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17234. * @returns a promise that will resolve to the new ShaderMaterial
  17235. */
  17236. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17237. }
  17238. }
  17239. declare module "babylonjs/Shaders/color.fragment" {
  17240. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17242. /** @hidden */
  17243. export var colorPixelShader: {
  17244. name: string;
  17245. shader: string;
  17246. };
  17247. }
  17248. declare module "babylonjs/Shaders/color.vertex" {
  17249. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17251. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17252. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17253. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17254. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17255. /** @hidden */
  17256. export var colorVertexShader: {
  17257. name: string;
  17258. shader: string;
  17259. };
  17260. }
  17261. declare module "babylonjs/Meshes/linesMesh" {
  17262. import { Nullable } from "babylonjs/types";
  17263. import { Scene } from "babylonjs/scene";
  17264. import { Color3 } from "babylonjs/Maths/math.color";
  17265. import { Node } from "babylonjs/node";
  17266. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17267. import { Mesh } from "babylonjs/Meshes/mesh";
  17268. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17269. import { Effect } from "babylonjs/Materials/effect";
  17270. import { Material } from "babylonjs/Materials/material";
  17271. import "babylonjs/Shaders/color.fragment";
  17272. import "babylonjs/Shaders/color.vertex";
  17273. /**
  17274. * Line mesh
  17275. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17276. */
  17277. export class LinesMesh extends Mesh {
  17278. /**
  17279. * If vertex color should be applied to the mesh
  17280. */
  17281. readonly useVertexColor?: boolean | undefined;
  17282. /**
  17283. * If vertex alpha should be applied to the mesh
  17284. */
  17285. readonly useVertexAlpha?: boolean | undefined;
  17286. /**
  17287. * Color of the line (Default: White)
  17288. */
  17289. color: Color3;
  17290. /**
  17291. * Alpha of the line (Default: 1)
  17292. */
  17293. alpha: number;
  17294. /**
  17295. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17296. * This margin is expressed in world space coordinates, so its value may vary.
  17297. * Default value is 0.1
  17298. */
  17299. intersectionThreshold: number;
  17300. private _colorShader;
  17301. private color4;
  17302. /**
  17303. * Creates a new LinesMesh
  17304. * @param name defines the name
  17305. * @param scene defines the hosting scene
  17306. * @param parent defines the parent mesh if any
  17307. * @param source defines the optional source LinesMesh used to clone data from
  17308. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17309. * When false, achieved by calling a clone(), also passing False.
  17310. * This will make creation of children, recursive.
  17311. * @param useVertexColor defines if this LinesMesh supports vertex color
  17312. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17313. */
  17314. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17315. /**
  17316. * If vertex color should be applied to the mesh
  17317. */
  17318. useVertexColor?: boolean | undefined,
  17319. /**
  17320. * If vertex alpha should be applied to the mesh
  17321. */
  17322. useVertexAlpha?: boolean | undefined);
  17323. private _addClipPlaneDefine;
  17324. private _removeClipPlaneDefine;
  17325. isReady(): boolean;
  17326. /**
  17327. * Returns the string "LineMesh"
  17328. */
  17329. getClassName(): string;
  17330. /**
  17331. * @hidden
  17332. */
  17333. get material(): Material;
  17334. /**
  17335. * @hidden
  17336. */
  17337. set material(value: Material);
  17338. /**
  17339. * @hidden
  17340. */
  17341. get checkCollisions(): boolean;
  17342. /** @hidden */
  17343. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17344. /** @hidden */
  17345. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17346. /**
  17347. * Disposes of the line mesh
  17348. * @param doNotRecurse If children should be disposed
  17349. */
  17350. dispose(doNotRecurse?: boolean): void;
  17351. /**
  17352. * Returns a new LineMesh object cloned from the current one.
  17353. */
  17354. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17355. /**
  17356. * Creates a new InstancedLinesMesh object from the mesh model.
  17357. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17358. * @param name defines the name of the new instance
  17359. * @returns a new InstancedLinesMesh
  17360. */
  17361. createInstance(name: string): InstancedLinesMesh;
  17362. }
  17363. /**
  17364. * Creates an instance based on a source LinesMesh
  17365. */
  17366. export class InstancedLinesMesh extends InstancedMesh {
  17367. /**
  17368. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17369. * This margin is expressed in world space coordinates, so its value may vary.
  17370. * Initilized with the intersectionThreshold value of the source LinesMesh
  17371. */
  17372. intersectionThreshold: number;
  17373. constructor(name: string, source: LinesMesh);
  17374. /**
  17375. * Returns the string "InstancedLinesMesh".
  17376. */
  17377. getClassName(): string;
  17378. }
  17379. }
  17380. declare module "babylonjs/Shaders/line.fragment" {
  17381. /** @hidden */
  17382. export var linePixelShader: {
  17383. name: string;
  17384. shader: string;
  17385. };
  17386. }
  17387. declare module "babylonjs/Shaders/line.vertex" {
  17388. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17389. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17390. /** @hidden */
  17391. export var lineVertexShader: {
  17392. name: string;
  17393. shader: string;
  17394. };
  17395. }
  17396. declare module "babylonjs/Rendering/edgesRenderer" {
  17397. import { Nullable } from "babylonjs/types";
  17398. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17400. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17401. import { IDisposable } from "babylonjs/scene";
  17402. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17403. import "babylonjs/Shaders/line.fragment";
  17404. import "babylonjs/Shaders/line.vertex";
  17405. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17406. import { SmartArray } from "babylonjs/Misc/smartArray";
  17407. module "babylonjs/scene" {
  17408. interface Scene {
  17409. /** @hidden */
  17410. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17411. }
  17412. }
  17413. module "babylonjs/Meshes/abstractMesh" {
  17414. interface AbstractMesh {
  17415. /**
  17416. * Gets the edgesRenderer associated with the mesh
  17417. */
  17418. edgesRenderer: Nullable<EdgesRenderer>;
  17419. }
  17420. }
  17421. module "babylonjs/Meshes/linesMesh" {
  17422. interface LinesMesh {
  17423. /**
  17424. * Enables the edge rendering mode on the mesh.
  17425. * This mode makes the mesh edges visible
  17426. * @param epsilon defines the maximal distance between two angles to detect a face
  17427. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17428. * @returns the currentAbstractMesh
  17429. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17430. */
  17431. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17432. }
  17433. }
  17434. module "babylonjs/Meshes/linesMesh" {
  17435. interface InstancedLinesMesh {
  17436. /**
  17437. * Enables the edge rendering mode on the mesh.
  17438. * This mode makes the mesh edges visible
  17439. * @param epsilon defines the maximal distance between two angles to detect a face
  17440. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17441. * @returns the current InstancedLinesMesh
  17442. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17443. */
  17444. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17445. }
  17446. }
  17447. /**
  17448. * Defines the minimum contract an Edges renderer should follow.
  17449. */
  17450. export interface IEdgesRenderer extends IDisposable {
  17451. /**
  17452. * Gets or sets a boolean indicating if the edgesRenderer is active
  17453. */
  17454. isEnabled: boolean;
  17455. /**
  17456. * Renders the edges of the attached mesh,
  17457. */
  17458. render(): void;
  17459. /**
  17460. * Checks wether or not the edges renderer is ready to render.
  17461. * @return true if ready, otherwise false.
  17462. */
  17463. isReady(): boolean;
  17464. /**
  17465. * List of instances to render in case the source mesh has instances
  17466. */
  17467. customInstances: SmartArray<Matrix>;
  17468. }
  17469. /**
  17470. * Defines the additional options of the edges renderer
  17471. */
  17472. export interface IEdgesRendererOptions {
  17473. /**
  17474. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17475. * If not defined, the default value is true
  17476. */
  17477. useAlternateEdgeFinder?: boolean;
  17478. /**
  17479. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17480. * If not defined, the default value is true.
  17481. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17482. * This option is used only if useAlternateEdgeFinder = true
  17483. */
  17484. useFastVertexMerger?: boolean;
  17485. /**
  17486. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17487. * The default value is 1e-6
  17488. * This option is used only if useAlternateEdgeFinder = true
  17489. */
  17490. epsilonVertexMerge?: number;
  17491. /**
  17492. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17493. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17494. * This option is used only if useAlternateEdgeFinder = true
  17495. */
  17496. applyTessellation?: boolean;
  17497. /**
  17498. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17499. * The default value is 1e-6
  17500. * This option is used only if useAlternateEdgeFinder = true
  17501. */
  17502. epsilonVertexAligned?: number;
  17503. }
  17504. /**
  17505. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17506. */
  17507. export class EdgesRenderer implements IEdgesRenderer {
  17508. /**
  17509. * Define the size of the edges with an orthographic camera
  17510. */
  17511. edgesWidthScalerForOrthographic: number;
  17512. /**
  17513. * Define the size of the edges with a perspective camera
  17514. */
  17515. edgesWidthScalerForPerspective: number;
  17516. protected _source: AbstractMesh;
  17517. protected _linesPositions: number[];
  17518. protected _linesNormals: number[];
  17519. protected _linesIndices: number[];
  17520. protected _epsilon: number;
  17521. protected _indicesCount: number;
  17522. protected _lineShader: ShaderMaterial;
  17523. protected _ib: DataBuffer;
  17524. protected _buffers: {
  17525. [key: string]: Nullable<VertexBuffer>;
  17526. };
  17527. protected _buffersForInstances: {
  17528. [key: string]: Nullable<VertexBuffer>;
  17529. };
  17530. protected _checkVerticesInsteadOfIndices: boolean;
  17531. protected _options: Nullable<IEdgesRendererOptions>;
  17532. private _meshRebuildObserver;
  17533. private _meshDisposeObserver;
  17534. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17535. isEnabled: boolean;
  17536. /**
  17537. * List of instances to render in case the source mesh has instances
  17538. */
  17539. customInstances: SmartArray<Matrix>;
  17540. private static GetShader;
  17541. /**
  17542. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17543. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17544. * @param source Mesh used to create edges
  17545. * @param epsilon sum of angles in adjacency to check for edge
  17546. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17547. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17548. * @param options The options to apply when generating the edges
  17549. */
  17550. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17551. protected _prepareRessources(): void;
  17552. /** @hidden */
  17553. _rebuild(): void;
  17554. /**
  17555. * Releases the required resources for the edges renderer
  17556. */
  17557. dispose(): void;
  17558. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17559. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17560. /**
  17561. * Checks if the pair of p0 and p1 is en edge
  17562. * @param faceIndex
  17563. * @param edge
  17564. * @param faceNormals
  17565. * @param p0
  17566. * @param p1
  17567. * @private
  17568. */
  17569. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17570. /**
  17571. * push line into the position, normal and index buffer
  17572. * @protected
  17573. */
  17574. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17575. /**
  17576. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17577. */
  17578. private _tessellateTriangle;
  17579. private _generateEdgesLinesAlternate;
  17580. /**
  17581. * Generates lines edges from adjacencjes
  17582. * @private
  17583. */
  17584. _generateEdgesLines(): void;
  17585. /**
  17586. * Checks wether or not the edges renderer is ready to render.
  17587. * @return true if ready, otherwise false.
  17588. */
  17589. isReady(): boolean;
  17590. /**
  17591. * Renders the edges of the attached mesh,
  17592. */
  17593. render(): void;
  17594. }
  17595. /**
  17596. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17597. */
  17598. export class LineEdgesRenderer extends EdgesRenderer {
  17599. /**
  17600. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17601. * @param source LineMesh used to generate edges
  17602. * @param epsilon not important (specified angle for edge detection)
  17603. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17604. */
  17605. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17606. /**
  17607. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17608. */
  17609. _generateEdgesLines(): void;
  17610. }
  17611. }
  17612. declare module "babylonjs/Rendering/renderingGroup" {
  17613. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17614. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17616. import { Nullable } from "babylonjs/types";
  17617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17618. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17619. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17620. import { Material } from "babylonjs/Materials/material";
  17621. import { Scene } from "babylonjs/scene";
  17622. /**
  17623. * This represents the object necessary to create a rendering group.
  17624. * This is exclusively used and created by the rendering manager.
  17625. * To modify the behavior, you use the available helpers in your scene or meshes.
  17626. * @hidden
  17627. */
  17628. export class RenderingGroup {
  17629. index: number;
  17630. private static _zeroVector;
  17631. private _scene;
  17632. private _opaqueSubMeshes;
  17633. private _transparentSubMeshes;
  17634. private _alphaTestSubMeshes;
  17635. private _depthOnlySubMeshes;
  17636. private _particleSystems;
  17637. private _spriteManagers;
  17638. private _opaqueSortCompareFn;
  17639. private _alphaTestSortCompareFn;
  17640. private _transparentSortCompareFn;
  17641. private _renderOpaque;
  17642. private _renderAlphaTest;
  17643. private _renderTransparent;
  17644. /** @hidden */
  17645. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17646. onBeforeTransparentRendering: () => void;
  17647. /**
  17648. * Set the opaque sort comparison function.
  17649. * If null the sub meshes will be render in the order they were created
  17650. */
  17651. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17652. /**
  17653. * Set the alpha test sort comparison function.
  17654. * If null the sub meshes will be render in the order they were created
  17655. */
  17656. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17657. /**
  17658. * Set the transparent sort comparison function.
  17659. * If null the sub meshes will be render in the order they were created
  17660. */
  17661. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17662. /**
  17663. * Creates a new rendering group.
  17664. * @param index The rendering group index
  17665. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17666. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17667. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17668. */
  17669. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17670. /**
  17671. * Render all the sub meshes contained in the group.
  17672. * @param customRenderFunction Used to override the default render behaviour of the group.
  17673. * @returns true if rendered some submeshes.
  17674. */
  17675. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17676. /**
  17677. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17678. * @param subMeshes The submeshes to render
  17679. */
  17680. private renderOpaqueSorted;
  17681. /**
  17682. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17683. * @param subMeshes The submeshes to render
  17684. */
  17685. private renderAlphaTestSorted;
  17686. /**
  17687. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17688. * @param subMeshes The submeshes to render
  17689. */
  17690. private renderTransparentSorted;
  17691. /**
  17692. * Renders the submeshes in a specified order.
  17693. * @param subMeshes The submeshes to sort before render
  17694. * @param sortCompareFn The comparison function use to sort
  17695. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17696. * @param transparent Specifies to activate blending if true
  17697. */
  17698. private static renderSorted;
  17699. /**
  17700. * Renders the submeshes in the order they were dispatched (no sort applied).
  17701. * @param subMeshes The submeshes to render
  17702. */
  17703. private static renderUnsorted;
  17704. /**
  17705. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17706. * are rendered back to front if in the same alpha index.
  17707. *
  17708. * @param a The first submesh
  17709. * @param b The second submesh
  17710. * @returns The result of the comparison
  17711. */
  17712. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17713. /**
  17714. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17715. * are rendered back to front.
  17716. *
  17717. * @param a The first submesh
  17718. * @param b The second submesh
  17719. * @returns The result of the comparison
  17720. */
  17721. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17722. /**
  17723. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17724. * are rendered front to back (prevent overdraw).
  17725. *
  17726. * @param a The first submesh
  17727. * @param b The second submesh
  17728. * @returns The result of the comparison
  17729. */
  17730. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17731. /**
  17732. * Resets the different lists of submeshes to prepare a new frame.
  17733. */
  17734. prepare(): void;
  17735. dispose(): void;
  17736. /**
  17737. * Inserts the submesh in its correct queue depending on its material.
  17738. * @param subMesh The submesh to dispatch
  17739. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17740. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17741. */
  17742. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17743. dispatchSprites(spriteManager: ISpriteManager): void;
  17744. dispatchParticles(particleSystem: IParticleSystem): void;
  17745. private _renderParticles;
  17746. private _renderSprites;
  17747. }
  17748. }
  17749. declare module "babylonjs/Rendering/renderingManager" {
  17750. import { Nullable } from "babylonjs/types";
  17751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17752. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17753. import { SmartArray } from "babylonjs/Misc/smartArray";
  17754. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17755. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17756. import { Material } from "babylonjs/Materials/material";
  17757. import { Scene } from "babylonjs/scene";
  17758. import { Camera } from "babylonjs/Cameras/camera";
  17759. /**
  17760. * Interface describing the different options available in the rendering manager
  17761. * regarding Auto Clear between groups.
  17762. */
  17763. export interface IRenderingManagerAutoClearSetup {
  17764. /**
  17765. * Defines whether or not autoclear is enable.
  17766. */
  17767. autoClear: boolean;
  17768. /**
  17769. * Defines whether or not to autoclear the depth buffer.
  17770. */
  17771. depth: boolean;
  17772. /**
  17773. * Defines whether or not to autoclear the stencil buffer.
  17774. */
  17775. stencil: boolean;
  17776. }
  17777. /**
  17778. * This class is used by the onRenderingGroupObservable
  17779. */
  17780. export class RenderingGroupInfo {
  17781. /**
  17782. * The Scene that being rendered
  17783. */
  17784. scene: Scene;
  17785. /**
  17786. * The camera currently used for the rendering pass
  17787. */
  17788. camera: Nullable<Camera>;
  17789. /**
  17790. * The ID of the renderingGroup being processed
  17791. */
  17792. renderingGroupId: number;
  17793. }
  17794. /**
  17795. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17796. * It is enable to manage the different groups as well as the different necessary sort functions.
  17797. * This should not be used directly aside of the few static configurations
  17798. */
  17799. export class RenderingManager {
  17800. /**
  17801. * The max id used for rendering groups (not included)
  17802. */
  17803. static MAX_RENDERINGGROUPS: number;
  17804. /**
  17805. * The min id used for rendering groups (included)
  17806. */
  17807. static MIN_RENDERINGGROUPS: number;
  17808. /**
  17809. * Used to globally prevent autoclearing scenes.
  17810. */
  17811. static AUTOCLEAR: boolean;
  17812. /**
  17813. * @hidden
  17814. */
  17815. _useSceneAutoClearSetup: boolean;
  17816. private _scene;
  17817. private _renderingGroups;
  17818. private _depthStencilBufferAlreadyCleaned;
  17819. private _autoClearDepthStencil;
  17820. private _customOpaqueSortCompareFn;
  17821. private _customAlphaTestSortCompareFn;
  17822. private _customTransparentSortCompareFn;
  17823. private _renderingGroupInfo;
  17824. /**
  17825. * Instantiates a new rendering group for a particular scene
  17826. * @param scene Defines the scene the groups belongs to
  17827. */
  17828. constructor(scene: Scene);
  17829. private _clearDepthStencilBuffer;
  17830. /**
  17831. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17832. * @hidden
  17833. */
  17834. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17835. /**
  17836. * Resets the different information of the group to prepare a new frame
  17837. * @hidden
  17838. */
  17839. reset(): void;
  17840. /**
  17841. * Dispose and release the group and its associated resources.
  17842. * @hidden
  17843. */
  17844. dispose(): void;
  17845. /**
  17846. * Clear the info related to rendering groups preventing retention points during dispose.
  17847. */
  17848. freeRenderingGroups(): void;
  17849. private _prepareRenderingGroup;
  17850. /**
  17851. * Add a sprite manager to the rendering manager in order to render it this frame.
  17852. * @param spriteManager Define the sprite manager to render
  17853. */
  17854. dispatchSprites(spriteManager: ISpriteManager): void;
  17855. /**
  17856. * Add a particle system to the rendering manager in order to render it this frame.
  17857. * @param particleSystem Define the particle system to render
  17858. */
  17859. dispatchParticles(particleSystem: IParticleSystem): void;
  17860. /**
  17861. * Add a submesh to the manager in order to render it this frame
  17862. * @param subMesh The submesh to dispatch
  17863. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17864. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17865. */
  17866. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17867. /**
  17868. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17869. * This allowed control for front to back rendering or reversly depending of the special needs.
  17870. *
  17871. * @param renderingGroupId The rendering group id corresponding to its index
  17872. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17873. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17874. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17875. */
  17876. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  17877. /**
  17878. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17879. *
  17880. * @param renderingGroupId The rendering group id corresponding to its index
  17881. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17882. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17883. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17884. */
  17885. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17886. /**
  17887. * Gets the current auto clear configuration for one rendering group of the rendering
  17888. * manager.
  17889. * @param index the rendering group index to get the information for
  17890. * @returns The auto clear setup for the requested rendering group
  17891. */
  17892. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17893. }
  17894. }
  17895. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17896. import { SmartArray } from "babylonjs/Misc/smartArray";
  17897. import { Nullable } from "babylonjs/types";
  17898. import { Scene } from "babylonjs/scene";
  17899. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17900. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17901. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17902. import { Mesh } from "babylonjs/Meshes/mesh";
  17903. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17904. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17905. import { Effect } from "babylonjs/Materials/effect";
  17906. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17907. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17908. import "babylonjs/Shaders/shadowMap.fragment";
  17909. import "babylonjs/Shaders/shadowMap.vertex";
  17910. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17911. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17912. import { Observable } from "babylonjs/Misc/observable";
  17913. /**
  17914. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17915. */
  17916. export interface ICustomShaderOptions {
  17917. /**
  17918. * Gets or sets the custom shader name to use
  17919. */
  17920. shaderName: string;
  17921. /**
  17922. * The list of attribute names used in the shader
  17923. */
  17924. attributes?: string[];
  17925. /**
  17926. * The list of unifrom names used in the shader
  17927. */
  17928. uniforms?: string[];
  17929. /**
  17930. * The list of sampler names used in the shader
  17931. */
  17932. samplers?: string[];
  17933. /**
  17934. * The list of defines used in the shader
  17935. */
  17936. defines?: string[];
  17937. }
  17938. /**
  17939. * Interface to implement to create a shadow generator compatible with BJS.
  17940. */
  17941. export interface IShadowGenerator {
  17942. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17943. id: string;
  17944. /**
  17945. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17946. * @returns The render target texture if present otherwise, null
  17947. */
  17948. getShadowMap(): Nullable<RenderTargetTexture>;
  17949. /**
  17950. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17951. * @param subMesh The submesh we want to render in the shadow map
  17952. * @param useInstances Defines wether will draw in the map using instances
  17953. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17954. * @returns true if ready otherwise, false
  17955. */
  17956. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17957. /**
  17958. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17959. * @param defines Defines of the material we want to update
  17960. * @param lightIndex Index of the light in the enabled light list of the material
  17961. */
  17962. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17963. /**
  17964. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17965. * defined in the generator but impacting the effect).
  17966. * It implies the unifroms available on the materials are the standard BJS ones.
  17967. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17968. * @param effect The effect we are binfing the information for
  17969. */
  17970. bindShadowLight(lightIndex: string, effect: Effect): void;
  17971. /**
  17972. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17973. * (eq to shadow prjection matrix * light transform matrix)
  17974. * @returns The transform matrix used to create the shadow map
  17975. */
  17976. getTransformMatrix(): Matrix;
  17977. /**
  17978. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17979. * Cube and 2D textures for instance.
  17980. */
  17981. recreateShadowMap(): void;
  17982. /**
  17983. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17984. * @param onCompiled Callback triggered at the and of the effects compilation
  17985. * @param options Sets of optional options forcing the compilation with different modes
  17986. */
  17987. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17988. useInstances: boolean;
  17989. }>): void;
  17990. /**
  17991. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17992. * @param options Sets of optional options forcing the compilation with different modes
  17993. * @returns A promise that resolves when the compilation completes
  17994. */
  17995. forceCompilationAsync(options?: Partial<{
  17996. useInstances: boolean;
  17997. }>): Promise<void>;
  17998. /**
  17999. * Serializes the shadow generator setup to a json object.
  18000. * @returns The serialized JSON object
  18001. */
  18002. serialize(): any;
  18003. /**
  18004. * Disposes the Shadow map and related Textures and effects.
  18005. */
  18006. dispose(): void;
  18007. }
  18008. /**
  18009. * Default implementation IShadowGenerator.
  18010. * This is the main object responsible of generating shadows in the framework.
  18011. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18012. */
  18013. export class ShadowGenerator implements IShadowGenerator {
  18014. /**
  18015. * Name of the shadow generator class
  18016. */
  18017. static CLASSNAME: string;
  18018. /**
  18019. * Shadow generator mode None: no filtering applied.
  18020. */
  18021. static readonly FILTER_NONE: number;
  18022. /**
  18023. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18024. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18025. */
  18026. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18027. /**
  18028. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18029. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18030. */
  18031. static readonly FILTER_POISSONSAMPLING: number;
  18032. /**
  18033. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18034. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18035. */
  18036. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18037. /**
  18038. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18039. * edge artifacts on steep falloff.
  18040. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18041. */
  18042. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18043. /**
  18044. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18045. * edge artifacts on steep falloff.
  18046. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18047. */
  18048. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18049. /**
  18050. * Shadow generator mode PCF: Percentage Closer Filtering
  18051. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18052. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18053. */
  18054. static readonly FILTER_PCF: number;
  18055. /**
  18056. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18057. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18058. * Contact Hardening
  18059. */
  18060. static readonly FILTER_PCSS: number;
  18061. /**
  18062. * Reserved for PCF and PCSS
  18063. * Highest Quality.
  18064. *
  18065. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18066. *
  18067. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18068. */
  18069. static readonly QUALITY_HIGH: number;
  18070. /**
  18071. * Reserved for PCF and PCSS
  18072. * Good tradeoff for quality/perf cross devices
  18073. *
  18074. * Execute PCF on a 3*3 kernel.
  18075. *
  18076. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18077. */
  18078. static readonly QUALITY_MEDIUM: number;
  18079. /**
  18080. * Reserved for PCF and PCSS
  18081. * The lowest quality but the fastest.
  18082. *
  18083. * Execute PCF on a 1*1 kernel.
  18084. *
  18085. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18086. */
  18087. static readonly QUALITY_LOW: number;
  18088. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18089. id: string;
  18090. /** Gets or sets the custom shader name to use */
  18091. customShaderOptions: ICustomShaderOptions;
  18092. /**
  18093. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18094. */
  18095. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18096. /**
  18097. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18098. */
  18099. onAfterShadowMapRenderObservable: Observable<Effect>;
  18100. /**
  18101. * Observable triggered before a mesh is rendered in the shadow map.
  18102. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18103. */
  18104. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18105. /**
  18106. * Observable triggered after a mesh is rendered in the shadow map.
  18107. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18108. */
  18109. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18110. protected _bias: number;
  18111. /**
  18112. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18113. */
  18114. get bias(): number;
  18115. /**
  18116. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18117. */
  18118. set bias(bias: number);
  18119. protected _normalBias: number;
  18120. /**
  18121. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18122. */
  18123. get normalBias(): number;
  18124. /**
  18125. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18126. */
  18127. set normalBias(normalBias: number);
  18128. protected _blurBoxOffset: number;
  18129. /**
  18130. * Gets the blur box offset: offset applied during the blur pass.
  18131. * Only useful if useKernelBlur = false
  18132. */
  18133. get blurBoxOffset(): number;
  18134. /**
  18135. * Sets the blur box offset: offset applied during the blur pass.
  18136. * Only useful if useKernelBlur = false
  18137. */
  18138. set blurBoxOffset(value: number);
  18139. protected _blurScale: number;
  18140. /**
  18141. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18142. * 2 means half of the size.
  18143. */
  18144. get blurScale(): number;
  18145. /**
  18146. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18147. * 2 means half of the size.
  18148. */
  18149. set blurScale(value: number);
  18150. protected _blurKernel: number;
  18151. /**
  18152. * Gets the blur kernel: kernel size of the blur pass.
  18153. * Only useful if useKernelBlur = true
  18154. */
  18155. get blurKernel(): number;
  18156. /**
  18157. * Sets the blur kernel: kernel size of the blur pass.
  18158. * Only useful if useKernelBlur = true
  18159. */
  18160. set blurKernel(value: number);
  18161. protected _useKernelBlur: boolean;
  18162. /**
  18163. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18164. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18165. */
  18166. get useKernelBlur(): boolean;
  18167. /**
  18168. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18169. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18170. */
  18171. set useKernelBlur(value: boolean);
  18172. protected _depthScale: number;
  18173. /**
  18174. * Gets the depth scale used in ESM mode.
  18175. */
  18176. get depthScale(): number;
  18177. /**
  18178. * Sets the depth scale used in ESM mode.
  18179. * This can override the scale stored on the light.
  18180. */
  18181. set depthScale(value: number);
  18182. protected _validateFilter(filter: number): number;
  18183. protected _filter: number;
  18184. /**
  18185. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18186. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18187. */
  18188. get filter(): number;
  18189. /**
  18190. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18191. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18192. */
  18193. set filter(value: number);
  18194. /**
  18195. * Gets if the current filter is set to Poisson Sampling.
  18196. */
  18197. get usePoissonSampling(): boolean;
  18198. /**
  18199. * Sets the current filter to Poisson Sampling.
  18200. */
  18201. set usePoissonSampling(value: boolean);
  18202. /**
  18203. * Gets if the current filter is set to ESM.
  18204. */
  18205. get useExponentialShadowMap(): boolean;
  18206. /**
  18207. * Sets the current filter is to ESM.
  18208. */
  18209. set useExponentialShadowMap(value: boolean);
  18210. /**
  18211. * Gets if the current filter is set to filtered ESM.
  18212. */
  18213. get useBlurExponentialShadowMap(): boolean;
  18214. /**
  18215. * Gets if the current filter is set to filtered ESM.
  18216. */
  18217. set useBlurExponentialShadowMap(value: boolean);
  18218. /**
  18219. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18220. * exponential to prevent steep falloff artifacts).
  18221. */
  18222. get useCloseExponentialShadowMap(): boolean;
  18223. /**
  18224. * Sets the current filter to "close ESM" (using the inverse of the
  18225. * exponential to prevent steep falloff artifacts).
  18226. */
  18227. set useCloseExponentialShadowMap(value: boolean);
  18228. /**
  18229. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18230. * exponential to prevent steep falloff artifacts).
  18231. */
  18232. get useBlurCloseExponentialShadowMap(): boolean;
  18233. /**
  18234. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18235. * exponential to prevent steep falloff artifacts).
  18236. */
  18237. set useBlurCloseExponentialShadowMap(value: boolean);
  18238. /**
  18239. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18240. */
  18241. get usePercentageCloserFiltering(): boolean;
  18242. /**
  18243. * Sets the current filter to "PCF" (percentage closer filtering).
  18244. */
  18245. set usePercentageCloserFiltering(value: boolean);
  18246. protected _filteringQuality: number;
  18247. /**
  18248. * Gets the PCF or PCSS Quality.
  18249. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18250. */
  18251. get filteringQuality(): number;
  18252. /**
  18253. * Sets the PCF or PCSS Quality.
  18254. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18255. */
  18256. set filteringQuality(filteringQuality: number);
  18257. /**
  18258. * Gets if the current filter is set to "PCSS" (contact hardening).
  18259. */
  18260. get useContactHardeningShadow(): boolean;
  18261. /**
  18262. * Sets the current filter to "PCSS" (contact hardening).
  18263. */
  18264. set useContactHardeningShadow(value: boolean);
  18265. protected _contactHardeningLightSizeUVRatio: number;
  18266. /**
  18267. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18268. * Using a ratio helps keeping shape stability independently of the map size.
  18269. *
  18270. * It does not account for the light projection as it was having too much
  18271. * instability during the light setup or during light position changes.
  18272. *
  18273. * Only valid if useContactHardeningShadow is true.
  18274. */
  18275. get contactHardeningLightSizeUVRatio(): number;
  18276. /**
  18277. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18278. * Using a ratio helps keeping shape stability independently of the map size.
  18279. *
  18280. * It does not account for the light projection as it was having too much
  18281. * instability during the light setup or during light position changes.
  18282. *
  18283. * Only valid if useContactHardeningShadow is true.
  18284. */
  18285. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18286. protected _darkness: number;
  18287. /** Gets or sets the actual darkness of a shadow */
  18288. get darkness(): number;
  18289. set darkness(value: number);
  18290. /**
  18291. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18292. * 0 means strongest and 1 would means no shadow.
  18293. * @returns the darkness.
  18294. */
  18295. getDarkness(): number;
  18296. /**
  18297. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18298. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18299. * @returns the shadow generator allowing fluent coding.
  18300. */
  18301. setDarkness(darkness: number): ShadowGenerator;
  18302. protected _transparencyShadow: boolean;
  18303. /** Gets or sets the ability to have transparent shadow */
  18304. get transparencyShadow(): boolean;
  18305. set transparencyShadow(value: boolean);
  18306. /**
  18307. * Sets the ability to have transparent shadow (boolean).
  18308. * @param transparent True if transparent else False
  18309. * @returns the shadow generator allowing fluent coding
  18310. */
  18311. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18312. /**
  18313. * Enables or disables shadows with varying strength based on the transparency
  18314. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18315. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18316. * mesh.visibility * alphaTexture.a
  18317. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18318. */
  18319. enableSoftTransparentShadow: boolean;
  18320. protected _shadowMap: Nullable<RenderTargetTexture>;
  18321. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18322. /**
  18323. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18324. * @returns The render target texture if present otherwise, null
  18325. */
  18326. getShadowMap(): Nullable<RenderTargetTexture>;
  18327. /**
  18328. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18329. * @returns The render target texture if the shadow map is present otherwise, null
  18330. */
  18331. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18332. /**
  18333. * Gets the class name of that object
  18334. * @returns "ShadowGenerator"
  18335. */
  18336. getClassName(): string;
  18337. /**
  18338. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18339. * @param mesh Mesh to add
  18340. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18341. * @returns the Shadow Generator itself
  18342. */
  18343. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18344. /**
  18345. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18346. * @param mesh Mesh to remove
  18347. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18348. * @returns the Shadow Generator itself
  18349. */
  18350. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18351. /**
  18352. * Controls the extent to which the shadows fade out at the edge of the frustum
  18353. */
  18354. frustumEdgeFalloff: number;
  18355. protected _light: IShadowLight;
  18356. /**
  18357. * Returns the associated light object.
  18358. * @returns the light generating the shadow
  18359. */
  18360. getLight(): IShadowLight;
  18361. /**
  18362. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18363. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18364. * It might on the other hand introduce peter panning.
  18365. */
  18366. forceBackFacesOnly: boolean;
  18367. protected _scene: Scene;
  18368. protected _lightDirection: Vector3;
  18369. protected _effect: Effect;
  18370. protected _viewMatrix: Matrix;
  18371. protected _projectionMatrix: Matrix;
  18372. protected _transformMatrix: Matrix;
  18373. protected _cachedPosition: Vector3;
  18374. protected _cachedDirection: Vector3;
  18375. protected _cachedDefines: string;
  18376. protected _currentRenderID: number;
  18377. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18378. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18379. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18380. protected _blurPostProcesses: PostProcess[];
  18381. protected _mapSize: number;
  18382. protected _currentFaceIndex: number;
  18383. protected _currentFaceIndexCache: number;
  18384. protected _textureType: number;
  18385. protected _defaultTextureMatrix: Matrix;
  18386. protected _storedUniqueId: Nullable<number>;
  18387. /** @hidden */
  18388. static _SceneComponentInitialization: (scene: Scene) => void;
  18389. /**
  18390. * Creates a ShadowGenerator object.
  18391. * A ShadowGenerator is the required tool to use the shadows.
  18392. * Each light casting shadows needs to use its own ShadowGenerator.
  18393. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18394. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18395. * @param light The light object generating the shadows.
  18396. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  18397. */
  18398. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18399. protected _initializeGenerator(): void;
  18400. protected _createTargetRenderTexture(): void;
  18401. protected _initializeShadowMap(): void;
  18402. protected _initializeBlurRTTAndPostProcesses(): void;
  18403. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18404. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18405. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18406. protected _applyFilterValues(): void;
  18407. /**
  18408. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18409. * @param onCompiled Callback triggered at the and of the effects compilation
  18410. * @param options Sets of optional options forcing the compilation with different modes
  18411. */
  18412. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18413. useInstances: boolean;
  18414. }>): void;
  18415. /**
  18416. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18417. * @param options Sets of optional options forcing the compilation with different modes
  18418. * @returns A promise that resolves when the compilation completes
  18419. */
  18420. forceCompilationAsync(options?: Partial<{
  18421. useInstances: boolean;
  18422. }>): Promise<void>;
  18423. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18424. private _prepareShadowDefines;
  18425. /**
  18426. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18427. * @param subMesh The submesh we want to render in the shadow map
  18428. * @param useInstances Defines wether will draw in the map using instances
  18429. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18430. * @returns true if ready otherwise, false
  18431. */
  18432. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18433. /**
  18434. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18435. * @param defines Defines of the material we want to update
  18436. * @param lightIndex Index of the light in the enabled light list of the material
  18437. */
  18438. prepareDefines(defines: any, lightIndex: number): void;
  18439. /**
  18440. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18441. * defined in the generator but impacting the effect).
  18442. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18443. * @param effect The effect we are binfing the information for
  18444. */
  18445. bindShadowLight(lightIndex: string, effect: Effect): void;
  18446. /**
  18447. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18448. * (eq to shadow prjection matrix * light transform matrix)
  18449. * @returns The transform matrix used to create the shadow map
  18450. */
  18451. getTransformMatrix(): Matrix;
  18452. /**
  18453. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18454. * Cube and 2D textures for instance.
  18455. */
  18456. recreateShadowMap(): void;
  18457. protected _disposeBlurPostProcesses(): void;
  18458. protected _disposeRTTandPostProcesses(): void;
  18459. /**
  18460. * Disposes the ShadowGenerator.
  18461. * Returns nothing.
  18462. */
  18463. dispose(): void;
  18464. /**
  18465. * Serializes the shadow generator setup to a json object.
  18466. * @returns The serialized JSON object
  18467. */
  18468. serialize(): any;
  18469. /**
  18470. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18471. * @param parsedShadowGenerator The JSON object to parse
  18472. * @param scene The scene to create the shadow map for
  18473. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18474. * @returns The parsed shadow generator
  18475. */
  18476. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18477. }
  18478. }
  18479. declare module "babylonjs/Lights/light" {
  18480. import { Nullable } from "babylonjs/types";
  18481. import { Scene } from "babylonjs/scene";
  18482. import { Vector3 } from "babylonjs/Maths/math.vector";
  18483. import { Color3 } from "babylonjs/Maths/math.color";
  18484. import { Node } from "babylonjs/node";
  18485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18486. import { Effect } from "babylonjs/Materials/effect";
  18487. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18488. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18489. /**
  18490. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18491. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18492. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  18493. */
  18494. export abstract class Light extends Node {
  18495. /**
  18496. * Falloff Default: light is falling off following the material specification:
  18497. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18498. */
  18499. static readonly FALLOFF_DEFAULT: number;
  18500. /**
  18501. * Falloff Physical: light is falling off following the inverse squared distance law.
  18502. */
  18503. static readonly FALLOFF_PHYSICAL: number;
  18504. /**
  18505. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18506. * to enhance interoperability with other engines.
  18507. */
  18508. static readonly FALLOFF_GLTF: number;
  18509. /**
  18510. * Falloff Standard: light is falling off like in the standard material
  18511. * to enhance interoperability with other materials.
  18512. */
  18513. static readonly FALLOFF_STANDARD: number;
  18514. /**
  18515. * If every light affecting the material is in this lightmapMode,
  18516. * material.lightmapTexture adds or multiplies
  18517. * (depends on material.useLightmapAsShadowmap)
  18518. * after every other light calculations.
  18519. */
  18520. static readonly LIGHTMAP_DEFAULT: number;
  18521. /**
  18522. * material.lightmapTexture as only diffuse lighting from this light
  18523. * adds only specular lighting from this light
  18524. * adds dynamic shadows
  18525. */
  18526. static readonly LIGHTMAP_SPECULAR: number;
  18527. /**
  18528. * material.lightmapTexture as only lighting
  18529. * no light calculation from this light
  18530. * only adds dynamic shadows from this light
  18531. */
  18532. static readonly LIGHTMAP_SHADOWSONLY: number;
  18533. /**
  18534. * Each light type uses the default quantity according to its type:
  18535. * point/spot lights use luminous intensity
  18536. * directional lights use illuminance
  18537. */
  18538. static readonly INTENSITYMODE_AUTOMATIC: number;
  18539. /**
  18540. * lumen (lm)
  18541. */
  18542. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18543. /**
  18544. * candela (lm/sr)
  18545. */
  18546. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18547. /**
  18548. * lux (lm/m^2)
  18549. */
  18550. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18551. /**
  18552. * nit (cd/m^2)
  18553. */
  18554. static readonly INTENSITYMODE_LUMINANCE: number;
  18555. /**
  18556. * Light type const id of the point light.
  18557. */
  18558. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18559. /**
  18560. * Light type const id of the directional light.
  18561. */
  18562. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18563. /**
  18564. * Light type const id of the spot light.
  18565. */
  18566. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18567. /**
  18568. * Light type const id of the hemispheric light.
  18569. */
  18570. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18571. /**
  18572. * Diffuse gives the basic color to an object.
  18573. */
  18574. diffuse: Color3;
  18575. /**
  18576. * Specular produces a highlight color on an object.
  18577. * Note: This is note affecting PBR materials.
  18578. */
  18579. specular: Color3;
  18580. /**
  18581. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18582. * falling off base on range or angle.
  18583. * This can be set to any values in Light.FALLOFF_x.
  18584. *
  18585. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18586. * other types of materials.
  18587. */
  18588. falloffType: number;
  18589. /**
  18590. * Strength of the light.
  18591. * Note: By default it is define in the framework own unit.
  18592. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18593. */
  18594. intensity: number;
  18595. private _range;
  18596. protected _inverseSquaredRange: number;
  18597. /**
  18598. * Defines how far from the source the light is impacting in scene units.
  18599. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18600. */
  18601. get range(): number;
  18602. /**
  18603. * Defines how far from the source the light is impacting in scene units.
  18604. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18605. */
  18606. set range(value: number);
  18607. /**
  18608. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18609. * of light.
  18610. */
  18611. private _photometricScale;
  18612. private _intensityMode;
  18613. /**
  18614. * Gets the photometric scale used to interpret the intensity.
  18615. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18616. */
  18617. get intensityMode(): number;
  18618. /**
  18619. * Sets the photometric scale used to interpret the intensity.
  18620. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18621. */
  18622. set intensityMode(value: number);
  18623. private _radius;
  18624. /**
  18625. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18626. */
  18627. get radius(): number;
  18628. /**
  18629. * sets the light radius used by PBR Materials to simulate soft area lights.
  18630. */
  18631. set radius(value: number);
  18632. private _renderPriority;
  18633. /**
  18634. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18635. * exceeding the number allowed of the materials.
  18636. */
  18637. renderPriority: number;
  18638. private _shadowEnabled;
  18639. /**
  18640. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18641. * the current shadow generator.
  18642. */
  18643. get shadowEnabled(): boolean;
  18644. /**
  18645. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18646. * the current shadow generator.
  18647. */
  18648. set shadowEnabled(value: boolean);
  18649. private _includedOnlyMeshes;
  18650. /**
  18651. * Gets the only meshes impacted by this light.
  18652. */
  18653. get includedOnlyMeshes(): AbstractMesh[];
  18654. /**
  18655. * Sets the only meshes impacted by this light.
  18656. */
  18657. set includedOnlyMeshes(value: AbstractMesh[]);
  18658. private _excludedMeshes;
  18659. /**
  18660. * Gets the meshes not impacted by this light.
  18661. */
  18662. get excludedMeshes(): AbstractMesh[];
  18663. /**
  18664. * Sets the meshes not impacted by this light.
  18665. */
  18666. set excludedMeshes(value: AbstractMesh[]);
  18667. private _excludeWithLayerMask;
  18668. /**
  18669. * Gets the layer id use to find what meshes are not impacted by the light.
  18670. * Inactive if 0
  18671. */
  18672. get excludeWithLayerMask(): number;
  18673. /**
  18674. * Sets the layer id use to find what meshes are not impacted by the light.
  18675. * Inactive if 0
  18676. */
  18677. set excludeWithLayerMask(value: number);
  18678. private _includeOnlyWithLayerMask;
  18679. /**
  18680. * Gets the layer id use to find what meshes are impacted by the light.
  18681. * Inactive if 0
  18682. */
  18683. get includeOnlyWithLayerMask(): number;
  18684. /**
  18685. * Sets the layer id use to find what meshes are impacted by the light.
  18686. * Inactive if 0
  18687. */
  18688. set includeOnlyWithLayerMask(value: number);
  18689. private _lightmapMode;
  18690. /**
  18691. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18692. */
  18693. get lightmapMode(): number;
  18694. /**
  18695. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18696. */
  18697. set lightmapMode(value: number);
  18698. /**
  18699. * Shadow generator associted to the light.
  18700. * @hidden Internal use only.
  18701. */
  18702. _shadowGenerator: Nullable<IShadowGenerator>;
  18703. /**
  18704. * @hidden Internal use only.
  18705. */
  18706. _excludedMeshesIds: string[];
  18707. /**
  18708. * @hidden Internal use only.
  18709. */
  18710. _includedOnlyMeshesIds: string[];
  18711. /**
  18712. * The current light unifom buffer.
  18713. * @hidden Internal use only.
  18714. */
  18715. _uniformBuffer: UniformBuffer;
  18716. /** @hidden */
  18717. _renderId: number;
  18718. /**
  18719. * Creates a Light object in the scene.
  18720. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18721. * @param name The firendly name of the light
  18722. * @param scene The scene the light belongs too
  18723. */
  18724. constructor(name: string, scene: Scene);
  18725. protected abstract _buildUniformLayout(): void;
  18726. /**
  18727. * Sets the passed Effect "effect" with the Light information.
  18728. * @param effect The effect to update
  18729. * @param lightIndex The index of the light in the effect to update
  18730. * @returns The light
  18731. */
  18732. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18733. /**
  18734. * Sets the passed Effect "effect" with the Light textures.
  18735. * @param effect The effect to update
  18736. * @param lightIndex The index of the light in the effect to update
  18737. * @returns The light
  18738. */
  18739. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18740. /**
  18741. * Binds the lights information from the scene to the effect for the given mesh.
  18742. * @param lightIndex Light index
  18743. * @param scene The scene where the light belongs to
  18744. * @param effect The effect we are binding the data to
  18745. * @param useSpecular Defines if specular is supported
  18746. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18747. */
  18748. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18749. /**
  18750. * Sets the passed Effect "effect" with the Light information.
  18751. * @param effect The effect to update
  18752. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18753. * @returns The light
  18754. */
  18755. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18756. /**
  18757. * Returns the string "Light".
  18758. * @returns the class name
  18759. */
  18760. getClassName(): string;
  18761. /** @hidden */
  18762. readonly _isLight: boolean;
  18763. /**
  18764. * Converts the light information to a readable string for debug purpose.
  18765. * @param fullDetails Supports for multiple levels of logging within scene loading
  18766. * @returns the human readable light info
  18767. */
  18768. toString(fullDetails?: boolean): string;
  18769. /** @hidden */
  18770. protected _syncParentEnabledState(): void;
  18771. /**
  18772. * Set the enabled state of this node.
  18773. * @param value - the new enabled state
  18774. */
  18775. setEnabled(value: boolean): void;
  18776. /**
  18777. * Returns the Light associated shadow generator if any.
  18778. * @return the associated shadow generator.
  18779. */
  18780. getShadowGenerator(): Nullable<IShadowGenerator>;
  18781. /**
  18782. * Returns a Vector3, the absolute light position in the World.
  18783. * @returns the world space position of the light
  18784. */
  18785. getAbsolutePosition(): Vector3;
  18786. /**
  18787. * Specifies if the light will affect the passed mesh.
  18788. * @param mesh The mesh to test against the light
  18789. * @return true the mesh is affected otherwise, false.
  18790. */
  18791. canAffectMesh(mesh: AbstractMesh): boolean;
  18792. /**
  18793. * Sort function to order lights for rendering.
  18794. * @param a First Light object to compare to second.
  18795. * @param b Second Light object to compare first.
  18796. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18797. */
  18798. static CompareLightsPriority(a: Light, b: Light): number;
  18799. /**
  18800. * Releases resources associated with this node.
  18801. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18802. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18803. */
  18804. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18805. /**
  18806. * Returns the light type ID (integer).
  18807. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18808. */
  18809. getTypeID(): number;
  18810. /**
  18811. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18812. * @returns the scaled intensity in intensity mode unit
  18813. */
  18814. getScaledIntensity(): number;
  18815. /**
  18816. * Returns a new Light object, named "name", from the current one.
  18817. * @param name The name of the cloned light
  18818. * @param newParent The parent of this light, if it has one
  18819. * @returns the new created light
  18820. */
  18821. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18822. /**
  18823. * Serializes the current light into a Serialization object.
  18824. * @returns the serialized object.
  18825. */
  18826. serialize(): any;
  18827. /**
  18828. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18829. * This new light is named "name" and added to the passed scene.
  18830. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18831. * @param name The friendly name of the light
  18832. * @param scene The scene the new light will belong to
  18833. * @returns the constructor function
  18834. */
  18835. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18836. /**
  18837. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18838. * @param parsedLight The JSON representation of the light
  18839. * @param scene The scene to create the parsed light in
  18840. * @returns the created light after parsing
  18841. */
  18842. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18843. private _hookArrayForExcluded;
  18844. private _hookArrayForIncludedOnly;
  18845. private _resyncMeshes;
  18846. /**
  18847. * Forces the meshes to update their light related information in their rendering used effects
  18848. * @hidden Internal Use Only
  18849. */
  18850. _markMeshesAsLightDirty(): void;
  18851. /**
  18852. * Recomputes the cached photometric scale if needed.
  18853. */
  18854. private _computePhotometricScale;
  18855. /**
  18856. * Returns the Photometric Scale according to the light type and intensity mode.
  18857. */
  18858. private _getPhotometricScale;
  18859. /**
  18860. * Reorder the light in the scene according to their defined priority.
  18861. * @hidden Internal Use Only
  18862. */
  18863. _reorderLightsInScene(): void;
  18864. /**
  18865. * Prepares the list of defines specific to the light type.
  18866. * @param defines the list of defines
  18867. * @param lightIndex defines the index of the light for the effect
  18868. */
  18869. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18870. }
  18871. }
  18872. declare module "babylonjs/Cameras/targetCamera" {
  18873. import { Nullable } from "babylonjs/types";
  18874. import { Camera } from "babylonjs/Cameras/camera";
  18875. import { Scene } from "babylonjs/scene";
  18876. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18877. /**
  18878. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18879. * This is the base of the follow, arc rotate cameras and Free camera
  18880. * @see https://doc.babylonjs.com/features/cameras
  18881. */
  18882. export class TargetCamera extends Camera {
  18883. private static _RigCamTransformMatrix;
  18884. private static _TargetTransformMatrix;
  18885. private static _TargetFocalPoint;
  18886. private _tmpUpVector;
  18887. private _tmpTargetVector;
  18888. /**
  18889. * Define the current direction the camera is moving to
  18890. */
  18891. cameraDirection: Vector3;
  18892. /**
  18893. * Define the current rotation the camera is rotating to
  18894. */
  18895. cameraRotation: Vector2;
  18896. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18897. ignoreParentScaling: boolean;
  18898. /**
  18899. * When set, the up vector of the camera will be updated by the rotation of the camera
  18900. */
  18901. updateUpVectorFromRotation: boolean;
  18902. private _tmpQuaternion;
  18903. /**
  18904. * Define the current rotation of the camera
  18905. */
  18906. rotation: Vector3;
  18907. /**
  18908. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18909. */
  18910. rotationQuaternion: Quaternion;
  18911. /**
  18912. * Define the current speed of the camera
  18913. */
  18914. speed: number;
  18915. /**
  18916. * Add constraint to the camera to prevent it to move freely in all directions and
  18917. * around all axis.
  18918. */
  18919. noRotationConstraint: boolean;
  18920. /**
  18921. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18922. * panning
  18923. */
  18924. invertRotation: boolean;
  18925. /**
  18926. * Speed multiplier for inverse camera panning
  18927. */
  18928. inverseRotationSpeed: number;
  18929. /**
  18930. * Define the current target of the camera as an object or a position.
  18931. */
  18932. lockedTarget: any;
  18933. /** @hidden */
  18934. _currentTarget: Vector3;
  18935. /** @hidden */
  18936. _initialFocalDistance: number;
  18937. /** @hidden */
  18938. _viewMatrix: Matrix;
  18939. /** @hidden */
  18940. _camMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraTransformMatrix: Matrix;
  18943. /** @hidden */
  18944. _cameraRotationMatrix: Matrix;
  18945. /** @hidden */
  18946. _referencePoint: Vector3;
  18947. /** @hidden */
  18948. _transformedReferencePoint: Vector3;
  18949. /** @hidden */
  18950. _reset: () => void;
  18951. private _defaultUp;
  18952. /**
  18953. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18954. * This is the base of the follow, arc rotate cameras and Free camera
  18955. * @see https://doc.babylonjs.com/features/cameras
  18956. * @param name Defines the name of the camera in the scene
  18957. * @param position Defines the start position of the camera in the scene
  18958. * @param scene Defines the scene the camera belongs to
  18959. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18960. */
  18961. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18962. /**
  18963. * Gets the position in front of the camera at a given distance.
  18964. * @param distance The distance from the camera we want the position to be
  18965. * @returns the position
  18966. */
  18967. getFrontPosition(distance: number): Vector3;
  18968. /** @hidden */
  18969. _getLockedTargetPosition(): Nullable<Vector3>;
  18970. private _storedPosition;
  18971. private _storedRotation;
  18972. private _storedRotationQuaternion;
  18973. /**
  18974. * Store current camera state of the camera (fov, position, rotation, etc..)
  18975. * @returns the camera
  18976. */
  18977. storeState(): Camera;
  18978. /**
  18979. * Restored camera state. You must call storeState() first
  18980. * @returns whether it was successful or not
  18981. * @hidden
  18982. */
  18983. _restoreStateValues(): boolean;
  18984. /** @hidden */
  18985. _initCache(): void;
  18986. /** @hidden */
  18987. _updateCache(ignoreParentClass?: boolean): void;
  18988. /** @hidden */
  18989. _isSynchronizedViewMatrix(): boolean;
  18990. /** @hidden */
  18991. _computeLocalCameraSpeed(): number;
  18992. /**
  18993. * Defines the target the camera should look at.
  18994. * @param target Defines the new target as a Vector or a mesh
  18995. */
  18996. setTarget(target: Vector3): void;
  18997. /**
  18998. * Defines the target point of the camera.
  18999. * The camera looks towards it form the radius distance.
  19000. */
  19001. get target(): Vector3;
  19002. set target(value: Vector3);
  19003. /**
  19004. * Return the current target position of the camera. This value is expressed in local space.
  19005. * @returns the target position
  19006. */
  19007. getTarget(): Vector3;
  19008. /** @hidden */
  19009. _decideIfNeedsToMove(): boolean;
  19010. /** @hidden */
  19011. _updatePosition(): void;
  19012. /** @hidden */
  19013. _checkInputs(): void;
  19014. protected _updateCameraRotationMatrix(): void;
  19015. /**
  19016. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  19017. * @returns the current camera
  19018. */
  19019. private _rotateUpVectorWithCameraRotationMatrix;
  19020. private _cachedRotationZ;
  19021. private _cachedQuaternionRotationZ;
  19022. /** @hidden */
  19023. _getViewMatrix(): Matrix;
  19024. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19025. /**
  19026. * @hidden
  19027. */
  19028. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19029. /**
  19030. * @hidden
  19031. */
  19032. _updateRigCameras(): void;
  19033. private _getRigCamPositionAndTarget;
  19034. /**
  19035. * Gets the current object class name.
  19036. * @return the class name
  19037. */
  19038. getClassName(): string;
  19039. }
  19040. }
  19041. declare module "babylonjs/Events/keyboardEvents" {
  19042. /**
  19043. * Gather the list of keyboard event types as constants.
  19044. */
  19045. export class KeyboardEventTypes {
  19046. /**
  19047. * The keydown event is fired when a key becomes active (pressed).
  19048. */
  19049. static readonly KEYDOWN: number;
  19050. /**
  19051. * The keyup event is fired when a key has been released.
  19052. */
  19053. static readonly KEYUP: number;
  19054. }
  19055. /**
  19056. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19057. */
  19058. export class KeyboardInfo {
  19059. /**
  19060. * Defines the type of event (KeyboardEventTypes)
  19061. */
  19062. type: number;
  19063. /**
  19064. * Defines the related dom event
  19065. */
  19066. event: KeyboardEvent;
  19067. /**
  19068. * Instantiates a new keyboard info.
  19069. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19070. * @param type Defines the type of event (KeyboardEventTypes)
  19071. * @param event Defines the related dom event
  19072. */
  19073. constructor(
  19074. /**
  19075. * Defines the type of event (KeyboardEventTypes)
  19076. */
  19077. type: number,
  19078. /**
  19079. * Defines the related dom event
  19080. */
  19081. event: KeyboardEvent);
  19082. }
  19083. /**
  19084. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19085. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19086. */
  19087. export class KeyboardInfoPre extends KeyboardInfo {
  19088. /**
  19089. * Defines the type of event (KeyboardEventTypes)
  19090. */
  19091. type: number;
  19092. /**
  19093. * Defines the related dom event
  19094. */
  19095. event: KeyboardEvent;
  19096. /**
  19097. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19098. */
  19099. skipOnPointerObservable: boolean;
  19100. /**
  19101. * Instantiates a new keyboard pre info.
  19102. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19103. * @param type Defines the type of event (KeyboardEventTypes)
  19104. * @param event Defines the related dom event
  19105. */
  19106. constructor(
  19107. /**
  19108. * Defines the type of event (KeyboardEventTypes)
  19109. */
  19110. type: number,
  19111. /**
  19112. * Defines the related dom event
  19113. */
  19114. event: KeyboardEvent);
  19115. }
  19116. }
  19117. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19118. import { Nullable } from "babylonjs/types";
  19119. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19120. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19121. /**
  19122. * Manage the keyboard inputs to control the movement of a free camera.
  19123. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19124. */
  19125. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19126. /**
  19127. * Defines the camera the input is attached to.
  19128. */
  19129. camera: FreeCamera;
  19130. /**
  19131. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19132. */
  19133. keysUp: number[];
  19134. /**
  19135. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19136. */
  19137. keysUpward: number[];
  19138. /**
  19139. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19140. */
  19141. keysDown: number[];
  19142. /**
  19143. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19144. */
  19145. keysDownward: number[];
  19146. /**
  19147. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19148. */
  19149. keysLeft: number[];
  19150. /**
  19151. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19152. */
  19153. keysRight: number[];
  19154. private _keys;
  19155. private _onCanvasBlurObserver;
  19156. private _onKeyboardObserver;
  19157. private _engine;
  19158. private _scene;
  19159. /**
  19160. * Attach the input controls to a specific dom element to get the input from.
  19161. * @param element Defines the element the controls should be listened from
  19162. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19163. */
  19164. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19165. /**
  19166. * Detach the current controls from the specified dom element.
  19167. * @param element Defines the element to stop listening the inputs from
  19168. */
  19169. detachControl(element: Nullable<HTMLElement>): void;
  19170. /**
  19171. * Update the current camera state depending on the inputs that have been used this frame.
  19172. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19173. */
  19174. checkInputs(): void;
  19175. /**
  19176. * Gets the class name of the current intput.
  19177. * @returns the class name
  19178. */
  19179. getClassName(): string;
  19180. /** @hidden */
  19181. _onLostFocus(): void;
  19182. /**
  19183. * Get the friendly name associated with the input class.
  19184. * @returns the input friendly name
  19185. */
  19186. getSimpleName(): string;
  19187. }
  19188. }
  19189. declare module "babylonjs/Events/pointerEvents" {
  19190. import { Nullable } from "babylonjs/types";
  19191. import { Vector2 } from "babylonjs/Maths/math.vector";
  19192. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19193. import { Ray } from "babylonjs/Culling/ray";
  19194. /**
  19195. * Gather the list of pointer event types as constants.
  19196. */
  19197. export class PointerEventTypes {
  19198. /**
  19199. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  19200. */
  19201. static readonly POINTERDOWN: number;
  19202. /**
  19203. * The pointerup event is fired when a pointer is no longer active.
  19204. */
  19205. static readonly POINTERUP: number;
  19206. /**
  19207. * The pointermove event is fired when a pointer changes coordinates.
  19208. */
  19209. static readonly POINTERMOVE: number;
  19210. /**
  19211. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19212. */
  19213. static readonly POINTERWHEEL: number;
  19214. /**
  19215. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19216. */
  19217. static readonly POINTERPICK: number;
  19218. /**
  19219. * The pointertap event is fired when a the object has been touched and released without drag.
  19220. */
  19221. static readonly POINTERTAP: number;
  19222. /**
  19223. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19224. */
  19225. static readonly POINTERDOUBLETAP: number;
  19226. }
  19227. /**
  19228. * Base class of pointer info types.
  19229. */
  19230. export class PointerInfoBase {
  19231. /**
  19232. * Defines the type of event (PointerEventTypes)
  19233. */
  19234. type: number;
  19235. /**
  19236. * Defines the related dom event
  19237. */
  19238. event: PointerEvent | MouseWheelEvent;
  19239. /**
  19240. * Instantiates the base class of pointers info.
  19241. * @param type Defines the type of event (PointerEventTypes)
  19242. * @param event Defines the related dom event
  19243. */
  19244. constructor(
  19245. /**
  19246. * Defines the type of event (PointerEventTypes)
  19247. */
  19248. type: number,
  19249. /**
  19250. * Defines the related dom event
  19251. */
  19252. event: PointerEvent | MouseWheelEvent);
  19253. }
  19254. /**
  19255. * This class is used to store pointer related info for the onPrePointerObservable event.
  19256. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19257. */
  19258. export class PointerInfoPre extends PointerInfoBase {
  19259. /**
  19260. * Ray from a pointer if availible (eg. 6dof controller)
  19261. */
  19262. ray: Nullable<Ray>;
  19263. /**
  19264. * Defines the local position of the pointer on the canvas.
  19265. */
  19266. localPosition: Vector2;
  19267. /**
  19268. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19269. */
  19270. skipOnPointerObservable: boolean;
  19271. /**
  19272. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19273. * @param type Defines the type of event (PointerEventTypes)
  19274. * @param event Defines the related dom event
  19275. * @param localX Defines the local x coordinates of the pointer when the event occured
  19276. * @param localY Defines the local y coordinates of the pointer when the event occured
  19277. */
  19278. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19279. }
  19280. /**
  19281. * This type contains all the data related to a pointer event in Babylon.js.
  19282. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  19283. */
  19284. export class PointerInfo extends PointerInfoBase {
  19285. /**
  19286. * Defines the picking info associated to the info (if any)\
  19287. */
  19288. pickInfo: Nullable<PickingInfo>;
  19289. /**
  19290. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19291. * @param type Defines the type of event (PointerEventTypes)
  19292. * @param event Defines the related dom event
  19293. * @param pickInfo Defines the picking info associated to the info (if any)\
  19294. */
  19295. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19296. /**
  19297. * Defines the picking info associated to the info (if any)\
  19298. */
  19299. pickInfo: Nullable<PickingInfo>);
  19300. }
  19301. /**
  19302. * Data relating to a touch event on the screen.
  19303. */
  19304. export interface PointerTouch {
  19305. /**
  19306. * X coordinate of touch.
  19307. */
  19308. x: number;
  19309. /**
  19310. * Y coordinate of touch.
  19311. */
  19312. y: number;
  19313. /**
  19314. * Id of touch. Unique for each finger.
  19315. */
  19316. pointerId: number;
  19317. /**
  19318. * Event type passed from DOM.
  19319. */
  19320. type: any;
  19321. }
  19322. }
  19323. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19324. import { Observable } from "babylonjs/Misc/observable";
  19325. import { Nullable } from "babylonjs/types";
  19326. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19327. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19328. /**
  19329. * Manage the mouse inputs to control the movement of a free camera.
  19330. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19331. */
  19332. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19333. /**
  19334. * Define if touch is enabled in the mouse input
  19335. */
  19336. touchEnabled: boolean;
  19337. /**
  19338. * Defines the camera the input is attached to.
  19339. */
  19340. camera: FreeCamera;
  19341. /**
  19342. * Defines the buttons associated with the input to handle camera move.
  19343. */
  19344. buttons: number[];
  19345. /**
  19346. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19347. */
  19348. angularSensibility: number;
  19349. private _pointerInput;
  19350. private _onMouseMove;
  19351. private _observer;
  19352. private previousPosition;
  19353. /**
  19354. * Observable for when a pointer move event occurs containing the move offset
  19355. */
  19356. onPointerMovedObservable: Observable<{
  19357. offsetX: number;
  19358. offsetY: number;
  19359. }>;
  19360. /**
  19361. * @hidden
  19362. * If the camera should be rotated automatically based on pointer movement
  19363. */
  19364. _allowCameraRotation: boolean;
  19365. /**
  19366. * Manage the mouse inputs to control the movement of a free camera.
  19367. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19368. * @param touchEnabled Defines if touch is enabled or not
  19369. */
  19370. constructor(
  19371. /**
  19372. * Define if touch is enabled in the mouse input
  19373. */
  19374. touchEnabled?: boolean);
  19375. /**
  19376. * Attach the input controls to a specific dom element to get the input from.
  19377. * @param element Defines the element the controls should be listened from
  19378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19379. */
  19380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19381. /**
  19382. * Called on JS contextmenu event.
  19383. * Override this method to provide functionality.
  19384. */
  19385. protected onContextMenu(evt: PointerEvent): void;
  19386. /**
  19387. * Detach the current controls from the specified dom element.
  19388. * @param element Defines the element to stop listening the inputs from
  19389. */
  19390. detachControl(element: Nullable<HTMLElement>): void;
  19391. /**
  19392. * Gets the class name of the current intput.
  19393. * @returns the class name
  19394. */
  19395. getClassName(): string;
  19396. /**
  19397. * Get the friendly name associated with the input class.
  19398. * @returns the input friendly name
  19399. */
  19400. getSimpleName(): string;
  19401. }
  19402. }
  19403. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19404. import { Nullable } from "babylonjs/types";
  19405. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19406. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19407. /**
  19408. * Manage the touch inputs to control the movement of a free camera.
  19409. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19410. */
  19411. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19412. /**
  19413. * Define if mouse events can be treated as touch events
  19414. */
  19415. allowMouse: boolean;
  19416. /**
  19417. * Defines the camera the input is attached to.
  19418. */
  19419. camera: FreeCamera;
  19420. /**
  19421. * Defines the touch sensibility for rotation.
  19422. * The higher the faster.
  19423. */
  19424. touchAngularSensibility: number;
  19425. /**
  19426. * Defines the touch sensibility for move.
  19427. * The higher the faster.
  19428. */
  19429. touchMoveSensibility: number;
  19430. private _offsetX;
  19431. private _offsetY;
  19432. private _pointerPressed;
  19433. private _pointerInput;
  19434. private _observer;
  19435. private _onLostFocus;
  19436. /**
  19437. * Manage the touch inputs to control the movement of a free camera.
  19438. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19439. * @param allowMouse Defines if mouse events can be treated as touch events
  19440. */
  19441. constructor(
  19442. /**
  19443. * Define if mouse events can be treated as touch events
  19444. */
  19445. allowMouse?: boolean);
  19446. /**
  19447. * Attach the input controls to a specific dom element to get the input from.
  19448. * @param element Defines the element the controls should be listened from
  19449. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19450. */
  19451. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19452. /**
  19453. * Detach the current controls from the specified dom element.
  19454. * @param element Defines the element to stop listening the inputs from
  19455. */
  19456. detachControl(element: Nullable<HTMLElement>): void;
  19457. /**
  19458. * Update the current camera state depending on the inputs that have been used this frame.
  19459. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19460. */
  19461. checkInputs(): void;
  19462. /**
  19463. * Gets the class name of the current intput.
  19464. * @returns the class name
  19465. */
  19466. getClassName(): string;
  19467. /**
  19468. * Get the friendly name associated with the input class.
  19469. * @returns the input friendly name
  19470. */
  19471. getSimpleName(): string;
  19472. }
  19473. }
  19474. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19475. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19476. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19477. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19478. import { Nullable } from "babylonjs/types";
  19479. /**
  19480. * Default Inputs manager for the FreeCamera.
  19481. * It groups all the default supported inputs for ease of use.
  19482. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19483. */
  19484. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19485. /**
  19486. * @hidden
  19487. */
  19488. _mouseInput: Nullable<FreeCameraMouseInput>;
  19489. /**
  19490. * Instantiates a new FreeCameraInputsManager.
  19491. * @param camera Defines the camera the inputs belong to
  19492. */
  19493. constructor(camera: FreeCamera);
  19494. /**
  19495. * Add keyboard input support to the input manager.
  19496. * @returns the current input manager
  19497. */
  19498. addKeyboard(): FreeCameraInputsManager;
  19499. /**
  19500. * Add mouse input support to the input manager.
  19501. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19502. * @returns the current input manager
  19503. */
  19504. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19505. /**
  19506. * Removes the mouse input support from the manager
  19507. * @returns the current input manager
  19508. */
  19509. removeMouse(): FreeCameraInputsManager;
  19510. /**
  19511. * Add touch input support to the input manager.
  19512. * @returns the current input manager
  19513. */
  19514. addTouch(): FreeCameraInputsManager;
  19515. /**
  19516. * Remove all attached input methods from a camera
  19517. */
  19518. clear(): void;
  19519. }
  19520. }
  19521. declare module "babylonjs/Cameras/freeCamera" {
  19522. import { Vector3 } from "babylonjs/Maths/math.vector";
  19523. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19524. import { Scene } from "babylonjs/scene";
  19525. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19526. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19527. /**
  19528. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19529. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19530. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19531. */
  19532. export class FreeCamera extends TargetCamera {
  19533. /**
  19534. * Define the collision ellipsoid of the camera.
  19535. * This is helpful to simulate a camera body like the player body around the camera
  19536. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19537. */
  19538. ellipsoid: Vector3;
  19539. /**
  19540. * Define an offset for the position of the ellipsoid around the camera.
  19541. * This can be helpful to determine the center of the body near the gravity center of the body
  19542. * instead of its head.
  19543. */
  19544. ellipsoidOffset: Vector3;
  19545. /**
  19546. * Enable or disable collisions of the camera with the rest of the scene objects.
  19547. */
  19548. checkCollisions: boolean;
  19549. /**
  19550. * Enable or disable gravity on the camera.
  19551. */
  19552. applyGravity: boolean;
  19553. /**
  19554. * Define the input manager associated to the camera.
  19555. */
  19556. inputs: FreeCameraInputsManager;
  19557. /**
  19558. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19559. * Higher values reduce sensitivity.
  19560. */
  19561. get angularSensibility(): number;
  19562. /**
  19563. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19564. * Higher values reduce sensitivity.
  19565. */
  19566. set angularSensibility(value: number);
  19567. /**
  19568. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19569. */
  19570. get keysUp(): number[];
  19571. set keysUp(value: number[]);
  19572. /**
  19573. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19574. */
  19575. get keysUpward(): number[];
  19576. set keysUpward(value: number[]);
  19577. /**
  19578. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19579. */
  19580. get keysDown(): number[];
  19581. set keysDown(value: number[]);
  19582. /**
  19583. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19584. */
  19585. get keysDownward(): number[];
  19586. set keysDownward(value: number[]);
  19587. /**
  19588. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19589. */
  19590. get keysLeft(): number[];
  19591. set keysLeft(value: number[]);
  19592. /**
  19593. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19594. */
  19595. get keysRight(): number[];
  19596. set keysRight(value: number[]);
  19597. /**
  19598. * Event raised when the camera collide with a mesh in the scene.
  19599. */
  19600. onCollide: (collidedMesh: AbstractMesh) => void;
  19601. private _collider;
  19602. private _needMoveForGravity;
  19603. private _oldPosition;
  19604. private _diffPosition;
  19605. private _newPosition;
  19606. /** @hidden */
  19607. _localDirection: Vector3;
  19608. /** @hidden */
  19609. _transformedDirection: Vector3;
  19610. /**
  19611. * Instantiates a Free Camera.
  19612. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19613. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19614. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19615. * @param name Define the name of the camera in the scene
  19616. * @param position Define the start position of the camera in the scene
  19617. * @param scene Define the scene the camera belongs to
  19618. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19619. */
  19620. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19621. /**
  19622. * Attached controls to the current camera.
  19623. * @param element Defines the element the controls should be listened from
  19624. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19625. */
  19626. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19627. /**
  19628. * Detach the current controls from the camera.
  19629. * The camera will stop reacting to inputs.
  19630. * @param element Defines the element to stop listening the inputs from
  19631. */
  19632. detachControl(element: HTMLElement): void;
  19633. private _collisionMask;
  19634. /**
  19635. * Define a collision mask to limit the list of object the camera can collide with
  19636. */
  19637. get collisionMask(): number;
  19638. set collisionMask(mask: number);
  19639. /** @hidden */
  19640. _collideWithWorld(displacement: Vector3): void;
  19641. private _onCollisionPositionChange;
  19642. /** @hidden */
  19643. _checkInputs(): void;
  19644. /** @hidden */
  19645. _decideIfNeedsToMove(): boolean;
  19646. /** @hidden */
  19647. _updatePosition(): void;
  19648. /**
  19649. * Destroy the camera and release the current resources hold by it.
  19650. */
  19651. dispose(): void;
  19652. /**
  19653. * Gets the current object class name.
  19654. * @return the class name
  19655. */
  19656. getClassName(): string;
  19657. }
  19658. }
  19659. declare module "babylonjs/Gamepads/gamepad" {
  19660. import { Observable } from "babylonjs/Misc/observable";
  19661. /**
  19662. * Represents a gamepad control stick position
  19663. */
  19664. export class StickValues {
  19665. /**
  19666. * The x component of the control stick
  19667. */
  19668. x: number;
  19669. /**
  19670. * The y component of the control stick
  19671. */
  19672. y: number;
  19673. /**
  19674. * Initializes the gamepad x and y control stick values
  19675. * @param x The x component of the gamepad control stick value
  19676. * @param y The y component of the gamepad control stick value
  19677. */
  19678. constructor(
  19679. /**
  19680. * The x component of the control stick
  19681. */
  19682. x: number,
  19683. /**
  19684. * The y component of the control stick
  19685. */
  19686. y: number);
  19687. }
  19688. /**
  19689. * An interface which manages callbacks for gamepad button changes
  19690. */
  19691. export interface GamepadButtonChanges {
  19692. /**
  19693. * Called when a gamepad has been changed
  19694. */
  19695. changed: boolean;
  19696. /**
  19697. * Called when a gamepad press event has been triggered
  19698. */
  19699. pressChanged: boolean;
  19700. /**
  19701. * Called when a touch event has been triggered
  19702. */
  19703. touchChanged: boolean;
  19704. /**
  19705. * Called when a value has changed
  19706. */
  19707. valueChanged: boolean;
  19708. }
  19709. /**
  19710. * Represents a gamepad
  19711. */
  19712. export class Gamepad {
  19713. /**
  19714. * The id of the gamepad
  19715. */
  19716. id: string;
  19717. /**
  19718. * The index of the gamepad
  19719. */
  19720. index: number;
  19721. /**
  19722. * The browser gamepad
  19723. */
  19724. browserGamepad: any;
  19725. /**
  19726. * Specifies what type of gamepad this represents
  19727. */
  19728. type: number;
  19729. private _leftStick;
  19730. private _rightStick;
  19731. /** @hidden */
  19732. _isConnected: boolean;
  19733. private _leftStickAxisX;
  19734. private _leftStickAxisY;
  19735. private _rightStickAxisX;
  19736. private _rightStickAxisY;
  19737. /**
  19738. * Triggered when the left control stick has been changed
  19739. */
  19740. private _onleftstickchanged;
  19741. /**
  19742. * Triggered when the right control stick has been changed
  19743. */
  19744. private _onrightstickchanged;
  19745. /**
  19746. * Represents a gamepad controller
  19747. */
  19748. static GAMEPAD: number;
  19749. /**
  19750. * Represents a generic controller
  19751. */
  19752. static GENERIC: number;
  19753. /**
  19754. * Represents an XBox controller
  19755. */
  19756. static XBOX: number;
  19757. /**
  19758. * Represents a pose-enabled controller
  19759. */
  19760. static POSE_ENABLED: number;
  19761. /**
  19762. * Represents an Dual Shock controller
  19763. */
  19764. static DUALSHOCK: number;
  19765. /**
  19766. * Specifies whether the left control stick should be Y-inverted
  19767. */
  19768. protected _invertLeftStickY: boolean;
  19769. /**
  19770. * Specifies if the gamepad has been connected
  19771. */
  19772. get isConnected(): boolean;
  19773. /**
  19774. * Initializes the gamepad
  19775. * @param id The id of the gamepad
  19776. * @param index The index of the gamepad
  19777. * @param browserGamepad The browser gamepad
  19778. * @param leftStickX The x component of the left joystick
  19779. * @param leftStickY The y component of the left joystick
  19780. * @param rightStickX The x component of the right joystick
  19781. * @param rightStickY The y component of the right joystick
  19782. */
  19783. constructor(
  19784. /**
  19785. * The id of the gamepad
  19786. */
  19787. id: string,
  19788. /**
  19789. * The index of the gamepad
  19790. */
  19791. index: number,
  19792. /**
  19793. * The browser gamepad
  19794. */
  19795. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19796. /**
  19797. * Callback triggered when the left joystick has changed
  19798. * @param callback
  19799. */
  19800. onleftstickchanged(callback: (values: StickValues) => void): void;
  19801. /**
  19802. * Callback triggered when the right joystick has changed
  19803. * @param callback
  19804. */
  19805. onrightstickchanged(callback: (values: StickValues) => void): void;
  19806. /**
  19807. * Gets the left joystick
  19808. */
  19809. get leftStick(): StickValues;
  19810. /**
  19811. * Sets the left joystick values
  19812. */
  19813. set leftStick(newValues: StickValues);
  19814. /**
  19815. * Gets the right joystick
  19816. */
  19817. get rightStick(): StickValues;
  19818. /**
  19819. * Sets the right joystick value
  19820. */
  19821. set rightStick(newValues: StickValues);
  19822. /**
  19823. * Updates the gamepad joystick positions
  19824. */
  19825. update(): void;
  19826. /**
  19827. * Disposes the gamepad
  19828. */
  19829. dispose(): void;
  19830. }
  19831. /**
  19832. * Represents a generic gamepad
  19833. */
  19834. export class GenericPad extends Gamepad {
  19835. private _buttons;
  19836. private _onbuttondown;
  19837. private _onbuttonup;
  19838. /**
  19839. * Observable triggered when a button has been pressed
  19840. */
  19841. onButtonDownObservable: Observable<number>;
  19842. /**
  19843. * Observable triggered when a button has been released
  19844. */
  19845. onButtonUpObservable: Observable<number>;
  19846. /**
  19847. * Callback triggered when a button has been pressed
  19848. * @param callback Called when a button has been pressed
  19849. */
  19850. onbuttondown(callback: (buttonPressed: number) => void): void;
  19851. /**
  19852. * Callback triggered when a button has been released
  19853. * @param callback Called when a button has been released
  19854. */
  19855. onbuttonup(callback: (buttonReleased: number) => void): void;
  19856. /**
  19857. * Initializes the generic gamepad
  19858. * @param id The id of the generic gamepad
  19859. * @param index The index of the generic gamepad
  19860. * @param browserGamepad The browser gamepad
  19861. */
  19862. constructor(id: string, index: number, browserGamepad: any);
  19863. private _setButtonValue;
  19864. /**
  19865. * Updates the generic gamepad
  19866. */
  19867. update(): void;
  19868. /**
  19869. * Disposes the generic gamepad
  19870. */
  19871. dispose(): void;
  19872. }
  19873. }
  19874. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19875. import { Observable } from "babylonjs/Misc/observable";
  19876. import { Nullable } from "babylonjs/types";
  19877. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19878. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19879. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19880. import { Ray } from "babylonjs/Culling/ray";
  19881. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19882. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19883. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19884. /**
  19885. * Defines the types of pose enabled controllers that are supported
  19886. */
  19887. export enum PoseEnabledControllerType {
  19888. /**
  19889. * HTC Vive
  19890. */
  19891. VIVE = 0,
  19892. /**
  19893. * Oculus Rift
  19894. */
  19895. OCULUS = 1,
  19896. /**
  19897. * Windows mixed reality
  19898. */
  19899. WINDOWS = 2,
  19900. /**
  19901. * Samsung gear VR
  19902. */
  19903. GEAR_VR = 3,
  19904. /**
  19905. * Google Daydream
  19906. */
  19907. DAYDREAM = 4,
  19908. /**
  19909. * Generic
  19910. */
  19911. GENERIC = 5
  19912. }
  19913. /**
  19914. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19915. */
  19916. export interface MutableGamepadButton {
  19917. /**
  19918. * Value of the button/trigger
  19919. */
  19920. value: number;
  19921. /**
  19922. * If the button/trigger is currently touched
  19923. */
  19924. touched: boolean;
  19925. /**
  19926. * If the button/trigger is currently pressed
  19927. */
  19928. pressed: boolean;
  19929. }
  19930. /**
  19931. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19932. * @hidden
  19933. */
  19934. export interface ExtendedGamepadButton extends GamepadButton {
  19935. /**
  19936. * If the button/trigger is currently pressed
  19937. */
  19938. readonly pressed: boolean;
  19939. /**
  19940. * If the button/trigger is currently touched
  19941. */
  19942. readonly touched: boolean;
  19943. /**
  19944. * Value of the button/trigger
  19945. */
  19946. readonly value: number;
  19947. }
  19948. /** @hidden */
  19949. export interface _GamePadFactory {
  19950. /**
  19951. * Returns whether or not the current gamepad can be created for this type of controller.
  19952. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19953. * @returns true if it can be created, otherwise false
  19954. */
  19955. canCreate(gamepadInfo: any): boolean;
  19956. /**
  19957. * Creates a new instance of the Gamepad.
  19958. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19959. * @returns the new gamepad instance
  19960. */
  19961. create(gamepadInfo: any): Gamepad;
  19962. }
  19963. /**
  19964. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19965. */
  19966. export class PoseEnabledControllerHelper {
  19967. /** @hidden */
  19968. static _ControllerFactories: _GamePadFactory[];
  19969. /** @hidden */
  19970. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19971. /**
  19972. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19973. * @param vrGamepad the gamepad to initialized
  19974. * @returns a vr controller of the type the gamepad identified as
  19975. */
  19976. static InitiateController(vrGamepad: any): Gamepad;
  19977. }
  19978. /**
  19979. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19980. */
  19981. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19982. /**
  19983. * If the controller is used in a webXR session
  19984. */
  19985. isXR: boolean;
  19986. private _deviceRoomPosition;
  19987. private _deviceRoomRotationQuaternion;
  19988. /**
  19989. * The device position in babylon space
  19990. */
  19991. devicePosition: Vector3;
  19992. /**
  19993. * The device rotation in babylon space
  19994. */
  19995. deviceRotationQuaternion: Quaternion;
  19996. /**
  19997. * The scale factor of the device in babylon space
  19998. */
  19999. deviceScaleFactor: number;
  20000. /**
  20001. * (Likely devicePosition should be used instead) The device position in its room space
  20002. */
  20003. position: Vector3;
  20004. /**
  20005. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20006. */
  20007. rotationQuaternion: Quaternion;
  20008. /**
  20009. * The type of controller (Eg. Windows mixed reality)
  20010. */
  20011. controllerType: PoseEnabledControllerType;
  20012. protected _calculatedPosition: Vector3;
  20013. private _calculatedRotation;
  20014. /**
  20015. * The raw pose from the device
  20016. */
  20017. rawPose: DevicePose;
  20018. private _trackPosition;
  20019. private _maxRotationDistFromHeadset;
  20020. private _draggedRoomRotation;
  20021. /**
  20022. * @hidden
  20023. */
  20024. _disableTrackPosition(fixedPosition: Vector3): void;
  20025. /**
  20026. * Internal, the mesh attached to the controller
  20027. * @hidden
  20028. */
  20029. _mesh: Nullable<AbstractMesh>;
  20030. private _poseControlledCamera;
  20031. private _leftHandSystemQuaternion;
  20032. /**
  20033. * Internal, matrix used to convert room space to babylon space
  20034. * @hidden
  20035. */
  20036. _deviceToWorld: Matrix;
  20037. /**
  20038. * Node to be used when casting a ray from the controller
  20039. * @hidden
  20040. */
  20041. _pointingPoseNode: Nullable<TransformNode>;
  20042. /**
  20043. * Name of the child mesh that can be used to cast a ray from the controller
  20044. */
  20045. static readonly POINTING_POSE: string;
  20046. /**
  20047. * Creates a new PoseEnabledController from a gamepad
  20048. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20049. */
  20050. constructor(browserGamepad: any);
  20051. private _workingMatrix;
  20052. /**
  20053. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20054. */
  20055. update(): void;
  20056. /**
  20057. * Updates only the pose device and mesh without doing any button event checking
  20058. */
  20059. protected _updatePoseAndMesh(): void;
  20060. /**
  20061. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20062. * @param poseData raw pose fromthe device
  20063. */
  20064. updateFromDevice(poseData: DevicePose): void;
  20065. /**
  20066. * @hidden
  20067. */
  20068. _meshAttachedObservable: Observable<AbstractMesh>;
  20069. /**
  20070. * Attaches a mesh to the controller
  20071. * @param mesh the mesh to be attached
  20072. */
  20073. attachToMesh(mesh: AbstractMesh): void;
  20074. /**
  20075. * Attaches the controllers mesh to a camera
  20076. * @param camera the camera the mesh should be attached to
  20077. */
  20078. attachToPoseControlledCamera(camera: TargetCamera): void;
  20079. /**
  20080. * Disposes of the controller
  20081. */
  20082. dispose(): void;
  20083. /**
  20084. * The mesh that is attached to the controller
  20085. */
  20086. get mesh(): Nullable<AbstractMesh>;
  20087. /**
  20088. * Gets the ray of the controller in the direction the controller is pointing
  20089. * @param length the length the resulting ray should be
  20090. * @returns a ray in the direction the controller is pointing
  20091. */
  20092. getForwardRay(length?: number): Ray;
  20093. }
  20094. }
  20095. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20096. import { Observable } from "babylonjs/Misc/observable";
  20097. import { Scene } from "babylonjs/scene";
  20098. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20099. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20100. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20101. import { Nullable } from "babylonjs/types";
  20102. /**
  20103. * Defines the WebVRController object that represents controllers tracked in 3D space
  20104. */
  20105. export abstract class WebVRController extends PoseEnabledController {
  20106. /**
  20107. * Internal, the default controller model for the controller
  20108. */
  20109. protected _defaultModel: Nullable<AbstractMesh>;
  20110. /**
  20111. * Fired when the trigger state has changed
  20112. */
  20113. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20114. /**
  20115. * Fired when the main button state has changed
  20116. */
  20117. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20118. /**
  20119. * Fired when the secondary button state has changed
  20120. */
  20121. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20122. /**
  20123. * Fired when the pad state has changed
  20124. */
  20125. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20126. /**
  20127. * Fired when controllers stick values have changed
  20128. */
  20129. onPadValuesChangedObservable: Observable<StickValues>;
  20130. /**
  20131. * Array of button availible on the controller
  20132. */
  20133. protected _buttons: Array<MutableGamepadButton>;
  20134. private _onButtonStateChange;
  20135. /**
  20136. * Fired when a controller button's state has changed
  20137. * @param callback the callback containing the button that was modified
  20138. */
  20139. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20140. /**
  20141. * X and Y axis corresponding to the controllers joystick
  20142. */
  20143. pad: StickValues;
  20144. /**
  20145. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20146. */
  20147. hand: string;
  20148. /**
  20149. * The default controller model for the controller
  20150. */
  20151. get defaultModel(): Nullable<AbstractMesh>;
  20152. /**
  20153. * Creates a new WebVRController from a gamepad
  20154. * @param vrGamepad the gamepad that the WebVRController should be created from
  20155. */
  20156. constructor(vrGamepad: any);
  20157. /**
  20158. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20159. */
  20160. update(): void;
  20161. /**
  20162. * Function to be called when a button is modified
  20163. */
  20164. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20165. /**
  20166. * Loads a mesh and attaches it to the controller
  20167. * @param scene the scene the mesh should be added to
  20168. * @param meshLoaded callback for when the mesh has been loaded
  20169. */
  20170. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20171. private _setButtonValue;
  20172. private _changes;
  20173. private _checkChanges;
  20174. /**
  20175. * Disposes of th webVRCOntroller
  20176. */
  20177. dispose(): void;
  20178. }
  20179. }
  20180. declare module "babylonjs/Lights/hemisphericLight" {
  20181. import { Nullable } from "babylonjs/types";
  20182. import { Scene } from "babylonjs/scene";
  20183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20184. import { Color3 } from "babylonjs/Maths/math.color";
  20185. import { Effect } from "babylonjs/Materials/effect";
  20186. import { Light } from "babylonjs/Lights/light";
  20187. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20188. /**
  20189. * The HemisphericLight simulates the ambient environment light,
  20190. * so the passed direction is the light reflection direction, not the incoming direction.
  20191. */
  20192. export class HemisphericLight extends Light {
  20193. /**
  20194. * The groundColor is the light in the opposite direction to the one specified during creation.
  20195. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  20196. */
  20197. groundColor: Color3;
  20198. /**
  20199. * The light reflection direction, not the incoming direction.
  20200. */
  20201. direction: Vector3;
  20202. /**
  20203. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20204. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20205. * The HemisphericLight can't cast shadows.
  20206. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20207. * @param name The friendly name of the light
  20208. * @param direction The direction of the light reflection
  20209. * @param scene The scene the light belongs to
  20210. */
  20211. constructor(name: string, direction: Vector3, scene: Scene);
  20212. protected _buildUniformLayout(): void;
  20213. /**
  20214. * Returns the string "HemisphericLight".
  20215. * @return The class name
  20216. */
  20217. getClassName(): string;
  20218. /**
  20219. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20220. * Returns the updated direction.
  20221. * @param target The target the direction should point to
  20222. * @return The computed direction
  20223. */
  20224. setDirectionToTarget(target: Vector3): Vector3;
  20225. /**
  20226. * Returns the shadow generator associated to the light.
  20227. * @returns Always null for hemispheric lights because it does not support shadows.
  20228. */
  20229. getShadowGenerator(): Nullable<IShadowGenerator>;
  20230. /**
  20231. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20232. * @param effect The effect to update
  20233. * @param lightIndex The index of the light in the effect to update
  20234. * @returns The hemispheric light
  20235. */
  20236. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20237. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20238. /**
  20239. * Computes the world matrix of the node
  20240. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20241. * @param useWasUpdatedFlag defines a reserved property
  20242. * @returns the world matrix
  20243. */
  20244. computeWorldMatrix(): Matrix;
  20245. /**
  20246. * Returns the integer 3.
  20247. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20248. */
  20249. getTypeID(): number;
  20250. /**
  20251. * Prepares the list of defines specific to the light type.
  20252. * @param defines the list of defines
  20253. * @param lightIndex defines the index of the light for the effect
  20254. */
  20255. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20256. }
  20257. }
  20258. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20259. /** @hidden */
  20260. export var vrMultiviewToSingleviewPixelShader: {
  20261. name: string;
  20262. shader: string;
  20263. };
  20264. }
  20265. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20266. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20267. import { Scene } from "babylonjs/scene";
  20268. /**
  20269. * Renders to multiple views with a single draw call
  20270. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20271. */
  20272. export class MultiviewRenderTarget extends RenderTargetTexture {
  20273. /**
  20274. * Creates a multiview render target
  20275. * @param scene scene used with the render target
  20276. * @param size the size of the render target (used for each view)
  20277. */
  20278. constructor(scene: Scene, size?: number | {
  20279. width: number;
  20280. height: number;
  20281. } | {
  20282. ratio: number;
  20283. });
  20284. /**
  20285. * @hidden
  20286. * @param faceIndex the face index, if its a cube texture
  20287. */
  20288. _bindFrameBuffer(faceIndex?: number): void;
  20289. /**
  20290. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20291. * @returns the view count
  20292. */
  20293. getViewCount(): number;
  20294. }
  20295. }
  20296. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20297. import { Camera } from "babylonjs/Cameras/camera";
  20298. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20299. import { Nullable } from "babylonjs/types";
  20300. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20301. import { Matrix } from "babylonjs/Maths/math.vector";
  20302. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20303. module "babylonjs/Engines/engine" {
  20304. interface Engine {
  20305. /**
  20306. * Creates a new multiview render target
  20307. * @param width defines the width of the texture
  20308. * @param height defines the height of the texture
  20309. * @returns the created multiview texture
  20310. */
  20311. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20312. /**
  20313. * Binds a multiview framebuffer to be drawn to
  20314. * @param multiviewTexture texture to bind
  20315. */
  20316. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20317. }
  20318. }
  20319. module "babylonjs/Cameras/camera" {
  20320. interface Camera {
  20321. /**
  20322. * @hidden
  20323. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20324. */
  20325. _useMultiviewToSingleView: boolean;
  20326. /**
  20327. * @hidden
  20328. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20329. */
  20330. _multiviewTexture: Nullable<RenderTargetTexture>;
  20331. /**
  20332. * @hidden
  20333. * ensures the multiview texture of the camera exists and has the specified width/height
  20334. * @param width height to set on the multiview texture
  20335. * @param height width to set on the multiview texture
  20336. */
  20337. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20338. }
  20339. }
  20340. module "babylonjs/scene" {
  20341. interface Scene {
  20342. /** @hidden */
  20343. _transformMatrixR: Matrix;
  20344. /** @hidden */
  20345. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20346. /** @hidden */
  20347. _createMultiviewUbo(): void;
  20348. /** @hidden */
  20349. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20350. /** @hidden */
  20351. _renderMultiviewToSingleView(camera: Camera): void;
  20352. }
  20353. }
  20354. }
  20355. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20356. import { Camera } from "babylonjs/Cameras/camera";
  20357. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20358. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20359. import "babylonjs/Engines/Extensions/engine.multiview";
  20360. /**
  20361. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20362. * This will not be used for webXR as it supports displaying texture arrays directly
  20363. */
  20364. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20365. /**
  20366. * Gets a string identifying the name of the class
  20367. * @returns "VRMultiviewToSingleviewPostProcess" string
  20368. */
  20369. getClassName(): string;
  20370. /**
  20371. * Initializes a VRMultiviewToSingleview
  20372. * @param name name of the post process
  20373. * @param camera camera to be applied to
  20374. * @param scaleFactor scaling factor to the size of the output texture
  20375. */
  20376. constructor(name: string, camera: Camera, scaleFactor: number);
  20377. }
  20378. }
  20379. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20380. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20381. import { Nullable } from "babylonjs/types";
  20382. import { Size } from "babylonjs/Maths/math.size";
  20383. import { Observable } from "babylonjs/Misc/observable";
  20384. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20385. /**
  20386. * Interface used to define additional presentation attributes
  20387. */
  20388. export interface IVRPresentationAttributes {
  20389. /**
  20390. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20391. */
  20392. highRefreshRate: boolean;
  20393. /**
  20394. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20395. */
  20396. foveationLevel: number;
  20397. }
  20398. module "babylonjs/Engines/engine" {
  20399. interface Engine {
  20400. /** @hidden */
  20401. _vrDisplay: any;
  20402. /** @hidden */
  20403. _vrSupported: boolean;
  20404. /** @hidden */
  20405. _oldSize: Size;
  20406. /** @hidden */
  20407. _oldHardwareScaleFactor: number;
  20408. /** @hidden */
  20409. _vrExclusivePointerMode: boolean;
  20410. /** @hidden */
  20411. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20412. /** @hidden */
  20413. _onVRDisplayPointerRestricted: () => void;
  20414. /** @hidden */
  20415. _onVRDisplayPointerUnrestricted: () => void;
  20416. /** @hidden */
  20417. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20418. /** @hidden */
  20419. _onVrDisplayDisconnect: Nullable<() => void>;
  20420. /** @hidden */
  20421. _onVrDisplayPresentChange: Nullable<() => void>;
  20422. /**
  20423. * Observable signaled when VR display mode changes
  20424. */
  20425. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20426. /**
  20427. * Observable signaled when VR request present is complete
  20428. */
  20429. onVRRequestPresentComplete: Observable<boolean>;
  20430. /**
  20431. * Observable signaled when VR request present starts
  20432. */
  20433. onVRRequestPresentStart: Observable<Engine>;
  20434. /**
  20435. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20436. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20437. */
  20438. isInVRExclusivePointerMode: boolean;
  20439. /**
  20440. * Gets a boolean indicating if a webVR device was detected
  20441. * @returns true if a webVR device was detected
  20442. */
  20443. isVRDevicePresent(): boolean;
  20444. /**
  20445. * Gets the current webVR device
  20446. * @returns the current webVR device (or null)
  20447. */
  20448. getVRDevice(): any;
  20449. /**
  20450. * Initializes a webVR display and starts listening to display change events
  20451. * The onVRDisplayChangedObservable will be notified upon these changes
  20452. * @returns A promise containing a VRDisplay and if vr is supported
  20453. */
  20454. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /** @hidden */
  20456. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20457. /**
  20458. * Gets or sets the presentation attributes used to configure VR rendering
  20459. */
  20460. vrPresentationAttributes?: IVRPresentationAttributes;
  20461. /**
  20462. * Call this function to switch to webVR mode
  20463. * Will do nothing if webVR is not supported or if there is no webVR device
  20464. * @param options the webvr options provided to the camera. mainly used for multiview
  20465. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20466. */
  20467. enableVR(options: WebVROptions): void;
  20468. /** @hidden */
  20469. _onVRFullScreenTriggered(): void;
  20470. }
  20471. }
  20472. }
  20473. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20474. import { Nullable } from "babylonjs/types";
  20475. import { Observable } from "babylonjs/Misc/observable";
  20476. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20477. import { Scene } from "babylonjs/scene";
  20478. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20479. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20480. import { Node } from "babylonjs/node";
  20481. import { Ray } from "babylonjs/Culling/ray";
  20482. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20483. import "babylonjs/Engines/Extensions/engine.webVR";
  20484. /**
  20485. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20486. * IMPORTANT!! The data is right-hand data.
  20487. * @export
  20488. * @interface DevicePose
  20489. */
  20490. export interface DevicePose {
  20491. /**
  20492. * The position of the device, values in array are [x,y,z].
  20493. */
  20494. readonly position: Nullable<Float32Array>;
  20495. /**
  20496. * The linearVelocity of the device, values in array are [x,y,z].
  20497. */
  20498. readonly linearVelocity: Nullable<Float32Array>;
  20499. /**
  20500. * The linearAcceleration of the device, values in array are [x,y,z].
  20501. */
  20502. readonly linearAcceleration: Nullable<Float32Array>;
  20503. /**
  20504. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20505. */
  20506. readonly orientation: Nullable<Float32Array>;
  20507. /**
  20508. * The angularVelocity of the device, values in array are [x,y,z].
  20509. */
  20510. readonly angularVelocity: Nullable<Float32Array>;
  20511. /**
  20512. * The angularAcceleration of the device, values in array are [x,y,z].
  20513. */
  20514. readonly angularAcceleration: Nullable<Float32Array>;
  20515. }
  20516. /**
  20517. * Interface representing a pose controlled object in Babylon.
  20518. * A pose controlled object has both regular pose values as well as pose values
  20519. * from an external device such as a VR head mounted display
  20520. */
  20521. export interface PoseControlled {
  20522. /**
  20523. * The position of the object in babylon space.
  20524. */
  20525. position: Vector3;
  20526. /**
  20527. * The rotation quaternion of the object in babylon space.
  20528. */
  20529. rotationQuaternion: Quaternion;
  20530. /**
  20531. * The position of the device in babylon space.
  20532. */
  20533. devicePosition?: Vector3;
  20534. /**
  20535. * The rotation quaternion of the device in babylon space.
  20536. */
  20537. deviceRotationQuaternion: Quaternion;
  20538. /**
  20539. * The raw pose coming from the device.
  20540. */
  20541. rawPose: Nullable<DevicePose>;
  20542. /**
  20543. * The scale of the device to be used when translating from device space to babylon space.
  20544. */
  20545. deviceScaleFactor: number;
  20546. /**
  20547. * Updates the poseControlled values based on the input device pose.
  20548. * @param poseData the pose data to update the object with
  20549. */
  20550. updateFromDevice(poseData: DevicePose): void;
  20551. }
  20552. /**
  20553. * Set of options to customize the webVRCamera
  20554. */
  20555. export interface WebVROptions {
  20556. /**
  20557. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20558. */
  20559. trackPosition?: boolean;
  20560. /**
  20561. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20562. */
  20563. positionScale?: number;
  20564. /**
  20565. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20566. */
  20567. displayName?: string;
  20568. /**
  20569. * Should the native controller meshes be initialized. (default: true)
  20570. */
  20571. controllerMeshes?: boolean;
  20572. /**
  20573. * Creating a default HemiLight only on controllers. (default: true)
  20574. */
  20575. defaultLightingOnControllers?: boolean;
  20576. /**
  20577. * If you don't want to use the default VR button of the helper. (default: false)
  20578. */
  20579. useCustomVRButton?: boolean;
  20580. /**
  20581. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20582. */
  20583. customVRButton?: HTMLButtonElement;
  20584. /**
  20585. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20586. */
  20587. rayLength?: number;
  20588. /**
  20589. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20590. */
  20591. defaultHeight?: number;
  20592. /**
  20593. * If multiview should be used if availible (default: false)
  20594. */
  20595. useMultiview?: boolean;
  20596. }
  20597. /**
  20598. * This represents a WebVR camera.
  20599. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20600. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20601. */
  20602. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20603. private webVROptions;
  20604. /**
  20605. * @hidden
  20606. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20607. */
  20608. _vrDevice: any;
  20609. /**
  20610. * The rawPose of the vrDevice.
  20611. */
  20612. rawPose: Nullable<DevicePose>;
  20613. private _onVREnabled;
  20614. private _specsVersion;
  20615. private _attached;
  20616. private _frameData;
  20617. protected _descendants: Array<Node>;
  20618. private _deviceRoomPosition;
  20619. /** @hidden */
  20620. _deviceRoomRotationQuaternion: Quaternion;
  20621. private _standingMatrix;
  20622. /**
  20623. * Represents device position in babylon space.
  20624. */
  20625. devicePosition: Vector3;
  20626. /**
  20627. * Represents device rotation in babylon space.
  20628. */
  20629. deviceRotationQuaternion: Quaternion;
  20630. /**
  20631. * The scale of the device to be used when translating from device space to babylon space.
  20632. */
  20633. deviceScaleFactor: number;
  20634. private _deviceToWorld;
  20635. private _worldToDevice;
  20636. /**
  20637. * References to the webVR controllers for the vrDevice.
  20638. */
  20639. controllers: Array<WebVRController>;
  20640. /**
  20641. * Emits an event when a controller is attached.
  20642. */
  20643. onControllersAttachedObservable: Observable<WebVRController[]>;
  20644. /**
  20645. * Emits an event when a controller's mesh has been loaded;
  20646. */
  20647. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20648. /**
  20649. * Emits an event when the HMD's pose has been updated.
  20650. */
  20651. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20652. private _poseSet;
  20653. /**
  20654. * If the rig cameras be used as parent instead of this camera.
  20655. */
  20656. rigParenting: boolean;
  20657. private _lightOnControllers;
  20658. private _defaultHeight?;
  20659. /**
  20660. * Instantiates a WebVRFreeCamera.
  20661. * @param name The name of the WebVRFreeCamera
  20662. * @param position The starting anchor position for the camera
  20663. * @param scene The scene the camera belongs to
  20664. * @param webVROptions a set of customizable options for the webVRCamera
  20665. */
  20666. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20667. /**
  20668. * Gets the device distance from the ground in meters.
  20669. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  20670. */
  20671. deviceDistanceToRoomGround(): number;
  20672. /**
  20673. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20674. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20675. */
  20676. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20677. /**
  20678. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20679. * @returns A promise with a boolean set to if the standing matrix is supported.
  20680. */
  20681. useStandingMatrixAsync(): Promise<boolean>;
  20682. /**
  20683. * Disposes the camera
  20684. */
  20685. dispose(): void;
  20686. /**
  20687. * Gets a vrController by name.
  20688. * @param name The name of the controller to retreive
  20689. * @returns the controller matching the name specified or null if not found
  20690. */
  20691. getControllerByName(name: string): Nullable<WebVRController>;
  20692. private _leftController;
  20693. /**
  20694. * The controller corresponding to the users left hand.
  20695. */
  20696. get leftController(): Nullable<WebVRController>;
  20697. private _rightController;
  20698. /**
  20699. * The controller corresponding to the users right hand.
  20700. */
  20701. get rightController(): Nullable<WebVRController>;
  20702. /**
  20703. * Casts a ray forward from the vrCamera's gaze.
  20704. * @param length Length of the ray (default: 100)
  20705. * @returns the ray corresponding to the gaze
  20706. */
  20707. getForwardRay(length?: number): Ray;
  20708. /**
  20709. * @hidden
  20710. * Updates the camera based on device's frame data
  20711. */
  20712. _checkInputs(): void;
  20713. /**
  20714. * Updates the poseControlled values based on the input device pose.
  20715. * @param poseData Pose coming from the device
  20716. */
  20717. updateFromDevice(poseData: DevicePose): void;
  20718. private _htmlElementAttached;
  20719. private _detachIfAttached;
  20720. /**
  20721. * WebVR's attach control will start broadcasting frames to the device.
  20722. * Note that in certain browsers (chrome for example) this function must be called
  20723. * within a user-interaction callback. Example:
  20724. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20725. *
  20726. * @param element html element to attach the vrDevice to
  20727. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20728. */
  20729. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20730. /**
  20731. * Detaches the camera from the html element and disables VR
  20732. *
  20733. * @param element html element to detach from
  20734. */
  20735. detachControl(element: HTMLElement): void;
  20736. /**
  20737. * @returns the name of this class
  20738. */
  20739. getClassName(): string;
  20740. /**
  20741. * Calls resetPose on the vrDisplay
  20742. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20743. */
  20744. resetToCurrentRotation(): void;
  20745. /**
  20746. * @hidden
  20747. * Updates the rig cameras (left and right eye)
  20748. */
  20749. _updateRigCameras(): void;
  20750. private _workingVector;
  20751. private _oneVector;
  20752. private _workingMatrix;
  20753. private updateCacheCalled;
  20754. private _correctPositionIfNotTrackPosition;
  20755. /**
  20756. * @hidden
  20757. * Updates the cached values of the camera
  20758. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20759. */
  20760. _updateCache(ignoreParentClass?: boolean): void;
  20761. /**
  20762. * @hidden
  20763. * Get current device position in babylon world
  20764. */
  20765. _computeDevicePosition(): void;
  20766. /**
  20767. * Updates the current device position and rotation in the babylon world
  20768. */
  20769. update(): void;
  20770. /**
  20771. * @hidden
  20772. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20773. * @returns an identity matrix
  20774. */
  20775. _getViewMatrix(): Matrix;
  20776. private _tmpMatrix;
  20777. /**
  20778. * This function is called by the two RIG cameras.
  20779. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20780. * @hidden
  20781. */
  20782. _getWebVRViewMatrix(): Matrix;
  20783. /** @hidden */
  20784. _getWebVRProjectionMatrix(): Matrix;
  20785. private _onGamepadConnectedObserver;
  20786. private _onGamepadDisconnectedObserver;
  20787. private _updateCacheWhenTrackingDisabledObserver;
  20788. /**
  20789. * Initializes the controllers and their meshes
  20790. */
  20791. initControllers(): void;
  20792. }
  20793. }
  20794. declare module "babylonjs/Materials/materialHelper" {
  20795. import { Nullable } from "babylonjs/types";
  20796. import { Scene } from "babylonjs/scene";
  20797. import { Engine } from "babylonjs/Engines/engine";
  20798. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20799. import { Light } from "babylonjs/Lights/light";
  20800. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20801. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20802. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20803. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20804. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20805. /**
  20806. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20807. *
  20808. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20809. *
  20810. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20811. */
  20812. export class MaterialHelper {
  20813. /**
  20814. * Bind the current view position to an effect.
  20815. * @param effect The effect to be bound
  20816. * @param scene The scene the eyes position is used from
  20817. * @param variableName name of the shader variable that will hold the eye position
  20818. */
  20819. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20820. /**
  20821. * Helps preparing the defines values about the UVs in used in the effect.
  20822. * UVs are shared as much as we can accross channels in the shaders.
  20823. * @param texture The texture we are preparing the UVs for
  20824. * @param defines The defines to update
  20825. * @param key The channel key "diffuse", "specular"... used in the shader
  20826. */
  20827. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20828. /**
  20829. * Binds a texture matrix value to its corrsponding uniform
  20830. * @param texture The texture to bind the matrix for
  20831. * @param uniformBuffer The uniform buffer receivin the data
  20832. * @param key The channel key "diffuse", "specular"... used in the shader
  20833. */
  20834. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20835. /**
  20836. * Gets the current status of the fog (should it be enabled?)
  20837. * @param mesh defines the mesh to evaluate for fog support
  20838. * @param scene defines the hosting scene
  20839. * @returns true if fog must be enabled
  20840. */
  20841. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20842. /**
  20843. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20844. * @param mesh defines the current mesh
  20845. * @param scene defines the current scene
  20846. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20847. * @param pointsCloud defines if point cloud rendering has to be turned on
  20848. * @param fogEnabled defines if fog has to be turned on
  20849. * @param alphaTest defines if alpha testing has to be turned on
  20850. * @param defines defines the current list of defines
  20851. */
  20852. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20853. /**
  20854. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20855. * @param scene defines the current scene
  20856. * @param engine defines the current engine
  20857. * @param defines specifies the list of active defines
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useClipPlane defines if clip plane have to be turned on
  20860. * @param useInstances defines if instances have to be turned on
  20861. * @param useThinInstances defines if thin instances have to be turned on
  20862. */
  20863. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20864. /**
  20865. * Prepares the defines for bones
  20866. * @param mesh The mesh containing the geometry data we will draw
  20867. * @param defines The defines to update
  20868. */
  20869. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20870. /**
  20871. * Prepares the defines for morph targets
  20872. * @param mesh The mesh containing the geometry data we will draw
  20873. * @param defines The defines to update
  20874. */
  20875. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20876. /**
  20877. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20878. * @param mesh The mesh containing the geometry data we will draw
  20879. * @param defines The defines to update
  20880. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20881. * @param useBones Precise whether bones should be used or not (override mesh info)
  20882. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20883. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20884. * @returns false if defines are considered not dirty and have not been checked
  20885. */
  20886. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20887. /**
  20888. * Prepares the defines related to multiview
  20889. * @param scene The scene we are intending to draw
  20890. * @param defines The defines to update
  20891. */
  20892. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20893. /**
  20894. * Prepares the defines related to the prepass
  20895. * @param scene The scene we are intending to draw
  20896. * @param defines The defines to update
  20897. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20898. */
  20899. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20900. /**
  20901. * Prepares the defines related to the light information passed in parameter
  20902. * @param scene The scene we are intending to draw
  20903. * @param mesh The mesh the effect is compiling for
  20904. * @param light The light the effect is compiling for
  20905. * @param lightIndex The index of the light
  20906. * @param defines The defines to update
  20907. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20908. * @param state Defines the current state regarding what is needed (normals, etc...)
  20909. */
  20910. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20911. needNormals: boolean;
  20912. needRebuild: boolean;
  20913. shadowEnabled: boolean;
  20914. specularEnabled: boolean;
  20915. lightmapMode: boolean;
  20916. }): void;
  20917. /**
  20918. * Prepares the defines related to the light information passed in parameter
  20919. * @param scene The scene we are intending to draw
  20920. * @param mesh The mesh the effect is compiling for
  20921. * @param defines The defines to update
  20922. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20923. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20924. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20925. * @returns true if normals will be required for the rest of the effect
  20926. */
  20927. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20928. /**
  20929. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20930. * @param lightIndex defines the light index
  20931. * @param uniformsList The uniform list
  20932. * @param samplersList The sampler list
  20933. * @param projectedLightTexture defines if projected texture must be used
  20934. * @param uniformBuffersList defines an optional list of uniform buffers
  20935. */
  20936. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20937. /**
  20938. * Prepares the uniforms and samplers list to be used in the effect
  20939. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20940. * @param samplersList The sampler list
  20941. * @param defines The defines helping in the list generation
  20942. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20943. */
  20944. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20945. /**
  20946. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20947. * @param defines The defines to update while falling back
  20948. * @param fallbacks The authorized effect fallbacks
  20949. * @param maxSimultaneousLights The maximum number of lights allowed
  20950. * @param rank the current rank of the Effect
  20951. * @returns The newly affected rank
  20952. */
  20953. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20954. private static _TmpMorphInfluencers;
  20955. /**
  20956. * Prepares the list of attributes required for morph targets according to the effect defines.
  20957. * @param attribs The current list of supported attribs
  20958. * @param mesh The mesh to prepare the morph targets attributes for
  20959. * @param influencers The number of influencers
  20960. */
  20961. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20962. /**
  20963. * Prepares the list of attributes required for morph targets according to the effect defines.
  20964. * @param attribs The current list of supported attribs
  20965. * @param mesh The mesh to prepare the morph targets attributes for
  20966. * @param defines The current Defines of the effect
  20967. */
  20968. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20969. /**
  20970. * Prepares the list of attributes required for bones according to the effect defines.
  20971. * @param attribs The current list of supported attribs
  20972. * @param mesh The mesh to prepare the bones attributes for
  20973. * @param defines The current Defines of the effect
  20974. * @param fallbacks The current efffect fallback strategy
  20975. */
  20976. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20977. /**
  20978. * Check and prepare the list of attributes required for instances according to the effect defines.
  20979. * @param attribs The current list of supported attribs
  20980. * @param defines The current MaterialDefines of the effect
  20981. */
  20982. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20983. /**
  20984. * Add the list of attributes required for instances to the attribs array.
  20985. * @param attribs The current list of supported attribs
  20986. */
  20987. static PushAttributesForInstances(attribs: string[]): void;
  20988. /**
  20989. * Binds the light information to the effect.
  20990. * @param light The light containing the generator
  20991. * @param effect The effect we are binding the data to
  20992. * @param lightIndex The light index in the effect used to render
  20993. */
  20994. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20995. /**
  20996. * Binds the lights information from the scene to the effect for the given mesh.
  20997. * @param light Light to bind
  20998. * @param lightIndex Light index
  20999. * @param scene The scene where the light belongs to
  21000. * @param effect The effect we are binding the data to
  21001. * @param useSpecular Defines if specular is supported
  21002. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21003. */
  21004. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21005. /**
  21006. * Binds the lights information from the scene to the effect for the given mesh.
  21007. * @param scene The scene the lights belongs to
  21008. * @param mesh The mesh we are binding the information to render
  21009. * @param effect The effect we are binding the data to
  21010. * @param defines The generated defines for the effect
  21011. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21012. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21013. */
  21014. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21015. private static _tempFogColor;
  21016. /**
  21017. * Binds the fog information from the scene to the effect for the given mesh.
  21018. * @param scene The scene the lights belongs to
  21019. * @param mesh The mesh we are binding the information to render
  21020. * @param effect The effect we are binding the data to
  21021. * @param linearSpace Defines if the fog effect is applied in linear space
  21022. */
  21023. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21024. /**
  21025. * Binds the bones information from the mesh to the effect.
  21026. * @param mesh The mesh we are binding the information to render
  21027. * @param effect The effect we are binding the data to
  21028. */
  21029. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21030. /**
  21031. * Binds the morph targets information from the mesh to the effect.
  21032. * @param abstractMesh The mesh we are binding the information to render
  21033. * @param effect The effect we are binding the data to
  21034. */
  21035. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21036. /**
  21037. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21038. * @param defines The generated defines used in the effect
  21039. * @param effect The effect we are binding the data to
  21040. * @param scene The scene we are willing to render with logarithmic scale for
  21041. */
  21042. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21043. /**
  21044. * Binds the clip plane information from the scene to the effect.
  21045. * @param scene The scene the clip plane information are extracted from
  21046. * @param effect The effect we are binding the data to
  21047. */
  21048. static BindClipPlane(effect: Effect, scene: Scene): void;
  21049. }
  21050. }
  21051. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21052. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21053. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21054. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21055. import { Nullable } from "babylonjs/types";
  21056. import { Effect } from "babylonjs/Materials/effect";
  21057. import { Matrix } from "babylonjs/Maths/math.vector";
  21058. import { Scene } from "babylonjs/scene";
  21059. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21060. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21061. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21062. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21063. import { Observable } from "babylonjs/Misc/observable";
  21064. /**
  21065. * Block used to expose an input value
  21066. */
  21067. export class InputBlock extends NodeMaterialBlock {
  21068. private _mode;
  21069. private _associatedVariableName;
  21070. private _storedValue;
  21071. private _valueCallback;
  21072. private _type;
  21073. private _animationType;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. min: number;
  21076. /** Gets or set a value used to limit the range of float values */
  21077. max: number;
  21078. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21079. isBoolean: boolean;
  21080. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21081. matrixMode: number;
  21082. /** @hidden */
  21083. _systemValue: Nullable<NodeMaterialSystemValues>;
  21084. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21085. visibleInInspector: boolean;
  21086. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21087. isConstant: boolean;
  21088. /** Gets or sets the group to use to display this block in the Inspector */
  21089. groupInInspector: string;
  21090. /** Gets an observable raised when the value is changed */
  21091. onValueChangedObservable: Observable<InputBlock>;
  21092. /**
  21093. * Gets or sets the connection point type (default is float)
  21094. */
  21095. get type(): NodeMaterialBlockConnectionPointTypes;
  21096. /**
  21097. * Creates a new InputBlock
  21098. * @param name defines the block name
  21099. * @param target defines the target of that block (Vertex by default)
  21100. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21101. */
  21102. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21103. /**
  21104. * Validates if a name is a reserve word.
  21105. * @param newName the new name to be given to the node.
  21106. * @returns false if the name is a reserve word, else true.
  21107. */
  21108. validateBlockName(newName: string): boolean;
  21109. /**
  21110. * Gets the output component
  21111. */
  21112. get output(): NodeMaterialConnectionPoint;
  21113. /**
  21114. * Set the source of this connection point to a vertex attribute
  21115. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21116. * @returns the current connection point
  21117. */
  21118. setAsAttribute(attributeName?: string): InputBlock;
  21119. /**
  21120. * Set the source of this connection point to a system value
  21121. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21122. * @returns the current connection point
  21123. */
  21124. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21125. /**
  21126. * Gets or sets the value of that point.
  21127. * Please note that this value will be ignored if valueCallback is defined
  21128. */
  21129. get value(): any;
  21130. set value(value: any);
  21131. /**
  21132. * Gets or sets a callback used to get the value of that point.
  21133. * Please note that setting this value will force the connection point to ignore the value property
  21134. */
  21135. get valueCallback(): () => any;
  21136. set valueCallback(value: () => any);
  21137. /**
  21138. * Gets or sets the associated variable name in the shader
  21139. */
  21140. get associatedVariableName(): string;
  21141. set associatedVariableName(value: string);
  21142. /** Gets or sets the type of animation applied to the input */
  21143. get animationType(): AnimatedInputBlockTypes;
  21144. set animationType(value: AnimatedInputBlockTypes);
  21145. /**
  21146. * Gets a boolean indicating that this connection point not defined yet
  21147. */
  21148. get isUndefined(): boolean;
  21149. /**
  21150. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21151. * In this case the connection point name must be the name of the uniform to use.
  21152. * Can only be set on inputs
  21153. */
  21154. get isUniform(): boolean;
  21155. set isUniform(value: boolean);
  21156. /**
  21157. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21158. * In this case the connection point name must be the name of the attribute to use
  21159. * Can only be set on inputs
  21160. */
  21161. get isAttribute(): boolean;
  21162. set isAttribute(value: boolean);
  21163. /**
  21164. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21165. * Can only be set on exit points
  21166. */
  21167. get isVarying(): boolean;
  21168. set isVarying(value: boolean);
  21169. /**
  21170. * Gets a boolean indicating that the current connection point is a system value
  21171. */
  21172. get isSystemValue(): boolean;
  21173. /**
  21174. * Gets or sets the current well known value or null if not defined as a system value
  21175. */
  21176. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21177. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21178. /**
  21179. * Gets the current class name
  21180. * @returns the class name
  21181. */
  21182. getClassName(): string;
  21183. /**
  21184. * Animate the input if animationType !== None
  21185. * @param scene defines the rendering scene
  21186. */
  21187. animate(scene: Scene): void;
  21188. private _emitDefine;
  21189. initialize(state: NodeMaterialBuildState): void;
  21190. /**
  21191. * Set the input block to its default value (based on its type)
  21192. */
  21193. setDefaultValue(): void;
  21194. private _emitConstant;
  21195. /** @hidden */
  21196. get _noContextSwitch(): boolean;
  21197. private _emit;
  21198. /** @hidden */
  21199. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21200. /** @hidden */
  21201. _transmit(effect: Effect, scene: Scene): void;
  21202. protected _buildBlock(state: NodeMaterialBuildState): void;
  21203. protected _dumpPropertiesCode(): string;
  21204. dispose(): void;
  21205. serialize(): any;
  21206. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21207. }
  21208. }
  21209. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21210. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21211. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21212. import { Nullable } from "babylonjs/types";
  21213. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21214. import { Observable } from "babylonjs/Misc/observable";
  21215. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21216. /**
  21217. * Enum used to define the compatibility state between two connection points
  21218. */
  21219. export enum NodeMaterialConnectionPointCompatibilityStates {
  21220. /** Points are compatibles */
  21221. Compatible = 0,
  21222. /** Points are incompatible because of their types */
  21223. TypeIncompatible = 1,
  21224. /** Points are incompatible because of their targets (vertex vs fragment) */
  21225. TargetIncompatible = 2
  21226. }
  21227. /**
  21228. * Defines the direction of a connection point
  21229. */
  21230. export enum NodeMaterialConnectionPointDirection {
  21231. /** Input */
  21232. Input = 0,
  21233. /** Output */
  21234. Output = 1
  21235. }
  21236. /**
  21237. * Defines a connection point for a block
  21238. */
  21239. export class NodeMaterialConnectionPoint {
  21240. /** @hidden */
  21241. _ownerBlock: NodeMaterialBlock;
  21242. /** @hidden */
  21243. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21244. private _endpoints;
  21245. private _associatedVariableName;
  21246. private _direction;
  21247. /** @hidden */
  21248. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. /** @hidden */
  21250. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21251. private _type;
  21252. /** @hidden */
  21253. _enforceAssociatedVariableName: boolean;
  21254. /** Gets the direction of the point */
  21255. get direction(): NodeMaterialConnectionPointDirection;
  21256. /** Indicates that this connection point needs dual validation before being connected to another point */
  21257. needDualDirectionValidation: boolean;
  21258. /**
  21259. * Gets or sets the additional types supported by this connection point
  21260. */
  21261. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21262. /**
  21263. * Gets or sets the additional types excluded by this connection point
  21264. */
  21265. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21266. /**
  21267. * Observable triggered when this point is connected
  21268. */
  21269. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21270. /**
  21271. * Gets or sets the associated variable name in the shader
  21272. */
  21273. get associatedVariableName(): string;
  21274. set associatedVariableName(value: string);
  21275. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21276. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21277. /**
  21278. * Gets or sets the connection point type (default is float)
  21279. */
  21280. get type(): NodeMaterialBlockConnectionPointTypes;
  21281. set type(value: NodeMaterialBlockConnectionPointTypes);
  21282. /**
  21283. * Gets or sets the connection point name
  21284. */
  21285. name: string;
  21286. /**
  21287. * Gets or sets the connection point name
  21288. */
  21289. displayName: string;
  21290. /**
  21291. * Gets or sets a boolean indicating that this connection point can be omitted
  21292. */
  21293. isOptional: boolean;
  21294. /**
  21295. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21296. */
  21297. isExposedOnFrame: boolean;
  21298. /**
  21299. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21300. */
  21301. define: string;
  21302. /** @hidden */
  21303. _prioritizeVertex: boolean;
  21304. private _target;
  21305. /** Gets or sets the target of that connection point */
  21306. get target(): NodeMaterialBlockTargets;
  21307. set target(value: NodeMaterialBlockTargets);
  21308. /**
  21309. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21310. */
  21311. get isConnected(): boolean;
  21312. /**
  21313. * Gets a boolean indicating that the current point is connected to an input block
  21314. */
  21315. get isConnectedToInputBlock(): boolean;
  21316. /**
  21317. * Gets a the connected input block (if any)
  21318. */
  21319. get connectInputBlock(): Nullable<InputBlock>;
  21320. /** Get the other side of the connection (if any) */
  21321. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21322. /** Get the block that owns this connection point */
  21323. get ownerBlock(): NodeMaterialBlock;
  21324. /** Get the block connected on the other side of this connection (if any) */
  21325. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21326. /** Get the block connected on the endpoints of this connection (if any) */
  21327. get connectedBlocks(): Array<NodeMaterialBlock>;
  21328. /** Gets the list of connected endpoints */
  21329. get endpoints(): NodeMaterialConnectionPoint[];
  21330. /** Gets a boolean indicating if that output point is connected to at least one input */
  21331. get hasEndpoints(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21333. get isConnectedInVertexShader(): boolean;
  21334. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21335. get isConnectedInFragmentShader(): boolean;
  21336. /**
  21337. * Creates a block suitable to be used as an input for this input point.
  21338. * If null is returned, a block based on the point type will be created.
  21339. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21340. */
  21341. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21342. /**
  21343. * Creates a new connection point
  21344. * @param name defines the connection point name
  21345. * @param ownerBlock defines the block hosting this connection point
  21346. * @param direction defines the direction of the connection point
  21347. */
  21348. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21349. /**
  21350. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21351. * @returns the class name
  21352. */
  21353. getClassName(): string;
  21354. /**
  21355. * Gets a boolean indicating if the current point can be connected to another point
  21356. * @param connectionPoint defines the other connection point
  21357. * @returns a boolean
  21358. */
  21359. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21360. /**
  21361. * Gets a number indicating if the current point can be connected to another point
  21362. * @param connectionPoint defines the other connection point
  21363. * @returns a number defining the compatibility state
  21364. */
  21365. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21366. /**
  21367. * Connect this point to another connection point
  21368. * @param connectionPoint defines the other connection point
  21369. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21370. * @returns the current connection point
  21371. */
  21372. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21373. /**
  21374. * Disconnect this point from one of his endpoint
  21375. * @param endpoint defines the other connection point
  21376. * @returns the current connection point
  21377. */
  21378. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21379. /**
  21380. * Serializes this point in a JSON representation
  21381. * @param isInput defines if the connection point is an input (default is true)
  21382. * @returns the serialized point object
  21383. */
  21384. serialize(isInput?: boolean): any;
  21385. /**
  21386. * Release resources
  21387. */
  21388. dispose(): void;
  21389. }
  21390. }
  21391. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21392. /**
  21393. * Enum used to define the material modes
  21394. */
  21395. export enum NodeMaterialModes {
  21396. /** Regular material */
  21397. Material = 0,
  21398. /** For post process */
  21399. PostProcess = 1,
  21400. /** For particle system */
  21401. Particle = 2
  21402. }
  21403. }
  21404. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21405. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21406. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21407. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21408. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21410. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21411. import { Effect } from "babylonjs/Materials/effect";
  21412. import { Mesh } from "babylonjs/Meshes/mesh";
  21413. import { Nullable } from "babylonjs/types";
  21414. import { Texture } from "babylonjs/Materials/Textures/texture";
  21415. import { Scene } from "babylonjs/scene";
  21416. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21417. /**
  21418. * Block used to read a texture from a sampler
  21419. */
  21420. export class TextureBlock extends NodeMaterialBlock {
  21421. private _defineName;
  21422. private _linearDefineName;
  21423. private _gammaDefineName;
  21424. private _tempTextureRead;
  21425. private _samplerName;
  21426. private _transformedUVName;
  21427. private _textureTransformName;
  21428. private _textureInfoName;
  21429. private _mainUVName;
  21430. private _mainUVDefineName;
  21431. private _fragmentOnly;
  21432. /**
  21433. * Gets or sets the texture associated with the node
  21434. */
  21435. texture: Nullable<Texture>;
  21436. /**
  21437. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21438. */
  21439. convertToGammaSpace: boolean;
  21440. /**
  21441. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21442. */
  21443. convertToLinearSpace: boolean;
  21444. /**
  21445. * Create a new TextureBlock
  21446. * @param name defines the block name
  21447. */
  21448. constructor(name: string, fragmentOnly?: boolean);
  21449. /**
  21450. * Gets the current class name
  21451. * @returns the class name
  21452. */
  21453. getClassName(): string;
  21454. /**
  21455. * Gets the uv input component
  21456. */
  21457. get uv(): NodeMaterialConnectionPoint;
  21458. /**
  21459. * Gets the rgba output component
  21460. */
  21461. get rgba(): NodeMaterialConnectionPoint;
  21462. /**
  21463. * Gets the rgb output component
  21464. */
  21465. get rgb(): NodeMaterialConnectionPoint;
  21466. /**
  21467. * Gets the r output component
  21468. */
  21469. get r(): NodeMaterialConnectionPoint;
  21470. /**
  21471. * Gets the g output component
  21472. */
  21473. get g(): NodeMaterialConnectionPoint;
  21474. /**
  21475. * Gets the b output component
  21476. */
  21477. get b(): NodeMaterialConnectionPoint;
  21478. /**
  21479. * Gets the a output component
  21480. */
  21481. get a(): NodeMaterialConnectionPoint;
  21482. get target(): NodeMaterialBlockTargets;
  21483. autoConfigure(material: NodeMaterial): void;
  21484. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21485. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21486. isReady(): boolean;
  21487. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21488. private get _isMixed();
  21489. private _injectVertexCode;
  21490. private _writeTextureRead;
  21491. private _writeOutput;
  21492. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21493. protected _dumpPropertiesCode(): string;
  21494. serialize(): any;
  21495. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21496. }
  21497. }
  21498. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21499. /** @hidden */
  21500. export var reflectionFunction: {
  21501. name: string;
  21502. shader: string;
  21503. };
  21504. }
  21505. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21506. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21507. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21508. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21509. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21511. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21512. import { Effect } from "babylonjs/Materials/effect";
  21513. import { Mesh } from "babylonjs/Meshes/mesh";
  21514. import { Nullable } from "babylonjs/types";
  21515. import { Scene } from "babylonjs/scene";
  21516. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21517. /**
  21518. * Base block used to read a reflection texture from a sampler
  21519. */
  21520. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21521. /** @hidden */
  21522. _define3DName: string;
  21523. /** @hidden */
  21524. _defineCubicName: string;
  21525. /** @hidden */
  21526. _defineExplicitName: string;
  21527. /** @hidden */
  21528. _defineProjectionName: string;
  21529. /** @hidden */
  21530. _defineLocalCubicName: string;
  21531. /** @hidden */
  21532. _defineSphericalName: string;
  21533. /** @hidden */
  21534. _definePlanarName: string;
  21535. /** @hidden */
  21536. _defineEquirectangularName: string;
  21537. /** @hidden */
  21538. _defineMirroredEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineEquirectangularFixedName: string;
  21541. /** @hidden */
  21542. _defineSkyboxName: string;
  21543. /** @hidden */
  21544. _defineOppositeZ: string;
  21545. /** @hidden */
  21546. _cubeSamplerName: string;
  21547. /** @hidden */
  21548. _2DSamplerName: string;
  21549. protected _positionUVWName: string;
  21550. protected _directionWName: string;
  21551. protected _reflectionVectorName: string;
  21552. /** @hidden */
  21553. _reflectionCoordsName: string;
  21554. /** @hidden */
  21555. _reflectionMatrixName: string;
  21556. protected _reflectionColorName: string;
  21557. /**
  21558. * Gets or sets the texture associated with the node
  21559. */
  21560. texture: Nullable<BaseTexture>;
  21561. /**
  21562. * Create a new ReflectionTextureBaseBlock
  21563. * @param name defines the block name
  21564. */
  21565. constructor(name: string);
  21566. /**
  21567. * Gets the current class name
  21568. * @returns the class name
  21569. */
  21570. getClassName(): string;
  21571. /**
  21572. * Gets the world position input component
  21573. */
  21574. abstract get position(): NodeMaterialConnectionPoint;
  21575. /**
  21576. * Gets the world position input component
  21577. */
  21578. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21579. /**
  21580. * Gets the world normal input component
  21581. */
  21582. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21583. /**
  21584. * Gets the world input component
  21585. */
  21586. abstract get world(): NodeMaterialConnectionPoint;
  21587. /**
  21588. * Gets the camera (or eye) position component
  21589. */
  21590. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21591. /**
  21592. * Gets the view input component
  21593. */
  21594. abstract get view(): NodeMaterialConnectionPoint;
  21595. protected _getTexture(): Nullable<BaseTexture>;
  21596. autoConfigure(material: NodeMaterial): void;
  21597. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21598. isReady(): boolean;
  21599. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21600. /**
  21601. * Gets the code to inject in the vertex shader
  21602. * @param state current state of the node material building
  21603. * @returns the shader code
  21604. */
  21605. handleVertexSide(state: NodeMaterialBuildState): string;
  21606. /**
  21607. * Handles the inits for the fragment code path
  21608. * @param state node material build state
  21609. */
  21610. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21611. /**
  21612. * Generates the reflection coords code for the fragment code path
  21613. * @param worldNormalVarName name of the world normal variable
  21614. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21615. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21616. * @returns the shader code
  21617. */
  21618. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21619. /**
  21620. * Generates the reflection color code for the fragment code path
  21621. * @param lodVarName name of the lod variable
  21622. * @param swizzleLookupTexture swizzle to use for the final color variable
  21623. * @returns the shader code
  21624. */
  21625. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21626. /**
  21627. * Generates the code corresponding to the connected output points
  21628. * @param state node material build state
  21629. * @param varName name of the variable to output
  21630. * @returns the shader code
  21631. */
  21632. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21633. protected _buildBlock(state: NodeMaterialBuildState): this;
  21634. protected _dumpPropertiesCode(): string;
  21635. serialize(): any;
  21636. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21637. }
  21638. }
  21639. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21640. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21641. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21642. import { Nullable } from "babylonjs/types";
  21643. /**
  21644. * Defines a connection point to be used for points with a custom object type
  21645. */
  21646. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21647. private _blockType;
  21648. private _blockName;
  21649. private _nameForCheking?;
  21650. /**
  21651. * Creates a new connection point
  21652. * @param name defines the connection point name
  21653. * @param ownerBlock defines the block hosting this connection point
  21654. * @param direction defines the direction of the connection point
  21655. */
  21656. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21657. /**
  21658. * Gets a number indicating if the current point can be connected to another point
  21659. * @param connectionPoint defines the other connection point
  21660. * @returns a number defining the compatibility state
  21661. */
  21662. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21663. /**
  21664. * Creates a block suitable to be used as an input for this input point.
  21665. * If null is returned, a block based on the point type will be created.
  21666. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21667. */
  21668. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21669. }
  21670. }
  21671. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21672. /**
  21673. * Enum defining the type of properties that can be edited in the property pages in the NME
  21674. */
  21675. export enum PropertyTypeForEdition {
  21676. /** property is a boolean */
  21677. Boolean = 0,
  21678. /** property is a float */
  21679. Float = 1,
  21680. /** property is a Vector2 */
  21681. Vector2 = 2,
  21682. /** property is a list of values */
  21683. List = 3
  21684. }
  21685. /**
  21686. * Interface that defines an option in a variable of type list
  21687. */
  21688. export interface IEditablePropertyListOption {
  21689. /** label of the option */
  21690. "label": string;
  21691. /** value of the option */
  21692. "value": number;
  21693. }
  21694. /**
  21695. * Interface that defines the options available for an editable property
  21696. */
  21697. export interface IEditablePropertyOption {
  21698. /** min value */
  21699. "min"?: number;
  21700. /** max value */
  21701. "max"?: number;
  21702. /** notifiers: indicates which actions to take when the property is changed */
  21703. "notifiers"?: {
  21704. /** the material should be rebuilt */
  21705. "rebuild"?: boolean;
  21706. /** the preview should be updated */
  21707. "update"?: boolean;
  21708. };
  21709. /** list of the options for a variable of type list */
  21710. "options"?: IEditablePropertyListOption[];
  21711. }
  21712. /**
  21713. * Interface that describes an editable property
  21714. */
  21715. export interface IPropertyDescriptionForEdition {
  21716. /** name of the property */
  21717. "propertyName": string;
  21718. /** display name of the property */
  21719. "displayName": string;
  21720. /** type of the property */
  21721. "type": PropertyTypeForEdition;
  21722. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21723. "groupName": string;
  21724. /** options for the property */
  21725. "options": IEditablePropertyOption;
  21726. }
  21727. /**
  21728. * Decorator that flags a property in a node material block as being editable
  21729. */
  21730. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21731. }
  21732. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21733. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21734. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21735. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21737. import { Nullable } from "babylonjs/types";
  21738. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21739. import { Mesh } from "babylonjs/Meshes/mesh";
  21740. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21741. import { Effect } from "babylonjs/Materials/effect";
  21742. import { Scene } from "babylonjs/scene";
  21743. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21744. /**
  21745. * Block used to implement the refraction part of the sub surface module of the PBR material
  21746. */
  21747. export class RefractionBlock extends NodeMaterialBlock {
  21748. /** @hidden */
  21749. _define3DName: string;
  21750. /** @hidden */
  21751. _refractionMatrixName: string;
  21752. /** @hidden */
  21753. _defineLODRefractionAlpha: string;
  21754. /** @hidden */
  21755. _defineLinearSpecularRefraction: string;
  21756. /** @hidden */
  21757. _defineOppositeZ: string;
  21758. /** @hidden */
  21759. _cubeSamplerName: string;
  21760. /** @hidden */
  21761. _2DSamplerName: string;
  21762. /** @hidden */
  21763. _vRefractionMicrosurfaceInfosName: string;
  21764. /** @hidden */
  21765. _vRefractionInfosName: string;
  21766. private _scene;
  21767. /**
  21768. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21769. * Materials half opaque for instance using refraction could benefit from this control.
  21770. */
  21771. linkRefractionWithTransparency: boolean;
  21772. /**
  21773. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21774. */
  21775. invertRefractionY: boolean;
  21776. /**
  21777. * Gets or sets the texture associated with the node
  21778. */
  21779. texture: Nullable<BaseTexture>;
  21780. /**
  21781. * Create a new RefractionBlock
  21782. * @param name defines the block name
  21783. */
  21784. constructor(name: string);
  21785. /**
  21786. * Gets the current class name
  21787. * @returns the class name
  21788. */
  21789. getClassName(): string;
  21790. /**
  21791. * Gets the intensity input component
  21792. */
  21793. get intensity(): NodeMaterialConnectionPoint;
  21794. /**
  21795. * Gets the index of refraction input component
  21796. */
  21797. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21798. /**
  21799. * Gets the tint at distance input component
  21800. */
  21801. get tintAtDistance(): NodeMaterialConnectionPoint;
  21802. /**
  21803. * Gets the view input component
  21804. */
  21805. get view(): NodeMaterialConnectionPoint;
  21806. /**
  21807. * Gets the refraction object output component
  21808. */
  21809. get refraction(): NodeMaterialConnectionPoint;
  21810. /**
  21811. * Returns true if the block has a texture
  21812. */
  21813. get hasTexture(): boolean;
  21814. protected _getTexture(): Nullable<BaseTexture>;
  21815. autoConfigure(material: NodeMaterial): void;
  21816. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21817. isReady(): boolean;
  21818. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21819. /**
  21820. * Gets the main code of the block (fragment side)
  21821. * @param state current state of the node material building
  21822. * @returns the shader code
  21823. */
  21824. getCode(state: NodeMaterialBuildState): string;
  21825. protected _buildBlock(state: NodeMaterialBuildState): this;
  21826. protected _dumpPropertiesCode(): string;
  21827. serialize(): any;
  21828. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21829. }
  21830. }
  21831. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21832. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21834. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21835. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21836. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21837. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21838. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21839. import { Nullable } from "babylonjs/types";
  21840. import { Scene } from "babylonjs/scene";
  21841. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21842. /**
  21843. * Base block used as input for post process
  21844. */
  21845. export class CurrentScreenBlock extends NodeMaterialBlock {
  21846. private _samplerName;
  21847. private _linearDefineName;
  21848. private _gammaDefineName;
  21849. private _mainUVName;
  21850. private _tempTextureRead;
  21851. /**
  21852. * Gets or sets the texture associated with the node
  21853. */
  21854. texture: Nullable<BaseTexture>;
  21855. /**
  21856. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21857. */
  21858. convertToGammaSpace: boolean;
  21859. /**
  21860. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21861. */
  21862. convertToLinearSpace: boolean;
  21863. /**
  21864. * Create a new CurrentScreenBlock
  21865. * @param name defines the block name
  21866. */
  21867. constructor(name: string);
  21868. /**
  21869. * Gets the current class name
  21870. * @returns the class name
  21871. */
  21872. getClassName(): string;
  21873. /**
  21874. * Gets the uv input component
  21875. */
  21876. get uv(): NodeMaterialConnectionPoint;
  21877. /**
  21878. * Gets the rgba output component
  21879. */
  21880. get rgba(): NodeMaterialConnectionPoint;
  21881. /**
  21882. * Gets the rgb output component
  21883. */
  21884. get rgb(): NodeMaterialConnectionPoint;
  21885. /**
  21886. * Gets the r output component
  21887. */
  21888. get r(): NodeMaterialConnectionPoint;
  21889. /**
  21890. * Gets the g output component
  21891. */
  21892. get g(): NodeMaterialConnectionPoint;
  21893. /**
  21894. * Gets the b output component
  21895. */
  21896. get b(): NodeMaterialConnectionPoint;
  21897. /**
  21898. * Gets the a output component
  21899. */
  21900. get a(): NodeMaterialConnectionPoint;
  21901. /**
  21902. * Initialize the block and prepare the context for build
  21903. * @param state defines the state that will be used for the build
  21904. */
  21905. initialize(state: NodeMaterialBuildState): void;
  21906. get target(): NodeMaterialBlockTargets;
  21907. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21908. isReady(): boolean;
  21909. private _injectVertexCode;
  21910. private _writeTextureRead;
  21911. private _writeOutput;
  21912. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21913. serialize(): any;
  21914. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21915. }
  21916. }
  21917. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21918. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21919. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21920. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21921. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21922. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21923. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21924. import { Nullable } from "babylonjs/types";
  21925. import { Scene } from "babylonjs/scene";
  21926. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21927. /**
  21928. * Base block used for the particle texture
  21929. */
  21930. export class ParticleTextureBlock extends NodeMaterialBlock {
  21931. private _samplerName;
  21932. private _linearDefineName;
  21933. private _gammaDefineName;
  21934. private _tempTextureRead;
  21935. /**
  21936. * Gets or sets the texture associated with the node
  21937. */
  21938. texture: Nullable<BaseTexture>;
  21939. /**
  21940. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21941. */
  21942. convertToGammaSpace: boolean;
  21943. /**
  21944. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21945. */
  21946. convertToLinearSpace: boolean;
  21947. /**
  21948. * Create a new ParticleTextureBlock
  21949. * @param name defines the block name
  21950. */
  21951. constructor(name: string);
  21952. /**
  21953. * Gets the current class name
  21954. * @returns the class name
  21955. */
  21956. getClassName(): string;
  21957. /**
  21958. * Gets the uv input component
  21959. */
  21960. get uv(): NodeMaterialConnectionPoint;
  21961. /**
  21962. * Gets the rgba output component
  21963. */
  21964. get rgba(): NodeMaterialConnectionPoint;
  21965. /**
  21966. * Gets the rgb output component
  21967. */
  21968. get rgb(): NodeMaterialConnectionPoint;
  21969. /**
  21970. * Gets the r output component
  21971. */
  21972. get r(): NodeMaterialConnectionPoint;
  21973. /**
  21974. * Gets the g output component
  21975. */
  21976. get g(): NodeMaterialConnectionPoint;
  21977. /**
  21978. * Gets the b output component
  21979. */
  21980. get b(): NodeMaterialConnectionPoint;
  21981. /**
  21982. * Gets the a output component
  21983. */
  21984. get a(): NodeMaterialConnectionPoint;
  21985. /**
  21986. * Initialize the block and prepare the context for build
  21987. * @param state defines the state that will be used for the build
  21988. */
  21989. initialize(state: NodeMaterialBuildState): void;
  21990. autoConfigure(material: NodeMaterial): void;
  21991. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21992. isReady(): boolean;
  21993. private _writeOutput;
  21994. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21995. serialize(): any;
  21996. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21997. }
  21998. }
  21999. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22001. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22002. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22003. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22004. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22005. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22006. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22007. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22008. import { Scene } from "babylonjs/scene";
  22009. /**
  22010. * Class used to store shared data between 2 NodeMaterialBuildState
  22011. */
  22012. export class NodeMaterialBuildStateSharedData {
  22013. /**
  22014. * Gets the list of emitted varyings
  22015. */
  22016. temps: string[];
  22017. /**
  22018. * Gets the list of emitted varyings
  22019. */
  22020. varyings: string[];
  22021. /**
  22022. * Gets the varying declaration string
  22023. */
  22024. varyingDeclaration: string;
  22025. /**
  22026. * Input blocks
  22027. */
  22028. inputBlocks: InputBlock[];
  22029. /**
  22030. * Input blocks
  22031. */
  22032. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22033. /**
  22034. * Bindable blocks (Blocks that need to set data to the effect)
  22035. */
  22036. bindableBlocks: NodeMaterialBlock[];
  22037. /**
  22038. * List of blocks that can provide a compilation fallback
  22039. */
  22040. blocksWithFallbacks: NodeMaterialBlock[];
  22041. /**
  22042. * List of blocks that can provide a define update
  22043. */
  22044. blocksWithDefines: NodeMaterialBlock[];
  22045. /**
  22046. * List of blocks that can provide a repeatable content
  22047. */
  22048. repeatableContentBlocks: NodeMaterialBlock[];
  22049. /**
  22050. * List of blocks that can provide a dynamic list of uniforms
  22051. */
  22052. dynamicUniformBlocks: NodeMaterialBlock[];
  22053. /**
  22054. * List of blocks that can block the isReady function for the material
  22055. */
  22056. blockingBlocks: NodeMaterialBlock[];
  22057. /**
  22058. * Gets the list of animated inputs
  22059. */
  22060. animatedInputs: InputBlock[];
  22061. /**
  22062. * Build Id used to avoid multiple recompilations
  22063. */
  22064. buildId: number;
  22065. /** List of emitted variables */
  22066. variableNames: {
  22067. [key: string]: number;
  22068. };
  22069. /** List of emitted defines */
  22070. defineNames: {
  22071. [key: string]: number;
  22072. };
  22073. /** Should emit comments? */
  22074. emitComments: boolean;
  22075. /** Emit build activity */
  22076. verbose: boolean;
  22077. /** Gets or sets the hosting scene */
  22078. scene: Scene;
  22079. /**
  22080. * Gets the compilation hints emitted at compilation time
  22081. */
  22082. hints: {
  22083. needWorldViewMatrix: boolean;
  22084. needWorldViewProjectionMatrix: boolean;
  22085. needAlphaBlending: boolean;
  22086. needAlphaTesting: boolean;
  22087. };
  22088. /**
  22089. * List of compilation checks
  22090. */
  22091. checks: {
  22092. emitVertex: boolean;
  22093. emitFragment: boolean;
  22094. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22095. };
  22096. /**
  22097. * Is vertex program allowed to be empty?
  22098. */
  22099. allowEmptyVertexProgram: boolean;
  22100. /** Creates a new shared data */
  22101. constructor();
  22102. /**
  22103. * Emits console errors and exceptions if there is a failing check
  22104. */
  22105. emitErrors(): void;
  22106. }
  22107. }
  22108. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22109. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22110. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22111. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22112. /**
  22113. * Class used to store node based material build state
  22114. */
  22115. export class NodeMaterialBuildState {
  22116. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22117. supportUniformBuffers: boolean;
  22118. /**
  22119. * Gets the list of emitted attributes
  22120. */
  22121. attributes: string[];
  22122. /**
  22123. * Gets the list of emitted uniforms
  22124. */
  22125. uniforms: string[];
  22126. /**
  22127. * Gets the list of emitted constants
  22128. */
  22129. constants: string[];
  22130. /**
  22131. * Gets the list of emitted samplers
  22132. */
  22133. samplers: string[];
  22134. /**
  22135. * Gets the list of emitted functions
  22136. */
  22137. functions: {
  22138. [key: string]: string;
  22139. };
  22140. /**
  22141. * Gets the list of emitted extensions
  22142. */
  22143. extensions: {
  22144. [key: string]: string;
  22145. };
  22146. /**
  22147. * Gets the target of the compilation state
  22148. */
  22149. target: NodeMaterialBlockTargets;
  22150. /**
  22151. * Gets the list of emitted counters
  22152. */
  22153. counters: {
  22154. [key: string]: number;
  22155. };
  22156. /**
  22157. * Shared data between multiple NodeMaterialBuildState instances
  22158. */
  22159. sharedData: NodeMaterialBuildStateSharedData;
  22160. /** @hidden */
  22161. _vertexState: NodeMaterialBuildState;
  22162. /** @hidden */
  22163. _attributeDeclaration: string;
  22164. /** @hidden */
  22165. _uniformDeclaration: string;
  22166. /** @hidden */
  22167. _constantDeclaration: string;
  22168. /** @hidden */
  22169. _samplerDeclaration: string;
  22170. /** @hidden */
  22171. _varyingTransfer: string;
  22172. /** @hidden */
  22173. _injectAtEnd: string;
  22174. private _repeatableContentAnchorIndex;
  22175. /** @hidden */
  22176. _builtCompilationString: string;
  22177. /**
  22178. * Gets the emitted compilation strings
  22179. */
  22180. compilationString: string;
  22181. /**
  22182. * Finalize the compilation strings
  22183. * @param state defines the current compilation state
  22184. */
  22185. finalize(state: NodeMaterialBuildState): void;
  22186. /** @hidden */
  22187. get _repeatableContentAnchor(): string;
  22188. /** @hidden */
  22189. _getFreeVariableName(prefix: string): string;
  22190. /** @hidden */
  22191. _getFreeDefineName(prefix: string): string;
  22192. /** @hidden */
  22193. _excludeVariableName(name: string): void;
  22194. /** @hidden */
  22195. _emit2DSampler(name: string): void;
  22196. /** @hidden */
  22197. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22198. /** @hidden */
  22199. _emitExtension(name: string, extension: string, define?: string): void;
  22200. /** @hidden */
  22201. _emitFunction(name: string, code: string, comments: string): void;
  22202. /** @hidden */
  22203. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22204. replaceStrings?: {
  22205. search: RegExp;
  22206. replace: string;
  22207. }[];
  22208. repeatKey?: string;
  22209. }): string;
  22210. /** @hidden */
  22211. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22212. repeatKey?: string;
  22213. removeAttributes?: boolean;
  22214. removeUniforms?: boolean;
  22215. removeVaryings?: boolean;
  22216. removeIfDef?: boolean;
  22217. replaceStrings?: {
  22218. search: RegExp;
  22219. replace: string;
  22220. }[];
  22221. }, storeKey?: string): void;
  22222. /** @hidden */
  22223. _registerTempVariable(name: string): boolean;
  22224. /** @hidden */
  22225. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22226. /** @hidden */
  22227. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22228. /** @hidden */
  22229. _emitFloat(value: number): string;
  22230. }
  22231. }
  22232. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22233. /**
  22234. * Helper class used to generate session unique ID
  22235. */
  22236. export class UniqueIdGenerator {
  22237. private static _UniqueIdCounter;
  22238. /**
  22239. * Gets an unique (relatively to the current scene) Id
  22240. */
  22241. static get UniqueId(): number;
  22242. }
  22243. }
  22244. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22245. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22247. import { Nullable } from "babylonjs/types";
  22248. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22249. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22250. import { Effect } from "babylonjs/Materials/effect";
  22251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22252. import { Mesh } from "babylonjs/Meshes/mesh";
  22253. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22254. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22255. import { Scene } from "babylonjs/scene";
  22256. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22257. /**
  22258. * Defines a block that can be used inside a node based material
  22259. */
  22260. export class NodeMaterialBlock {
  22261. private _buildId;
  22262. private _buildTarget;
  22263. private _target;
  22264. private _isFinalMerger;
  22265. private _isInput;
  22266. private _name;
  22267. protected _isUnique: boolean;
  22268. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22269. inputsAreExclusive: boolean;
  22270. /** @hidden */
  22271. _codeVariableName: string;
  22272. /** @hidden */
  22273. _inputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _outputs: NodeMaterialConnectionPoint[];
  22276. /** @hidden */
  22277. _preparationId: number;
  22278. /**
  22279. * Gets the name of the block
  22280. */
  22281. get name(): string;
  22282. /**
  22283. * Sets the name of the block. Will check if the name is valid.
  22284. */
  22285. set name(newName: string);
  22286. /**
  22287. * Gets or sets the unique id of the node
  22288. */
  22289. uniqueId: number;
  22290. /**
  22291. * Gets or sets the comments associated with this block
  22292. */
  22293. comments: string;
  22294. /**
  22295. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22296. */
  22297. get isUnique(): boolean;
  22298. /**
  22299. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22300. */
  22301. get isFinalMerger(): boolean;
  22302. /**
  22303. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22304. */
  22305. get isInput(): boolean;
  22306. /**
  22307. * Gets or sets the build Id
  22308. */
  22309. get buildId(): number;
  22310. set buildId(value: number);
  22311. /**
  22312. * Gets or sets the target of the block
  22313. */
  22314. get target(): NodeMaterialBlockTargets;
  22315. set target(value: NodeMaterialBlockTargets);
  22316. /**
  22317. * Gets the list of input points
  22318. */
  22319. get inputs(): NodeMaterialConnectionPoint[];
  22320. /** Gets the list of output points */
  22321. get outputs(): NodeMaterialConnectionPoint[];
  22322. /**
  22323. * Find an input by its name
  22324. * @param name defines the name of the input to look for
  22325. * @returns the input or null if not found
  22326. */
  22327. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22328. /**
  22329. * Find an output by its name
  22330. * @param name defines the name of the outputto look for
  22331. * @returns the output or null if not found
  22332. */
  22333. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22334. /**
  22335. * Creates a new NodeMaterialBlock
  22336. * @param name defines the block name
  22337. * @param target defines the target of that block (Vertex by default)
  22338. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22339. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22340. */
  22341. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22342. /**
  22343. * Initialize the block and prepare the context for build
  22344. * @param state defines the state that will be used for the build
  22345. */
  22346. initialize(state: NodeMaterialBuildState): void;
  22347. /**
  22348. * Bind data to effect. Will only be called for blocks with isBindable === true
  22349. * @param effect defines the effect to bind data to
  22350. * @param nodeMaterial defines the hosting NodeMaterial
  22351. * @param mesh defines the mesh that will be rendered
  22352. * @param subMesh defines the submesh that will be rendered
  22353. */
  22354. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22355. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22356. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22357. protected _writeFloat(value: number): string;
  22358. /**
  22359. * Gets the current class name e.g. "NodeMaterialBlock"
  22360. * @returns the class name
  22361. */
  22362. getClassName(): string;
  22363. /**
  22364. * Register a new input. Must be called inside a block constructor
  22365. * @param name defines the connection point name
  22366. * @param type defines the connection point type
  22367. * @param isOptional defines a boolean indicating that this input can be omitted
  22368. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22369. * @param point an already created connection point. If not provided, create a new one
  22370. * @returns the current block
  22371. */
  22372. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22373. /**
  22374. * Register a new output. Must be called inside a block constructor
  22375. * @param name defines the connection point name
  22376. * @param type defines the connection point type
  22377. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22378. * @param point an already created connection point. If not provided, create a new one
  22379. * @returns the current block
  22380. */
  22381. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22382. /**
  22383. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22384. * @param forOutput defines an optional connection point to check compatibility with
  22385. * @returns the first available input or null
  22386. */
  22387. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22388. /**
  22389. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22390. * @param forBlock defines an optional block to check compatibility with
  22391. * @returns the first available input or null
  22392. */
  22393. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22394. /**
  22395. * Gets the sibling of the given output
  22396. * @param current defines the current output
  22397. * @returns the next output in the list or null
  22398. */
  22399. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22400. /**
  22401. * Connect current block with another block
  22402. * @param other defines the block to connect with
  22403. * @param options define the various options to help pick the right connections
  22404. * @returns the current block
  22405. */
  22406. connectTo(other: NodeMaterialBlock, options?: {
  22407. input?: string;
  22408. output?: string;
  22409. outputSwizzle?: string;
  22410. }): this | undefined;
  22411. protected _buildBlock(state: NodeMaterialBuildState): void;
  22412. /**
  22413. * Add uniforms, samplers and uniform buffers at compilation time
  22414. * @param state defines the state to update
  22415. * @param nodeMaterial defines the node material requesting the update
  22416. * @param defines defines the material defines to update
  22417. * @param uniformBuffers defines the list of uniform buffer names
  22418. */
  22419. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22420. /**
  22421. * Add potential fallbacks if shader compilation fails
  22422. * @param mesh defines the mesh to be rendered
  22423. * @param fallbacks defines the current prioritized list of fallbacks
  22424. */
  22425. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22426. /**
  22427. * Initialize defines for shader compilation
  22428. * @param mesh defines the mesh to be rendered
  22429. * @param nodeMaterial defines the node material requesting the update
  22430. * @param defines defines the material defines to update
  22431. * @param useInstances specifies that instances should be used
  22432. */
  22433. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22434. /**
  22435. * Update defines for shader compilation
  22436. * @param mesh defines the mesh to be rendered
  22437. * @param nodeMaterial defines the node material requesting the update
  22438. * @param defines defines the material defines to update
  22439. * @param useInstances specifies that instances should be used
  22440. * @param subMesh defines which submesh to render
  22441. */
  22442. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22443. /**
  22444. * Lets the block try to connect some inputs automatically
  22445. * @param material defines the hosting NodeMaterial
  22446. */
  22447. autoConfigure(material: NodeMaterial): void;
  22448. /**
  22449. * Function called when a block is declared as repeatable content generator
  22450. * @param vertexShaderState defines the current compilation state for the vertex shader
  22451. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22452. * @param mesh defines the mesh to be rendered
  22453. * @param defines defines the material defines to update
  22454. */
  22455. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22456. /**
  22457. * Checks if the block is ready
  22458. * @param mesh defines the mesh to be rendered
  22459. * @param nodeMaterial defines the node material requesting the update
  22460. * @param defines defines the material defines to update
  22461. * @param useInstances specifies that instances should be used
  22462. * @returns true if the block is ready
  22463. */
  22464. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22465. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22466. private _processBuild;
  22467. /**
  22468. * Validates the new name for the block node.
  22469. * @param newName the new name to be given to the node.
  22470. * @returns false if the name is a reserve word, else true.
  22471. */
  22472. validateBlockName(newName: string): boolean;
  22473. /**
  22474. * Compile the current node and generate the shader code
  22475. * @param state defines the current compilation state (uniforms, samplers, current string)
  22476. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22477. * @returns true if already built
  22478. */
  22479. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22480. protected _inputRename(name: string): string;
  22481. protected _outputRename(name: string): string;
  22482. protected _dumpPropertiesCode(): string;
  22483. /** @hidden */
  22484. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22485. /** @hidden */
  22486. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22487. /**
  22488. * Clone the current block to a new identical block
  22489. * @param scene defines the hosting scene
  22490. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22491. * @returns a copy of the current block
  22492. */
  22493. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22494. /**
  22495. * Serializes this block in a JSON representation
  22496. * @returns the serialized block object
  22497. */
  22498. serialize(): any;
  22499. /** @hidden */
  22500. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22501. private _deserializePortDisplayNamesAndExposedOnFrame;
  22502. /**
  22503. * Release resources
  22504. */
  22505. dispose(): void;
  22506. }
  22507. }
  22508. declare module "babylonjs/Materials/pushMaterial" {
  22509. import { Nullable } from "babylonjs/types";
  22510. import { Scene } from "babylonjs/scene";
  22511. import { Matrix } from "babylonjs/Maths/math.vector";
  22512. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22513. import { Mesh } from "babylonjs/Meshes/mesh";
  22514. import { Material } from "babylonjs/Materials/material";
  22515. import { Effect } from "babylonjs/Materials/effect";
  22516. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22517. /**
  22518. * Base class of materials working in push mode in babylon JS
  22519. * @hidden
  22520. */
  22521. export class PushMaterial extends Material {
  22522. protected _activeEffect: Effect;
  22523. protected _normalMatrix: Matrix;
  22524. constructor(name: string, scene: Scene);
  22525. getEffect(): Effect;
  22526. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22527. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22528. /**
  22529. * Binds the given world matrix to the active effect
  22530. *
  22531. * @param world the matrix to bind
  22532. */
  22533. bindOnlyWorldMatrix(world: Matrix): void;
  22534. /**
  22535. * Binds the given normal matrix to the active effect
  22536. *
  22537. * @param normalMatrix the matrix to bind
  22538. */
  22539. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22540. bind(world: Matrix, mesh?: Mesh): void;
  22541. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22542. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22543. }
  22544. }
  22545. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22546. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22547. /**
  22548. * Root class for all node material optimizers
  22549. */
  22550. export class NodeMaterialOptimizer {
  22551. /**
  22552. * Function used to optimize a NodeMaterial graph
  22553. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22554. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22555. */
  22556. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22557. }
  22558. }
  22559. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22561. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22562. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22563. import { Scene } from "babylonjs/scene";
  22564. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22565. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22566. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22567. /**
  22568. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22569. */
  22570. export class TransformBlock extends NodeMaterialBlock {
  22571. /**
  22572. * Defines the value to use to complement W value to transform it to a Vector4
  22573. */
  22574. complementW: number;
  22575. /**
  22576. * Defines the value to use to complement z value to transform it to a Vector4
  22577. */
  22578. complementZ: number;
  22579. /**
  22580. * Creates a new TransformBlock
  22581. * @param name defines the block name
  22582. */
  22583. constructor(name: string);
  22584. /**
  22585. * Gets the current class name
  22586. * @returns the class name
  22587. */
  22588. getClassName(): string;
  22589. /**
  22590. * Gets the vector input
  22591. */
  22592. get vector(): NodeMaterialConnectionPoint;
  22593. /**
  22594. * Gets the output component
  22595. */
  22596. get output(): NodeMaterialConnectionPoint;
  22597. /**
  22598. * Gets the xyz output component
  22599. */
  22600. get xyz(): NodeMaterialConnectionPoint;
  22601. /**
  22602. * Gets the matrix transform input
  22603. */
  22604. get transform(): NodeMaterialConnectionPoint;
  22605. protected _buildBlock(state: NodeMaterialBuildState): this;
  22606. /**
  22607. * Update defines for shader compilation
  22608. * @param mesh defines the mesh to be rendered
  22609. * @param nodeMaterial defines the node material requesting the update
  22610. * @param defines defines the material defines to update
  22611. * @param useInstances specifies that instances should be used
  22612. * @param subMesh defines which submesh to render
  22613. */
  22614. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22615. serialize(): any;
  22616. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22617. protected _dumpPropertiesCode(): string;
  22618. }
  22619. }
  22620. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22621. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22622. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22623. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22624. /**
  22625. * Block used to output the vertex position
  22626. */
  22627. export class VertexOutputBlock extends NodeMaterialBlock {
  22628. /**
  22629. * Creates a new VertexOutputBlock
  22630. * @param name defines the block name
  22631. */
  22632. constructor(name: string);
  22633. /**
  22634. * Gets the current class name
  22635. * @returns the class name
  22636. */
  22637. getClassName(): string;
  22638. /**
  22639. * Gets the vector input component
  22640. */
  22641. get vector(): NodeMaterialConnectionPoint;
  22642. protected _buildBlock(state: NodeMaterialBuildState): this;
  22643. }
  22644. }
  22645. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22646. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22647. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22648. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22649. /**
  22650. * Block used to output the final color
  22651. */
  22652. export class FragmentOutputBlock extends NodeMaterialBlock {
  22653. /**
  22654. * Create a new FragmentOutputBlock
  22655. * @param name defines the block name
  22656. */
  22657. constructor(name: string);
  22658. /**
  22659. * Gets the current class name
  22660. * @returns the class name
  22661. */
  22662. getClassName(): string;
  22663. /**
  22664. * Gets the rgba input component
  22665. */
  22666. get rgba(): NodeMaterialConnectionPoint;
  22667. /**
  22668. * Gets the rgb input component
  22669. */
  22670. get rgb(): NodeMaterialConnectionPoint;
  22671. /**
  22672. * Gets the a input component
  22673. */
  22674. get a(): NodeMaterialConnectionPoint;
  22675. protected _buildBlock(state: NodeMaterialBuildState): this;
  22676. }
  22677. }
  22678. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22679. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22680. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22681. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22682. /**
  22683. * Block used for the particle ramp gradient section
  22684. */
  22685. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22686. /**
  22687. * Create a new ParticleRampGradientBlock
  22688. * @param name defines the block name
  22689. */
  22690. constructor(name: string);
  22691. /**
  22692. * Gets the current class name
  22693. * @returns the class name
  22694. */
  22695. getClassName(): string;
  22696. /**
  22697. * Gets the color input component
  22698. */
  22699. get color(): NodeMaterialConnectionPoint;
  22700. /**
  22701. * Gets the rampColor output component
  22702. */
  22703. get rampColor(): NodeMaterialConnectionPoint;
  22704. /**
  22705. * Initialize the block and prepare the context for build
  22706. * @param state defines the state that will be used for the build
  22707. */
  22708. initialize(state: NodeMaterialBuildState): void;
  22709. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22710. }
  22711. }
  22712. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22713. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22714. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22715. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22716. /**
  22717. * Block used for the particle blend multiply section
  22718. */
  22719. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22720. /**
  22721. * Create a new ParticleBlendMultiplyBlock
  22722. * @param name defines the block name
  22723. */
  22724. constructor(name: string);
  22725. /**
  22726. * Gets the current class name
  22727. * @returns the class name
  22728. */
  22729. getClassName(): string;
  22730. /**
  22731. * Gets the color input component
  22732. */
  22733. get color(): NodeMaterialConnectionPoint;
  22734. /**
  22735. * Gets the alphaTexture input component
  22736. */
  22737. get alphaTexture(): NodeMaterialConnectionPoint;
  22738. /**
  22739. * Gets the alphaColor input component
  22740. */
  22741. get alphaColor(): NodeMaterialConnectionPoint;
  22742. /**
  22743. * Gets the blendColor output component
  22744. */
  22745. get blendColor(): NodeMaterialConnectionPoint;
  22746. /**
  22747. * Initialize the block and prepare the context for build
  22748. * @param state defines the state that will be used for the build
  22749. */
  22750. initialize(state: NodeMaterialBuildState): void;
  22751. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22752. }
  22753. }
  22754. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22755. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22756. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22757. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22758. /**
  22759. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22760. */
  22761. export class VectorMergerBlock extends NodeMaterialBlock {
  22762. /**
  22763. * Create a new VectorMergerBlock
  22764. * @param name defines the block name
  22765. */
  22766. constructor(name: string);
  22767. /**
  22768. * Gets the current class name
  22769. * @returns the class name
  22770. */
  22771. getClassName(): string;
  22772. /**
  22773. * Gets the xyz component (input)
  22774. */
  22775. get xyzIn(): NodeMaterialConnectionPoint;
  22776. /**
  22777. * Gets the xy component (input)
  22778. */
  22779. get xyIn(): NodeMaterialConnectionPoint;
  22780. /**
  22781. * Gets the x component (input)
  22782. */
  22783. get x(): NodeMaterialConnectionPoint;
  22784. /**
  22785. * Gets the y component (input)
  22786. */
  22787. get y(): NodeMaterialConnectionPoint;
  22788. /**
  22789. * Gets the z component (input)
  22790. */
  22791. get z(): NodeMaterialConnectionPoint;
  22792. /**
  22793. * Gets the w component (input)
  22794. */
  22795. get w(): NodeMaterialConnectionPoint;
  22796. /**
  22797. * Gets the xyzw component (output)
  22798. */
  22799. get xyzw(): NodeMaterialConnectionPoint;
  22800. /**
  22801. * Gets the xyz component (output)
  22802. */
  22803. get xyzOut(): NodeMaterialConnectionPoint;
  22804. /**
  22805. * Gets the xy component (output)
  22806. */
  22807. get xyOut(): NodeMaterialConnectionPoint;
  22808. /**
  22809. * Gets the xy component (output)
  22810. * @deprecated Please use xyOut instead.
  22811. */
  22812. get xy(): NodeMaterialConnectionPoint;
  22813. /**
  22814. * Gets the xyz component (output)
  22815. * @deprecated Please use xyzOut instead.
  22816. */
  22817. get xyz(): NodeMaterialConnectionPoint;
  22818. protected _buildBlock(state: NodeMaterialBuildState): this;
  22819. }
  22820. }
  22821. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22822. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22823. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22824. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22825. import { Vector2 } from "babylonjs/Maths/math.vector";
  22826. import { Scene } from "babylonjs/scene";
  22827. /**
  22828. * Block used to remap a float from a range to a new one
  22829. */
  22830. export class RemapBlock extends NodeMaterialBlock {
  22831. /**
  22832. * Gets or sets the source range
  22833. */
  22834. sourceRange: Vector2;
  22835. /**
  22836. * Gets or sets the target range
  22837. */
  22838. targetRange: Vector2;
  22839. /**
  22840. * Creates a new RemapBlock
  22841. * @param name defines the block name
  22842. */
  22843. constructor(name: string);
  22844. /**
  22845. * Gets the current class name
  22846. * @returns the class name
  22847. */
  22848. getClassName(): string;
  22849. /**
  22850. * Gets the input component
  22851. */
  22852. get input(): NodeMaterialConnectionPoint;
  22853. /**
  22854. * Gets the source min input component
  22855. */
  22856. get sourceMin(): NodeMaterialConnectionPoint;
  22857. /**
  22858. * Gets the source max input component
  22859. */
  22860. get sourceMax(): NodeMaterialConnectionPoint;
  22861. /**
  22862. * Gets the target min input component
  22863. */
  22864. get targetMin(): NodeMaterialConnectionPoint;
  22865. /**
  22866. * Gets the target max input component
  22867. */
  22868. get targetMax(): NodeMaterialConnectionPoint;
  22869. /**
  22870. * Gets the output component
  22871. */
  22872. get output(): NodeMaterialConnectionPoint;
  22873. protected _buildBlock(state: NodeMaterialBuildState): this;
  22874. protected _dumpPropertiesCode(): string;
  22875. serialize(): any;
  22876. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22877. }
  22878. }
  22879. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22880. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22881. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22882. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22883. /**
  22884. * Block used to multiply 2 values
  22885. */
  22886. export class MultiplyBlock extends NodeMaterialBlock {
  22887. /**
  22888. * Creates a new MultiplyBlock
  22889. * @param name defines the block name
  22890. */
  22891. constructor(name: string);
  22892. /**
  22893. * Gets the current class name
  22894. * @returns the class name
  22895. */
  22896. getClassName(): string;
  22897. /**
  22898. * Gets the left operand input component
  22899. */
  22900. get left(): NodeMaterialConnectionPoint;
  22901. /**
  22902. * Gets the right operand input component
  22903. */
  22904. get right(): NodeMaterialConnectionPoint;
  22905. /**
  22906. * Gets the output component
  22907. */
  22908. get output(): NodeMaterialConnectionPoint;
  22909. protected _buildBlock(state: NodeMaterialBuildState): this;
  22910. }
  22911. }
  22912. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22913. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22914. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22916. /**
  22917. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22918. */
  22919. export class ColorSplitterBlock extends NodeMaterialBlock {
  22920. /**
  22921. * Create a new ColorSplitterBlock
  22922. * @param name defines the block name
  22923. */
  22924. constructor(name: string);
  22925. /**
  22926. * Gets the current class name
  22927. * @returns the class name
  22928. */
  22929. getClassName(): string;
  22930. /**
  22931. * Gets the rgba component (input)
  22932. */
  22933. get rgba(): NodeMaterialConnectionPoint;
  22934. /**
  22935. * Gets the rgb component (input)
  22936. */
  22937. get rgbIn(): NodeMaterialConnectionPoint;
  22938. /**
  22939. * Gets the rgb component (output)
  22940. */
  22941. get rgbOut(): NodeMaterialConnectionPoint;
  22942. /**
  22943. * Gets the r component (output)
  22944. */
  22945. get r(): NodeMaterialConnectionPoint;
  22946. /**
  22947. * Gets the g component (output)
  22948. */
  22949. get g(): NodeMaterialConnectionPoint;
  22950. /**
  22951. * Gets the b component (output)
  22952. */
  22953. get b(): NodeMaterialConnectionPoint;
  22954. /**
  22955. * Gets the a component (output)
  22956. */
  22957. get a(): NodeMaterialConnectionPoint;
  22958. protected _inputRename(name: string): string;
  22959. protected _outputRename(name: string): string;
  22960. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22961. }
  22962. }
  22963. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22964. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22965. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22966. import { Scene } from "babylonjs/scene";
  22967. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22968. import { Matrix } from "babylonjs/Maths/math.vector";
  22969. import { Mesh } from "babylonjs/Meshes/mesh";
  22970. import { Engine } from "babylonjs/Engines/engine";
  22971. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22972. import { Observable } from "babylonjs/Misc/observable";
  22973. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22974. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22975. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22976. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22977. import { Nullable } from "babylonjs/types";
  22978. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22979. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22980. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22981. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22982. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22983. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22984. import { Effect } from "babylonjs/Materials/effect";
  22985. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22986. import { Camera } from "babylonjs/Cameras/camera";
  22987. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22988. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22989. /**
  22990. * Interface used to configure the node material editor
  22991. */
  22992. export interface INodeMaterialEditorOptions {
  22993. /** Define the URl to load node editor script */
  22994. editorURL?: string;
  22995. }
  22996. /** @hidden */
  22997. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22998. NORMAL: boolean;
  22999. TANGENT: boolean;
  23000. UV1: boolean;
  23001. /** BONES */
  23002. NUM_BONE_INFLUENCERS: number;
  23003. BonesPerMesh: number;
  23004. BONETEXTURE: boolean;
  23005. /** MORPH TARGETS */
  23006. MORPHTARGETS: boolean;
  23007. MORPHTARGETS_NORMAL: boolean;
  23008. MORPHTARGETS_TANGENT: boolean;
  23009. MORPHTARGETS_UV: boolean;
  23010. NUM_MORPH_INFLUENCERS: number;
  23011. /** IMAGE PROCESSING */
  23012. IMAGEPROCESSING: boolean;
  23013. VIGNETTE: boolean;
  23014. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23015. VIGNETTEBLENDMODEOPAQUE: boolean;
  23016. TONEMAPPING: boolean;
  23017. TONEMAPPING_ACES: boolean;
  23018. CONTRAST: boolean;
  23019. EXPOSURE: boolean;
  23020. COLORCURVES: boolean;
  23021. COLORGRADING: boolean;
  23022. COLORGRADING3D: boolean;
  23023. SAMPLER3DGREENDEPTH: boolean;
  23024. SAMPLER3DBGRMAP: boolean;
  23025. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23026. /** MISC. */
  23027. BUMPDIRECTUV: number;
  23028. constructor();
  23029. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23030. }
  23031. /**
  23032. * Class used to configure NodeMaterial
  23033. */
  23034. export interface INodeMaterialOptions {
  23035. /**
  23036. * Defines if blocks should emit comments
  23037. */
  23038. emitComments: boolean;
  23039. }
  23040. /**
  23041. * Class used to create a node based material built by assembling shader blocks
  23042. */
  23043. export class NodeMaterial extends PushMaterial {
  23044. private static _BuildIdGenerator;
  23045. private _options;
  23046. private _vertexCompilationState;
  23047. private _fragmentCompilationState;
  23048. private _sharedData;
  23049. private _buildId;
  23050. private _buildWasSuccessful;
  23051. private _cachedWorldViewMatrix;
  23052. private _cachedWorldViewProjectionMatrix;
  23053. private _optimizers;
  23054. private _animationFrame;
  23055. /** Define the Url to load node editor script */
  23056. static EditorURL: string;
  23057. /** Define the Url to load snippets */
  23058. static SnippetUrl: string;
  23059. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23060. static IgnoreTexturesAtLoadTime: boolean;
  23061. private BJSNODEMATERIALEDITOR;
  23062. /** Get the inspector from bundle or global */
  23063. private _getGlobalNodeMaterialEditor;
  23064. /**
  23065. * Snippet ID if the material was created from the snippet server
  23066. */
  23067. snippetId: string;
  23068. /**
  23069. * Gets or sets data used by visual editor
  23070. * @see https://nme.babylonjs.com
  23071. */
  23072. editorData: any;
  23073. /**
  23074. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  23075. */
  23076. ignoreAlpha: boolean;
  23077. /**
  23078. * Defines the maximum number of lights that can be used in the material
  23079. */
  23080. maxSimultaneousLights: number;
  23081. /**
  23082. * Observable raised when the material is built
  23083. */
  23084. onBuildObservable: Observable<NodeMaterial>;
  23085. /**
  23086. * Gets or sets the root nodes of the material vertex shader
  23087. */
  23088. _vertexOutputNodes: NodeMaterialBlock[];
  23089. /**
  23090. * Gets or sets the root nodes of the material fragment (pixel) shader
  23091. */
  23092. _fragmentOutputNodes: NodeMaterialBlock[];
  23093. /** Gets or sets options to control the node material overall behavior */
  23094. get options(): INodeMaterialOptions;
  23095. set options(options: INodeMaterialOptions);
  23096. /**
  23097. * Default configuration related to image processing available in the standard Material.
  23098. */
  23099. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23100. /**
  23101. * Gets the image processing configuration used either in this material.
  23102. */
  23103. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23104. /**
  23105. * Sets the Default image processing configuration used either in the this material.
  23106. *
  23107. * If sets to null, the scene one is in use.
  23108. */
  23109. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23110. /**
  23111. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23112. */
  23113. attachedBlocks: NodeMaterialBlock[];
  23114. /**
  23115. * Specifies the mode of the node material
  23116. * @hidden
  23117. */
  23118. _mode: NodeMaterialModes;
  23119. /**
  23120. * Gets the mode property
  23121. */
  23122. get mode(): NodeMaterialModes;
  23123. /**
  23124. * Create a new node based material
  23125. * @param name defines the material name
  23126. * @param scene defines the hosting scene
  23127. * @param options defines creation option
  23128. */
  23129. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23130. /**
  23131. * Gets the current class name of the material e.g. "NodeMaterial"
  23132. * @returns the class name
  23133. */
  23134. getClassName(): string;
  23135. /**
  23136. * Keep track of the image processing observer to allow dispose and replace.
  23137. */
  23138. private _imageProcessingObserver;
  23139. /**
  23140. * Attaches a new image processing configuration to the Standard Material.
  23141. * @param configuration
  23142. */
  23143. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23144. /**
  23145. * Get a block by its name
  23146. * @param name defines the name of the block to retrieve
  23147. * @returns the required block or null if not found
  23148. */
  23149. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23150. /**
  23151. * Get a block by its name
  23152. * @param predicate defines the predicate used to find the good candidate
  23153. * @returns the required block or null if not found
  23154. */
  23155. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23156. /**
  23157. * Get an input block by its name
  23158. * @param predicate defines the predicate used to find the good candidate
  23159. * @returns the required input block or null if not found
  23160. */
  23161. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23162. /**
  23163. * Gets the list of input blocks attached to this material
  23164. * @returns an array of InputBlocks
  23165. */
  23166. getInputBlocks(): InputBlock[];
  23167. /**
  23168. * Adds a new optimizer to the list of optimizers
  23169. * @param optimizer defines the optimizers to add
  23170. * @returns the current material
  23171. */
  23172. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23173. /**
  23174. * Remove an optimizer from the list of optimizers
  23175. * @param optimizer defines the optimizers to remove
  23176. * @returns the current material
  23177. */
  23178. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23179. /**
  23180. * Add a new block to the list of output nodes
  23181. * @param node defines the node to add
  23182. * @returns the current material
  23183. */
  23184. addOutputNode(node: NodeMaterialBlock): this;
  23185. /**
  23186. * Remove a block from the list of root nodes
  23187. * @param node defines the node to remove
  23188. * @returns the current material
  23189. */
  23190. removeOutputNode(node: NodeMaterialBlock): this;
  23191. private _addVertexOutputNode;
  23192. private _removeVertexOutputNode;
  23193. private _addFragmentOutputNode;
  23194. private _removeFragmentOutputNode;
  23195. /**
  23196. * Specifies if the material will require alpha blending
  23197. * @returns a boolean specifying if alpha blending is needed
  23198. */
  23199. needAlphaBlending(): boolean;
  23200. /**
  23201. * Specifies if this material should be rendered in alpha test mode
  23202. * @returns a boolean specifying if an alpha test is needed.
  23203. */
  23204. needAlphaTesting(): boolean;
  23205. private _initializeBlock;
  23206. private _resetDualBlocks;
  23207. /**
  23208. * Remove a block from the current node material
  23209. * @param block defines the block to remove
  23210. */
  23211. removeBlock(block: NodeMaterialBlock): void;
  23212. /**
  23213. * Build the material and generates the inner effect
  23214. * @param verbose defines if the build should log activity
  23215. */
  23216. build(verbose?: boolean): void;
  23217. /**
  23218. * Runs an otpimization phase to try to improve the shader code
  23219. */
  23220. optimize(): void;
  23221. private _prepareDefinesForAttributes;
  23222. /**
  23223. * Create a post process from the material
  23224. * @param camera The camera to apply the render pass to.
  23225. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23226. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23227. * @param engine The engine which the post process will be applied. (default: current engine)
  23228. * @param reusable If the post process can be reused on the same frame. (default: false)
  23229. * @param textureType Type of textures used when performing the post process. (default: 0)
  23230. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23231. * @returns the post process created
  23232. */
  23233. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23234. /**
  23235. * Create the post process effect from the material
  23236. * @param postProcess The post process to create the effect for
  23237. */
  23238. createEffectForPostProcess(postProcess: PostProcess): void;
  23239. private _createEffectOrPostProcess;
  23240. private _createEffectForParticles;
  23241. /**
  23242. * Create the effect to be used as the custom effect for a particle system
  23243. * @param particleSystem Particle system to create the effect for
  23244. * @param onCompiled defines a function to call when the effect creation is successful
  23245. * @param onError defines a function to call when the effect creation has failed
  23246. */
  23247. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23248. private _processDefines;
  23249. /**
  23250. * Get if the submesh is ready to be used and all its information available.
  23251. * Child classes can use it to update shaders
  23252. * @param mesh defines the mesh to check
  23253. * @param subMesh defines which submesh to check
  23254. * @param useInstances specifies that instances should be used
  23255. * @returns a boolean indicating that the submesh is ready or not
  23256. */
  23257. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23258. /**
  23259. * Get a string representing the shaders built by the current node graph
  23260. */
  23261. get compiledShaders(): string;
  23262. /**
  23263. * Binds the world matrix to the material
  23264. * @param world defines the world transformation matrix
  23265. */
  23266. bindOnlyWorldMatrix(world: Matrix): void;
  23267. /**
  23268. * Binds the submesh to this material by preparing the effect and shader to draw
  23269. * @param world defines the world transformation matrix
  23270. * @param mesh defines the mesh containing the submesh
  23271. * @param subMesh defines the submesh to bind the material to
  23272. */
  23273. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23274. /**
  23275. * Gets the active textures from the material
  23276. * @returns an array of textures
  23277. */
  23278. getActiveTextures(): BaseTexture[];
  23279. /**
  23280. * Gets the list of texture blocks
  23281. * @returns an array of texture blocks
  23282. */
  23283. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23284. /**
  23285. * Specifies if the material uses a texture
  23286. * @param texture defines the texture to check against the material
  23287. * @returns a boolean specifying if the material uses the texture
  23288. */
  23289. hasTexture(texture: BaseTexture): boolean;
  23290. /**
  23291. * Disposes the material
  23292. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23293. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23294. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23295. */
  23296. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23297. /** Creates the node editor window. */
  23298. private _createNodeEditor;
  23299. /**
  23300. * Launch the node material editor
  23301. * @param config Define the configuration of the editor
  23302. * @return a promise fulfilled when the node editor is visible
  23303. */
  23304. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23305. /**
  23306. * Clear the current material
  23307. */
  23308. clear(): void;
  23309. /**
  23310. * Clear the current material and set it to a default state
  23311. */
  23312. setToDefault(): void;
  23313. /**
  23314. * Clear the current material and set it to a default state for post process
  23315. */
  23316. setToDefaultPostProcess(): void;
  23317. /**
  23318. * Clear the current material and set it to a default state for particle
  23319. */
  23320. setToDefaultParticle(): void;
  23321. /**
  23322. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23323. * @param url defines the url to load from
  23324. * @returns a promise that will fullfil when the material is fully loaded
  23325. */
  23326. loadAsync(url: string): Promise<void>;
  23327. private _gatherBlocks;
  23328. /**
  23329. * Generate a string containing the code declaration required to create an equivalent of this material
  23330. * @returns a string
  23331. */
  23332. generateCode(): string;
  23333. /**
  23334. * Serializes this material in a JSON representation
  23335. * @returns the serialized material object
  23336. */
  23337. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23338. private _restoreConnections;
  23339. /**
  23340. * Clear the current graph and load a new one from a serialization object
  23341. * @param source defines the JSON representation of the material
  23342. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23343. * @param merge defines whether or not the source must be merged or replace the current content
  23344. */
  23345. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23346. /**
  23347. * Makes a duplicate of the current material.
  23348. * @param name - name to use for the new material.
  23349. */
  23350. clone(name: string): NodeMaterial;
  23351. /**
  23352. * Creates a node material from parsed material data
  23353. * @param source defines the JSON representation of the material
  23354. * @param scene defines the hosting scene
  23355. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23356. * @returns a new node material
  23357. */
  23358. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23359. /**
  23360. * Creates a node material from a snippet saved in a remote file
  23361. * @param name defines the name of the material to create
  23362. * @param url defines the url to load from
  23363. * @param scene defines the hosting scene
  23364. * @returns a promise that will resolve to the new node material
  23365. */
  23366. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23367. /**
  23368. * Creates a node material from a snippet saved by the node material editor
  23369. * @param snippetId defines the snippet to load
  23370. * @param scene defines the hosting scene
  23371. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23372. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23373. * @returns a promise that will resolve to the new node material
  23374. */
  23375. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23376. /**
  23377. * Creates a new node material set to default basic configuration
  23378. * @param name defines the name of the material
  23379. * @param scene defines the hosting scene
  23380. * @returns a new NodeMaterial
  23381. */
  23382. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23383. }
  23384. }
  23385. declare module "babylonjs/PostProcesses/postProcess" {
  23386. import { Nullable } from "babylonjs/types";
  23387. import { SmartArray } from "babylonjs/Misc/smartArray";
  23388. import { Observable } from "babylonjs/Misc/observable";
  23389. import { Vector2 } from "babylonjs/Maths/math.vector";
  23390. import { Camera } from "babylonjs/Cameras/camera";
  23391. import { Effect } from "babylonjs/Materials/effect";
  23392. import "babylonjs/Shaders/postprocess.vertex";
  23393. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23394. import { Engine } from "babylonjs/Engines/engine";
  23395. import { Color4 } from "babylonjs/Maths/math.color";
  23396. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23397. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23398. import { Scene } from "babylonjs/scene";
  23399. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23400. /**
  23401. * Size options for a post process
  23402. */
  23403. export type PostProcessOptions = {
  23404. width: number;
  23405. height: number;
  23406. };
  23407. /**
  23408. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23409. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23410. */
  23411. export class PostProcess {
  23412. /**
  23413. * Gets or sets the unique id of the post process
  23414. */
  23415. uniqueId: number;
  23416. /** Name of the PostProcess. */
  23417. name: string;
  23418. /**
  23419. * Width of the texture to apply the post process on
  23420. */
  23421. width: number;
  23422. /**
  23423. * Height of the texture to apply the post process on
  23424. */
  23425. height: number;
  23426. /**
  23427. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23428. */
  23429. nodeMaterialSource: Nullable<NodeMaterial>;
  23430. /**
  23431. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23432. * @hidden
  23433. */
  23434. _outputTexture: Nullable<InternalTexture>;
  23435. /**
  23436. * Sampling mode used by the shader
  23437. * See https://doc.babylonjs.com/classes/3.1/texture
  23438. */
  23439. renderTargetSamplingMode: number;
  23440. /**
  23441. * Clear color to use when screen clearing
  23442. */
  23443. clearColor: Color4;
  23444. /**
  23445. * If the buffer needs to be cleared before applying the post process. (default: true)
  23446. * Should be set to false if shader will overwrite all previous pixels.
  23447. */
  23448. autoClear: boolean;
  23449. /**
  23450. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23451. */
  23452. alphaMode: number;
  23453. /**
  23454. * Sets the setAlphaBlendConstants of the babylon engine
  23455. */
  23456. alphaConstants: Color4;
  23457. /**
  23458. * Animations to be used for the post processing
  23459. */
  23460. animations: import("babylonjs/Animations/animation").Animation[];
  23461. /**
  23462. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23463. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23464. */
  23465. enablePixelPerfectMode: boolean;
  23466. /**
  23467. * Force the postprocess to be applied without taking in account viewport
  23468. */
  23469. forceFullscreenViewport: boolean;
  23470. /**
  23471. * List of inspectable custom properties (used by the Inspector)
  23472. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23473. */
  23474. inspectableCustomProperties: IInspectable[];
  23475. /**
  23476. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23477. *
  23478. * | Value | Type | Description |
  23479. * | ----- | ----------------------------------- | ----------- |
  23480. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23481. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23482. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23483. *
  23484. */
  23485. scaleMode: number;
  23486. /**
  23487. * Force textures to be a power of two (default: false)
  23488. */
  23489. alwaysForcePOT: boolean;
  23490. private _samples;
  23491. /**
  23492. * Number of sample textures (default: 1)
  23493. */
  23494. get samples(): number;
  23495. set samples(n: number);
  23496. /**
  23497. * Modify the scale of the post process to be the same as the viewport (default: false)
  23498. */
  23499. adaptScaleToCurrentViewport: boolean;
  23500. private _camera;
  23501. protected _scene: Scene;
  23502. private _engine;
  23503. private _options;
  23504. private _reusable;
  23505. private _textureType;
  23506. private _textureFormat;
  23507. /**
  23508. * Smart array of input and output textures for the post process.
  23509. * @hidden
  23510. */
  23511. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23512. /**
  23513. * The index in _textures that corresponds to the output texture.
  23514. * @hidden
  23515. */
  23516. _currentRenderTextureInd: number;
  23517. private _effect;
  23518. private _samplers;
  23519. private _fragmentUrl;
  23520. private _vertexUrl;
  23521. private _parameters;
  23522. private _scaleRatio;
  23523. protected _indexParameters: any;
  23524. private _shareOutputWithPostProcess;
  23525. private _texelSize;
  23526. private _forcedOutputTexture;
  23527. /**
  23528. * Returns the fragment url or shader name used in the post process.
  23529. * @returns the fragment url or name in the shader store.
  23530. */
  23531. getEffectName(): string;
  23532. /**
  23533. * An event triggered when the postprocess is activated.
  23534. */
  23535. onActivateObservable: Observable<Camera>;
  23536. private _onActivateObserver;
  23537. /**
  23538. * A function that is added to the onActivateObservable
  23539. */
  23540. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23541. /**
  23542. * An event triggered when the postprocess changes its size.
  23543. */
  23544. onSizeChangedObservable: Observable<PostProcess>;
  23545. private _onSizeChangedObserver;
  23546. /**
  23547. * A function that is added to the onSizeChangedObservable
  23548. */
  23549. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23550. /**
  23551. * An event triggered when the postprocess applies its effect.
  23552. */
  23553. onApplyObservable: Observable<Effect>;
  23554. private _onApplyObserver;
  23555. /**
  23556. * A function that is added to the onApplyObservable
  23557. */
  23558. set onApply(callback: (effect: Effect) => void);
  23559. /**
  23560. * An event triggered before rendering the postprocess
  23561. */
  23562. onBeforeRenderObservable: Observable<Effect>;
  23563. private _onBeforeRenderObserver;
  23564. /**
  23565. * A function that is added to the onBeforeRenderObservable
  23566. */
  23567. set onBeforeRender(callback: (effect: Effect) => void);
  23568. /**
  23569. * An event triggered after rendering the postprocess
  23570. */
  23571. onAfterRenderObservable: Observable<Effect>;
  23572. private _onAfterRenderObserver;
  23573. /**
  23574. * A function that is added to the onAfterRenderObservable
  23575. */
  23576. set onAfterRender(callback: (efect: Effect) => void);
  23577. /**
  23578. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  23579. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23580. */
  23581. get inputTexture(): InternalTexture;
  23582. set inputTexture(value: InternalTexture);
  23583. /**
  23584. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23585. * the only way to unset it is to use this function to restore its internal state
  23586. */
  23587. restoreDefaultInputTexture(): void;
  23588. /**
  23589. * Gets the camera which post process is applied to.
  23590. * @returns The camera the post process is applied to.
  23591. */
  23592. getCamera(): Camera;
  23593. /**
  23594. * Gets the texel size of the postprocess.
  23595. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23596. */
  23597. get texelSize(): Vector2;
  23598. /**
  23599. * Creates a new instance PostProcess
  23600. * @param name The name of the PostProcess.
  23601. * @param fragmentUrl The url of the fragment shader to be used.
  23602. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23603. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23604. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23605. * @param camera The camera to apply the render pass to.
  23606. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23607. * @param engine The engine which the post process will be applied. (default: current engine)
  23608. * @param reusable If the post process can be reused on the same frame. (default: false)
  23609. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23610. * @param textureType Type of textures used when performing the post process. (default: 0)
  23611. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23612. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23613. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23614. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23615. */
  23616. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23617. /**
  23618. * Gets a string identifying the name of the class
  23619. * @returns "PostProcess" string
  23620. */
  23621. getClassName(): string;
  23622. /**
  23623. * Gets the engine which this post process belongs to.
  23624. * @returns The engine the post process was enabled with.
  23625. */
  23626. getEngine(): Engine;
  23627. /**
  23628. * The effect that is created when initializing the post process.
  23629. * @returns The created effect corresponding the the postprocess.
  23630. */
  23631. getEffect(): Effect;
  23632. /**
  23633. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23634. * @param postProcess The post process to share the output with.
  23635. * @returns This post process.
  23636. */
  23637. shareOutputWith(postProcess: PostProcess): PostProcess;
  23638. /**
  23639. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23640. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23641. */
  23642. useOwnOutput(): void;
  23643. /**
  23644. * Updates the effect with the current post process compile time values and recompiles the shader.
  23645. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23646. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23647. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23648. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23649. * @param onCompiled Called when the shader has been compiled.
  23650. * @param onError Called if there is an error when compiling a shader.
  23651. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23652. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23653. */
  23654. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23655. /**
  23656. * The post process is reusable if it can be used multiple times within one frame.
  23657. * @returns If the post process is reusable
  23658. */
  23659. isReusable(): boolean;
  23660. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23661. markTextureDirty(): void;
  23662. /**
  23663. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23664. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  23665. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23666. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23667. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23668. * @returns The target texture that was bound to be written to.
  23669. */
  23670. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23671. /**
  23672. * If the post process is supported.
  23673. */
  23674. get isSupported(): boolean;
  23675. /**
  23676. * The aspect ratio of the output texture.
  23677. */
  23678. get aspectRatio(): number;
  23679. /**
  23680. * Get a value indicating if the post-process is ready to be used
  23681. * @returns true if the post-process is ready (shader is compiled)
  23682. */
  23683. isReady(): boolean;
  23684. /**
  23685. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23686. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23687. */
  23688. apply(): Nullable<Effect>;
  23689. private _disposeTextures;
  23690. /**
  23691. * Disposes the post process.
  23692. * @param camera The camera to dispose the post process on.
  23693. */
  23694. dispose(camera?: Camera): void;
  23695. /**
  23696. * Serializes the particle system to a JSON object
  23697. * @returns the JSON object
  23698. */
  23699. serialize(): any;
  23700. /**
  23701. * Creates a material from parsed material data
  23702. * @param parsedPostProcess defines parsed post process data
  23703. * @param scene defines the hosting scene
  23704. * @param rootUrl defines the root URL to use to load textures
  23705. * @returns a new post process
  23706. */
  23707. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23708. }
  23709. }
  23710. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23711. /** @hidden */
  23712. export var kernelBlurVaryingDeclaration: {
  23713. name: string;
  23714. shader: string;
  23715. };
  23716. }
  23717. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23718. /** @hidden */
  23719. export var kernelBlurFragment: {
  23720. name: string;
  23721. shader: string;
  23722. };
  23723. }
  23724. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23725. /** @hidden */
  23726. export var kernelBlurFragment2: {
  23727. name: string;
  23728. shader: string;
  23729. };
  23730. }
  23731. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23733. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23734. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23735. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23736. /** @hidden */
  23737. export var kernelBlurPixelShader: {
  23738. name: string;
  23739. shader: string;
  23740. };
  23741. }
  23742. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23743. /** @hidden */
  23744. export var kernelBlurVertex: {
  23745. name: string;
  23746. shader: string;
  23747. };
  23748. }
  23749. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23750. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23751. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23752. /** @hidden */
  23753. export var kernelBlurVertexShader: {
  23754. name: string;
  23755. shader: string;
  23756. };
  23757. }
  23758. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23759. import { Vector2 } from "babylonjs/Maths/math.vector";
  23760. import { Nullable } from "babylonjs/types";
  23761. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23762. import { Camera } from "babylonjs/Cameras/camera";
  23763. import { Effect } from "babylonjs/Materials/effect";
  23764. import { Engine } from "babylonjs/Engines/engine";
  23765. import "babylonjs/Shaders/kernelBlur.fragment";
  23766. import "babylonjs/Shaders/kernelBlur.vertex";
  23767. import { Scene } from "babylonjs/scene";
  23768. /**
  23769. * The Blur Post Process which blurs an image based on a kernel and direction.
  23770. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23771. */
  23772. export class BlurPostProcess extends PostProcess {
  23773. private blockCompilation;
  23774. protected _kernel: number;
  23775. protected _idealKernel: number;
  23776. protected _packedFloat: boolean;
  23777. private _staticDefines;
  23778. /** The direction in which to blur the image. */
  23779. direction: Vector2;
  23780. /**
  23781. * Sets the length in pixels of the blur sample region
  23782. */
  23783. set kernel(v: number);
  23784. /**
  23785. * Gets the length in pixels of the blur sample region
  23786. */
  23787. get kernel(): number;
  23788. /**
  23789. * Sets wether or not the blur needs to unpack/repack floats
  23790. */
  23791. set packedFloat(v: boolean);
  23792. /**
  23793. * Gets wether or not the blur is unpacking/repacking floats
  23794. */
  23795. get packedFloat(): boolean;
  23796. /**
  23797. * Gets a string identifying the name of the class
  23798. * @returns "BlurPostProcess" string
  23799. */
  23800. getClassName(): string;
  23801. /**
  23802. * Creates a new instance BlurPostProcess
  23803. * @param name The name of the effect.
  23804. * @param direction The direction in which to blur the image.
  23805. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  23806. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23807. * @param camera The camera to apply the render pass to.
  23808. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23809. * @param engine The engine which the post process will be applied. (default: current engine)
  23810. * @param reusable If the post process can be reused on the same frame. (default: false)
  23811. * @param textureType Type of textures used when performing the post process. (default: 0)
  23812. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  23813. */
  23814. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23815. /**
  23816. * Updates the effect with the current post process compile time values and recompiles the shader.
  23817. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23818. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23819. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23820. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23821. * @param onCompiled Called when the shader has been compiled.
  23822. * @param onError Called if there is an error when compiling a shader.
  23823. */
  23824. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23825. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23826. /**
  23827. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23828. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23829. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23830. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23831. * The gaps between physical kernels are compensated for in the weighting of the samples
  23832. * @param idealKernel Ideal blur kernel.
  23833. * @return Nearest best kernel.
  23834. */
  23835. protected _nearestBestKernel(idealKernel: number): number;
  23836. /**
  23837. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23838. * @param x The point on the Gaussian distribution to sample.
  23839. * @return the value of the Gaussian function at x.
  23840. */
  23841. protected _gaussianWeight(x: number): number;
  23842. /**
  23843. * Generates a string that can be used as a floating point number in GLSL.
  23844. * @param x Value to print.
  23845. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23846. * @return GLSL float string.
  23847. */
  23848. protected _glslFloat(x: number, decimalFigures?: number): string;
  23849. /** @hidden */
  23850. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23851. }
  23852. }
  23853. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23854. import { Scene } from "babylonjs/scene";
  23855. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23856. import { Plane } from "babylonjs/Maths/math.plane";
  23857. /**
  23858. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23859. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23860. * You can then easily use it as a reflectionTexture on a flat surface.
  23861. * In case the surface is not a plane, please consider relying on reflection probes.
  23862. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23863. */
  23864. export class MirrorTexture extends RenderTargetTexture {
  23865. private scene;
  23866. /**
  23867. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23868. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  23869. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23870. */
  23871. mirrorPlane: Plane;
  23872. /**
  23873. * Define the blur ratio used to blur the reflection if needed.
  23874. */
  23875. set blurRatio(value: number);
  23876. get blurRatio(): number;
  23877. /**
  23878. * Define the adaptive blur kernel used to blur the reflection if needed.
  23879. * This will autocompute the closest best match for the `blurKernel`
  23880. */
  23881. set adaptiveBlurKernel(value: number);
  23882. /**
  23883. * Define the blur kernel used to blur the reflection if needed.
  23884. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23885. */
  23886. set blurKernel(value: number);
  23887. /**
  23888. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23889. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23890. */
  23891. set blurKernelX(value: number);
  23892. get blurKernelX(): number;
  23893. /**
  23894. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23895. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23896. */
  23897. set blurKernelY(value: number);
  23898. get blurKernelY(): number;
  23899. private _autoComputeBlurKernel;
  23900. protected _onRatioRescale(): void;
  23901. private _updateGammaSpace;
  23902. private _imageProcessingConfigChangeObserver;
  23903. private _transformMatrix;
  23904. private _mirrorMatrix;
  23905. private _savedViewMatrix;
  23906. private _blurX;
  23907. private _blurY;
  23908. private _adaptiveBlurKernel;
  23909. private _blurKernelX;
  23910. private _blurKernelY;
  23911. private _blurRatio;
  23912. /**
  23913. * Instantiates a Mirror Texture.
  23914. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23915. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23916. * You can then easily use it as a reflectionTexture on a flat surface.
  23917. * In case the surface is not a plane, please consider relying on reflection probes.
  23918. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23919. * @param name
  23920. * @param size
  23921. * @param scene
  23922. * @param generateMipMaps
  23923. * @param type
  23924. * @param samplingMode
  23925. * @param generateDepthBuffer
  23926. */
  23927. constructor(name: string, size: number | {
  23928. width: number;
  23929. height: number;
  23930. } | {
  23931. ratio: number;
  23932. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23933. private _preparePostProcesses;
  23934. /**
  23935. * Clone the mirror texture.
  23936. * @returns the cloned texture
  23937. */
  23938. clone(): MirrorTexture;
  23939. /**
  23940. * Serialize the texture to a JSON representation you could use in Parse later on
  23941. * @returns the serialized JSON representation
  23942. */
  23943. serialize(): any;
  23944. /**
  23945. * Dispose the texture and release its associated resources.
  23946. */
  23947. dispose(): void;
  23948. }
  23949. }
  23950. declare module "babylonjs/Materials/Textures/texture" {
  23951. import { Observable } from "babylonjs/Misc/observable";
  23952. import { Nullable } from "babylonjs/types";
  23953. import { Matrix } from "babylonjs/Maths/math.vector";
  23954. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23955. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23956. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23957. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23958. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23959. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23960. import { Scene } from "babylonjs/scene";
  23961. /**
  23962. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23963. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23964. */
  23965. export class Texture extends BaseTexture {
  23966. /**
  23967. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23968. */
  23969. static SerializeBuffers: boolean;
  23970. /** @hidden */
  23971. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23972. /** @hidden */
  23973. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23974. /** @hidden */
  23975. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_SAMPLINGMODE: number;
  23978. /** nearest is mag = nearest and min = nearest and mip = linear */
  23979. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly BILINEAR_SAMPLINGMODE: number;
  23982. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23983. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly TRILINEAR_SAMPLINGMODE: number;
  23986. /** Trilinear is mag = linear and min = linear and mip = linear */
  23987. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23988. /** mag = nearest and min = nearest and mip = nearest */
  23989. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = nearest */
  23991. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23992. /** mag = nearest and min = linear and mip = linear */
  23993. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23994. /** mag = nearest and min = linear and mip = none */
  23995. static readonly NEAREST_LINEAR: number;
  23996. /** mag = nearest and min = nearest and mip = none */
  23997. static readonly NEAREST_NEAREST: number;
  23998. /** mag = linear and min = nearest and mip = nearest */
  23999. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24000. /** mag = linear and min = nearest and mip = linear */
  24001. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24002. /** mag = linear and min = linear and mip = none */
  24003. static readonly LINEAR_LINEAR: number;
  24004. /** mag = linear and min = nearest and mip = none */
  24005. static readonly LINEAR_NEAREST: number;
  24006. /** Explicit coordinates mode */
  24007. static readonly EXPLICIT_MODE: number;
  24008. /** Spherical coordinates mode */
  24009. static readonly SPHERICAL_MODE: number;
  24010. /** Planar coordinates mode */
  24011. static readonly PLANAR_MODE: number;
  24012. /** Cubic coordinates mode */
  24013. static readonly CUBIC_MODE: number;
  24014. /** Projection coordinates mode */
  24015. static readonly PROJECTION_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly SKYBOX_MODE: number;
  24018. /** Inverse Cubic coordinates mode */
  24019. static readonly INVCUBIC_MODE: number;
  24020. /** Equirectangular coordinates mode */
  24021. static readonly EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24024. /** Equirectangular Fixed Mirrored coordinates mode */
  24025. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24026. /** Texture is not repeating outside of 0..1 UVs */
  24027. static readonly CLAMP_ADDRESSMODE: number;
  24028. /** Texture is repeating outside of 0..1 UVs */
  24029. static readonly WRAP_ADDRESSMODE: number;
  24030. /** Texture is repeating and mirrored */
  24031. static readonly MIRROR_ADDRESSMODE: number;
  24032. /**
  24033. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  24034. */
  24035. static UseSerializedUrlIfAny: boolean;
  24036. /**
  24037. * Define the url of the texture.
  24038. */
  24039. url: Nullable<string>;
  24040. /**
  24041. * Define an offset on the texture to offset the u coordinates of the UVs
  24042. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24043. */
  24044. uOffset: number;
  24045. /**
  24046. * Define an offset on the texture to offset the v coordinates of the UVs
  24047. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24048. */
  24049. vOffset: number;
  24050. /**
  24051. * Define an offset on the texture to scale the u coordinates of the UVs
  24052. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24053. */
  24054. uScale: number;
  24055. /**
  24056. * Define an offset on the texture to scale the v coordinates of the UVs
  24057. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24058. */
  24059. vScale: number;
  24060. /**
  24061. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24062. * @see https://doc.babylonjs.com/how_to/more_materials
  24063. */
  24064. uAng: number;
  24065. /**
  24066. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24067. * @see https://doc.babylonjs.com/how_to/more_materials
  24068. */
  24069. vAng: number;
  24070. /**
  24071. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24072. * @see https://doc.babylonjs.com/how_to/more_materials
  24073. */
  24074. wAng: number;
  24075. /**
  24076. * Defines the center of rotation (U)
  24077. */
  24078. uRotationCenter: number;
  24079. /**
  24080. * Defines the center of rotation (V)
  24081. */
  24082. vRotationCenter: number;
  24083. /**
  24084. * Defines the center of rotation (W)
  24085. */
  24086. wRotationCenter: number;
  24087. /**
  24088. * Are mip maps generated for this texture or not.
  24089. */
  24090. get noMipmap(): boolean;
  24091. /**
  24092. * List of inspectable custom properties (used by the Inspector)
  24093. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24094. */
  24095. inspectableCustomProperties: Nullable<IInspectable[]>;
  24096. private _noMipmap;
  24097. /** @hidden */
  24098. _invertY: boolean;
  24099. private _rowGenerationMatrix;
  24100. private _cachedTextureMatrix;
  24101. private _projectionModeMatrix;
  24102. private _t0;
  24103. private _t1;
  24104. private _t2;
  24105. private _cachedUOffset;
  24106. private _cachedVOffset;
  24107. private _cachedUScale;
  24108. private _cachedVScale;
  24109. private _cachedUAng;
  24110. private _cachedVAng;
  24111. private _cachedWAng;
  24112. private _cachedProjectionMatrixId;
  24113. private _cachedCoordinatesMode;
  24114. /** @hidden */
  24115. protected _initialSamplingMode: number;
  24116. /** @hidden */
  24117. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24118. private _deleteBuffer;
  24119. protected _format: Nullable<number>;
  24120. private _delayedOnLoad;
  24121. private _delayedOnError;
  24122. private _mimeType?;
  24123. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24124. get mimeType(): string | undefined;
  24125. /**
  24126. * Observable triggered once the texture has been loaded.
  24127. */
  24128. onLoadObservable: Observable<Texture>;
  24129. protected _isBlocking: boolean;
  24130. /**
  24131. * Is the texture preventing material to render while loading.
  24132. * If false, a default texture will be used instead of the loading one during the preparation step.
  24133. */
  24134. set isBlocking(value: boolean);
  24135. get isBlocking(): boolean;
  24136. /**
  24137. * Get the current sampling mode associated with the texture.
  24138. */
  24139. get samplingMode(): number;
  24140. /**
  24141. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24142. */
  24143. get invertY(): boolean;
  24144. /**
  24145. * Instantiates a new texture.
  24146. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24147. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24148. * @param url defines the url of the picture to load as a texture
  24149. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24150. * @param noMipmap defines if the texture will require mip maps or not
  24151. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24152. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24153. * @param onLoad defines a callback triggered when the texture has been loaded
  24154. * @param onError defines a callback triggered when an error occurred during the loading session
  24155. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24156. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24157. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24158. * @param mimeType defines an optional mime type information
  24159. */
  24160. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  24161. /**
  24162. * Update the url (and optional buffer) of this texture if url was null during construction.
  24163. * @param url the url of the texture
  24164. * @param buffer the buffer of the texture (defaults to null)
  24165. * @param onLoad callback called when the texture is loaded (defaults to null)
  24166. */
  24167. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24168. /**
  24169. * Finish the loading sequence of a texture flagged as delayed load.
  24170. * @hidden
  24171. */
  24172. delayLoad(): void;
  24173. private _prepareRowForTextureGeneration;
  24174. /**
  24175. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24176. * @returns the transform matrix of the texture.
  24177. */
  24178. getTextureMatrix(uBase?: number): Matrix;
  24179. /**
  24180. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24181. * @returns The reflection texture transform
  24182. */
  24183. getReflectionTextureMatrix(): Matrix;
  24184. /**
  24185. * Clones the texture.
  24186. * @returns the cloned texture
  24187. */
  24188. clone(): Texture;
  24189. /**
  24190. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24191. * @returns The JSON representation of the texture
  24192. */
  24193. serialize(): any;
  24194. /**
  24195. * Get the current class name of the texture useful for serialization or dynamic coding.
  24196. * @returns "Texture"
  24197. */
  24198. getClassName(): string;
  24199. /**
  24200. * Dispose the texture and release its associated resources.
  24201. */
  24202. dispose(): void;
  24203. /**
  24204. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24205. * @param parsedTexture Define the JSON representation of the texture
  24206. * @param scene Define the scene the parsed texture should be instantiated in
  24207. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24208. * @returns The parsed texture if successful
  24209. */
  24210. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24211. /**
  24212. * Creates a texture from its base 64 representation.
  24213. * @param data Define the base64 payload without the data: prefix
  24214. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24215. * @param scene Define the scene the texture should belong to
  24216. * @param noMipmap Forces the texture to not create mip map information if true
  24217. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24218. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24219. * @param onLoad define a callback triggered when the texture has been loaded
  24220. * @param onError define a callback triggered when an error occurred during the loading session
  24221. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24222. * @returns the created texture
  24223. */
  24224. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24225. /**
  24226. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24227. * @param data Define the base64 payload without the data: prefix
  24228. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24229. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24230. * @param scene Define the scene the texture should belong to
  24231. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24232. * @param noMipmap Forces the texture to not create mip map information if true
  24233. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24234. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24235. * @param onLoad define a callback triggered when the texture has been loaded
  24236. * @param onError define a callback triggered when an error occurred during the loading session
  24237. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24238. * @returns the created texture
  24239. */
  24240. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  24241. }
  24242. }
  24243. declare module "babylonjs/PostProcesses/postProcessManager" {
  24244. import { Nullable } from "babylonjs/types";
  24245. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24246. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24247. import { Scene } from "babylonjs/scene";
  24248. /**
  24249. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24250. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24251. */
  24252. export class PostProcessManager {
  24253. private _scene;
  24254. private _indexBuffer;
  24255. private _vertexBuffers;
  24256. /**
  24257. * Creates a new instance PostProcess
  24258. * @param scene The scene that the post process is associated with.
  24259. */
  24260. constructor(scene: Scene);
  24261. private _prepareBuffers;
  24262. private _buildIndexBuffer;
  24263. /**
  24264. * Rebuilds the vertex buffers of the manager.
  24265. * @hidden
  24266. */
  24267. _rebuild(): void;
  24268. /**
  24269. * Prepares a frame to be run through a post process.
  24270. * @param sourceTexture The input texture to the post procesess. (default: null)
  24271. * @param postProcesses An array of post processes to be run. (default: null)
  24272. * @returns True if the post processes were able to be run.
  24273. * @hidden
  24274. */
  24275. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24276. /**
  24277. * Manually render a set of post processes to a texture.
  24278. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24279. * @param postProcesses An array of post processes to be run.
  24280. * @param targetTexture The target texture to render to.
  24281. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24282. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24283. * @param lodLevel defines which lod of the texture to render to
  24284. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24285. */
  24286. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24287. /**
  24288. * Finalize the result of the output of the postprocesses.
  24289. * @param doNotPresent If true the result will not be displayed to the screen.
  24290. * @param targetTexture The target texture to render to.
  24291. * @param faceIndex The index of the face to bind the target texture to.
  24292. * @param postProcesses The array of post processes to render.
  24293. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24294. * @hidden
  24295. */
  24296. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24297. /**
  24298. * Disposes of the post process manager.
  24299. */
  24300. dispose(): void;
  24301. }
  24302. }
  24303. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24304. import { Observable } from "babylonjs/Misc/observable";
  24305. import { SmartArray } from "babylonjs/Misc/smartArray";
  24306. import { Nullable, Immutable } from "babylonjs/types";
  24307. import { Camera } from "babylonjs/Cameras/camera";
  24308. import { Scene } from "babylonjs/scene";
  24309. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24310. import { Color4 } from "babylonjs/Maths/math.color";
  24311. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24313. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24314. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24315. import { Texture } from "babylonjs/Materials/Textures/texture";
  24316. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24317. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24318. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24319. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24320. import { Engine } from "babylonjs/Engines/engine";
  24321. /**
  24322. * This Helps creating a texture that will be created from a camera in your scene.
  24323. * It is basically a dynamic texture that could be used to create special effects for instance.
  24324. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24325. */
  24326. export class RenderTargetTexture extends Texture {
  24327. /**
  24328. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24329. */
  24330. static readonly REFRESHRATE_RENDER_ONCE: number;
  24331. /**
  24332. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24333. */
  24334. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24335. /**
  24336. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24337. * the central point of your effect and can save a lot of performances.
  24338. */
  24339. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24340. /**
  24341. * Use this predicate to dynamically define the list of mesh you want to render.
  24342. * If set, the renderList property will be overwritten.
  24343. */
  24344. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24345. private _renderList;
  24346. /**
  24347. * Use this list to define the list of mesh you want to render.
  24348. */
  24349. get renderList(): Nullable<Array<AbstractMesh>>;
  24350. set renderList(value: Nullable<Array<AbstractMesh>>);
  24351. /**
  24352. * Use this function to overload the renderList array at rendering time.
  24353. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24354. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24355. * the cube (if the RTT is a cube, else layerOrFace=0).
  24356. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24357. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24358. * hold dummy elements!
  24359. */
  24360. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24361. private _hookArray;
  24362. /**
  24363. * Define if particles should be rendered in your texture.
  24364. */
  24365. renderParticles: boolean;
  24366. /**
  24367. * Define if sprites should be rendered in your texture.
  24368. */
  24369. renderSprites: boolean;
  24370. /**
  24371. * Define the camera used to render the texture.
  24372. */
  24373. activeCamera: Nullable<Camera>;
  24374. /**
  24375. * Override the mesh isReady function with your own one.
  24376. */
  24377. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24378. /**
  24379. * Override the render function of the texture with your own one.
  24380. */
  24381. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24382. /**
  24383. * Define if camera post processes should be use while rendering the texture.
  24384. */
  24385. useCameraPostProcesses: boolean;
  24386. /**
  24387. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24388. */
  24389. ignoreCameraViewport: boolean;
  24390. private _postProcessManager;
  24391. private _postProcesses;
  24392. private _resizeObserver;
  24393. /**
  24394. * An event triggered when the texture is unbind.
  24395. */
  24396. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24397. /**
  24398. * An event triggered when the texture is unbind.
  24399. */
  24400. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24401. private _onAfterUnbindObserver;
  24402. /**
  24403. * Set a after unbind callback in the texture.
  24404. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24405. */
  24406. set onAfterUnbind(callback: () => void);
  24407. /**
  24408. * An event triggered before rendering the texture
  24409. */
  24410. onBeforeRenderObservable: Observable<number>;
  24411. private _onBeforeRenderObserver;
  24412. /**
  24413. * Set a before render callback in the texture.
  24414. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24415. */
  24416. set onBeforeRender(callback: (faceIndex: number) => void);
  24417. /**
  24418. * An event triggered after rendering the texture
  24419. */
  24420. onAfterRenderObservable: Observable<number>;
  24421. private _onAfterRenderObserver;
  24422. /**
  24423. * Set a after render callback in the texture.
  24424. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24425. */
  24426. set onAfterRender(callback: (faceIndex: number) => void);
  24427. /**
  24428. * An event triggered after the texture clear
  24429. */
  24430. onClearObservable: Observable<Engine>;
  24431. private _onClearObserver;
  24432. /**
  24433. * Set a clear callback in the texture.
  24434. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24435. */
  24436. set onClear(callback: (Engine: Engine) => void);
  24437. /**
  24438. * An event triggered when the texture is resized.
  24439. */
  24440. onResizeObservable: Observable<RenderTargetTexture>;
  24441. /**
  24442. * Define the clear color of the Render Target if it should be different from the scene.
  24443. */
  24444. clearColor: Color4;
  24445. protected _size: number | {
  24446. width: number;
  24447. height: number;
  24448. layers?: number;
  24449. };
  24450. protected _initialSizeParameter: number | {
  24451. width: number;
  24452. height: number;
  24453. } | {
  24454. ratio: number;
  24455. };
  24456. protected _sizeRatio: Nullable<number>;
  24457. /** @hidden */
  24458. _generateMipMaps: boolean;
  24459. protected _renderingManager: RenderingManager;
  24460. /** @hidden */
  24461. _waitingRenderList?: string[];
  24462. protected _doNotChangeAspectRatio: boolean;
  24463. protected _currentRefreshId: number;
  24464. protected _refreshRate: number;
  24465. protected _textureMatrix: Matrix;
  24466. protected _samples: number;
  24467. protected _renderTargetOptions: RenderTargetCreationOptions;
  24468. /**
  24469. * Gets render target creation options that were used.
  24470. */
  24471. get renderTargetOptions(): RenderTargetCreationOptions;
  24472. protected _onRatioRescale(): void;
  24473. /**
  24474. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24475. * It must define where the camera used to render the texture is set
  24476. */
  24477. boundingBoxPosition: Vector3;
  24478. private _boundingBoxSize;
  24479. /**
  24480. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24481. * When defined, the cubemap will switch to local mode
  24482. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24483. * @example https://www.babylonjs-playground.com/#RNASML
  24484. */
  24485. set boundingBoxSize(value: Vector3);
  24486. get boundingBoxSize(): Vector3;
  24487. /**
  24488. * In case the RTT has been created with a depth texture, get the associated
  24489. * depth texture.
  24490. * Otherwise, return null.
  24491. */
  24492. get depthStencilTexture(): Nullable<InternalTexture>;
  24493. /**
  24494. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24495. * or used a shadow, depth texture...
  24496. * @param name The friendly name of the texture
  24497. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  24498. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24499. * @param generateMipMaps True if mip maps need to be generated after render.
  24500. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24501. * @param type The type of the buffer in the RTT (int, half float, float...)
  24502. * @param isCube True if a cube texture needs to be created
  24503. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24504. * @param generateDepthBuffer True to generate a depth buffer
  24505. * @param generateStencilBuffer True to generate a stencil buffer
  24506. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24507. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24508. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24509. */
  24510. constructor(name: string, size: number | {
  24511. width: number;
  24512. height: number;
  24513. layers?: number;
  24514. } | {
  24515. ratio: number;
  24516. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24517. /**
  24518. * Creates a depth stencil texture.
  24519. * This is only available in WebGL 2 or with the depth texture extension available.
  24520. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24521. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24522. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24523. */
  24524. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24525. private _processSizeParameter;
  24526. /**
  24527. * Define the number of samples to use in case of MSAA.
  24528. * It defaults to one meaning no MSAA has been enabled.
  24529. */
  24530. get samples(): number;
  24531. set samples(value: number);
  24532. /**
  24533. * Resets the refresh counter of the texture and start bak from scratch.
  24534. * Could be useful to regenerate the texture if it is setup to render only once.
  24535. */
  24536. resetRefreshCounter(): void;
  24537. /**
  24538. * Define the refresh rate of the texture or the rendering frequency.
  24539. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24540. */
  24541. get refreshRate(): number;
  24542. set refreshRate(value: number);
  24543. /**
  24544. * Adds a post process to the render target rendering passes.
  24545. * @param postProcess define the post process to add
  24546. */
  24547. addPostProcess(postProcess: PostProcess): void;
  24548. /**
  24549. * Clear all the post processes attached to the render target
  24550. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24551. */
  24552. clearPostProcesses(dispose?: boolean): void;
  24553. /**
  24554. * Remove one of the post process from the list of attached post processes to the texture
  24555. * @param postProcess define the post process to remove from the list
  24556. */
  24557. removePostProcess(postProcess: PostProcess): void;
  24558. /** @hidden */
  24559. _shouldRender(): boolean;
  24560. /**
  24561. * Gets the actual render size of the texture.
  24562. * @returns the width of the render size
  24563. */
  24564. getRenderSize(): number;
  24565. /**
  24566. * Gets the actual render width of the texture.
  24567. * @returns the width of the render size
  24568. */
  24569. getRenderWidth(): number;
  24570. /**
  24571. * Gets the actual render height of the texture.
  24572. * @returns the height of the render size
  24573. */
  24574. getRenderHeight(): number;
  24575. /**
  24576. * Gets the actual number of layers of the texture.
  24577. * @returns the number of layers
  24578. */
  24579. getRenderLayers(): number;
  24580. /**
  24581. * Get if the texture can be rescaled or not.
  24582. */
  24583. get canRescale(): boolean;
  24584. /**
  24585. * Resize the texture using a ratio.
  24586. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24587. */
  24588. scale(ratio: number): void;
  24589. /**
  24590. * Get the texture reflection matrix used to rotate/transform the reflection.
  24591. * @returns the reflection matrix
  24592. */
  24593. getReflectionTextureMatrix(): Matrix;
  24594. /**
  24595. * Resize the texture to a new desired size.
  24596. * Be carrefull as it will recreate all the data in the new texture.
  24597. * @param size Define the new size. It can be:
  24598. * - a number for squared texture,
  24599. * - an object containing { width: number, height: number }
  24600. * - or an object containing a ratio { ratio: number }
  24601. */
  24602. resize(size: number | {
  24603. width: number;
  24604. height: number;
  24605. } | {
  24606. ratio: number;
  24607. }): void;
  24608. private _defaultRenderListPrepared;
  24609. /**
  24610. * Renders all the objects from the render list into the texture.
  24611. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24612. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24613. */
  24614. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24615. private _bestReflectionRenderTargetDimension;
  24616. private _prepareRenderingManager;
  24617. /**
  24618. * @hidden
  24619. * @param faceIndex face index to bind to if this is a cubetexture
  24620. * @param layer defines the index of the texture to bind in the array
  24621. */
  24622. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24623. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24624. private renderToTarget;
  24625. /**
  24626. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24627. * This allowed control for front to back rendering or reversly depending of the special needs.
  24628. *
  24629. * @param renderingGroupId The rendering group id corresponding to its index
  24630. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24631. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24632. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24633. */
  24634. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  24635. /**
  24636. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24637. *
  24638. * @param renderingGroupId The rendering group id corresponding to its index
  24639. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24640. */
  24641. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24642. /**
  24643. * Clones the texture.
  24644. * @returns the cloned texture
  24645. */
  24646. clone(): RenderTargetTexture;
  24647. /**
  24648. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24649. * @returns The JSON representation of the texture
  24650. */
  24651. serialize(): any;
  24652. /**
  24653. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24654. */
  24655. disposeFramebufferObjects(): void;
  24656. /**
  24657. * Dispose the texture and release its associated resources.
  24658. */
  24659. dispose(): void;
  24660. /** @hidden */
  24661. _rebuild(): void;
  24662. /**
  24663. * Clear the info related to rendering groups preventing retention point in material dispose.
  24664. */
  24665. freeRenderingGroups(): void;
  24666. /**
  24667. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24668. * @returns the view count
  24669. */
  24670. getViewCount(): number;
  24671. }
  24672. }
  24673. declare module "babylonjs/Misc/guid" {
  24674. /**
  24675. * Class used to manipulate GUIDs
  24676. */
  24677. export class GUID {
  24678. /**
  24679. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24680. * Be aware Math.random() could cause collisions, but:
  24681. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  24682. * @returns a pseudo random id
  24683. */
  24684. static RandomId(): string;
  24685. }
  24686. }
  24687. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24688. import { Nullable } from "babylonjs/types";
  24689. import { Scene } from "babylonjs/scene";
  24690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24691. import { Material } from "babylonjs/Materials/material";
  24692. import { Effect } from "babylonjs/Materials/effect";
  24693. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24694. /**
  24695. * Options to be used when creating a shadow depth material
  24696. */
  24697. export interface IIOptionShadowDepthMaterial {
  24698. /** Variables in the vertex shader code that need to have their names remapped.
  24699. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24700. * "var_name" should be either: worldPos or vNormalW
  24701. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24702. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24703. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24704. */
  24705. remappedVariables?: string[];
  24706. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24707. standalone?: boolean;
  24708. }
  24709. /**
  24710. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24711. */
  24712. export class ShadowDepthWrapper {
  24713. private _scene;
  24714. private _options?;
  24715. private _baseMaterial;
  24716. private _onEffectCreatedObserver;
  24717. private _subMeshToEffect;
  24718. private _subMeshToDepthEffect;
  24719. private _meshes;
  24720. /** @hidden */
  24721. _matriceNames: any;
  24722. /** Gets the standalone status of the wrapper */
  24723. get standalone(): boolean;
  24724. /** Gets the base material the wrapper is built upon */
  24725. get baseMaterial(): Material;
  24726. /**
  24727. * Instantiate a new shadow depth wrapper.
  24728. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24729. * generate the shadow depth map. For more information, please refer to the documentation:
  24730. * https://doc.babylonjs.com/babylon101/shadows
  24731. * @param baseMaterial Material to wrap
  24732. * @param scene Define the scene the material belongs to
  24733. * @param options Options used to create the wrapper
  24734. */
  24735. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24736. /**
  24737. * Gets the effect to use to generate the depth map
  24738. * @param subMesh subMesh to get the effect for
  24739. * @param shadowGenerator shadow generator to get the effect for
  24740. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24741. */
  24742. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24743. /**
  24744. * Specifies that the submesh is ready to be used for depth rendering
  24745. * @param subMesh submesh to check
  24746. * @param defines the list of defines to take into account when checking the effect
  24747. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24748. * @param useInstances specifies that instances should be used
  24749. * @returns a boolean indicating that the submesh is ready or not
  24750. */
  24751. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24752. /**
  24753. * Disposes the resources
  24754. */
  24755. dispose(): void;
  24756. private _makeEffect;
  24757. }
  24758. }
  24759. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24760. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24761. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24762. import { Nullable } from "babylonjs/types";
  24763. module "babylonjs/Engines/thinEngine" {
  24764. interface ThinEngine {
  24765. /**
  24766. * Unbind a list of render target textures from the webGL context
  24767. * This is used only when drawBuffer extension or webGL2 are active
  24768. * @param textures defines the render target textures to unbind
  24769. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24770. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24771. */
  24772. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24773. /**
  24774. * Create a multi render target texture
  24775. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24776. * @param size defines the size of the texture
  24777. * @param options defines the creation options
  24778. * @returns the cube texture as an InternalTexture
  24779. */
  24780. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24781. /**
  24782. * Update the sample count for a given multiple render target texture
  24783. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24784. * @param textures defines the textures to update
  24785. * @param samples defines the sample count to set
  24786. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24787. */
  24788. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24789. /**
  24790. * Select a subsets of attachments to draw to.
  24791. * @param attachments gl attachments
  24792. */
  24793. bindAttachments(attachments: number[]): void;
  24794. }
  24795. }
  24796. }
  24797. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24798. import { Scene } from "babylonjs/scene";
  24799. import { Engine } from "babylonjs/Engines/engine";
  24800. import { Texture } from "babylonjs/Materials/Textures/texture";
  24801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24802. import "babylonjs/Engines/Extensions/engine.multiRender";
  24803. /**
  24804. * Creation options of the multi render target texture.
  24805. */
  24806. export interface IMultiRenderTargetOptions {
  24807. /**
  24808. * Define if the texture needs to create mip maps after render.
  24809. */
  24810. generateMipMaps?: boolean;
  24811. /**
  24812. * Define the types of all the draw buffers we want to create
  24813. */
  24814. types?: number[];
  24815. /**
  24816. * Define the sampling modes of all the draw buffers we want to create
  24817. */
  24818. samplingModes?: number[];
  24819. /**
  24820. * Define if a depth buffer is required
  24821. */
  24822. generateDepthBuffer?: boolean;
  24823. /**
  24824. * Define if a stencil buffer is required
  24825. */
  24826. generateStencilBuffer?: boolean;
  24827. /**
  24828. * Define if a depth texture is required instead of a depth buffer
  24829. */
  24830. generateDepthTexture?: boolean;
  24831. /**
  24832. * Define the number of desired draw buffers
  24833. */
  24834. textureCount?: number;
  24835. /**
  24836. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24837. */
  24838. doNotChangeAspectRatio?: boolean;
  24839. /**
  24840. * Define the default type of the buffers we are creating
  24841. */
  24842. defaultType?: number;
  24843. }
  24844. /**
  24845. * A multi render target, like a render target provides the ability to render to a texture.
  24846. * Unlike the render target, it can render to several draw buffers in one draw.
  24847. * This is specially interesting in deferred rendering or for any effects requiring more than
  24848. * just one color from a single pass.
  24849. */
  24850. export class MultiRenderTarget extends RenderTargetTexture {
  24851. private _internalTextures;
  24852. private _textures;
  24853. private _multiRenderTargetOptions;
  24854. private _count;
  24855. /**
  24856. * Get if draw buffers are currently supported by the used hardware and browser.
  24857. */
  24858. get isSupported(): boolean;
  24859. /**
  24860. * Get the list of textures generated by the multi render target.
  24861. */
  24862. get textures(): Texture[];
  24863. /**
  24864. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24865. */
  24866. get count(): number;
  24867. /**
  24868. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24869. */
  24870. get depthTexture(): Texture;
  24871. /**
  24872. * Set the wrapping mode on U of all the textures we are rendering to.
  24873. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24874. */
  24875. set wrapU(wrap: number);
  24876. /**
  24877. * Set the wrapping mode on V of all the textures we are rendering to.
  24878. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24879. */
  24880. set wrapV(wrap: number);
  24881. /**
  24882. * Instantiate a new multi render target texture.
  24883. * A multi render target, like a render target provides the ability to render to a texture.
  24884. * Unlike the render target, it can render to several draw buffers in one draw.
  24885. * This is specially interesting in deferred rendering or for any effects requiring more than
  24886. * just one color from a single pass.
  24887. * @param name Define the name of the texture
  24888. * @param size Define the size of the buffers to render to
  24889. * @param count Define the number of target we are rendering into
  24890. * @param scene Define the scene the texture belongs to
  24891. * @param options Define the options used to create the multi render target
  24892. */
  24893. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24894. /** @hidden */
  24895. _rebuild(): void;
  24896. private _createInternalTextures;
  24897. private _createTextures;
  24898. /**
  24899. * Define the number of samples used if MSAA is enabled.
  24900. */
  24901. get samples(): number;
  24902. set samples(value: number);
  24903. /**
  24904. * Resize all the textures in the multi render target.
  24905. * Be carrefull as it will recreate all the data in the new texture.
  24906. * @param size Define the new size
  24907. */
  24908. resize(size: any): void;
  24909. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24910. /**
  24911. * Dispose the render targets and their associated resources
  24912. */
  24913. dispose(): void;
  24914. /**
  24915. * Release all the underlying texture used as draw buffers.
  24916. */
  24917. releaseInternalTextures(): void;
  24918. }
  24919. }
  24920. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24921. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24922. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24923. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24924. /** @hidden */
  24925. export var imageProcessingPixelShader: {
  24926. name: string;
  24927. shader: string;
  24928. };
  24929. }
  24930. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24931. import { Nullable } from "babylonjs/types";
  24932. import { Color4 } from "babylonjs/Maths/math.color";
  24933. import { Camera } from "babylonjs/Cameras/camera";
  24934. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24935. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24936. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24937. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24938. import { Engine } from "babylonjs/Engines/engine";
  24939. import "babylonjs/Shaders/imageProcessing.fragment";
  24940. import "babylonjs/Shaders/postprocess.vertex";
  24941. /**
  24942. * ImageProcessingPostProcess
  24943. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24944. */
  24945. export class ImageProcessingPostProcess extends PostProcess {
  24946. /**
  24947. * Default configuration related to image processing available in the PBR Material.
  24948. */
  24949. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24950. /**
  24951. * Gets the image processing configuration used either in this material.
  24952. */
  24953. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24954. /**
  24955. * Sets the Default image processing configuration used either in the this material.
  24956. *
  24957. * If sets to null, the scene one is in use.
  24958. */
  24959. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24960. /**
  24961. * Keep track of the image processing observer to allow dispose and replace.
  24962. */
  24963. private _imageProcessingObserver;
  24964. /**
  24965. * Attaches a new image processing configuration to the PBR Material.
  24966. * @param configuration
  24967. */
  24968. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24969. /**
  24970. * If the post process is supported.
  24971. */
  24972. get isSupported(): boolean;
  24973. /**
  24974. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24975. */
  24976. get colorCurves(): Nullable<ColorCurves>;
  24977. /**
  24978. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24979. */
  24980. set colorCurves(value: Nullable<ColorCurves>);
  24981. /**
  24982. * Gets wether the color curves effect is enabled.
  24983. */
  24984. get colorCurvesEnabled(): boolean;
  24985. /**
  24986. * Sets wether the color curves effect is enabled.
  24987. */
  24988. set colorCurvesEnabled(value: boolean);
  24989. /**
  24990. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24991. */
  24992. get colorGradingTexture(): Nullable<BaseTexture>;
  24993. /**
  24994. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24995. */
  24996. set colorGradingTexture(value: Nullable<BaseTexture>);
  24997. /**
  24998. * Gets wether the color grading effect is enabled.
  24999. */
  25000. get colorGradingEnabled(): boolean;
  25001. /**
  25002. * Gets wether the color grading effect is enabled.
  25003. */
  25004. set colorGradingEnabled(value: boolean);
  25005. /**
  25006. * Gets exposure used in the effect.
  25007. */
  25008. get exposure(): number;
  25009. /**
  25010. * Sets exposure used in the effect.
  25011. */
  25012. set exposure(value: number);
  25013. /**
  25014. * Gets wether tonemapping is enabled or not.
  25015. */
  25016. get toneMappingEnabled(): boolean;
  25017. /**
  25018. * Sets wether tonemapping is enabled or not
  25019. */
  25020. set toneMappingEnabled(value: boolean);
  25021. /**
  25022. * Gets the type of tone mapping effect.
  25023. */
  25024. get toneMappingType(): number;
  25025. /**
  25026. * Sets the type of tone mapping effect.
  25027. */
  25028. set toneMappingType(value: number);
  25029. /**
  25030. * Gets contrast used in the effect.
  25031. */
  25032. get contrast(): number;
  25033. /**
  25034. * Sets contrast used in the effect.
  25035. */
  25036. set contrast(value: number);
  25037. /**
  25038. * Gets Vignette stretch size.
  25039. */
  25040. get vignetteStretch(): number;
  25041. /**
  25042. * Sets Vignette stretch size.
  25043. */
  25044. set vignetteStretch(value: number);
  25045. /**
  25046. * Gets Vignette centre X Offset.
  25047. */
  25048. get vignetteCentreX(): number;
  25049. /**
  25050. * Sets Vignette centre X Offset.
  25051. */
  25052. set vignetteCentreX(value: number);
  25053. /**
  25054. * Gets Vignette centre Y Offset.
  25055. */
  25056. get vignetteCentreY(): number;
  25057. /**
  25058. * Sets Vignette centre Y Offset.
  25059. */
  25060. set vignetteCentreY(value: number);
  25061. /**
  25062. * Gets Vignette weight or intensity of the vignette effect.
  25063. */
  25064. get vignetteWeight(): number;
  25065. /**
  25066. * Sets Vignette weight or intensity of the vignette effect.
  25067. */
  25068. set vignetteWeight(value: number);
  25069. /**
  25070. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25071. * if vignetteEnabled is set to true.
  25072. */
  25073. get vignetteColor(): Color4;
  25074. /**
  25075. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25076. * if vignetteEnabled is set to true.
  25077. */
  25078. set vignetteColor(value: Color4);
  25079. /**
  25080. * Gets Camera field of view used by the Vignette effect.
  25081. */
  25082. get vignetteCameraFov(): number;
  25083. /**
  25084. * Sets Camera field of view used by the Vignette effect.
  25085. */
  25086. set vignetteCameraFov(value: number);
  25087. /**
  25088. * Gets the vignette blend mode allowing different kind of effect.
  25089. */
  25090. get vignetteBlendMode(): number;
  25091. /**
  25092. * Sets the vignette blend mode allowing different kind of effect.
  25093. */
  25094. set vignetteBlendMode(value: number);
  25095. /**
  25096. * Gets wether the vignette effect is enabled.
  25097. */
  25098. get vignetteEnabled(): boolean;
  25099. /**
  25100. * Sets wether the vignette effect is enabled.
  25101. */
  25102. set vignetteEnabled(value: boolean);
  25103. private _fromLinearSpace;
  25104. /**
  25105. * Gets wether the input of the processing is in Gamma or Linear Space.
  25106. */
  25107. get fromLinearSpace(): boolean;
  25108. /**
  25109. * Sets wether the input of the processing is in Gamma or Linear Space.
  25110. */
  25111. set fromLinearSpace(value: boolean);
  25112. /**
  25113. * Defines cache preventing GC.
  25114. */
  25115. private _defines;
  25116. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25117. /**
  25118. * "ImageProcessingPostProcess"
  25119. * @returns "ImageProcessingPostProcess"
  25120. */
  25121. getClassName(): string;
  25122. /**
  25123. * @hidden
  25124. */
  25125. _updateParameters(): void;
  25126. dispose(camera?: Camera): void;
  25127. }
  25128. }
  25129. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25130. /** @hidden */
  25131. export var fibonacci: {
  25132. name: string;
  25133. shader: string;
  25134. };
  25135. }
  25136. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25137. /** @hidden */
  25138. export var subSurfaceScatteringFunctions: {
  25139. name: string;
  25140. shader: string;
  25141. };
  25142. }
  25143. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25144. /** @hidden */
  25145. export var diffusionProfile: {
  25146. name: string;
  25147. shader: string;
  25148. };
  25149. }
  25150. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25151. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25152. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25153. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25155. /** @hidden */
  25156. export var subSurfaceScatteringPixelShader: {
  25157. name: string;
  25158. shader: string;
  25159. };
  25160. }
  25161. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25162. import { Nullable } from "babylonjs/types";
  25163. import { Camera } from "babylonjs/Cameras/camera";
  25164. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25165. import { Engine } from "babylonjs/Engines/engine";
  25166. import { Scene } from "babylonjs/scene";
  25167. import "babylonjs/Shaders/imageProcessing.fragment";
  25168. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25169. import "babylonjs/Shaders/postprocess.vertex";
  25170. /**
  25171. * Sub surface scattering post process
  25172. */
  25173. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25174. /**
  25175. * Gets a string identifying the name of the class
  25176. * @returns "SubSurfaceScatteringPostProcess" string
  25177. */
  25178. getClassName(): string;
  25179. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25180. }
  25181. }
  25182. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25183. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25184. /**
  25185. * Interface for defining prepass effects in the prepass post-process pipeline
  25186. */
  25187. export interface PrePassEffectConfiguration {
  25188. /**
  25189. * Post process to attach for this effect
  25190. */
  25191. postProcess: PostProcess;
  25192. /**
  25193. * Is the effect enabled
  25194. */
  25195. enabled: boolean;
  25196. /**
  25197. * Disposes the effect configuration
  25198. */
  25199. dispose(): void;
  25200. /**
  25201. * Disposes the effect configuration
  25202. */
  25203. createPostProcess: () => PostProcess;
  25204. }
  25205. }
  25206. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25207. import { Scene } from "babylonjs/scene";
  25208. import { Color3 } from "babylonjs/Maths/math.color";
  25209. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25210. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25211. /**
  25212. * Contains all parameters needed for the prepass to perform
  25213. * screen space subsurface scattering
  25214. */
  25215. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25216. private _ssDiffusionS;
  25217. private _ssFilterRadii;
  25218. private _ssDiffusionD;
  25219. /**
  25220. * Post process to attach for screen space subsurface scattering
  25221. */
  25222. postProcess: SubSurfaceScatteringPostProcess;
  25223. /**
  25224. * Diffusion profile color for subsurface scattering
  25225. */
  25226. get ssDiffusionS(): number[];
  25227. /**
  25228. * Diffusion profile max color channel value for subsurface scattering
  25229. */
  25230. get ssDiffusionD(): number[];
  25231. /**
  25232. * Diffusion profile filter radius for subsurface scattering
  25233. */
  25234. get ssFilterRadii(): number[];
  25235. /**
  25236. * Is subsurface enabled
  25237. */
  25238. enabled: boolean;
  25239. /**
  25240. * Diffusion profile colors for subsurface scattering
  25241. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25242. * See ...
  25243. * Note that you can only store up to 5 of them
  25244. */
  25245. ssDiffusionProfileColors: Color3[];
  25246. /**
  25247. * Defines the ratio real world => scene units.
  25248. * Used for subsurface scattering
  25249. */
  25250. metersPerUnit: number;
  25251. private _scene;
  25252. /**
  25253. * Builds a subsurface configuration object
  25254. * @param scene The scene
  25255. */
  25256. constructor(scene: Scene);
  25257. /**
  25258. * Adds a new diffusion profile.
  25259. * Useful for more realistic subsurface scattering on diverse materials.
  25260. * @param color The color of the diffusion profile. Should be the average color of the material.
  25261. * @return The index of the diffusion profile for the material subsurface configuration
  25262. */
  25263. addDiffusionProfile(color: Color3): number;
  25264. /**
  25265. * Creates the sss post process
  25266. * @return The created post process
  25267. */
  25268. createPostProcess(): SubSurfaceScatteringPostProcess;
  25269. /**
  25270. * Deletes all diffusion profiles.
  25271. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25272. */
  25273. clearAllDiffusionProfiles(): void;
  25274. /**
  25275. * Disposes this object
  25276. */
  25277. dispose(): void;
  25278. /**
  25279. * @hidden
  25280. * https://zero-radiance.github.io/post/sampling-diffusion/
  25281. *
  25282. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25283. * ------------------------------------------------------------------------------------
  25284. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25285. * PDF[r, phi, s] = r * R[r, phi, s]
  25286. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25287. * ------------------------------------------------------------------------------------
  25288. * We importance sample the color channel with the widest scattering distance.
  25289. */
  25290. getDiffusionProfileParameters(color: Color3): number;
  25291. /**
  25292. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25293. * 'u' is the random number (the value of the CDF): [0, 1).
  25294. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25295. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25296. */
  25297. private _sampleBurleyDiffusionProfile;
  25298. }
  25299. }
  25300. declare module "babylonjs/Rendering/prePassRenderer" {
  25301. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25302. import { Scene } from "babylonjs/scene";
  25303. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25304. import { Effect } from "babylonjs/Materials/effect";
  25305. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25306. /**
  25307. * Renders a pre pass of the scene
  25308. * This means every mesh in the scene will be rendered to a render target texture
  25309. * And then this texture will be composited to the rendering canvas with post processes
  25310. * It is necessary for effects like subsurface scattering or deferred shading
  25311. */
  25312. export class PrePassRenderer {
  25313. /** @hidden */
  25314. static _SceneComponentInitialization: (scene: Scene) => void;
  25315. private _scene;
  25316. private _engine;
  25317. private _isDirty;
  25318. /**
  25319. * Number of textures in the multi render target texture where the scene is directly rendered
  25320. */
  25321. readonly mrtCount: number;
  25322. /**
  25323. * The render target where the scene is directly rendered
  25324. */
  25325. prePassRT: MultiRenderTarget;
  25326. private _mrtTypes;
  25327. private _multiRenderAttachments;
  25328. private _defaultAttachments;
  25329. private _clearAttachments;
  25330. private _postProcesses;
  25331. private readonly _clearColor;
  25332. /**
  25333. * Image processing post process for composition
  25334. */
  25335. imageProcessingPostProcess: ImageProcessingPostProcess;
  25336. /**
  25337. * Configuration for sub surface scattering post process
  25338. */
  25339. subSurfaceConfiguration: SubSurfaceConfiguration;
  25340. /**
  25341. * Should materials render their geometry on the MRT
  25342. */
  25343. materialsShouldRenderGeometry: boolean;
  25344. /**
  25345. * Should materials render the irradiance information on the MRT
  25346. */
  25347. materialsShouldRenderIrradiance: boolean;
  25348. private _enabled;
  25349. /**
  25350. * Indicates if the prepass is enabled
  25351. */
  25352. get enabled(): boolean;
  25353. /**
  25354. * How many samples are used for MSAA of the scene render target
  25355. */
  25356. get samples(): number;
  25357. set samples(n: number);
  25358. /**
  25359. * Instanciates a prepass renderer
  25360. * @param scene The scene
  25361. */
  25362. constructor(scene: Scene);
  25363. private _initializeAttachments;
  25364. private _createCompositionEffect;
  25365. /**
  25366. * Indicates if rendering a prepass is supported
  25367. */
  25368. get isSupported(): boolean;
  25369. /**
  25370. * Sets the proper output textures to draw in the engine.
  25371. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25372. */
  25373. bindAttachmentsForEffect(effect: Effect): void;
  25374. /**
  25375. * @hidden
  25376. */
  25377. _beforeCameraDraw(): void;
  25378. /**
  25379. * @hidden
  25380. */
  25381. _afterCameraDraw(): void;
  25382. private _checkRTSize;
  25383. private _bindFrameBuffer;
  25384. /**
  25385. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25386. */
  25387. clear(): void;
  25388. private _setState;
  25389. private _enable;
  25390. private _disable;
  25391. private _resetPostProcessChain;
  25392. private _bindPostProcessChain;
  25393. /**
  25394. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25395. */
  25396. markAsDirty(): void;
  25397. private _update;
  25398. /**
  25399. * Disposes the prepass renderer.
  25400. */
  25401. dispose(): void;
  25402. }
  25403. }
  25404. declare module "babylonjs/Materials/material" {
  25405. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25406. import { SmartArray } from "babylonjs/Misc/smartArray";
  25407. import { Observable } from "babylonjs/Misc/observable";
  25408. import { Nullable } from "babylonjs/types";
  25409. import { Scene } from "babylonjs/scene";
  25410. import { Matrix } from "babylonjs/Maths/math.vector";
  25411. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25412. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25413. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25414. import { Effect } from "babylonjs/Materials/effect";
  25415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25416. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25417. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25418. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25419. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25420. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25421. import { Mesh } from "babylonjs/Meshes/mesh";
  25422. import { Animation } from "babylonjs/Animations/animation";
  25423. /**
  25424. * Options for compiling materials.
  25425. */
  25426. export interface IMaterialCompilationOptions {
  25427. /**
  25428. * Defines whether clip planes are enabled.
  25429. */
  25430. clipPlane: boolean;
  25431. /**
  25432. * Defines whether instances are enabled.
  25433. */
  25434. useInstances: boolean;
  25435. }
  25436. /**
  25437. * Options passed when calling customShaderNameResolve
  25438. */
  25439. export interface ICustomShaderNameResolveOptions {
  25440. /**
  25441. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  25442. */
  25443. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25444. }
  25445. /**
  25446. * Base class for the main features of a material in Babylon.js
  25447. */
  25448. export class Material implements IAnimatable {
  25449. /**
  25450. * Returns the triangle fill mode
  25451. */
  25452. static readonly TriangleFillMode: number;
  25453. /**
  25454. * Returns the wireframe mode
  25455. */
  25456. static readonly WireFrameFillMode: number;
  25457. /**
  25458. * Returns the point fill mode
  25459. */
  25460. static readonly PointFillMode: number;
  25461. /**
  25462. * Returns the point list draw mode
  25463. */
  25464. static readonly PointListDrawMode: number;
  25465. /**
  25466. * Returns the line list draw mode
  25467. */
  25468. static readonly LineListDrawMode: number;
  25469. /**
  25470. * Returns the line loop draw mode
  25471. */
  25472. static readonly LineLoopDrawMode: number;
  25473. /**
  25474. * Returns the line strip draw mode
  25475. */
  25476. static readonly LineStripDrawMode: number;
  25477. /**
  25478. * Returns the triangle strip draw mode
  25479. */
  25480. static readonly TriangleStripDrawMode: number;
  25481. /**
  25482. * Returns the triangle fan draw mode
  25483. */
  25484. static readonly TriangleFanDrawMode: number;
  25485. /**
  25486. * Stores the clock-wise side orientation
  25487. */
  25488. static readonly ClockWiseSideOrientation: number;
  25489. /**
  25490. * Stores the counter clock-wise side orientation
  25491. */
  25492. static readonly CounterClockWiseSideOrientation: number;
  25493. /**
  25494. * The dirty texture flag value
  25495. */
  25496. static readonly TextureDirtyFlag: number;
  25497. /**
  25498. * The dirty light flag value
  25499. */
  25500. static readonly LightDirtyFlag: number;
  25501. /**
  25502. * The dirty fresnel flag value
  25503. */
  25504. static readonly FresnelDirtyFlag: number;
  25505. /**
  25506. * The dirty attribute flag value
  25507. */
  25508. static readonly AttributesDirtyFlag: number;
  25509. /**
  25510. * The dirty misc flag value
  25511. */
  25512. static readonly MiscDirtyFlag: number;
  25513. /**
  25514. * The all dirty flag value
  25515. */
  25516. static readonly AllDirtyFlag: number;
  25517. /**
  25518. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25519. */
  25520. static readonly MATERIAL_OPAQUE: number;
  25521. /**
  25522. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25523. */
  25524. static readonly MATERIAL_ALPHATEST: number;
  25525. /**
  25526. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25527. */
  25528. static readonly MATERIAL_ALPHABLEND: number;
  25529. /**
  25530. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25531. * They are also discarded below the alpha cutoff threshold to improve performances.
  25532. */
  25533. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25534. /**
  25535. * The Whiteout method is used to blend normals.
  25536. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25537. */
  25538. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25539. /**
  25540. * The Reoriented Normal Mapping method is used to blend normals.
  25541. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25542. */
  25543. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25544. /**
  25545. * Custom callback helping to override the default shader used in the material.
  25546. */
  25547. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25548. /**
  25549. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25550. */
  25551. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25552. /**
  25553. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25554. * This means that the material can keep using a previous shader while a new one is being compiled.
  25555. * This is mostly used when shader parallel compilation is supported (true by default)
  25556. */
  25557. allowShaderHotSwapping: boolean;
  25558. /**
  25559. * The ID of the material
  25560. */
  25561. id: string;
  25562. /**
  25563. * Gets or sets the unique id of the material
  25564. */
  25565. uniqueId: number;
  25566. /**
  25567. * The name of the material
  25568. */
  25569. name: string;
  25570. /**
  25571. * Gets or sets user defined metadata
  25572. */
  25573. metadata: any;
  25574. /**
  25575. * For internal use only. Please do not use.
  25576. */
  25577. reservedDataStore: any;
  25578. /**
  25579. * Specifies if the ready state should be checked on each call
  25580. */
  25581. checkReadyOnEveryCall: boolean;
  25582. /**
  25583. * Specifies if the ready state should be checked once
  25584. */
  25585. checkReadyOnlyOnce: boolean;
  25586. /**
  25587. * The state of the material
  25588. */
  25589. state: string;
  25590. /**
  25591. * If the material can be rendered to several textures with MRT extension
  25592. */
  25593. get canRenderToMRT(): boolean;
  25594. /**
  25595. * The alpha value of the material
  25596. */
  25597. protected _alpha: number;
  25598. /**
  25599. * List of inspectable custom properties (used by the Inspector)
  25600. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25601. */
  25602. inspectableCustomProperties: IInspectable[];
  25603. /**
  25604. * Sets the alpha value of the material
  25605. */
  25606. set alpha(value: number);
  25607. /**
  25608. * Gets the alpha value of the material
  25609. */
  25610. get alpha(): number;
  25611. /**
  25612. * Specifies if back face culling is enabled
  25613. */
  25614. protected _backFaceCulling: boolean;
  25615. /**
  25616. * Sets the back-face culling state
  25617. */
  25618. set backFaceCulling(value: boolean);
  25619. /**
  25620. * Gets the back-face culling state
  25621. */
  25622. get backFaceCulling(): boolean;
  25623. /**
  25624. * Stores the value for side orientation
  25625. */
  25626. sideOrientation: number;
  25627. /**
  25628. * Callback triggered when the material is compiled
  25629. */
  25630. onCompiled: Nullable<(effect: Effect) => void>;
  25631. /**
  25632. * Callback triggered when an error occurs
  25633. */
  25634. onError: Nullable<(effect: Effect, errors: string) => void>;
  25635. /**
  25636. * Callback triggered to get the render target textures
  25637. */
  25638. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25639. /**
  25640. * Gets a boolean indicating that current material needs to register RTT
  25641. */
  25642. get hasRenderTargetTextures(): boolean;
  25643. /**
  25644. * Specifies if the material should be serialized
  25645. */
  25646. doNotSerialize: boolean;
  25647. /**
  25648. * @hidden
  25649. */
  25650. _storeEffectOnSubMeshes: boolean;
  25651. /**
  25652. * Stores the animations for the material
  25653. */
  25654. animations: Nullable<Array<Animation>>;
  25655. /**
  25656. * An event triggered when the material is disposed
  25657. */
  25658. onDisposeObservable: Observable<Material>;
  25659. /**
  25660. * An observer which watches for dispose events
  25661. */
  25662. private _onDisposeObserver;
  25663. private _onUnBindObservable;
  25664. /**
  25665. * Called during a dispose event
  25666. */
  25667. set onDispose(callback: () => void);
  25668. private _onBindObservable;
  25669. /**
  25670. * An event triggered when the material is bound
  25671. */
  25672. get onBindObservable(): Observable<AbstractMesh>;
  25673. /**
  25674. * An observer which watches for bind events
  25675. */
  25676. private _onBindObserver;
  25677. /**
  25678. * Called during a bind event
  25679. */
  25680. set onBind(callback: (Mesh: AbstractMesh) => void);
  25681. /**
  25682. * An event triggered when the material is unbound
  25683. */
  25684. get onUnBindObservable(): Observable<Material>;
  25685. protected _onEffectCreatedObservable: Nullable<Observable<{
  25686. effect: Effect;
  25687. subMesh: Nullable<SubMesh>;
  25688. }>>;
  25689. /**
  25690. * An event triggered when the effect is (re)created
  25691. */
  25692. get onEffectCreatedObservable(): Observable<{
  25693. effect: Effect;
  25694. subMesh: Nullable<SubMesh>;
  25695. }>;
  25696. /**
  25697. * Stores the value of the alpha mode
  25698. */
  25699. private _alphaMode;
  25700. /**
  25701. * Sets the value of the alpha mode.
  25702. *
  25703. * | Value | Type | Description |
  25704. * | --- | --- | --- |
  25705. * | 0 | ALPHA_DISABLE | |
  25706. * | 1 | ALPHA_ADD | |
  25707. * | 2 | ALPHA_COMBINE | |
  25708. * | 3 | ALPHA_SUBTRACT | |
  25709. * | 4 | ALPHA_MULTIPLY | |
  25710. * | 5 | ALPHA_MAXIMIZED | |
  25711. * | 6 | ALPHA_ONEONE | |
  25712. * | 7 | ALPHA_PREMULTIPLIED | |
  25713. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25714. * | 9 | ALPHA_INTERPOLATE | |
  25715. * | 10 | ALPHA_SCREENMODE | |
  25716. *
  25717. */
  25718. set alphaMode(value: number);
  25719. /**
  25720. * Gets the value of the alpha mode
  25721. */
  25722. get alphaMode(): number;
  25723. /**
  25724. * Stores the state of the need depth pre-pass value
  25725. */
  25726. private _needDepthPrePass;
  25727. /**
  25728. * Sets the need depth pre-pass value
  25729. */
  25730. set needDepthPrePass(value: boolean);
  25731. /**
  25732. * Gets the depth pre-pass value
  25733. */
  25734. get needDepthPrePass(): boolean;
  25735. /**
  25736. * Specifies if depth writing should be disabled
  25737. */
  25738. disableDepthWrite: boolean;
  25739. /**
  25740. * Specifies if color writing should be disabled
  25741. */
  25742. disableColorWrite: boolean;
  25743. /**
  25744. * Specifies if depth writing should be forced
  25745. */
  25746. forceDepthWrite: boolean;
  25747. /**
  25748. * Specifies the depth function that should be used. 0 means the default engine function
  25749. */
  25750. depthFunction: number;
  25751. /**
  25752. * Specifies if there should be a separate pass for culling
  25753. */
  25754. separateCullingPass: boolean;
  25755. /**
  25756. * Stores the state specifing if fog should be enabled
  25757. */
  25758. private _fogEnabled;
  25759. /**
  25760. * Sets the state for enabling fog
  25761. */
  25762. set fogEnabled(value: boolean);
  25763. /**
  25764. * Gets the value of the fog enabled state
  25765. */
  25766. get fogEnabled(): boolean;
  25767. /**
  25768. * Stores the size of points
  25769. */
  25770. pointSize: number;
  25771. /**
  25772. * Stores the z offset value
  25773. */
  25774. zOffset: number;
  25775. get wireframe(): boolean;
  25776. /**
  25777. * Sets the state of wireframe mode
  25778. */
  25779. set wireframe(value: boolean);
  25780. /**
  25781. * Gets the value specifying if point clouds are enabled
  25782. */
  25783. get pointsCloud(): boolean;
  25784. /**
  25785. * Sets the state of point cloud mode
  25786. */
  25787. set pointsCloud(value: boolean);
  25788. /**
  25789. * Gets the material fill mode
  25790. */
  25791. get fillMode(): number;
  25792. /**
  25793. * Sets the material fill mode
  25794. */
  25795. set fillMode(value: number);
  25796. /**
  25797. * @hidden
  25798. * Stores the effects for the material
  25799. */
  25800. _effect: Nullable<Effect>;
  25801. /**
  25802. * Specifies if uniform buffers should be used
  25803. */
  25804. private _useUBO;
  25805. /**
  25806. * Stores a reference to the scene
  25807. */
  25808. private _scene;
  25809. /**
  25810. * Stores the fill mode state
  25811. */
  25812. private _fillMode;
  25813. /**
  25814. * Specifies if the depth write state should be cached
  25815. */
  25816. private _cachedDepthWriteState;
  25817. /**
  25818. * Specifies if the color write state should be cached
  25819. */
  25820. private _cachedColorWriteState;
  25821. /**
  25822. * Specifies if the depth function state should be cached
  25823. */
  25824. private _cachedDepthFunctionState;
  25825. /**
  25826. * Stores the uniform buffer
  25827. */
  25828. protected _uniformBuffer: UniformBuffer;
  25829. /** @hidden */
  25830. _indexInSceneMaterialArray: number;
  25831. /** @hidden */
  25832. meshMap: Nullable<{
  25833. [id: string]: AbstractMesh | undefined;
  25834. }>;
  25835. /**
  25836. * Creates a material instance
  25837. * @param name defines the name of the material
  25838. * @param scene defines the scene to reference
  25839. * @param doNotAdd specifies if the material should be added to the scene
  25840. */
  25841. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25842. /**
  25843. * Returns a string representation of the current material
  25844. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25845. * @returns a string with material information
  25846. */
  25847. toString(fullDetails?: boolean): string;
  25848. /**
  25849. * Gets the class name of the material
  25850. * @returns a string with the class name of the material
  25851. */
  25852. getClassName(): string;
  25853. /**
  25854. * Specifies if updates for the material been locked
  25855. */
  25856. get isFrozen(): boolean;
  25857. /**
  25858. * Locks updates for the material
  25859. */
  25860. freeze(): void;
  25861. /**
  25862. * Unlocks updates for the material
  25863. */
  25864. unfreeze(): void;
  25865. /**
  25866. * Specifies if the material is ready to be used
  25867. * @param mesh defines the mesh to check
  25868. * @param useInstances specifies if instances should be used
  25869. * @returns a boolean indicating if the material is ready to be used
  25870. */
  25871. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25872. /**
  25873. * Specifies that the submesh is ready to be used
  25874. * @param mesh defines the mesh to check
  25875. * @param subMesh defines which submesh to check
  25876. * @param useInstances specifies that instances should be used
  25877. * @returns a boolean indicating that the submesh is ready or not
  25878. */
  25879. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25880. /**
  25881. * Returns the material effect
  25882. * @returns the effect associated with the material
  25883. */
  25884. getEffect(): Nullable<Effect>;
  25885. /**
  25886. * Returns the current scene
  25887. * @returns a Scene
  25888. */
  25889. getScene(): Scene;
  25890. /**
  25891. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25892. */
  25893. protected _forceAlphaTest: boolean;
  25894. /**
  25895. * The transparency mode of the material.
  25896. */
  25897. protected _transparencyMode: Nullable<number>;
  25898. /**
  25899. * Gets the current transparency mode.
  25900. */
  25901. get transparencyMode(): Nullable<number>;
  25902. /**
  25903. * Sets the transparency mode of the material.
  25904. *
  25905. * | Value | Type | Description |
  25906. * | ----- | ----------------------------------- | ----------- |
  25907. * | 0 | OPAQUE | |
  25908. * | 1 | ALPHATEST | |
  25909. * | 2 | ALPHABLEND | |
  25910. * | 3 | ALPHATESTANDBLEND | |
  25911. *
  25912. */
  25913. set transparencyMode(value: Nullable<number>);
  25914. /**
  25915. * Returns true if alpha blending should be disabled.
  25916. */
  25917. protected get _disableAlphaBlending(): boolean;
  25918. /**
  25919. * Specifies whether or not this material should be rendered in alpha blend mode.
  25920. * @returns a boolean specifying if alpha blending is needed
  25921. */
  25922. needAlphaBlending(): boolean;
  25923. /**
  25924. * Specifies if the mesh will require alpha blending
  25925. * @param mesh defines the mesh to check
  25926. * @returns a boolean specifying if alpha blending is needed for the mesh
  25927. */
  25928. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25929. /**
  25930. * Specifies whether or not this material should be rendered in alpha test mode.
  25931. * @returns a boolean specifying if an alpha test is needed.
  25932. */
  25933. needAlphaTesting(): boolean;
  25934. /**
  25935. * Specifies if material alpha testing should be turned on for the mesh
  25936. * @param mesh defines the mesh to check
  25937. */
  25938. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25939. /**
  25940. * Gets the texture used for the alpha test
  25941. * @returns the texture to use for alpha testing
  25942. */
  25943. getAlphaTestTexture(): Nullable<BaseTexture>;
  25944. /**
  25945. * Marks the material to indicate that it needs to be re-calculated
  25946. */
  25947. markDirty(): void;
  25948. /** @hidden */
  25949. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25950. /**
  25951. * Binds the material to the mesh
  25952. * @param world defines the world transformation matrix
  25953. * @param mesh defines the mesh to bind the material to
  25954. */
  25955. bind(world: Matrix, mesh?: Mesh): void;
  25956. /**
  25957. * Binds the submesh to the material
  25958. * @param world defines the world transformation matrix
  25959. * @param mesh defines the mesh containing the submesh
  25960. * @param subMesh defines the submesh to bind the material to
  25961. */
  25962. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25963. /**
  25964. * Binds the world matrix to the material
  25965. * @param world defines the world transformation matrix
  25966. */
  25967. bindOnlyWorldMatrix(world: Matrix): void;
  25968. /**
  25969. * Binds the scene's uniform buffer to the effect.
  25970. * @param effect defines the effect to bind to the scene uniform buffer
  25971. * @param sceneUbo defines the uniform buffer storing scene data
  25972. */
  25973. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25974. /**
  25975. * Binds the view matrix to the effect
  25976. * @param effect defines the effect to bind the view matrix to
  25977. */
  25978. bindView(effect: Effect): void;
  25979. /**
  25980. * Binds the view projection matrix to the effect
  25981. * @param effect defines the effect to bind the view projection matrix to
  25982. */
  25983. bindViewProjection(effect: Effect): void;
  25984. /**
  25985. * Processes to execute after binding the material to a mesh
  25986. * @param mesh defines the rendered mesh
  25987. */
  25988. protected _afterBind(mesh?: Mesh): void;
  25989. /**
  25990. * Unbinds the material from the mesh
  25991. */
  25992. unbind(): void;
  25993. /**
  25994. * Gets the active textures from the material
  25995. * @returns an array of textures
  25996. */
  25997. getActiveTextures(): BaseTexture[];
  25998. /**
  25999. * Specifies if the material uses a texture
  26000. * @param texture defines the texture to check against the material
  26001. * @returns a boolean specifying if the material uses the texture
  26002. */
  26003. hasTexture(texture: BaseTexture): boolean;
  26004. /**
  26005. * Makes a duplicate of the material, and gives it a new name
  26006. * @param name defines the new name for the duplicated material
  26007. * @returns the cloned material
  26008. */
  26009. clone(name: string): Nullable<Material>;
  26010. /**
  26011. * Gets the meshes bound to the material
  26012. * @returns an array of meshes bound to the material
  26013. */
  26014. getBindedMeshes(): AbstractMesh[];
  26015. /**
  26016. * Force shader compilation
  26017. * @param mesh defines the mesh associated with this material
  26018. * @param onCompiled defines a function to execute once the material is compiled
  26019. * @param options defines the options to configure the compilation
  26020. * @param onError defines a function to execute if the material fails compiling
  26021. */
  26022. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26023. /**
  26024. * Force shader compilation
  26025. * @param mesh defines the mesh that will use this material
  26026. * @param options defines additional options for compiling the shaders
  26027. * @returns a promise that resolves when the compilation completes
  26028. */
  26029. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26030. private static readonly _AllDirtyCallBack;
  26031. private static readonly _ImageProcessingDirtyCallBack;
  26032. private static readonly _TextureDirtyCallBack;
  26033. private static readonly _FresnelDirtyCallBack;
  26034. private static readonly _MiscDirtyCallBack;
  26035. private static readonly _LightsDirtyCallBack;
  26036. private static readonly _AttributeDirtyCallBack;
  26037. private static _FresnelAndMiscDirtyCallBack;
  26038. private static _TextureAndMiscDirtyCallBack;
  26039. private static readonly _DirtyCallbackArray;
  26040. private static readonly _RunDirtyCallBacks;
  26041. /**
  26042. * Marks a define in the material to indicate that it needs to be re-computed
  26043. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26044. */
  26045. markAsDirty(flag: number): void;
  26046. /**
  26047. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26048. * @param func defines a function which checks material defines against the submeshes
  26049. */
  26050. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26051. /**
  26052. * Indicates that the scene should check if the rendering now needs a prepass
  26053. */
  26054. protected _markScenePrePassDirty(): void;
  26055. /**
  26056. * Indicates that we need to re-calculated for all submeshes
  26057. */
  26058. protected _markAllSubMeshesAsAllDirty(): void;
  26059. /**
  26060. * Indicates that image processing needs to be re-calculated for all submeshes
  26061. */
  26062. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26063. /**
  26064. * Indicates that textures need to be re-calculated for all submeshes
  26065. */
  26066. protected _markAllSubMeshesAsTexturesDirty(): void;
  26067. /**
  26068. * Indicates that fresnel needs to be re-calculated for all submeshes
  26069. */
  26070. protected _markAllSubMeshesAsFresnelDirty(): void;
  26071. /**
  26072. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26073. */
  26074. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26075. /**
  26076. * Indicates that lights need to be re-calculated for all submeshes
  26077. */
  26078. protected _markAllSubMeshesAsLightsDirty(): void;
  26079. /**
  26080. * Indicates that attributes need to be re-calculated for all submeshes
  26081. */
  26082. protected _markAllSubMeshesAsAttributesDirty(): void;
  26083. /**
  26084. * Indicates that misc needs to be re-calculated for all submeshes
  26085. */
  26086. protected _markAllSubMeshesAsMiscDirty(): void;
  26087. /**
  26088. * Indicates that textures and misc need to be re-calculated for all submeshes
  26089. */
  26090. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26091. /**
  26092. * Sets the required values to the prepass renderer.
  26093. * @param prePassRenderer defines the prepass renderer to setup.
  26094. * @returns true if the pre pass is needed.
  26095. */
  26096. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26097. /**
  26098. * Disposes the material
  26099. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26100. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26101. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26102. */
  26103. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26104. /** @hidden */
  26105. private releaseVertexArrayObject;
  26106. /**
  26107. * Serializes this material
  26108. * @returns the serialized material object
  26109. */
  26110. serialize(): any;
  26111. /**
  26112. * Creates a material from parsed material data
  26113. * @param parsedMaterial defines parsed material data
  26114. * @param scene defines the hosting scene
  26115. * @param rootUrl defines the root URL to use to load textures
  26116. * @returns a new material
  26117. */
  26118. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26119. }
  26120. }
  26121. declare module "babylonjs/Materials/multiMaterial" {
  26122. import { Nullable } from "babylonjs/types";
  26123. import { Scene } from "babylonjs/scene";
  26124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26125. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26126. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26127. import { Material } from "babylonjs/Materials/material";
  26128. /**
  26129. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26130. * separate meshes. This can be use to improve performances.
  26131. * @see https://doc.babylonjs.com/how_to/multi_materials
  26132. */
  26133. export class MultiMaterial extends Material {
  26134. private _subMaterials;
  26135. /**
  26136. * Gets or Sets the list of Materials used within the multi material.
  26137. * They need to be ordered according to the submeshes order in the associated mesh
  26138. */
  26139. get subMaterials(): Nullable<Material>[];
  26140. set subMaterials(value: Nullable<Material>[]);
  26141. /**
  26142. * Function used to align with Node.getChildren()
  26143. * @returns the list of Materials used within the multi material
  26144. */
  26145. getChildren(): Nullable<Material>[];
  26146. /**
  26147. * Instantiates a new Multi Material
  26148. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26149. * separate meshes. This can be use to improve performances.
  26150. * @see https://doc.babylonjs.com/how_to/multi_materials
  26151. * @param name Define the name in the scene
  26152. * @param scene Define the scene the material belongs to
  26153. */
  26154. constructor(name: string, scene: Scene);
  26155. private _hookArray;
  26156. /**
  26157. * Get one of the submaterial by its index in the submaterials array
  26158. * @param index The index to look the sub material at
  26159. * @returns The Material if the index has been defined
  26160. */
  26161. getSubMaterial(index: number): Nullable<Material>;
  26162. /**
  26163. * Get the list of active textures for the whole sub materials list.
  26164. * @returns All the textures that will be used during the rendering
  26165. */
  26166. getActiveTextures(): BaseTexture[];
  26167. /**
  26168. * Gets the current class name of the material e.g. "MultiMaterial"
  26169. * Mainly use in serialization.
  26170. * @returns the class name
  26171. */
  26172. getClassName(): string;
  26173. /**
  26174. * Checks if the material is ready to render the requested sub mesh
  26175. * @param mesh Define the mesh the submesh belongs to
  26176. * @param subMesh Define the sub mesh to look readyness for
  26177. * @param useInstances Define whether or not the material is used with instances
  26178. * @returns true if ready, otherwise false
  26179. */
  26180. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26181. /**
  26182. * Clones the current material and its related sub materials
  26183. * @param name Define the name of the newly cloned material
  26184. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26185. * @returns the cloned material
  26186. */
  26187. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26188. /**
  26189. * Serializes the materials into a JSON representation.
  26190. * @returns the JSON representation
  26191. */
  26192. serialize(): any;
  26193. /**
  26194. * Dispose the material and release its associated resources
  26195. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  26196. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  26197. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  26198. */
  26199. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26200. /**
  26201. * Creates a MultiMaterial from parsed MultiMaterial data.
  26202. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26203. * @param scene defines the hosting scene
  26204. * @returns a new MultiMaterial
  26205. */
  26206. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26207. }
  26208. }
  26209. declare module "babylonjs/Meshes/subMesh" {
  26210. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26211. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26212. import { Engine } from "babylonjs/Engines/engine";
  26213. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26214. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26215. import { Effect } from "babylonjs/Materials/effect";
  26216. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26217. import { Plane } from "babylonjs/Maths/math.plane";
  26218. import { Collider } from "babylonjs/Collisions/collider";
  26219. import { Material } from "babylonjs/Materials/material";
  26220. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26222. import { Mesh } from "babylonjs/Meshes/mesh";
  26223. import { Ray } from "babylonjs/Culling/ray";
  26224. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26225. /**
  26226. * Defines a subdivision inside a mesh
  26227. */
  26228. export class SubMesh implements ICullable {
  26229. /** the material index to use */
  26230. materialIndex: number;
  26231. /** vertex index start */
  26232. verticesStart: number;
  26233. /** vertices count */
  26234. verticesCount: number;
  26235. /** index start */
  26236. indexStart: number;
  26237. /** indices count */
  26238. indexCount: number;
  26239. /** @hidden */
  26240. _materialDefines: Nullable<MaterialDefines>;
  26241. /** @hidden */
  26242. _materialEffect: Nullable<Effect>;
  26243. /** @hidden */
  26244. _effectOverride: Nullable<Effect>;
  26245. /**
  26246. * Gets material defines used by the effect associated to the sub mesh
  26247. */
  26248. get materialDefines(): Nullable<MaterialDefines>;
  26249. /**
  26250. * Sets material defines used by the effect associated to the sub mesh
  26251. */
  26252. set materialDefines(defines: Nullable<MaterialDefines>);
  26253. /**
  26254. * Gets associated effect
  26255. */
  26256. get effect(): Nullable<Effect>;
  26257. /**
  26258. * Sets associated effect (effect used to render this submesh)
  26259. * @param effect defines the effect to associate with
  26260. * @param defines defines the set of defines used to compile this effect
  26261. */
  26262. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26263. /** @hidden */
  26264. _linesIndexCount: number;
  26265. private _mesh;
  26266. private _renderingMesh;
  26267. private _boundingInfo;
  26268. private _linesIndexBuffer;
  26269. /** @hidden */
  26270. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26271. /** @hidden */
  26272. _trianglePlanes: Plane[];
  26273. /** @hidden */
  26274. _lastColliderTransformMatrix: Nullable<Matrix>;
  26275. /** @hidden */
  26276. _renderId: number;
  26277. /** @hidden */
  26278. _alphaIndex: number;
  26279. /** @hidden */
  26280. _distanceToCamera: number;
  26281. /** @hidden */
  26282. _id: number;
  26283. private _currentMaterial;
  26284. /**
  26285. * Add a new submesh to a mesh
  26286. * @param materialIndex defines the material index to use
  26287. * @param verticesStart defines vertex index start
  26288. * @param verticesCount defines vertices count
  26289. * @param indexStart defines index start
  26290. * @param indexCount defines indices count
  26291. * @param mesh defines the parent mesh
  26292. * @param renderingMesh defines an optional rendering mesh
  26293. * @param createBoundingBox defines if bounding box should be created for this submesh
  26294. * @returns the new submesh
  26295. */
  26296. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26297. /**
  26298. * Creates a new submesh
  26299. * @param materialIndex defines the material index to use
  26300. * @param verticesStart defines vertex index start
  26301. * @param verticesCount defines vertices count
  26302. * @param indexStart defines index start
  26303. * @param indexCount defines indices count
  26304. * @param mesh defines the parent mesh
  26305. * @param renderingMesh defines an optional rendering mesh
  26306. * @param createBoundingBox defines if bounding box should be created for this submesh
  26307. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26308. */
  26309. constructor(
  26310. /** the material index to use */
  26311. materialIndex: number,
  26312. /** vertex index start */
  26313. verticesStart: number,
  26314. /** vertices count */
  26315. verticesCount: number,
  26316. /** index start */
  26317. indexStart: number,
  26318. /** indices count */
  26319. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26320. /**
  26321. * Returns true if this submesh covers the entire parent mesh
  26322. * @ignorenaming
  26323. */
  26324. get IsGlobal(): boolean;
  26325. /**
  26326. * Returns the submesh BoudingInfo object
  26327. * @returns current bounding info (or mesh's one if the submesh is global)
  26328. */
  26329. getBoundingInfo(): BoundingInfo;
  26330. /**
  26331. * Sets the submesh BoundingInfo
  26332. * @param boundingInfo defines the new bounding info to use
  26333. * @returns the SubMesh
  26334. */
  26335. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26336. /**
  26337. * Returns the mesh of the current submesh
  26338. * @return the parent mesh
  26339. */
  26340. getMesh(): AbstractMesh;
  26341. /**
  26342. * Returns the rendering mesh of the submesh
  26343. * @returns the rendering mesh (could be different from parent mesh)
  26344. */
  26345. getRenderingMesh(): Mesh;
  26346. /**
  26347. * Returns the replacement mesh of the submesh
  26348. * @returns the replacement mesh (could be different from parent mesh)
  26349. */
  26350. getReplacementMesh(): Nullable<AbstractMesh>;
  26351. /**
  26352. * Returns the effective mesh of the submesh
  26353. * @returns the effective mesh (could be different from parent mesh)
  26354. */
  26355. getEffectiveMesh(): AbstractMesh;
  26356. /**
  26357. * Returns the submesh material
  26358. * @returns null or the current material
  26359. */
  26360. getMaterial(): Nullable<Material>;
  26361. private _IsMultiMaterial;
  26362. /**
  26363. * Sets a new updated BoundingInfo object to the submesh
  26364. * @param data defines an optional position array to use to determine the bounding info
  26365. * @returns the SubMesh
  26366. */
  26367. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26368. /** @hidden */
  26369. _checkCollision(collider: Collider): boolean;
  26370. /**
  26371. * Updates the submesh BoundingInfo
  26372. * @param world defines the world matrix to use to update the bounding info
  26373. * @returns the submesh
  26374. */
  26375. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26376. /**
  26377. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26378. * @param frustumPlanes defines the frustum planes
  26379. * @returns true if the submesh is intersecting with the frustum
  26380. */
  26381. isInFrustum(frustumPlanes: Plane[]): boolean;
  26382. /**
  26383. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26384. * @param frustumPlanes defines the frustum planes
  26385. * @returns true if the submesh is inside the frustum
  26386. */
  26387. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26388. /**
  26389. * Renders the submesh
  26390. * @param enableAlphaMode defines if alpha needs to be used
  26391. * @returns the submesh
  26392. */
  26393. render(enableAlphaMode: boolean): SubMesh;
  26394. /**
  26395. * @hidden
  26396. */
  26397. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26398. /**
  26399. * Checks if the submesh intersects with a ray
  26400. * @param ray defines the ray to test
  26401. * @returns true is the passed ray intersects the submesh bounding box
  26402. */
  26403. canIntersects(ray: Ray): boolean;
  26404. /**
  26405. * Intersects current submesh with a ray
  26406. * @param ray defines the ray to test
  26407. * @param positions defines mesh's positions array
  26408. * @param indices defines mesh's indices array
  26409. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26410. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26411. * @returns intersection info or null if no intersection
  26412. */
  26413. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26414. /** @hidden */
  26415. private _intersectLines;
  26416. /** @hidden */
  26417. private _intersectUnIndexedLines;
  26418. /** @hidden */
  26419. private _intersectTriangles;
  26420. /** @hidden */
  26421. private _intersectUnIndexedTriangles;
  26422. /** @hidden */
  26423. _rebuild(): void;
  26424. /**
  26425. * Creates a new submesh from the passed mesh
  26426. * @param newMesh defines the new hosting mesh
  26427. * @param newRenderingMesh defines an optional rendering mesh
  26428. * @returns the new submesh
  26429. */
  26430. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26431. /**
  26432. * Release associated resources
  26433. */
  26434. dispose(): void;
  26435. /**
  26436. * Gets the class name
  26437. * @returns the string "SubMesh".
  26438. */
  26439. getClassName(): string;
  26440. /**
  26441. * Creates a new submesh from indices data
  26442. * @param materialIndex the index of the main mesh material
  26443. * @param startIndex the index where to start the copy in the mesh indices array
  26444. * @param indexCount the number of indices to copy then from the startIndex
  26445. * @param mesh the main mesh to create the submesh from
  26446. * @param renderingMesh the optional rendering mesh
  26447. * @returns a new submesh
  26448. */
  26449. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26450. }
  26451. }
  26452. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26453. /**
  26454. * Class used to represent data loading progression
  26455. */
  26456. export class SceneLoaderFlags {
  26457. private static _ForceFullSceneLoadingForIncremental;
  26458. private static _ShowLoadingScreen;
  26459. private static _CleanBoneMatrixWeights;
  26460. private static _loggingLevel;
  26461. /**
  26462. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26463. */
  26464. static get ForceFullSceneLoadingForIncremental(): boolean;
  26465. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26466. /**
  26467. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26468. */
  26469. static get ShowLoadingScreen(): boolean;
  26470. static set ShowLoadingScreen(value: boolean);
  26471. /**
  26472. * Defines the current logging level (while loading the scene)
  26473. * @ignorenaming
  26474. */
  26475. static get loggingLevel(): number;
  26476. static set loggingLevel(value: number);
  26477. /**
  26478. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26479. */
  26480. static get CleanBoneMatrixWeights(): boolean;
  26481. static set CleanBoneMatrixWeights(value: boolean);
  26482. }
  26483. }
  26484. declare module "babylonjs/Meshes/geometry" {
  26485. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26486. import { Scene } from "babylonjs/scene";
  26487. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26488. import { Engine } from "babylonjs/Engines/engine";
  26489. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26490. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26491. import { Effect } from "babylonjs/Materials/effect";
  26492. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26493. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26494. import { Mesh } from "babylonjs/Meshes/mesh";
  26495. /**
  26496. * Class used to store geometry data (vertex buffers + index buffer)
  26497. */
  26498. export class Geometry implements IGetSetVerticesData {
  26499. /**
  26500. * Gets or sets the ID of the geometry
  26501. */
  26502. id: string;
  26503. /**
  26504. * Gets or sets the unique ID of the geometry
  26505. */
  26506. uniqueId: number;
  26507. /**
  26508. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26509. */
  26510. delayLoadState: number;
  26511. /**
  26512. * Gets the file containing the data to load when running in delay load state
  26513. */
  26514. delayLoadingFile: Nullable<string>;
  26515. /**
  26516. * Callback called when the geometry is updated
  26517. */
  26518. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26519. private _scene;
  26520. private _engine;
  26521. private _meshes;
  26522. private _totalVertices;
  26523. /** @hidden */
  26524. _indices: IndicesArray;
  26525. /** @hidden */
  26526. _vertexBuffers: {
  26527. [key: string]: VertexBuffer;
  26528. };
  26529. private _isDisposed;
  26530. private _extend;
  26531. private _boundingBias;
  26532. /** @hidden */
  26533. _delayInfo: Array<string>;
  26534. private _indexBuffer;
  26535. private _indexBufferIsUpdatable;
  26536. /** @hidden */
  26537. _boundingInfo: Nullable<BoundingInfo>;
  26538. /** @hidden */
  26539. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26540. /** @hidden */
  26541. _softwareSkinningFrameId: number;
  26542. private _vertexArrayObjects;
  26543. private _updatable;
  26544. /** @hidden */
  26545. _positions: Nullable<Vector3[]>;
  26546. /**
  26547. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26548. */
  26549. get boundingBias(): Vector2;
  26550. /**
  26551. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26552. */
  26553. set boundingBias(value: Vector2);
  26554. /**
  26555. * Static function used to attach a new empty geometry to a mesh
  26556. * @param mesh defines the mesh to attach the geometry to
  26557. * @returns the new Geometry
  26558. */
  26559. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26560. /** Get the list of meshes using this geometry */
  26561. get meshes(): Mesh[];
  26562. /**
  26563. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  26564. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26565. */
  26566. useBoundingInfoFromGeometry: boolean;
  26567. /**
  26568. * Creates a new geometry
  26569. * @param id defines the unique ID
  26570. * @param scene defines the hosting scene
  26571. * @param vertexData defines the VertexData used to get geometry data
  26572. * @param updatable defines if geometry must be updatable (false by default)
  26573. * @param mesh defines the mesh that will be associated with the geometry
  26574. */
  26575. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26576. /**
  26577. * Gets the current extend of the geometry
  26578. */
  26579. get extend(): {
  26580. minimum: Vector3;
  26581. maximum: Vector3;
  26582. };
  26583. /**
  26584. * Gets the hosting scene
  26585. * @returns the hosting Scene
  26586. */
  26587. getScene(): Scene;
  26588. /**
  26589. * Gets the hosting engine
  26590. * @returns the hosting Engine
  26591. */
  26592. getEngine(): Engine;
  26593. /**
  26594. * Defines if the geometry is ready to use
  26595. * @returns true if the geometry is ready to be used
  26596. */
  26597. isReady(): boolean;
  26598. /**
  26599. * Gets a value indicating that the geometry should not be serialized
  26600. */
  26601. get doNotSerialize(): boolean;
  26602. /** @hidden */
  26603. _rebuild(): void;
  26604. /**
  26605. * Affects all geometry data in one call
  26606. * @param vertexData defines the geometry data
  26607. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26608. */
  26609. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26610. /**
  26611. * Set specific vertex data
  26612. * @param kind defines the data kind (Position, normal, etc...)
  26613. * @param data defines the vertex data to use
  26614. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26615. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26616. */
  26617. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26618. /**
  26619. * Removes a specific vertex data
  26620. * @param kind defines the data kind (Position, normal, etc...)
  26621. */
  26622. removeVerticesData(kind: string): void;
  26623. /**
  26624. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26625. * @param buffer defines the vertex buffer to use
  26626. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26627. */
  26628. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26629. /**
  26630. * Update a specific vertex buffer
  26631. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26632. * It will do nothing if the buffer is not updatable
  26633. * @param kind defines the data kind (Position, normal, etc...)
  26634. * @param data defines the data to use
  26635. * @param offset defines the offset in the target buffer where to store the data
  26636. * @param useBytes set to true if the offset is in bytes
  26637. */
  26638. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26639. /**
  26640. * Update a specific vertex buffer
  26641. * This function will create a new buffer if the current one is not updatable
  26642. * @param kind defines the data kind (Position, normal, etc...)
  26643. * @param data defines the data to use
  26644. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26645. */
  26646. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26647. private _updateBoundingInfo;
  26648. /** @hidden */
  26649. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26650. /**
  26651. * Gets total number of vertices
  26652. * @returns the total number of vertices
  26653. */
  26654. getTotalVertices(): number;
  26655. /**
  26656. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26657. * @param kind defines the data kind (Position, normal, etc...)
  26658. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26659. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26660. * @returns a float array containing vertex data
  26661. */
  26662. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26663. /**
  26664. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26665. * @param kind defines the data kind (Position, normal, etc...)
  26666. * @returns true if the vertex buffer with the specified kind is updatable
  26667. */
  26668. isVertexBufferUpdatable(kind: string): boolean;
  26669. /**
  26670. * Gets a specific vertex buffer
  26671. * @param kind defines the data kind (Position, normal, etc...)
  26672. * @returns a VertexBuffer
  26673. */
  26674. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26675. /**
  26676. * Returns all vertex buffers
  26677. * @return an object holding all vertex buffers indexed by kind
  26678. */
  26679. getVertexBuffers(): Nullable<{
  26680. [key: string]: VertexBuffer;
  26681. }>;
  26682. /**
  26683. * Gets a boolean indicating if specific vertex buffer is present
  26684. * @param kind defines the data kind (Position, normal, etc...)
  26685. * @returns true if data is present
  26686. */
  26687. isVerticesDataPresent(kind: string): boolean;
  26688. /**
  26689. * Gets a list of all attached data kinds (Position, normal, etc...)
  26690. * @returns a list of string containing all kinds
  26691. */
  26692. getVerticesDataKinds(): string[];
  26693. /**
  26694. * Update index buffer
  26695. * @param indices defines the indices to store in the index buffer
  26696. * @param offset defines the offset in the target buffer where to store the data
  26697. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  26698. */
  26699. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26700. /**
  26701. * Creates a new index buffer
  26702. * @param indices defines the indices to store in the index buffer
  26703. * @param totalVertices defines the total number of vertices (could be null)
  26704. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26705. */
  26706. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26707. /**
  26708. * Return the total number of indices
  26709. * @returns the total number of indices
  26710. */
  26711. getTotalIndices(): number;
  26712. /**
  26713. * Gets the index buffer array
  26714. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26715. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26716. * @returns the index buffer array
  26717. */
  26718. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26719. /**
  26720. * Gets the index buffer
  26721. * @return the index buffer
  26722. */
  26723. getIndexBuffer(): Nullable<DataBuffer>;
  26724. /** @hidden */
  26725. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26726. /**
  26727. * Release the associated resources for a specific mesh
  26728. * @param mesh defines the source mesh
  26729. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26730. */
  26731. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26732. /**
  26733. * Apply current geometry to a given mesh
  26734. * @param mesh defines the mesh to apply geometry to
  26735. */
  26736. applyToMesh(mesh: Mesh): void;
  26737. private _updateExtend;
  26738. private _applyToMesh;
  26739. private notifyUpdate;
  26740. /**
  26741. * Load the geometry if it was flagged as delay loaded
  26742. * @param scene defines the hosting scene
  26743. * @param onLoaded defines a callback called when the geometry is loaded
  26744. */
  26745. load(scene: Scene, onLoaded?: () => void): void;
  26746. private _queueLoad;
  26747. /**
  26748. * Invert the geometry to move from a right handed system to a left handed one.
  26749. */
  26750. toLeftHanded(): void;
  26751. /** @hidden */
  26752. _resetPointsArrayCache(): void;
  26753. /** @hidden */
  26754. _generatePointsArray(): boolean;
  26755. /**
  26756. * Gets a value indicating if the geometry is disposed
  26757. * @returns true if the geometry was disposed
  26758. */
  26759. isDisposed(): boolean;
  26760. private _disposeVertexArrayObjects;
  26761. /**
  26762. * Free all associated resources
  26763. */
  26764. dispose(): void;
  26765. /**
  26766. * Clone the current geometry into a new geometry
  26767. * @param id defines the unique ID of the new geometry
  26768. * @returns a new geometry object
  26769. */
  26770. copy(id: string): Geometry;
  26771. /**
  26772. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26773. * @return a JSON representation of the current geometry data (without the vertices data)
  26774. */
  26775. serialize(): any;
  26776. private toNumberArray;
  26777. /**
  26778. * Serialize all vertices data into a JSON oject
  26779. * @returns a JSON representation of the current geometry data
  26780. */
  26781. serializeVerticeData(): any;
  26782. /**
  26783. * Extracts a clone of a mesh geometry
  26784. * @param mesh defines the source mesh
  26785. * @param id defines the unique ID of the new geometry object
  26786. * @returns the new geometry object
  26787. */
  26788. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26789. /**
  26790. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26791. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26792. * Be aware Math.random() could cause collisions, but:
  26793. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  26794. * @returns a string containing a new GUID
  26795. */
  26796. static RandomId(): string;
  26797. /** @hidden */
  26798. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26799. private static _CleanMatricesWeights;
  26800. /**
  26801. * Create a new geometry from persisted data (Using .babylon file format)
  26802. * @param parsedVertexData defines the persisted data
  26803. * @param scene defines the hosting scene
  26804. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26805. * @returns the new geometry object
  26806. */
  26807. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26808. }
  26809. }
  26810. declare module "babylonjs/Meshes/mesh.vertexData" {
  26811. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26812. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26813. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26814. import { Geometry } from "babylonjs/Meshes/geometry";
  26815. import { Mesh } from "babylonjs/Meshes/mesh";
  26816. /**
  26817. * Define an interface for all classes that will get and set the data on vertices
  26818. */
  26819. export interface IGetSetVerticesData {
  26820. /**
  26821. * Gets a boolean indicating if specific vertex data is present
  26822. * @param kind defines the vertex data kind to use
  26823. * @returns true is data kind is present
  26824. */
  26825. isVerticesDataPresent(kind: string): boolean;
  26826. /**
  26827. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26828. * @param kind defines the data kind (Position, normal, etc...)
  26829. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26830. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26831. * @returns a float array containing vertex data
  26832. */
  26833. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26834. /**
  26835. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26836. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  26837. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26838. * @returns the indices array or an empty array if the mesh has no geometry
  26839. */
  26840. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26841. /**
  26842. * Set specific vertex data
  26843. * @param kind defines the data kind (Position, normal, etc...)
  26844. * @param data defines the vertex data to use
  26845. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26846. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26847. */
  26848. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26849. /**
  26850. * Update a specific associated vertex buffer
  26851. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26852. * - VertexBuffer.PositionKind
  26853. * - VertexBuffer.UVKind
  26854. * - VertexBuffer.UV2Kind
  26855. * - VertexBuffer.UV3Kind
  26856. * - VertexBuffer.UV4Kind
  26857. * - VertexBuffer.UV5Kind
  26858. * - VertexBuffer.UV6Kind
  26859. * - VertexBuffer.ColorKind
  26860. * - VertexBuffer.MatricesIndicesKind
  26861. * - VertexBuffer.MatricesIndicesExtraKind
  26862. * - VertexBuffer.MatricesWeightsKind
  26863. * - VertexBuffer.MatricesWeightsExtraKind
  26864. * @param data defines the data source
  26865. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26866. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  26867. */
  26868. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26869. /**
  26870. * Creates a new index buffer
  26871. * @param indices defines the indices to store in the index buffer
  26872. * @param totalVertices defines the total number of vertices (could be null)
  26873. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26874. */
  26875. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26876. }
  26877. /**
  26878. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26879. */
  26880. export class VertexData {
  26881. /**
  26882. * Mesh side orientation : usually the external or front surface
  26883. */
  26884. static readonly FRONTSIDE: number;
  26885. /**
  26886. * Mesh side orientation : usually the internal or back surface
  26887. */
  26888. static readonly BACKSIDE: number;
  26889. /**
  26890. * Mesh side orientation : both internal and external or front and back surfaces
  26891. */
  26892. static readonly DOUBLESIDE: number;
  26893. /**
  26894. * Mesh side orientation : by default, `FRONTSIDE`
  26895. */
  26896. static readonly DEFAULTSIDE: number;
  26897. /**
  26898. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26899. */
  26900. positions: Nullable<FloatArray>;
  26901. /**
  26902. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26903. */
  26904. normals: Nullable<FloatArray>;
  26905. /**
  26906. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26907. */
  26908. tangents: Nullable<FloatArray>;
  26909. /**
  26910. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26911. */
  26912. uvs: Nullable<FloatArray>;
  26913. /**
  26914. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26915. */
  26916. uvs2: Nullable<FloatArray>;
  26917. /**
  26918. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26919. */
  26920. uvs3: Nullable<FloatArray>;
  26921. /**
  26922. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26923. */
  26924. uvs4: Nullable<FloatArray>;
  26925. /**
  26926. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26927. */
  26928. uvs5: Nullable<FloatArray>;
  26929. /**
  26930. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26931. */
  26932. uvs6: Nullable<FloatArray>;
  26933. /**
  26934. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26935. */
  26936. colors: Nullable<FloatArray>;
  26937. /**
  26938. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  26939. */
  26940. matricesIndices: Nullable<FloatArray>;
  26941. /**
  26942. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26943. */
  26944. matricesWeights: Nullable<FloatArray>;
  26945. /**
  26946. * An array extending the number of possible indices
  26947. */
  26948. matricesIndicesExtra: Nullable<FloatArray>;
  26949. /**
  26950. * An array extending the number of possible weights when the number of indices is extended
  26951. */
  26952. matricesWeightsExtra: Nullable<FloatArray>;
  26953. /**
  26954. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26955. */
  26956. indices: Nullable<IndicesArray>;
  26957. /**
  26958. * Uses the passed data array to set the set the values for the specified kind of data
  26959. * @param data a linear array of floating numbers
  26960. * @param kind the type of data that is being set, eg positions, colors etc
  26961. */
  26962. set(data: FloatArray, kind: string): void;
  26963. /**
  26964. * Associates the vertexData to the passed Mesh.
  26965. * Sets it as updatable or not (default `false`)
  26966. * @param mesh the mesh the vertexData is applied to
  26967. * @param updatable when used and having the value true allows new data to update the vertexData
  26968. * @returns the VertexData
  26969. */
  26970. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26971. /**
  26972. * Associates the vertexData to the passed Geometry.
  26973. * Sets it as updatable or not (default `false`)
  26974. * @param geometry the geometry the vertexData is applied to
  26975. * @param updatable when used and having the value true allows new data to update the vertexData
  26976. * @returns VertexData
  26977. */
  26978. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26979. /**
  26980. * Updates the associated mesh
  26981. * @param mesh the mesh to be updated
  26982. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26983. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26984. * @returns VertexData
  26985. */
  26986. updateMesh(mesh: Mesh): VertexData;
  26987. /**
  26988. * Updates the associated geometry
  26989. * @param geometry the geometry to be updated
  26990. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26991. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26992. * @returns VertexData.
  26993. */
  26994. updateGeometry(geometry: Geometry): VertexData;
  26995. private _applyTo;
  26996. private _update;
  26997. /**
  26998. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26999. * @param matrix the transforming matrix
  27000. * @returns the VertexData
  27001. */
  27002. transform(matrix: Matrix): VertexData;
  27003. /**
  27004. * Merges the passed VertexData into the current one
  27005. * @param other the VertexData to be merged into the current one
  27006. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27007. * @returns the modified VertexData
  27008. */
  27009. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27010. private _mergeElement;
  27011. private _validate;
  27012. /**
  27013. * Serializes the VertexData
  27014. * @returns a serialized object
  27015. */
  27016. serialize(): any;
  27017. /**
  27018. * Extracts the vertexData from a mesh
  27019. * @param mesh the mesh from which to extract the VertexData
  27020. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27021. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27022. * @returns the object VertexData associated to the passed mesh
  27023. */
  27024. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27025. /**
  27026. * Extracts the vertexData from the geometry
  27027. * @param geometry the geometry from which to extract the VertexData
  27028. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27029. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27030. * @returns the object VertexData associated to the passed mesh
  27031. */
  27032. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27033. private static _ExtractFrom;
  27034. /**
  27035. * Creates the VertexData for a Ribbon
  27036. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27037. * * pathArray array of paths, each of which an array of successive Vector3
  27038. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27039. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27040. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  27041. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27042. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27043. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27044. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27045. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27046. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27047. * @returns the VertexData of the ribbon
  27048. */
  27049. static CreateRibbon(options: {
  27050. pathArray: Vector3[][];
  27051. closeArray?: boolean;
  27052. closePath?: boolean;
  27053. offset?: number;
  27054. sideOrientation?: number;
  27055. frontUVs?: Vector4;
  27056. backUVs?: Vector4;
  27057. invertUV?: boolean;
  27058. uvs?: Vector2[];
  27059. colors?: Color4[];
  27060. }): VertexData;
  27061. /**
  27062. * Creates the VertexData for a box
  27063. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27064. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27065. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27066. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27067. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27068. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27069. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27070. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27071. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27072. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27073. * @returns the VertexData of the box
  27074. */
  27075. static CreateBox(options: {
  27076. size?: number;
  27077. width?: number;
  27078. height?: number;
  27079. depth?: number;
  27080. faceUV?: Vector4[];
  27081. faceColors?: Color4[];
  27082. sideOrientation?: number;
  27083. frontUVs?: Vector4;
  27084. backUVs?: Vector4;
  27085. }): VertexData;
  27086. /**
  27087. * Creates the VertexData for a tiled box
  27088. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27089. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27090. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27091. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27092. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27093. * @returns the VertexData of the box
  27094. */
  27095. static CreateTiledBox(options: {
  27096. pattern?: number;
  27097. width?: number;
  27098. height?: number;
  27099. depth?: number;
  27100. tileSize?: number;
  27101. tileWidth?: number;
  27102. tileHeight?: number;
  27103. alignHorizontal?: number;
  27104. alignVertical?: number;
  27105. faceUV?: Vector4[];
  27106. faceColors?: Color4[];
  27107. sideOrientation?: number;
  27108. }): VertexData;
  27109. /**
  27110. * Creates the VertexData for a tiled plane
  27111. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27112. * * pattern a limited pattern arrangement depending on the number
  27113. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27114. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27115. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27116. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27117. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27118. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27119. * @returns the VertexData of the tiled plane
  27120. */
  27121. static CreateTiledPlane(options: {
  27122. pattern?: number;
  27123. tileSize?: number;
  27124. tileWidth?: number;
  27125. tileHeight?: number;
  27126. size?: number;
  27127. width?: number;
  27128. height?: number;
  27129. alignHorizontal?: number;
  27130. alignVertical?: number;
  27131. sideOrientation?: number;
  27132. frontUVs?: Vector4;
  27133. backUVs?: Vector4;
  27134. }): VertexData;
  27135. /**
  27136. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27137. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27138. * * segments sets the number of horizontal strips optional, default 32
  27139. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27140. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27141. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27142. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27143. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  27144. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  27145. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27146. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27147. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27148. * @returns the VertexData of the ellipsoid
  27149. */
  27150. static CreateSphere(options: {
  27151. segments?: number;
  27152. diameter?: number;
  27153. diameterX?: number;
  27154. diameterY?: number;
  27155. diameterZ?: number;
  27156. arc?: number;
  27157. slice?: number;
  27158. sideOrientation?: number;
  27159. frontUVs?: Vector4;
  27160. backUVs?: Vector4;
  27161. }): VertexData;
  27162. /**
  27163. * Creates the VertexData for a cylinder, cone or prism
  27164. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27165. * * height sets the height (y direction) of the cylinder, optional, default 2
  27166. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27167. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27168. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27169. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27170. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27171. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  27172. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27173. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27174. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27175. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27176. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27177. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27178. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27179. * @returns the VertexData of the cylinder, cone or prism
  27180. */
  27181. static CreateCylinder(options: {
  27182. height?: number;
  27183. diameterTop?: number;
  27184. diameterBottom?: number;
  27185. diameter?: number;
  27186. tessellation?: number;
  27187. subdivisions?: number;
  27188. arc?: number;
  27189. faceColors?: Color4[];
  27190. faceUV?: Vector4[];
  27191. hasRings?: boolean;
  27192. enclose?: boolean;
  27193. sideOrientation?: number;
  27194. frontUVs?: Vector4;
  27195. backUVs?: Vector4;
  27196. }): VertexData;
  27197. /**
  27198. * Creates the VertexData for a torus
  27199. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27200. * * diameter the diameter of the torus, optional default 1
  27201. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27202. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27203. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27204. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27205. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27206. * @returns the VertexData of the torus
  27207. */
  27208. static CreateTorus(options: {
  27209. diameter?: number;
  27210. thickness?: number;
  27211. tessellation?: number;
  27212. sideOrientation?: number;
  27213. frontUVs?: Vector4;
  27214. backUVs?: Vector4;
  27215. }): VertexData;
  27216. /**
  27217. * Creates the VertexData of the LineSystem
  27218. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27219. * - lines an array of lines, each line being an array of successive Vector3
  27220. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27221. * @returns the VertexData of the LineSystem
  27222. */
  27223. static CreateLineSystem(options: {
  27224. lines: Vector3[][];
  27225. colors?: Nullable<Color4[][]>;
  27226. }): VertexData;
  27227. /**
  27228. * Create the VertexData for a DashedLines
  27229. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27230. * - points an array successive Vector3
  27231. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27232. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27233. * - dashNb the intended total number of dashes, optional, default 200
  27234. * @returns the VertexData for the DashedLines
  27235. */
  27236. static CreateDashedLines(options: {
  27237. points: Vector3[];
  27238. dashSize?: number;
  27239. gapSize?: number;
  27240. dashNb?: number;
  27241. }): VertexData;
  27242. /**
  27243. * Creates the VertexData for a Ground
  27244. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27245. * - width the width (x direction) of the ground, optional, default 1
  27246. * - height the height (z direction) of the ground, optional, default 1
  27247. * - subdivisions the number of subdivisions per side, optional, default 1
  27248. * @returns the VertexData of the Ground
  27249. */
  27250. static CreateGround(options: {
  27251. width?: number;
  27252. height?: number;
  27253. subdivisions?: number;
  27254. subdivisionsX?: number;
  27255. subdivisionsY?: number;
  27256. }): VertexData;
  27257. /**
  27258. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27259. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27260. * * xmin the ground minimum X coordinate, optional, default -1
  27261. * * zmin the ground minimum Z coordinate, optional, default -1
  27262. * * xmax the ground maximum X coordinate, optional, default 1
  27263. * * zmax the ground maximum Z coordinate, optional, default 1
  27264. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  27265. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  27266. * @returns the VertexData of the TiledGround
  27267. */
  27268. static CreateTiledGround(options: {
  27269. xmin: number;
  27270. zmin: number;
  27271. xmax: number;
  27272. zmax: number;
  27273. subdivisions?: {
  27274. w: number;
  27275. h: number;
  27276. };
  27277. precision?: {
  27278. w: number;
  27279. h: number;
  27280. };
  27281. }): VertexData;
  27282. /**
  27283. * Creates the VertexData of the Ground designed from a heightmap
  27284. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27285. * * width the width (x direction) of the ground
  27286. * * height the height (z direction) of the ground
  27287. * * subdivisions the number of subdivisions per side
  27288. * * minHeight the minimum altitude on the ground, optional, default 0
  27289. * * maxHeight the maximum altitude on the ground, optional default 1
  27290. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27291. * * buffer the array holding the image color data
  27292. * * bufferWidth the width of image
  27293. * * bufferHeight the height of image
  27294. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27295. * @returns the VertexData of the Ground designed from a heightmap
  27296. */
  27297. static CreateGroundFromHeightMap(options: {
  27298. width: number;
  27299. height: number;
  27300. subdivisions: number;
  27301. minHeight: number;
  27302. maxHeight: number;
  27303. colorFilter: Color3;
  27304. buffer: Uint8Array;
  27305. bufferWidth: number;
  27306. bufferHeight: number;
  27307. alphaFilter: number;
  27308. }): VertexData;
  27309. /**
  27310. * Creates the VertexData for a Plane
  27311. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27312. * * size sets the width and height of the plane to the value of size, optional default 1
  27313. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27314. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27315. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27316. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27317. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27318. * @returns the VertexData of the box
  27319. */
  27320. static CreatePlane(options: {
  27321. size?: number;
  27322. width?: number;
  27323. height?: number;
  27324. sideOrientation?: number;
  27325. frontUVs?: Vector4;
  27326. backUVs?: Vector4;
  27327. }): VertexData;
  27328. /**
  27329. * Creates the VertexData of the Disc or regular Polygon
  27330. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27331. * * radius the radius of the disc, optional default 0.5
  27332. * * tessellation the number of polygon sides, optional, default 64
  27333. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  27334. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27335. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27336. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27337. * @returns the VertexData of the box
  27338. */
  27339. static CreateDisc(options: {
  27340. radius?: number;
  27341. tessellation?: number;
  27342. arc?: number;
  27343. sideOrientation?: number;
  27344. frontUVs?: Vector4;
  27345. backUVs?: Vector4;
  27346. }): VertexData;
  27347. /**
  27348. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27349. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27350. * @param polygon a mesh built from polygonTriangulation.build()
  27351. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27352. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27353. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27354. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27355. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27356. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27357. * @returns the VertexData of the Polygon
  27358. */
  27359. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27360. /**
  27361. * Creates the VertexData of the IcoSphere
  27362. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27363. * * radius the radius of the IcoSphere, optional default 1
  27364. * * radiusX allows stretching in the x direction, optional, default radius
  27365. * * radiusY allows stretching in the y direction, optional, default radius
  27366. * * radiusZ allows stretching in the z direction, optional, default radius
  27367. * * flat when true creates a flat shaded mesh, optional, default true
  27368. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27369. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27370. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27371. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27372. * @returns the VertexData of the IcoSphere
  27373. */
  27374. static CreateIcoSphere(options: {
  27375. radius?: number;
  27376. radiusX?: number;
  27377. radiusY?: number;
  27378. radiusZ?: number;
  27379. flat?: boolean;
  27380. subdivisions?: number;
  27381. sideOrientation?: number;
  27382. frontUVs?: Vector4;
  27383. backUVs?: Vector4;
  27384. }): VertexData;
  27385. /**
  27386. * Creates the VertexData for a Polyhedron
  27387. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27388. * * type provided types are:
  27389. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27390. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  27391. * * size the size of the IcoSphere, optional default 1
  27392. * * sizeX allows stretching in the x direction, optional, default size
  27393. * * sizeY allows stretching in the y direction, optional, default size
  27394. * * sizeZ allows stretching in the z direction, optional, default size
  27395. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  27396. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27397. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27398. * * flat when true creates a flat shaded mesh, optional, default true
  27399. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27400. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27401. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27402. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27403. * @returns the VertexData of the Polyhedron
  27404. */
  27405. static CreatePolyhedron(options: {
  27406. type?: number;
  27407. size?: number;
  27408. sizeX?: number;
  27409. sizeY?: number;
  27410. sizeZ?: number;
  27411. custom?: any;
  27412. faceUV?: Vector4[];
  27413. faceColors?: Color4[];
  27414. flat?: boolean;
  27415. sideOrientation?: number;
  27416. frontUVs?: Vector4;
  27417. backUVs?: Vector4;
  27418. }): VertexData;
  27419. /**
  27420. * Creates the VertexData for a TorusKnot
  27421. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27422. * * radius the radius of the torus knot, optional, default 2
  27423. * * tube the thickness of the tube, optional, default 0.5
  27424. * * radialSegments the number of sides on each tube segments, optional, default 32
  27425. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27426. * * p the number of windings around the z axis, optional, default 2
  27427. * * q the number of windings around the x axis, optional, default 3
  27428. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27429. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27430. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27431. * @returns the VertexData of the Torus Knot
  27432. */
  27433. static CreateTorusKnot(options: {
  27434. radius?: number;
  27435. tube?: number;
  27436. radialSegments?: number;
  27437. tubularSegments?: number;
  27438. p?: number;
  27439. q?: number;
  27440. sideOrientation?: number;
  27441. frontUVs?: Vector4;
  27442. backUVs?: Vector4;
  27443. }): VertexData;
  27444. /**
  27445. * Compute normals for given positions and indices
  27446. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27447. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27448. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27449. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27450. * * facetNormals : optional array of facet normals (vector3)
  27451. * * facetPositions : optional array of facet positions (vector3)
  27452. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27453. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27454. * * bInfo : optional bounding info, required for facetPartitioning computation
  27455. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27456. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27457. * * useRightHandedSystem: optional boolean to for right handed system computation
  27458. * * depthSort : optional boolean to enable the facet depth sort computation
  27459. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27460. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27461. */
  27462. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27463. facetNormals?: any;
  27464. facetPositions?: any;
  27465. facetPartitioning?: any;
  27466. ratio?: number;
  27467. bInfo?: any;
  27468. bbSize?: Vector3;
  27469. subDiv?: any;
  27470. useRightHandedSystem?: boolean;
  27471. depthSort?: boolean;
  27472. distanceTo?: Vector3;
  27473. depthSortedFacets?: any;
  27474. }): void;
  27475. /** @hidden */
  27476. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27477. /**
  27478. * Applies VertexData created from the imported parameters to the geometry
  27479. * @param parsedVertexData the parsed data from an imported file
  27480. * @param geometry the geometry to apply the VertexData to
  27481. */
  27482. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27483. }
  27484. }
  27485. declare module "babylonjs/Morph/morphTarget" {
  27486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27487. import { Observable } from "babylonjs/Misc/observable";
  27488. import { Nullable, FloatArray } from "babylonjs/types";
  27489. import { Scene } from "babylonjs/scene";
  27490. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27491. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27492. /**
  27493. * Defines a target to use with MorphTargetManager
  27494. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27495. */
  27496. export class MorphTarget implements IAnimatable {
  27497. /** defines the name of the target */
  27498. name: string;
  27499. /**
  27500. * Gets or sets the list of animations
  27501. */
  27502. animations: import("babylonjs/Animations/animation").Animation[];
  27503. private _scene;
  27504. private _positions;
  27505. private _normals;
  27506. private _tangents;
  27507. private _uvs;
  27508. private _influence;
  27509. private _uniqueId;
  27510. /**
  27511. * Observable raised when the influence changes
  27512. */
  27513. onInfluenceChanged: Observable<boolean>;
  27514. /** @hidden */
  27515. _onDataLayoutChanged: Observable<void>;
  27516. /**
  27517. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27518. */
  27519. get influence(): number;
  27520. set influence(influence: number);
  27521. /**
  27522. * Gets or sets the id of the morph Target
  27523. */
  27524. id: string;
  27525. private _animationPropertiesOverride;
  27526. /**
  27527. * Gets or sets the animation properties override
  27528. */
  27529. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27530. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27531. /**
  27532. * Creates a new MorphTarget
  27533. * @param name defines the name of the target
  27534. * @param influence defines the influence to use
  27535. * @param scene defines the scene the morphtarget belongs to
  27536. */
  27537. constructor(
  27538. /** defines the name of the target */
  27539. name: string, influence?: number, scene?: Nullable<Scene>);
  27540. /**
  27541. * Gets the unique ID of this manager
  27542. */
  27543. get uniqueId(): number;
  27544. /**
  27545. * Gets a boolean defining if the target contains position data
  27546. */
  27547. get hasPositions(): boolean;
  27548. /**
  27549. * Gets a boolean defining if the target contains normal data
  27550. */
  27551. get hasNormals(): boolean;
  27552. /**
  27553. * Gets a boolean defining if the target contains tangent data
  27554. */
  27555. get hasTangents(): boolean;
  27556. /**
  27557. * Gets a boolean defining if the target contains texture coordinates data
  27558. */
  27559. get hasUVs(): boolean;
  27560. /**
  27561. * Affects position data to this target
  27562. * @param data defines the position data to use
  27563. */
  27564. setPositions(data: Nullable<FloatArray>): void;
  27565. /**
  27566. * Gets the position data stored in this target
  27567. * @returns a FloatArray containing the position data (or null if not present)
  27568. */
  27569. getPositions(): Nullable<FloatArray>;
  27570. /**
  27571. * Affects normal data to this target
  27572. * @param data defines the normal data to use
  27573. */
  27574. setNormals(data: Nullable<FloatArray>): void;
  27575. /**
  27576. * Gets the normal data stored in this target
  27577. * @returns a FloatArray containing the normal data (or null if not present)
  27578. */
  27579. getNormals(): Nullable<FloatArray>;
  27580. /**
  27581. * Affects tangent data to this target
  27582. * @param data defines the tangent data to use
  27583. */
  27584. setTangents(data: Nullable<FloatArray>): void;
  27585. /**
  27586. * Gets the tangent data stored in this target
  27587. * @returns a FloatArray containing the tangent data (or null if not present)
  27588. */
  27589. getTangents(): Nullable<FloatArray>;
  27590. /**
  27591. * Affects texture coordinates data to this target
  27592. * @param data defines the texture coordinates data to use
  27593. */
  27594. setUVs(data: Nullable<FloatArray>): void;
  27595. /**
  27596. * Gets the texture coordinates data stored in this target
  27597. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27598. */
  27599. getUVs(): Nullable<FloatArray>;
  27600. /**
  27601. * Clone the current target
  27602. * @returns a new MorphTarget
  27603. */
  27604. clone(): MorphTarget;
  27605. /**
  27606. * Serializes the current target into a Serialization object
  27607. * @returns the serialized object
  27608. */
  27609. serialize(): any;
  27610. /**
  27611. * Returns the string "MorphTarget"
  27612. * @returns "MorphTarget"
  27613. */
  27614. getClassName(): string;
  27615. /**
  27616. * Creates a new target from serialized data
  27617. * @param serializationObject defines the serialized data to use
  27618. * @returns a new MorphTarget
  27619. */
  27620. static Parse(serializationObject: any): MorphTarget;
  27621. /**
  27622. * Creates a MorphTarget from mesh data
  27623. * @param mesh defines the source mesh
  27624. * @param name defines the name to use for the new target
  27625. * @param influence defines the influence to attach to the target
  27626. * @returns a new MorphTarget
  27627. */
  27628. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27629. }
  27630. }
  27631. declare module "babylonjs/Morph/morphTargetManager" {
  27632. import { Nullable } from "babylonjs/types";
  27633. import { Scene } from "babylonjs/scene";
  27634. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27635. /**
  27636. * This class is used to deform meshes using morphing between different targets
  27637. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27638. */
  27639. export class MorphTargetManager {
  27640. private _targets;
  27641. private _targetInfluenceChangedObservers;
  27642. private _targetDataLayoutChangedObservers;
  27643. private _activeTargets;
  27644. private _scene;
  27645. private _influences;
  27646. private _supportsNormals;
  27647. private _supportsTangents;
  27648. private _supportsUVs;
  27649. private _vertexCount;
  27650. private _uniqueId;
  27651. private _tempInfluences;
  27652. /**
  27653. * Gets or sets a boolean indicating if normals must be morphed
  27654. */
  27655. enableNormalMorphing: boolean;
  27656. /**
  27657. * Gets or sets a boolean indicating if tangents must be morphed
  27658. */
  27659. enableTangentMorphing: boolean;
  27660. /**
  27661. * Gets or sets a boolean indicating if UV must be morphed
  27662. */
  27663. enableUVMorphing: boolean;
  27664. /**
  27665. * Creates a new MorphTargetManager
  27666. * @param scene defines the current scene
  27667. */
  27668. constructor(scene?: Nullable<Scene>);
  27669. /**
  27670. * Gets the unique ID of this manager
  27671. */
  27672. get uniqueId(): number;
  27673. /**
  27674. * Gets the number of vertices handled by this manager
  27675. */
  27676. get vertexCount(): number;
  27677. /**
  27678. * Gets a boolean indicating if this manager supports morphing of normals
  27679. */
  27680. get supportsNormals(): boolean;
  27681. /**
  27682. * Gets a boolean indicating if this manager supports morphing of tangents
  27683. */
  27684. get supportsTangents(): boolean;
  27685. /**
  27686. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27687. */
  27688. get supportsUVs(): boolean;
  27689. /**
  27690. * Gets the number of targets stored in this manager
  27691. */
  27692. get numTargets(): number;
  27693. /**
  27694. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27695. */
  27696. get numInfluencers(): number;
  27697. /**
  27698. * Gets the list of influences (one per target)
  27699. */
  27700. get influences(): Float32Array;
  27701. /**
  27702. * Gets the active target at specified index. An active target is a target with an influence > 0
  27703. * @param index defines the index to check
  27704. * @returns the requested target
  27705. */
  27706. getActiveTarget(index: number): MorphTarget;
  27707. /**
  27708. * Gets the target at specified index
  27709. * @param index defines the index to check
  27710. * @returns the requested target
  27711. */
  27712. getTarget(index: number): MorphTarget;
  27713. /**
  27714. * Add a new target to this manager
  27715. * @param target defines the target to add
  27716. */
  27717. addTarget(target: MorphTarget): void;
  27718. /**
  27719. * Removes a target from the manager
  27720. * @param target defines the target to remove
  27721. */
  27722. removeTarget(target: MorphTarget): void;
  27723. /**
  27724. * Clone the current manager
  27725. * @returns a new MorphTargetManager
  27726. */
  27727. clone(): MorphTargetManager;
  27728. /**
  27729. * Serializes the current manager into a Serialization object
  27730. * @returns the serialized object
  27731. */
  27732. serialize(): any;
  27733. private _syncActiveTargets;
  27734. /**
  27735. * Syncrhonize the targets with all the meshes using this morph target manager
  27736. */
  27737. synchronize(): void;
  27738. /**
  27739. * Creates a new MorphTargetManager from serialized data
  27740. * @param serializationObject defines the serialized data
  27741. * @param scene defines the hosting scene
  27742. * @returns the new MorphTargetManager
  27743. */
  27744. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27745. }
  27746. }
  27747. declare module "babylonjs/Meshes/meshLODLevel" {
  27748. import { Mesh } from "babylonjs/Meshes/mesh";
  27749. import { Nullable } from "babylonjs/types";
  27750. /**
  27751. * Class used to represent a specific level of detail of a mesh
  27752. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27753. */
  27754. export class MeshLODLevel {
  27755. /** Defines the distance where this level should start being displayed */
  27756. distance: number;
  27757. /** Defines the mesh to use to render this level */
  27758. mesh: Nullable<Mesh>;
  27759. /**
  27760. * Creates a new LOD level
  27761. * @param distance defines the distance where this level should star being displayed
  27762. * @param mesh defines the mesh to use to render this level
  27763. */
  27764. constructor(
  27765. /** Defines the distance where this level should start being displayed */
  27766. distance: number,
  27767. /** Defines the mesh to use to render this level */
  27768. mesh: Nullable<Mesh>);
  27769. }
  27770. }
  27771. declare module "babylonjs/Misc/canvasGenerator" {
  27772. /**
  27773. * Helper class used to generate a canvas to manipulate images
  27774. */
  27775. export class CanvasGenerator {
  27776. /**
  27777. * Create a new canvas (or offscreen canvas depending on the context)
  27778. * @param width defines the expected width
  27779. * @param height defines the expected height
  27780. * @return a new canvas or offscreen canvas
  27781. */
  27782. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27783. }
  27784. }
  27785. declare module "babylonjs/Meshes/groundMesh" {
  27786. import { Scene } from "babylonjs/scene";
  27787. import { Vector3 } from "babylonjs/Maths/math.vector";
  27788. import { Mesh } from "babylonjs/Meshes/mesh";
  27789. /**
  27790. * Mesh representing the gorund
  27791. */
  27792. export class GroundMesh extends Mesh {
  27793. /** If octree should be generated */
  27794. generateOctree: boolean;
  27795. private _heightQuads;
  27796. /** @hidden */
  27797. _subdivisionsX: number;
  27798. /** @hidden */
  27799. _subdivisionsY: number;
  27800. /** @hidden */
  27801. _width: number;
  27802. /** @hidden */
  27803. _height: number;
  27804. /** @hidden */
  27805. _minX: number;
  27806. /** @hidden */
  27807. _maxX: number;
  27808. /** @hidden */
  27809. _minZ: number;
  27810. /** @hidden */
  27811. _maxZ: number;
  27812. constructor(name: string, scene: Scene);
  27813. /**
  27814. * "GroundMesh"
  27815. * @returns "GroundMesh"
  27816. */
  27817. getClassName(): string;
  27818. /**
  27819. * The minimum of x and y subdivisions
  27820. */
  27821. get subdivisions(): number;
  27822. /**
  27823. * X subdivisions
  27824. */
  27825. get subdivisionsX(): number;
  27826. /**
  27827. * Y subdivisions
  27828. */
  27829. get subdivisionsY(): number;
  27830. /**
  27831. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27832. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27833. * @param chunksCount the number of subdivisions for x and y
  27834. * @param octreeBlocksSize (Default: 32)
  27835. */
  27836. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27837. /**
  27838. * Returns a height (y) value in the Worl system :
  27839. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27840. * @param x x coordinate
  27841. * @param z z coordinate
  27842. * @returns the ground y position if (x, z) are outside the ground surface.
  27843. */
  27844. getHeightAtCoordinates(x: number, z: number): number;
  27845. /**
  27846. * Returns a normalized vector (Vector3) orthogonal to the ground
  27847. * at the ground coordinates (x, z) expressed in the World system.
  27848. * @param x x coordinate
  27849. * @param z z coordinate
  27850. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27851. */
  27852. getNormalAtCoordinates(x: number, z: number): Vector3;
  27853. /**
  27854. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27855. * at the ground coordinates (x, z) expressed in the World system.
  27856. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27857. * @param x x coordinate
  27858. * @param z z coordinate
  27859. * @param ref vector to store the result
  27860. * @returns the GroundMesh.
  27861. */
  27862. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27863. /**
  27864. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27865. * if the ground has been updated.
  27866. * This can be used in the render loop.
  27867. * @returns the GroundMesh.
  27868. */
  27869. updateCoordinateHeights(): GroundMesh;
  27870. private _getFacetAt;
  27871. private _initHeightQuads;
  27872. private _computeHeightQuads;
  27873. /**
  27874. * Serializes this ground mesh
  27875. * @param serializationObject object to write serialization to
  27876. */
  27877. serialize(serializationObject: any): void;
  27878. /**
  27879. * Parses a serialized ground mesh
  27880. * @param parsedMesh the serialized mesh
  27881. * @param scene the scene to create the ground mesh in
  27882. * @returns the created ground mesh
  27883. */
  27884. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27885. }
  27886. }
  27887. declare module "babylonjs/Physics/physicsJoint" {
  27888. import { Vector3 } from "babylonjs/Maths/math.vector";
  27889. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27890. /**
  27891. * Interface for Physics-Joint data
  27892. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27893. */
  27894. export interface PhysicsJointData {
  27895. /**
  27896. * The main pivot of the joint
  27897. */
  27898. mainPivot?: Vector3;
  27899. /**
  27900. * The connected pivot of the joint
  27901. */
  27902. connectedPivot?: Vector3;
  27903. /**
  27904. * The main axis of the joint
  27905. */
  27906. mainAxis?: Vector3;
  27907. /**
  27908. * The connected axis of the joint
  27909. */
  27910. connectedAxis?: Vector3;
  27911. /**
  27912. * The collision of the joint
  27913. */
  27914. collision?: boolean;
  27915. /**
  27916. * Native Oimo/Cannon/Energy data
  27917. */
  27918. nativeParams?: any;
  27919. }
  27920. /**
  27921. * This is a holder class for the physics joint created by the physics plugin
  27922. * It holds a set of functions to control the underlying joint
  27923. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27924. */
  27925. export class PhysicsJoint {
  27926. /**
  27927. * The type of the physics joint
  27928. */
  27929. type: number;
  27930. /**
  27931. * The data for the physics joint
  27932. */
  27933. jointData: PhysicsJointData;
  27934. private _physicsJoint;
  27935. protected _physicsPlugin: IPhysicsEnginePlugin;
  27936. /**
  27937. * Initializes the physics joint
  27938. * @param type The type of the physics joint
  27939. * @param jointData The data for the physics joint
  27940. */
  27941. constructor(
  27942. /**
  27943. * The type of the physics joint
  27944. */
  27945. type: number,
  27946. /**
  27947. * The data for the physics joint
  27948. */
  27949. jointData: PhysicsJointData);
  27950. /**
  27951. * Gets the physics joint
  27952. */
  27953. get physicsJoint(): any;
  27954. /**
  27955. * Sets the physics joint
  27956. */
  27957. set physicsJoint(newJoint: any);
  27958. /**
  27959. * Sets the physics plugin
  27960. */
  27961. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27962. /**
  27963. * Execute a function that is physics-plugin specific.
  27964. * @param {Function} func the function that will be executed.
  27965. * It accepts two parameters: the physics world and the physics joint
  27966. */
  27967. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27968. /**
  27969. * Distance-Joint type
  27970. */
  27971. static DistanceJoint: number;
  27972. /**
  27973. * Hinge-Joint type
  27974. */
  27975. static HingeJoint: number;
  27976. /**
  27977. * Ball-and-Socket joint type
  27978. */
  27979. static BallAndSocketJoint: number;
  27980. /**
  27981. * Wheel-Joint type
  27982. */
  27983. static WheelJoint: number;
  27984. /**
  27985. * Slider-Joint type
  27986. */
  27987. static SliderJoint: number;
  27988. /**
  27989. * Prismatic-Joint type
  27990. */
  27991. static PrismaticJoint: number;
  27992. /**
  27993. * Universal-Joint type
  27994. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27995. */
  27996. static UniversalJoint: number;
  27997. /**
  27998. * Hinge-Joint 2 type
  27999. */
  28000. static Hinge2Joint: number;
  28001. /**
  28002. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28003. */
  28004. static PointToPointJoint: number;
  28005. /**
  28006. * Spring-Joint type
  28007. */
  28008. static SpringJoint: number;
  28009. /**
  28010. * Lock-Joint type
  28011. */
  28012. static LockJoint: number;
  28013. }
  28014. /**
  28015. * A class representing a physics distance joint
  28016. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28017. */
  28018. export class DistanceJoint extends PhysicsJoint {
  28019. /**
  28020. *
  28021. * @param jointData The data for the Distance-Joint
  28022. */
  28023. constructor(jointData: DistanceJointData);
  28024. /**
  28025. * Update the predefined distance.
  28026. * @param maxDistance The maximum preferred distance
  28027. * @param minDistance The minimum preferred distance
  28028. */
  28029. updateDistance(maxDistance: number, minDistance?: number): void;
  28030. }
  28031. /**
  28032. * Represents a Motor-Enabled Joint
  28033. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28034. */
  28035. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28036. /**
  28037. * Initializes the Motor-Enabled Joint
  28038. * @param type The type of the joint
  28039. * @param jointData The physica joint data for the joint
  28040. */
  28041. constructor(type: number, jointData: PhysicsJointData);
  28042. /**
  28043. * Set the motor values.
  28044. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28045. * @param force the force to apply
  28046. * @param maxForce max force for this motor.
  28047. */
  28048. setMotor(force?: number, maxForce?: number): void;
  28049. /**
  28050. * Set the motor's limits.
  28051. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28052. * @param upperLimit The upper limit of the motor
  28053. * @param lowerLimit The lower limit of the motor
  28054. */
  28055. setLimit(upperLimit: number, lowerLimit?: number): void;
  28056. }
  28057. /**
  28058. * This class represents a single physics Hinge-Joint
  28059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28060. */
  28061. export class HingeJoint extends MotorEnabledJoint {
  28062. /**
  28063. * Initializes the Hinge-Joint
  28064. * @param jointData The joint data for the Hinge-Joint
  28065. */
  28066. constructor(jointData: PhysicsJointData);
  28067. /**
  28068. * Set the motor values.
  28069. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28070. * @param {number} force the force to apply
  28071. * @param {number} maxForce max force for this motor.
  28072. */
  28073. setMotor(force?: number, maxForce?: number): void;
  28074. /**
  28075. * Set the motor's limits.
  28076. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28077. * @param upperLimit The upper limit of the motor
  28078. * @param lowerLimit The lower limit of the motor
  28079. */
  28080. setLimit(upperLimit: number, lowerLimit?: number): void;
  28081. }
  28082. /**
  28083. * This class represents a dual hinge physics joint (same as wheel joint)
  28084. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28085. */
  28086. export class Hinge2Joint extends MotorEnabledJoint {
  28087. /**
  28088. * Initializes the Hinge2-Joint
  28089. * @param jointData The joint data for the Hinge2-Joint
  28090. */
  28091. constructor(jointData: PhysicsJointData);
  28092. /**
  28093. * Set the motor values.
  28094. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28095. * @param {number} targetSpeed the speed the motor is to reach
  28096. * @param {number} maxForce max force for this motor.
  28097. * @param {motorIndex} the motor's index, 0 or 1.
  28098. */
  28099. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28100. /**
  28101. * Set the motor limits.
  28102. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28103. * @param {number} upperLimit the upper limit
  28104. * @param {number} lowerLimit lower limit
  28105. * @param {motorIndex} the motor's index, 0 or 1.
  28106. */
  28107. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28108. }
  28109. /**
  28110. * Interface for a motor enabled joint
  28111. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28112. */
  28113. export interface IMotorEnabledJoint {
  28114. /**
  28115. * Physics joint
  28116. */
  28117. physicsJoint: any;
  28118. /**
  28119. * Sets the motor of the motor-enabled joint
  28120. * @param force The force of the motor
  28121. * @param maxForce The maximum force of the motor
  28122. * @param motorIndex The index of the motor
  28123. */
  28124. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28125. /**
  28126. * Sets the limit of the motor
  28127. * @param upperLimit The upper limit of the motor
  28128. * @param lowerLimit The lower limit of the motor
  28129. * @param motorIndex The index of the motor
  28130. */
  28131. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28132. }
  28133. /**
  28134. * Joint data for a Distance-Joint
  28135. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28136. */
  28137. export interface DistanceJointData extends PhysicsJointData {
  28138. /**
  28139. * Max distance the 2 joint objects can be apart
  28140. */
  28141. maxDistance: number;
  28142. }
  28143. /**
  28144. * Joint data from a spring joint
  28145. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28146. */
  28147. export interface SpringJointData extends PhysicsJointData {
  28148. /**
  28149. * Length of the spring
  28150. */
  28151. length: number;
  28152. /**
  28153. * Stiffness of the spring
  28154. */
  28155. stiffness: number;
  28156. /**
  28157. * Damping of the spring
  28158. */
  28159. damping: number;
  28160. /** this callback will be called when applying the force to the impostors. */
  28161. forceApplicationCallback: () => void;
  28162. }
  28163. }
  28164. declare module "babylonjs/Physics/physicsRaycastResult" {
  28165. import { Vector3 } from "babylonjs/Maths/math.vector";
  28166. /**
  28167. * Holds the data for the raycast result
  28168. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28169. */
  28170. export class PhysicsRaycastResult {
  28171. private _hasHit;
  28172. private _hitDistance;
  28173. private _hitNormalWorld;
  28174. private _hitPointWorld;
  28175. private _rayFromWorld;
  28176. private _rayToWorld;
  28177. /**
  28178. * Gets if there was a hit
  28179. */
  28180. get hasHit(): boolean;
  28181. /**
  28182. * Gets the distance from the hit
  28183. */
  28184. get hitDistance(): number;
  28185. /**
  28186. * Gets the hit normal/direction in the world
  28187. */
  28188. get hitNormalWorld(): Vector3;
  28189. /**
  28190. * Gets the hit point in the world
  28191. */
  28192. get hitPointWorld(): Vector3;
  28193. /**
  28194. * Gets the ray "start point" of the ray in the world
  28195. */
  28196. get rayFromWorld(): Vector3;
  28197. /**
  28198. * Gets the ray "end point" of the ray in the world
  28199. */
  28200. get rayToWorld(): Vector3;
  28201. /**
  28202. * Sets the hit data (normal & point in world space)
  28203. * @param hitNormalWorld defines the normal in world space
  28204. * @param hitPointWorld defines the point in world space
  28205. */
  28206. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28207. /**
  28208. * Sets the distance from the start point to the hit point
  28209. * @param distance
  28210. */
  28211. setHitDistance(distance: number): void;
  28212. /**
  28213. * Calculates the distance manually
  28214. */
  28215. calculateHitDistance(): void;
  28216. /**
  28217. * Resets all the values to default
  28218. * @param from The from point on world space
  28219. * @param to The to point on world space
  28220. */
  28221. reset(from?: Vector3, to?: Vector3): void;
  28222. }
  28223. /**
  28224. * Interface for the size containing width and height
  28225. */
  28226. interface IXYZ {
  28227. /**
  28228. * X
  28229. */
  28230. x: number;
  28231. /**
  28232. * Y
  28233. */
  28234. y: number;
  28235. /**
  28236. * Z
  28237. */
  28238. z: number;
  28239. }
  28240. }
  28241. declare module "babylonjs/Physics/IPhysicsEngine" {
  28242. import { Nullable } from "babylonjs/types";
  28243. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28245. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28246. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28247. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28248. /**
  28249. * Interface used to describe a physics joint
  28250. */
  28251. export interface PhysicsImpostorJoint {
  28252. /** Defines the main impostor to which the joint is linked */
  28253. mainImpostor: PhysicsImpostor;
  28254. /** Defines the impostor that is connected to the main impostor using this joint */
  28255. connectedImpostor: PhysicsImpostor;
  28256. /** Defines the joint itself */
  28257. joint: PhysicsJoint;
  28258. }
  28259. /** @hidden */
  28260. export interface IPhysicsEnginePlugin {
  28261. world: any;
  28262. name: string;
  28263. setGravity(gravity: Vector3): void;
  28264. setTimeStep(timeStep: number): void;
  28265. getTimeStep(): number;
  28266. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28267. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28268. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28270. removePhysicsBody(impostor: PhysicsImpostor): void;
  28271. generateJoint(joint: PhysicsImpostorJoint): void;
  28272. removeJoint(joint: PhysicsImpostorJoint): void;
  28273. isSupported(): boolean;
  28274. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28275. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28276. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28277. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28279. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28281. getBodyMass(impostor: PhysicsImpostor): number;
  28282. getBodyFriction(impostor: PhysicsImpostor): number;
  28283. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28284. getBodyRestitution(impostor: PhysicsImpostor): number;
  28285. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28286. getBodyPressure?(impostor: PhysicsImpostor): number;
  28287. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28288. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28289. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28290. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28291. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28292. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28293. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28294. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28295. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. sleepBody(impostor: PhysicsImpostor): void;
  28297. wakeUpBody(impostor: PhysicsImpostor): void;
  28298. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28299. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28300. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28301. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28302. getRadius(impostor: PhysicsImpostor): number;
  28303. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28304. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28305. dispose(): void;
  28306. }
  28307. /**
  28308. * Interface used to define a physics engine
  28309. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28310. */
  28311. export interface IPhysicsEngine {
  28312. /**
  28313. * Gets the gravity vector used by the simulation
  28314. */
  28315. gravity: Vector3;
  28316. /**
  28317. * Sets the gravity vector used by the simulation
  28318. * @param gravity defines the gravity vector to use
  28319. */
  28320. setGravity(gravity: Vector3): void;
  28321. /**
  28322. * Set the time step of the physics engine.
  28323. * Default is 1/60.
  28324. * To slow it down, enter 1/600 for example.
  28325. * To speed it up, 1/30
  28326. * @param newTimeStep the new timestep to apply to this world.
  28327. */
  28328. setTimeStep(newTimeStep: number): void;
  28329. /**
  28330. * Get the time step of the physics engine.
  28331. * @returns the current time step
  28332. */
  28333. getTimeStep(): number;
  28334. /**
  28335. * Set the sub time step of the physics engine.
  28336. * Default is 0 meaning there is no sub steps
  28337. * To increase physics resolution precision, set a small value (like 1 ms)
  28338. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28339. */
  28340. setSubTimeStep(subTimeStep: number): void;
  28341. /**
  28342. * Get the sub time step of the physics engine.
  28343. * @returns the current sub time step
  28344. */
  28345. getSubTimeStep(): number;
  28346. /**
  28347. * Release all resources
  28348. */
  28349. dispose(): void;
  28350. /**
  28351. * Gets the name of the current physics plugin
  28352. * @returns the name of the plugin
  28353. */
  28354. getPhysicsPluginName(): string;
  28355. /**
  28356. * Adding a new impostor for the impostor tracking.
  28357. * This will be done by the impostor itself.
  28358. * @param impostor the impostor to add
  28359. */
  28360. addImpostor(impostor: PhysicsImpostor): void;
  28361. /**
  28362. * Remove an impostor from the engine.
  28363. * This impostor and its mesh will not longer be updated by the physics engine.
  28364. * @param impostor the impostor to remove
  28365. */
  28366. removeImpostor(impostor: PhysicsImpostor): void;
  28367. /**
  28368. * Add a joint to the physics engine
  28369. * @param mainImpostor defines the main impostor to which the joint is added.
  28370. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28371. * @param joint defines the joint that will connect both impostors.
  28372. */
  28373. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28374. /**
  28375. * Removes a joint from the simulation
  28376. * @param mainImpostor defines the impostor used with the joint
  28377. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28378. * @param joint defines the joint to remove
  28379. */
  28380. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28381. /**
  28382. * Gets the current plugin used to run the simulation
  28383. * @returns current plugin
  28384. */
  28385. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28386. /**
  28387. * Gets the list of physic impostors
  28388. * @returns an array of PhysicsImpostor
  28389. */
  28390. getImpostors(): Array<PhysicsImpostor>;
  28391. /**
  28392. * Gets the impostor for a physics enabled object
  28393. * @param object defines the object impersonated by the impostor
  28394. * @returns the PhysicsImpostor or null if not found
  28395. */
  28396. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28397. /**
  28398. * Gets the impostor for a physics body object
  28399. * @param body defines physics body used by the impostor
  28400. * @returns the PhysicsImpostor or null if not found
  28401. */
  28402. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28403. /**
  28404. * Does a raycast in the physics world
  28405. * @param from when should the ray start?
  28406. * @param to when should the ray end?
  28407. * @returns PhysicsRaycastResult
  28408. */
  28409. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28410. /**
  28411. * Called by the scene. No need to call it.
  28412. * @param delta defines the timespam between frames
  28413. */
  28414. _step(delta: number): void;
  28415. }
  28416. }
  28417. declare module "babylonjs/Physics/physicsImpostor" {
  28418. import { Nullable, IndicesArray } from "babylonjs/types";
  28419. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28420. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28422. import { Scene } from "babylonjs/scene";
  28423. import { Bone } from "babylonjs/Bones/bone";
  28424. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28425. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28426. import { Space } from "babylonjs/Maths/math.axis";
  28427. /**
  28428. * The interface for the physics imposter parameters
  28429. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28430. */
  28431. export interface PhysicsImpostorParameters {
  28432. /**
  28433. * The mass of the physics imposter
  28434. */
  28435. mass: number;
  28436. /**
  28437. * The friction of the physics imposter
  28438. */
  28439. friction?: number;
  28440. /**
  28441. * The coefficient of restitution of the physics imposter
  28442. */
  28443. restitution?: number;
  28444. /**
  28445. * The native options of the physics imposter
  28446. */
  28447. nativeOptions?: any;
  28448. /**
  28449. * Specifies if the parent should be ignored
  28450. */
  28451. ignoreParent?: boolean;
  28452. /**
  28453. * Specifies if bi-directional transformations should be disabled
  28454. */
  28455. disableBidirectionalTransformation?: boolean;
  28456. /**
  28457. * The pressure inside the physics imposter, soft object only
  28458. */
  28459. pressure?: number;
  28460. /**
  28461. * The stiffness the physics imposter, soft object only
  28462. */
  28463. stiffness?: number;
  28464. /**
  28465. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28466. */
  28467. velocityIterations?: number;
  28468. /**
  28469. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28470. */
  28471. positionIterations?: number;
  28472. /**
  28473. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28474. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28475. * Add to fix multiple points
  28476. */
  28477. fixedPoints?: number;
  28478. /**
  28479. * The collision margin around a soft object
  28480. */
  28481. margin?: number;
  28482. /**
  28483. * The collision margin around a soft object
  28484. */
  28485. damping?: number;
  28486. /**
  28487. * The path for a rope based on an extrusion
  28488. */
  28489. path?: any;
  28490. /**
  28491. * The shape of an extrusion used for a rope based on an extrusion
  28492. */
  28493. shape?: any;
  28494. }
  28495. /**
  28496. * Interface for a physics-enabled object
  28497. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28498. */
  28499. export interface IPhysicsEnabledObject {
  28500. /**
  28501. * The position of the physics-enabled object
  28502. */
  28503. position: Vector3;
  28504. /**
  28505. * The rotation of the physics-enabled object
  28506. */
  28507. rotationQuaternion: Nullable<Quaternion>;
  28508. /**
  28509. * The scale of the physics-enabled object
  28510. */
  28511. scaling: Vector3;
  28512. /**
  28513. * The rotation of the physics-enabled object
  28514. */
  28515. rotation?: Vector3;
  28516. /**
  28517. * The parent of the physics-enabled object
  28518. */
  28519. parent?: any;
  28520. /**
  28521. * The bounding info of the physics-enabled object
  28522. * @returns The bounding info of the physics-enabled object
  28523. */
  28524. getBoundingInfo(): BoundingInfo;
  28525. /**
  28526. * Computes the world matrix
  28527. * @param force Specifies if the world matrix should be computed by force
  28528. * @returns A world matrix
  28529. */
  28530. computeWorldMatrix(force: boolean): Matrix;
  28531. /**
  28532. * Gets the world matrix
  28533. * @returns A world matrix
  28534. */
  28535. getWorldMatrix?(): Matrix;
  28536. /**
  28537. * Gets the child meshes
  28538. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28539. * @returns An array of abstract meshes
  28540. */
  28541. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28542. /**
  28543. * Gets the vertex data
  28544. * @param kind The type of vertex data
  28545. * @returns A nullable array of numbers, or a float32 array
  28546. */
  28547. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28548. /**
  28549. * Gets the indices from the mesh
  28550. * @returns A nullable array of index arrays
  28551. */
  28552. getIndices?(): Nullable<IndicesArray>;
  28553. /**
  28554. * Gets the scene from the mesh
  28555. * @returns the indices array or null
  28556. */
  28557. getScene?(): Scene;
  28558. /**
  28559. * Gets the absolute position from the mesh
  28560. * @returns the absolute position
  28561. */
  28562. getAbsolutePosition(): Vector3;
  28563. /**
  28564. * Gets the absolute pivot point from the mesh
  28565. * @returns the absolute pivot point
  28566. */
  28567. getAbsolutePivotPoint(): Vector3;
  28568. /**
  28569. * Rotates the mesh
  28570. * @param axis The axis of rotation
  28571. * @param amount The amount of rotation
  28572. * @param space The space of the rotation
  28573. * @returns The rotation transform node
  28574. */
  28575. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28576. /**
  28577. * Translates the mesh
  28578. * @param axis The axis of translation
  28579. * @param distance The distance of translation
  28580. * @param space The space of the translation
  28581. * @returns The transform node
  28582. */
  28583. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28584. /**
  28585. * Sets the absolute position of the mesh
  28586. * @param absolutePosition The absolute position of the mesh
  28587. * @returns The transform node
  28588. */
  28589. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28590. /**
  28591. * Gets the class name of the mesh
  28592. * @returns The class name
  28593. */
  28594. getClassName(): string;
  28595. }
  28596. /**
  28597. * Represents a physics imposter
  28598. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28599. */
  28600. export class PhysicsImpostor {
  28601. /**
  28602. * The physics-enabled object used as the physics imposter
  28603. */
  28604. object: IPhysicsEnabledObject;
  28605. /**
  28606. * The type of the physics imposter
  28607. */
  28608. type: number;
  28609. private _options;
  28610. private _scene?;
  28611. /**
  28612. * The default object size of the imposter
  28613. */
  28614. static DEFAULT_OBJECT_SIZE: Vector3;
  28615. /**
  28616. * The identity quaternion of the imposter
  28617. */
  28618. static IDENTITY_QUATERNION: Quaternion;
  28619. /** @hidden */
  28620. _pluginData: any;
  28621. private _physicsEngine;
  28622. private _physicsBody;
  28623. private _bodyUpdateRequired;
  28624. private _onBeforePhysicsStepCallbacks;
  28625. private _onAfterPhysicsStepCallbacks;
  28626. /** @hidden */
  28627. _onPhysicsCollideCallbacks: Array<{
  28628. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28629. otherImpostors: Array<PhysicsImpostor>;
  28630. }>;
  28631. private _deltaPosition;
  28632. private _deltaRotation;
  28633. private _deltaRotationConjugated;
  28634. /** @hidden */
  28635. _isFromLine: boolean;
  28636. private _parent;
  28637. private _isDisposed;
  28638. private static _tmpVecs;
  28639. private static _tmpQuat;
  28640. /**
  28641. * Specifies if the physics imposter is disposed
  28642. */
  28643. get isDisposed(): boolean;
  28644. /**
  28645. * Gets the mass of the physics imposter
  28646. */
  28647. get mass(): number;
  28648. set mass(value: number);
  28649. /**
  28650. * Gets the coefficient of friction
  28651. */
  28652. get friction(): number;
  28653. /**
  28654. * Sets the coefficient of friction
  28655. */
  28656. set friction(value: number);
  28657. /**
  28658. * Gets the coefficient of restitution
  28659. */
  28660. get restitution(): number;
  28661. /**
  28662. * Sets the coefficient of restitution
  28663. */
  28664. set restitution(value: number);
  28665. /**
  28666. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28667. */
  28668. get pressure(): number;
  28669. /**
  28670. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28671. */
  28672. set pressure(value: number);
  28673. /**
  28674. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28675. */
  28676. get stiffness(): number;
  28677. /**
  28678. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28679. */
  28680. set stiffness(value: number);
  28681. /**
  28682. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28683. */
  28684. get velocityIterations(): number;
  28685. /**
  28686. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28687. */
  28688. set velocityIterations(value: number);
  28689. /**
  28690. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28691. */
  28692. get positionIterations(): number;
  28693. /**
  28694. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28695. */
  28696. set positionIterations(value: number);
  28697. /**
  28698. * The unique id of the physics imposter
  28699. * set by the physics engine when adding this impostor to the array
  28700. */
  28701. uniqueId: number;
  28702. /**
  28703. * @hidden
  28704. */
  28705. soft: boolean;
  28706. /**
  28707. * @hidden
  28708. */
  28709. segments: number;
  28710. private _joints;
  28711. /**
  28712. * Initializes the physics imposter
  28713. * @param object The physics-enabled object used as the physics imposter
  28714. * @param type The type of the physics imposter
  28715. * @param _options The options for the physics imposter
  28716. * @param _scene The Babylon scene
  28717. */
  28718. constructor(
  28719. /**
  28720. * The physics-enabled object used as the physics imposter
  28721. */
  28722. object: IPhysicsEnabledObject,
  28723. /**
  28724. * The type of the physics imposter
  28725. */
  28726. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28727. /**
  28728. * This function will completly initialize this impostor.
  28729. * It will create a new body - but only if this mesh has no parent.
  28730. * If it has, this impostor will not be used other than to define the impostor
  28731. * of the child mesh.
  28732. * @hidden
  28733. */
  28734. _init(): void;
  28735. private _getPhysicsParent;
  28736. /**
  28737. * Should a new body be generated.
  28738. * @returns boolean specifying if body initialization is required
  28739. */
  28740. isBodyInitRequired(): boolean;
  28741. /**
  28742. * Sets the updated scaling
  28743. * @param updated Specifies if the scaling is updated
  28744. */
  28745. setScalingUpdated(): void;
  28746. /**
  28747. * Force a regeneration of this or the parent's impostor's body.
  28748. * Use under cautious - This will remove all joints already implemented.
  28749. */
  28750. forceUpdate(): void;
  28751. /**
  28752. * Gets the body that holds this impostor. Either its own, or its parent.
  28753. */
  28754. get physicsBody(): any;
  28755. /**
  28756. * Get the parent of the physics imposter
  28757. * @returns Physics imposter or null
  28758. */
  28759. get parent(): Nullable<PhysicsImpostor>;
  28760. /**
  28761. * Sets the parent of the physics imposter
  28762. */
  28763. set parent(value: Nullable<PhysicsImpostor>);
  28764. /**
  28765. * Set the physics body. Used mainly by the physics engine/plugin
  28766. */
  28767. set physicsBody(physicsBody: any);
  28768. /**
  28769. * Resets the update flags
  28770. */
  28771. resetUpdateFlags(): void;
  28772. /**
  28773. * Gets the object extend size
  28774. * @returns the object extend size
  28775. */
  28776. getObjectExtendSize(): Vector3;
  28777. /**
  28778. * Gets the object center
  28779. * @returns The object center
  28780. */
  28781. getObjectCenter(): Vector3;
  28782. /**
  28783. * Get a specific parameter from the options parameters
  28784. * @param paramName The object parameter name
  28785. * @returns The object parameter
  28786. */
  28787. getParam(paramName: string): any;
  28788. /**
  28789. * Sets a specific parameter in the options given to the physics plugin
  28790. * @param paramName The parameter name
  28791. * @param value The value of the parameter
  28792. */
  28793. setParam(paramName: string, value: number): void;
  28794. /**
  28795. * Specifically change the body's mass option. Won't recreate the physics body object
  28796. * @param mass The mass of the physics imposter
  28797. */
  28798. setMass(mass: number): void;
  28799. /**
  28800. * Gets the linear velocity
  28801. * @returns linear velocity or null
  28802. */
  28803. getLinearVelocity(): Nullable<Vector3>;
  28804. /**
  28805. * Sets the linear velocity
  28806. * @param velocity linear velocity or null
  28807. */
  28808. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28809. /**
  28810. * Gets the angular velocity
  28811. * @returns angular velocity or null
  28812. */
  28813. getAngularVelocity(): Nullable<Vector3>;
  28814. /**
  28815. * Sets the angular velocity
  28816. * @param velocity The velocity or null
  28817. */
  28818. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28819. /**
  28820. * Execute a function with the physics plugin native code
  28821. * Provide a function the will have two variables - the world object and the physics body object
  28822. * @param func The function to execute with the physics plugin native code
  28823. */
  28824. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28825. /**
  28826. * Register a function that will be executed before the physics world is stepping forward
  28827. * @param func The function to execute before the physics world is stepped forward
  28828. */
  28829. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28830. /**
  28831. * Unregister a function that will be executed before the physics world is stepping forward
  28832. * @param func The function to execute before the physics world is stepped forward
  28833. */
  28834. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28835. /**
  28836. * Register a function that will be executed after the physics step
  28837. * @param func The function to execute after physics step
  28838. */
  28839. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28840. /**
  28841. * Unregisters a function that will be executed after the physics step
  28842. * @param func The function to execute after physics step
  28843. */
  28844. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28845. /**
  28846. * register a function that will be executed when this impostor collides against a different body
  28847. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28848. * @param func Callback that is executed on collision
  28849. */
  28850. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28851. /**
  28852. * Unregisters the physics imposter on contact
  28853. * @param collideAgainst The physics object to collide against
  28854. * @param func Callback to execute on collision
  28855. */
  28856. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28857. private _tmpQuat;
  28858. private _tmpQuat2;
  28859. /**
  28860. * Get the parent rotation
  28861. * @returns The parent rotation
  28862. */
  28863. getParentsRotation(): Quaternion;
  28864. /**
  28865. * this function is executed by the physics engine.
  28866. */
  28867. beforeStep: () => void;
  28868. /**
  28869. * this function is executed by the physics engine
  28870. */
  28871. afterStep: () => void;
  28872. /**
  28873. * Legacy collision detection event support
  28874. */
  28875. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28876. /**
  28877. * event and body object due to cannon's event-based architecture.
  28878. */
  28879. onCollide: (e: {
  28880. body: any;
  28881. }) => void;
  28882. /**
  28883. * Apply a force
  28884. * @param force The force to apply
  28885. * @param contactPoint The contact point for the force
  28886. * @returns The physics imposter
  28887. */
  28888. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28889. /**
  28890. * Apply an impulse
  28891. * @param force The impulse force
  28892. * @param contactPoint The contact point for the impulse force
  28893. * @returns The physics imposter
  28894. */
  28895. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28896. /**
  28897. * A help function to create a joint
  28898. * @param otherImpostor A physics imposter used to create a joint
  28899. * @param jointType The type of joint
  28900. * @param jointData The data for the joint
  28901. * @returns The physics imposter
  28902. */
  28903. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28904. /**
  28905. * Add a joint to this impostor with a different impostor
  28906. * @param otherImpostor A physics imposter used to add a joint
  28907. * @param joint The joint to add
  28908. * @returns The physics imposter
  28909. */
  28910. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28911. /**
  28912. * Add an anchor to a cloth impostor
  28913. * @param otherImpostor rigid impostor to anchor to
  28914. * @param width ratio across width from 0 to 1
  28915. * @param height ratio up height from 0 to 1
  28916. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28917. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28918. * @returns impostor the soft imposter
  28919. */
  28920. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28921. /**
  28922. * Add a hook to a rope impostor
  28923. * @param otherImpostor rigid impostor to anchor to
  28924. * @param length ratio across rope from 0 to 1
  28925. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28926. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28927. * @returns impostor the rope imposter
  28928. */
  28929. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28930. /**
  28931. * Will keep this body still, in a sleep mode.
  28932. * @returns the physics imposter
  28933. */
  28934. sleep(): PhysicsImpostor;
  28935. /**
  28936. * Wake the body up.
  28937. * @returns The physics imposter
  28938. */
  28939. wakeUp(): PhysicsImpostor;
  28940. /**
  28941. * Clones the physics imposter
  28942. * @param newObject The physics imposter clones to this physics-enabled object
  28943. * @returns A nullable physics imposter
  28944. */
  28945. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28946. /**
  28947. * Disposes the physics imposter
  28948. */
  28949. dispose(): void;
  28950. /**
  28951. * Sets the delta position
  28952. * @param position The delta position amount
  28953. */
  28954. setDeltaPosition(position: Vector3): void;
  28955. /**
  28956. * Sets the delta rotation
  28957. * @param rotation The delta rotation amount
  28958. */
  28959. setDeltaRotation(rotation: Quaternion): void;
  28960. /**
  28961. * Gets the box size of the physics imposter and stores the result in the input parameter
  28962. * @param result Stores the box size
  28963. * @returns The physics imposter
  28964. */
  28965. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28966. /**
  28967. * Gets the radius of the physics imposter
  28968. * @returns Radius of the physics imposter
  28969. */
  28970. getRadius(): number;
  28971. /**
  28972. * Sync a bone with this impostor
  28973. * @param bone The bone to sync to the impostor.
  28974. * @param boneMesh The mesh that the bone is influencing.
  28975. * @param jointPivot The pivot of the joint / bone in local space.
  28976. * @param distToJoint Optional distance from the impostor to the joint.
  28977. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28978. */
  28979. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28980. /**
  28981. * Sync impostor to a bone
  28982. * @param bone The bone that the impostor will be synced to.
  28983. * @param boneMesh The mesh that the bone is influencing.
  28984. * @param jointPivot The pivot of the joint / bone in local space.
  28985. * @param distToJoint Optional distance from the impostor to the joint.
  28986. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28987. * @param boneAxis Optional vector3 axis the bone is aligned with
  28988. */
  28989. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28990. /**
  28991. * No-Imposter type
  28992. */
  28993. static NoImpostor: number;
  28994. /**
  28995. * Sphere-Imposter type
  28996. */
  28997. static SphereImpostor: number;
  28998. /**
  28999. * Box-Imposter type
  29000. */
  29001. static BoxImpostor: number;
  29002. /**
  29003. * Plane-Imposter type
  29004. */
  29005. static PlaneImpostor: number;
  29006. /**
  29007. * Mesh-imposter type
  29008. */
  29009. static MeshImpostor: number;
  29010. /**
  29011. * Capsule-Impostor type (Ammo.js plugin only)
  29012. */
  29013. static CapsuleImpostor: number;
  29014. /**
  29015. * Cylinder-Imposter type
  29016. */
  29017. static CylinderImpostor: number;
  29018. /**
  29019. * Particle-Imposter type
  29020. */
  29021. static ParticleImpostor: number;
  29022. /**
  29023. * Heightmap-Imposter type
  29024. */
  29025. static HeightmapImpostor: number;
  29026. /**
  29027. * ConvexHull-Impostor type (Ammo.js plugin only)
  29028. */
  29029. static ConvexHullImpostor: number;
  29030. /**
  29031. * Custom-Imposter type (Ammo.js plugin only)
  29032. */
  29033. static CustomImpostor: number;
  29034. /**
  29035. * Rope-Imposter type
  29036. */
  29037. static RopeImpostor: number;
  29038. /**
  29039. * Cloth-Imposter type
  29040. */
  29041. static ClothImpostor: number;
  29042. /**
  29043. * Softbody-Imposter type
  29044. */
  29045. static SoftbodyImpostor: number;
  29046. }
  29047. }
  29048. declare module "babylonjs/Meshes/mesh" {
  29049. import { Observable } from "babylonjs/Misc/observable";
  29050. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29051. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29052. import { Camera } from "babylonjs/Cameras/camera";
  29053. import { Scene } from "babylonjs/scene";
  29054. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29055. import { Color4 } from "babylonjs/Maths/math.color";
  29056. import { Engine } from "babylonjs/Engines/engine";
  29057. import { Node } from "babylonjs/node";
  29058. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29059. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29060. import { Buffer } from "babylonjs/Meshes/buffer";
  29061. import { Geometry } from "babylonjs/Meshes/geometry";
  29062. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29063. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29064. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29065. import { Effect } from "babylonjs/Materials/effect";
  29066. import { Material } from "babylonjs/Materials/material";
  29067. import { Skeleton } from "babylonjs/Bones/skeleton";
  29068. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29069. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29070. import { Path3D } from "babylonjs/Maths/math.path";
  29071. import { Plane } from "babylonjs/Maths/math.plane";
  29072. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29073. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29074. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29075. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29076. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29077. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29078. /**
  29079. * @hidden
  29080. **/
  29081. export class _CreationDataStorage {
  29082. closePath?: boolean;
  29083. closeArray?: boolean;
  29084. idx: number[];
  29085. dashSize: number;
  29086. gapSize: number;
  29087. path3D: Path3D;
  29088. pathArray: Vector3[][];
  29089. arc: number;
  29090. radius: number;
  29091. cap: number;
  29092. tessellation: number;
  29093. }
  29094. /**
  29095. * @hidden
  29096. **/
  29097. class _InstanceDataStorage {
  29098. visibleInstances: any;
  29099. batchCache: _InstancesBatch;
  29100. instancesBufferSize: number;
  29101. instancesBuffer: Nullable<Buffer>;
  29102. instancesData: Float32Array;
  29103. overridenInstanceCount: number;
  29104. isFrozen: boolean;
  29105. previousBatch: Nullable<_InstancesBatch>;
  29106. hardwareInstancedRendering: boolean;
  29107. sideOrientation: number;
  29108. manualUpdate: boolean;
  29109. }
  29110. /**
  29111. * @hidden
  29112. **/
  29113. export class _InstancesBatch {
  29114. mustReturn: boolean;
  29115. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29116. renderSelf: boolean[];
  29117. hardwareInstancedRendering: boolean[];
  29118. }
  29119. /**
  29120. * @hidden
  29121. **/
  29122. class _ThinInstanceDataStorage {
  29123. instancesCount: number;
  29124. matrixBuffer: Nullable<Buffer>;
  29125. matrixBufferSize: number;
  29126. matrixData: Nullable<Float32Array>;
  29127. boundingVectors: Array<Vector3>;
  29128. worldMatrices: Nullable<Matrix[]>;
  29129. }
  29130. /**
  29131. * Class used to represent renderable models
  29132. */
  29133. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29134. /**
  29135. * Mesh side orientation : usually the external or front surface
  29136. */
  29137. static readonly FRONTSIDE: number;
  29138. /**
  29139. * Mesh side orientation : usually the internal or back surface
  29140. */
  29141. static readonly BACKSIDE: number;
  29142. /**
  29143. * Mesh side orientation : both internal and external or front and back surfaces
  29144. */
  29145. static readonly DOUBLESIDE: number;
  29146. /**
  29147. * Mesh side orientation : by default, `FRONTSIDE`
  29148. */
  29149. static readonly DEFAULTSIDE: number;
  29150. /**
  29151. * Mesh cap setting : no cap
  29152. */
  29153. static readonly NO_CAP: number;
  29154. /**
  29155. * Mesh cap setting : one cap at the beginning of the mesh
  29156. */
  29157. static readonly CAP_START: number;
  29158. /**
  29159. * Mesh cap setting : one cap at the end of the mesh
  29160. */
  29161. static readonly CAP_END: number;
  29162. /**
  29163. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29164. */
  29165. static readonly CAP_ALL: number;
  29166. /**
  29167. * Mesh pattern setting : no flip or rotate
  29168. */
  29169. static readonly NO_FLIP: number;
  29170. /**
  29171. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29172. */
  29173. static readonly FLIP_TILE: number;
  29174. /**
  29175. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29176. */
  29177. static readonly ROTATE_TILE: number;
  29178. /**
  29179. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29180. */
  29181. static readonly FLIP_ROW: number;
  29182. /**
  29183. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29184. */
  29185. static readonly ROTATE_ROW: number;
  29186. /**
  29187. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29188. */
  29189. static readonly FLIP_N_ROTATE_TILE: number;
  29190. /**
  29191. * Mesh pattern setting : rotate pattern and rotate
  29192. */
  29193. static readonly FLIP_N_ROTATE_ROW: number;
  29194. /**
  29195. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29196. */
  29197. static readonly CENTER: number;
  29198. /**
  29199. * Mesh tile positioning : part tiles on left
  29200. */
  29201. static readonly LEFT: number;
  29202. /**
  29203. * Mesh tile positioning : part tiles on right
  29204. */
  29205. static readonly RIGHT: number;
  29206. /**
  29207. * Mesh tile positioning : part tiles on top
  29208. */
  29209. static readonly TOP: number;
  29210. /**
  29211. * Mesh tile positioning : part tiles on bottom
  29212. */
  29213. static readonly BOTTOM: number;
  29214. /**
  29215. * Gets the default side orientation.
  29216. * @param orientation the orientation to value to attempt to get
  29217. * @returns the default orientation
  29218. * @hidden
  29219. */
  29220. static _GetDefaultSideOrientation(orientation?: number): number;
  29221. private _internalMeshDataInfo;
  29222. get computeBonesUsingShaders(): boolean;
  29223. set computeBonesUsingShaders(value: boolean);
  29224. /**
  29225. * An event triggered before rendering the mesh
  29226. */
  29227. get onBeforeRenderObservable(): Observable<Mesh>;
  29228. /**
  29229. * An event triggered before binding the mesh
  29230. */
  29231. get onBeforeBindObservable(): Observable<Mesh>;
  29232. /**
  29233. * An event triggered after rendering the mesh
  29234. */
  29235. get onAfterRenderObservable(): Observable<Mesh>;
  29236. /**
  29237. * An event triggered before drawing the mesh
  29238. */
  29239. get onBeforeDrawObservable(): Observable<Mesh>;
  29240. private _onBeforeDrawObserver;
  29241. /**
  29242. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29243. */
  29244. set onBeforeDraw(callback: () => void);
  29245. get hasInstances(): boolean;
  29246. get hasThinInstances(): boolean;
  29247. /**
  29248. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29249. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29250. */
  29251. delayLoadState: number;
  29252. /**
  29253. * Gets the list of instances created from this mesh
  29254. * it is not supposed to be modified manually.
  29255. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29256. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29257. */
  29258. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29259. /**
  29260. * Gets the file containing delay loading data for this mesh
  29261. */
  29262. delayLoadingFile: string;
  29263. /** @hidden */
  29264. _binaryInfo: any;
  29265. /**
  29266. * User defined function used to change how LOD level selection is done
  29267. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29268. */
  29269. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29270. /**
  29271. * Gets or sets the morph target manager
  29272. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29273. */
  29274. get morphTargetManager(): Nullable<MorphTargetManager>;
  29275. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29276. /** @hidden */
  29277. _creationDataStorage: Nullable<_CreationDataStorage>;
  29278. /** @hidden */
  29279. _geometry: Nullable<Geometry>;
  29280. /** @hidden */
  29281. _delayInfo: Array<string>;
  29282. /** @hidden */
  29283. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29284. /** @hidden */
  29285. _instanceDataStorage: _InstanceDataStorage;
  29286. /** @hidden */
  29287. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29288. private _effectiveMaterial;
  29289. /** @hidden */
  29290. _shouldGenerateFlatShading: boolean;
  29291. /** @hidden */
  29292. _originalBuilderSideOrientation: number;
  29293. /**
  29294. * Use this property to change the original side orientation defined at construction time
  29295. */
  29296. overrideMaterialSideOrientation: Nullable<number>;
  29297. /**
  29298. * Gets the source mesh (the one used to clone this one from)
  29299. */
  29300. get source(): Nullable<Mesh>;
  29301. /**
  29302. * Gets the list of clones of this mesh
  29303. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29304. * Note that useClonedMeshMap=true is the default setting
  29305. */
  29306. get cloneMeshMap(): Nullable<{
  29307. [id: string]: Mesh | undefined;
  29308. }>;
  29309. /**
  29310. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29311. */
  29312. get isUnIndexed(): boolean;
  29313. set isUnIndexed(value: boolean);
  29314. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29315. get worldMatrixInstancedBuffer(): Float32Array;
  29316. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29317. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29318. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29319. /**
  29320. * @constructor
  29321. * @param name The value used by scene.getMeshByName() to do a lookup.
  29322. * @param scene The scene to add this mesh to.
  29323. * @param parent The parent of this mesh, if it has one
  29324. * @param source An optional Mesh from which geometry is shared, cloned.
  29325. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29326. * When false, achieved by calling a clone(), also passing False.
  29327. * This will make creation of children, recursive.
  29328. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29329. */
  29330. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29331. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29332. doNotInstantiate: boolean;
  29333. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29334. /**
  29335. * Gets the class name
  29336. * @returns the string "Mesh".
  29337. */
  29338. getClassName(): string;
  29339. /** @hidden */
  29340. get _isMesh(): boolean;
  29341. /**
  29342. * Returns a description of this mesh
  29343. * @param fullDetails define if full details about this mesh must be used
  29344. * @returns a descriptive string representing this mesh
  29345. */
  29346. toString(fullDetails?: boolean): string;
  29347. /** @hidden */
  29348. _unBindEffect(): void;
  29349. /**
  29350. * Gets a boolean indicating if this mesh has LOD
  29351. */
  29352. get hasLODLevels(): boolean;
  29353. /**
  29354. * Gets the list of MeshLODLevel associated with the current mesh
  29355. * @returns an array of MeshLODLevel
  29356. */
  29357. getLODLevels(): MeshLODLevel[];
  29358. private _sortLODLevels;
  29359. /**
  29360. * Add a mesh as LOD level triggered at the given distance.
  29361. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29362. * @param distance The distance from the center of the object to show this level
  29363. * @param mesh The mesh to be added as LOD level (can be null)
  29364. * @return This mesh (for chaining)
  29365. */
  29366. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29367. /**
  29368. * Returns the LOD level mesh at the passed distance or null if not found.
  29369. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29370. * @param distance The distance from the center of the object to show this level
  29371. * @returns a Mesh or `null`
  29372. */
  29373. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29374. /**
  29375. * Remove a mesh from the LOD array
  29376. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29377. * @param mesh defines the mesh to be removed
  29378. * @return This mesh (for chaining)
  29379. */
  29380. removeLODLevel(mesh: Mesh): Mesh;
  29381. /**
  29382. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29383. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29384. * @param camera defines the camera to use to compute distance
  29385. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29386. * @return This mesh (for chaining)
  29387. */
  29388. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29389. /**
  29390. * Gets the mesh internal Geometry object
  29391. */
  29392. get geometry(): Nullable<Geometry>;
  29393. /**
  29394. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29395. * @returns the total number of vertices
  29396. */
  29397. getTotalVertices(): number;
  29398. /**
  29399. * Returns the content of an associated vertex buffer
  29400. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29401. * - VertexBuffer.PositionKind
  29402. * - VertexBuffer.UVKind
  29403. * - VertexBuffer.UV2Kind
  29404. * - VertexBuffer.UV3Kind
  29405. * - VertexBuffer.UV4Kind
  29406. * - VertexBuffer.UV5Kind
  29407. * - VertexBuffer.UV6Kind
  29408. * - VertexBuffer.ColorKind
  29409. * - VertexBuffer.MatricesIndicesKind
  29410. * - VertexBuffer.MatricesIndicesExtraKind
  29411. * - VertexBuffer.MatricesWeightsKind
  29412. * - VertexBuffer.MatricesWeightsExtraKind
  29413. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  29414. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29415. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29416. */
  29417. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29418. /**
  29419. * Returns the mesh VertexBuffer object from the requested `kind`
  29420. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29421. * - VertexBuffer.PositionKind
  29422. * - VertexBuffer.NormalKind
  29423. * - VertexBuffer.UVKind
  29424. * - VertexBuffer.UV2Kind
  29425. * - VertexBuffer.UV3Kind
  29426. * - VertexBuffer.UV4Kind
  29427. * - VertexBuffer.UV5Kind
  29428. * - VertexBuffer.UV6Kind
  29429. * - VertexBuffer.ColorKind
  29430. * - VertexBuffer.MatricesIndicesKind
  29431. * - VertexBuffer.MatricesIndicesExtraKind
  29432. * - VertexBuffer.MatricesWeightsKind
  29433. * - VertexBuffer.MatricesWeightsExtraKind
  29434. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29435. */
  29436. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29437. /**
  29438. * Tests if a specific vertex buffer is associated with this mesh
  29439. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29440. * - VertexBuffer.PositionKind
  29441. * - VertexBuffer.NormalKind
  29442. * - VertexBuffer.UVKind
  29443. * - VertexBuffer.UV2Kind
  29444. * - VertexBuffer.UV3Kind
  29445. * - VertexBuffer.UV4Kind
  29446. * - VertexBuffer.UV5Kind
  29447. * - VertexBuffer.UV6Kind
  29448. * - VertexBuffer.ColorKind
  29449. * - VertexBuffer.MatricesIndicesKind
  29450. * - VertexBuffer.MatricesIndicesExtraKind
  29451. * - VertexBuffer.MatricesWeightsKind
  29452. * - VertexBuffer.MatricesWeightsExtraKind
  29453. * @returns a boolean
  29454. */
  29455. isVerticesDataPresent(kind: string): boolean;
  29456. /**
  29457. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29458. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29459. * - VertexBuffer.PositionKind
  29460. * - VertexBuffer.UVKind
  29461. * - VertexBuffer.UV2Kind
  29462. * - VertexBuffer.UV3Kind
  29463. * - VertexBuffer.UV4Kind
  29464. * - VertexBuffer.UV5Kind
  29465. * - VertexBuffer.UV6Kind
  29466. * - VertexBuffer.ColorKind
  29467. * - VertexBuffer.MatricesIndicesKind
  29468. * - VertexBuffer.MatricesIndicesExtraKind
  29469. * - VertexBuffer.MatricesWeightsKind
  29470. * - VertexBuffer.MatricesWeightsExtraKind
  29471. * @returns a boolean
  29472. */
  29473. isVertexBufferUpdatable(kind: string): boolean;
  29474. /**
  29475. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29476. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29477. * - VertexBuffer.PositionKind
  29478. * - VertexBuffer.NormalKind
  29479. * - VertexBuffer.UVKind
  29480. * - VertexBuffer.UV2Kind
  29481. * - VertexBuffer.UV3Kind
  29482. * - VertexBuffer.UV4Kind
  29483. * - VertexBuffer.UV5Kind
  29484. * - VertexBuffer.UV6Kind
  29485. * - VertexBuffer.ColorKind
  29486. * - VertexBuffer.MatricesIndicesKind
  29487. * - VertexBuffer.MatricesIndicesExtraKind
  29488. * - VertexBuffer.MatricesWeightsKind
  29489. * - VertexBuffer.MatricesWeightsExtraKind
  29490. * @returns an array of strings
  29491. */
  29492. getVerticesDataKinds(): string[];
  29493. /**
  29494. * Returns a positive integer : the total number of indices in this mesh geometry.
  29495. * @returns the numner of indices or zero if the mesh has no geometry.
  29496. */
  29497. getTotalIndices(): number;
  29498. /**
  29499. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29500. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  29501. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29502. * @returns the indices array or an empty array if the mesh has no geometry
  29503. */
  29504. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29505. get isBlocked(): boolean;
  29506. /**
  29507. * Determine if the current mesh is ready to be rendered
  29508. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29509. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29510. * @returns true if all associated assets are ready (material, textures, shaders)
  29511. */
  29512. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29513. /**
  29514. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  29515. */
  29516. get areNormalsFrozen(): boolean;
  29517. /**
  29518. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  29519. * @returns the current mesh
  29520. */
  29521. freezeNormals(): Mesh;
  29522. /**
  29523. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  29524. * @returns the current mesh
  29525. */
  29526. unfreezeNormals(): Mesh;
  29527. /**
  29528. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29529. */
  29530. set overridenInstanceCount(count: number);
  29531. /** @hidden */
  29532. _preActivate(): Mesh;
  29533. /** @hidden */
  29534. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29535. /** @hidden */
  29536. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29537. protected _afterComputeWorldMatrix(): void;
  29538. /** @hidden */
  29539. _postActivate(): void;
  29540. /**
  29541. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29542. * This means the mesh underlying bounding box and sphere are recomputed.
  29543. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29544. * @returns the current mesh
  29545. */
  29546. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29547. /** @hidden */
  29548. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29549. /**
  29550. * This function will subdivide the mesh into multiple submeshes
  29551. * @param count defines the expected number of submeshes
  29552. */
  29553. subdivide(count: number): void;
  29554. /**
  29555. * Copy a FloatArray into a specific associated vertex buffer
  29556. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29557. * - VertexBuffer.PositionKind
  29558. * - VertexBuffer.UVKind
  29559. * - VertexBuffer.UV2Kind
  29560. * - VertexBuffer.UV3Kind
  29561. * - VertexBuffer.UV4Kind
  29562. * - VertexBuffer.UV5Kind
  29563. * - VertexBuffer.UV6Kind
  29564. * - VertexBuffer.ColorKind
  29565. * - VertexBuffer.MatricesIndicesKind
  29566. * - VertexBuffer.MatricesIndicesExtraKind
  29567. * - VertexBuffer.MatricesWeightsKind
  29568. * - VertexBuffer.MatricesWeightsExtraKind
  29569. * @param data defines the data source
  29570. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29571. * @param stride defines the data stride size (can be null)
  29572. * @returns the current mesh
  29573. */
  29574. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29575. /**
  29576. * Delete a vertex buffer associated with this mesh
  29577. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29578. * - VertexBuffer.PositionKind
  29579. * - VertexBuffer.UVKind
  29580. * - VertexBuffer.UV2Kind
  29581. * - VertexBuffer.UV3Kind
  29582. * - VertexBuffer.UV4Kind
  29583. * - VertexBuffer.UV5Kind
  29584. * - VertexBuffer.UV6Kind
  29585. * - VertexBuffer.ColorKind
  29586. * - VertexBuffer.MatricesIndicesKind
  29587. * - VertexBuffer.MatricesIndicesExtraKind
  29588. * - VertexBuffer.MatricesWeightsKind
  29589. * - VertexBuffer.MatricesWeightsExtraKind
  29590. */
  29591. removeVerticesData(kind: string): void;
  29592. /**
  29593. * Flags an associated vertex buffer as updatable
  29594. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29595. * - VertexBuffer.PositionKind
  29596. * - VertexBuffer.UVKind
  29597. * - VertexBuffer.UV2Kind
  29598. * - VertexBuffer.UV3Kind
  29599. * - VertexBuffer.UV4Kind
  29600. * - VertexBuffer.UV5Kind
  29601. * - VertexBuffer.UV6Kind
  29602. * - VertexBuffer.ColorKind
  29603. * - VertexBuffer.MatricesIndicesKind
  29604. * - VertexBuffer.MatricesIndicesExtraKind
  29605. * - VertexBuffer.MatricesWeightsKind
  29606. * - VertexBuffer.MatricesWeightsExtraKind
  29607. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29608. */
  29609. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29610. /**
  29611. * Sets the mesh global Vertex Buffer
  29612. * @param buffer defines the buffer to use
  29613. * @returns the current mesh
  29614. */
  29615. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29616. /**
  29617. * Update a specific associated vertex buffer
  29618. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29619. * - VertexBuffer.PositionKind
  29620. * - VertexBuffer.UVKind
  29621. * - VertexBuffer.UV2Kind
  29622. * - VertexBuffer.UV3Kind
  29623. * - VertexBuffer.UV4Kind
  29624. * - VertexBuffer.UV5Kind
  29625. * - VertexBuffer.UV6Kind
  29626. * - VertexBuffer.ColorKind
  29627. * - VertexBuffer.MatricesIndicesKind
  29628. * - VertexBuffer.MatricesIndicesExtraKind
  29629. * - VertexBuffer.MatricesWeightsKind
  29630. * - VertexBuffer.MatricesWeightsExtraKind
  29631. * @param data defines the data source
  29632. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29633. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  29634. * @returns the current mesh
  29635. */
  29636. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29637. /**
  29638. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29639. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29640. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29641. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29642. * @returns the current mesh
  29643. */
  29644. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29645. /**
  29646. * Creates a un-shared specific occurence of the geometry for the mesh.
  29647. * @returns the current mesh
  29648. */
  29649. makeGeometryUnique(): Mesh;
  29650. /**
  29651. * Set the index buffer of this mesh
  29652. * @param indices defines the source data
  29653. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29654. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29655. * @returns the current mesh
  29656. */
  29657. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29658. /**
  29659. * Update the current index buffer
  29660. * @param indices defines the source data
  29661. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29662. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  29663. * @returns the current mesh
  29664. */
  29665. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29666. /**
  29667. * Invert the geometry to move from a right handed system to a left handed one.
  29668. * @returns the current mesh
  29669. */
  29670. toLeftHanded(): Mesh;
  29671. /** @hidden */
  29672. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29673. /** @hidden */
  29674. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29675. /**
  29676. * Registers for this mesh a javascript function called just before the rendering process
  29677. * @param func defines the function to call before rendering this mesh
  29678. * @returns the current mesh
  29679. */
  29680. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29681. /**
  29682. * Disposes a previously registered javascript function called before the rendering
  29683. * @param func defines the function to remove
  29684. * @returns the current mesh
  29685. */
  29686. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29687. /**
  29688. * Registers for this mesh a javascript function called just after the rendering is complete
  29689. * @param func defines the function to call after rendering this mesh
  29690. * @returns the current mesh
  29691. */
  29692. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29693. /**
  29694. * Disposes a previously registered javascript function called after the rendering.
  29695. * @param func defines the function to remove
  29696. * @returns the current mesh
  29697. */
  29698. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29699. /** @hidden */
  29700. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29701. /** @hidden */
  29702. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29703. /** @hidden */
  29704. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29705. /** @hidden */
  29706. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29707. /** @hidden */
  29708. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29709. /** @hidden */
  29710. _rebuild(): void;
  29711. /** @hidden */
  29712. _freeze(): void;
  29713. /** @hidden */
  29714. _unFreeze(): void;
  29715. /**
  29716. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  29717. * @param subMesh defines the subMesh to render
  29718. * @param enableAlphaMode defines if alpha mode can be changed
  29719. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29720. * @returns the current mesh
  29721. */
  29722. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29723. private _onBeforeDraw;
  29724. /**
  29725. * Renormalize the mesh and patch it up if there are no weights
  29726. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29727. * However in the case of zero weights then we set just a single influence to 1.
  29728. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29729. */
  29730. cleanMatrixWeights(): void;
  29731. private normalizeSkinFourWeights;
  29732. private normalizeSkinWeightsAndExtra;
  29733. /**
  29734. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29735. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29736. * the user know there was an issue with importing the mesh
  29737. * @returns a validation object with skinned, valid and report string
  29738. */
  29739. validateSkinning(): {
  29740. skinned: boolean;
  29741. valid: boolean;
  29742. report: string;
  29743. };
  29744. /** @hidden */
  29745. _checkDelayState(): Mesh;
  29746. private _queueLoad;
  29747. /**
  29748. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29749. * A mesh is in the frustum if its bounding box intersects the frustum
  29750. * @param frustumPlanes defines the frustum to test
  29751. * @returns true if the mesh is in the frustum planes
  29752. */
  29753. isInFrustum(frustumPlanes: Plane[]): boolean;
  29754. /**
  29755. * Sets the mesh material by the material or multiMaterial `id` property
  29756. * @param id is a string identifying the material or the multiMaterial
  29757. * @returns the current mesh
  29758. */
  29759. setMaterialByID(id: string): Mesh;
  29760. /**
  29761. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29762. * @returns an array of IAnimatable
  29763. */
  29764. getAnimatables(): IAnimatable[];
  29765. /**
  29766. * Modifies the mesh geometry according to the passed transformation matrix.
  29767. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29768. * The mesh normals are modified using the same transformation.
  29769. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29770. * @param transform defines the transform matrix to use
  29771. * @see https://doc.babylonjs.com/resources/baking_transformations
  29772. * @returns the current mesh
  29773. */
  29774. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29775. /**
  29776. * Modifies the mesh geometry according to its own current World Matrix.
  29777. * The mesh World Matrix is then reset.
  29778. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29779. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29780. * @see https://doc.babylonjs.com/resources/baking_transformations
  29781. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29782. * @returns the current mesh
  29783. */
  29784. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29785. /** @hidden */
  29786. get _positions(): Nullable<Vector3[]>;
  29787. /** @hidden */
  29788. _resetPointsArrayCache(): Mesh;
  29789. /** @hidden */
  29790. _generatePointsArray(): boolean;
  29791. /**
  29792. * Returns a new Mesh object generated from the current mesh properties.
  29793. * This method must not get confused with createInstance()
  29794. * @param name is a string, the name given to the new mesh
  29795. * @param newParent can be any Node object (default `null`)
  29796. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29797. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29798. * @returns a new mesh
  29799. */
  29800. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29801. /**
  29802. * Releases resources associated with this mesh.
  29803. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29804. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29805. */
  29806. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29807. /** @hidden */
  29808. _disposeInstanceSpecificData(): void;
  29809. /** @hidden */
  29810. _disposeThinInstanceSpecificData(): void;
  29811. /**
  29812. * Modifies the mesh geometry according to a displacement map.
  29813. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29814. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29815. * @param url is a string, the URL from the image file is to be downloaded.
  29816. * @param minHeight is the lower limit of the displacement.
  29817. * @param maxHeight is the upper limit of the displacement.
  29818. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29819. * @param uvOffset is an optional vector2 used to offset UV.
  29820. * @param uvScale is an optional vector2 used to scale UV.
  29821. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29822. * @returns the Mesh.
  29823. */
  29824. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29825. /**
  29826. * Modifies the mesh geometry according to a displacementMap buffer.
  29827. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  29828. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29829. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29830. * @param heightMapWidth is the width of the buffer image.
  29831. * @param heightMapHeight is the height of the buffer image.
  29832. * @param minHeight is the lower limit of the displacement.
  29833. * @param maxHeight is the upper limit of the displacement.
  29834. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  29835. * @param uvOffset is an optional vector2 used to offset UV.
  29836. * @param uvScale is an optional vector2 used to scale UV.
  29837. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  29838. * @returns the Mesh.
  29839. */
  29840. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29841. /**
  29842. * Modify the mesh to get a flat shading rendering.
  29843. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29844. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29845. * @returns current mesh
  29846. */
  29847. convertToFlatShadedMesh(): Mesh;
  29848. /**
  29849. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29850. * In other words, more vertices, no more indices and a single bigger VBO.
  29851. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29852. * @returns current mesh
  29853. */
  29854. convertToUnIndexedMesh(): Mesh;
  29855. /**
  29856. * Inverses facet orientations.
  29857. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29858. * @param flipNormals will also inverts the normals
  29859. * @returns current mesh
  29860. */
  29861. flipFaces(flipNormals?: boolean): Mesh;
  29862. /**
  29863. * Increase the number of facets and hence vertices in a mesh
  29864. * Vertex normals are interpolated from existing vertex normals
  29865. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29866. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29867. */
  29868. increaseVertices(numberPerEdge: number): void;
  29869. /**
  29870. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29871. * This will undo any application of covertToFlatShadedMesh
  29872. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29873. */
  29874. forceSharedVertices(): void;
  29875. /** @hidden */
  29876. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29877. /** @hidden */
  29878. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29879. /**
  29880. * Creates a new InstancedMesh object from the mesh model.
  29881. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29882. * @param name defines the name of the new instance
  29883. * @returns a new InstancedMesh
  29884. */
  29885. createInstance(name: string): InstancedMesh;
  29886. /**
  29887. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29888. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29889. * @returns the current mesh
  29890. */
  29891. synchronizeInstances(): Mesh;
  29892. /**
  29893. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29894. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29895. * This should be used together with the simplification to avoid disappearing triangles.
  29896. * @param successCallback an optional success callback to be called after the optimization finished.
  29897. * @returns the current mesh
  29898. */
  29899. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29900. /**
  29901. * Serialize current mesh
  29902. * @param serializationObject defines the object which will receive the serialization data
  29903. */
  29904. serialize(serializationObject: any): void;
  29905. /** @hidden */
  29906. _syncGeometryWithMorphTargetManager(): void;
  29907. /** @hidden */
  29908. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29909. /**
  29910. * Returns a new Mesh object parsed from the source provided.
  29911. * @param parsedMesh is the source
  29912. * @param scene defines the hosting scene
  29913. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29914. * @returns a new Mesh
  29915. */
  29916. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29917. /**
  29918. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29919. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29920. * @param name defines the name of the mesh to create
  29921. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29922. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29923. * @param closePath creates a seam between the first and the last points of each path of the path array
  29924. * @param offset is taken in account only if the `pathArray` is containing a single path
  29925. * @param scene defines the hosting scene
  29926. * @param updatable defines if the mesh must be flagged as updatable
  29927. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29928. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  29929. * @returns a new Mesh
  29930. */
  29931. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29932. /**
  29933. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29934. * @param name defines the name of the mesh to create
  29935. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29936. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  29937. * @param scene defines the hosting scene
  29938. * @param updatable defines if the mesh must be flagged as updatable
  29939. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29940. * @returns a new Mesh
  29941. */
  29942. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29943. /**
  29944. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29945. * @param name defines the name of the mesh to create
  29946. * @param size sets the size (float) of each box side (default 1)
  29947. * @param scene defines the hosting scene
  29948. * @param updatable defines if the mesh must be flagged as updatable
  29949. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29950. * @returns a new Mesh
  29951. */
  29952. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29953. /**
  29954. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29955. * @param name defines the name of the mesh to create
  29956. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29957. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29958. * @param scene defines the hosting scene
  29959. * @param updatable defines if the mesh must be flagged as updatable
  29960. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29961. * @returns a new Mesh
  29962. */
  29963. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29964. /**
  29965. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29966. * @param name defines the name of the mesh to create
  29967. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29968. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29969. * @param scene defines the hosting scene
  29970. * @returns a new Mesh
  29971. */
  29972. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29973. /**
  29974. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29975. * @param name defines the name of the mesh to create
  29976. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29977. * @param diameterTop set the top cap diameter (floats, default 1)
  29978. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29979. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29980. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29981. * @param scene defines the hosting scene
  29982. * @param updatable defines if the mesh must be flagged as updatable
  29983. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29984. * @returns a new Mesh
  29985. */
  29986. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29987. /**
  29988. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29989. * @param name defines the name of the mesh to create
  29990. * @param diameter sets the diameter size (float) of the torus (default 1)
  29991. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29992. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29993. * @param scene defines the hosting scene
  29994. * @param updatable defines if the mesh must be flagged as updatable
  29995. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29996. * @returns a new Mesh
  29997. */
  29998. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29999. /**
  30000. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30001. * @param name defines the name of the mesh to create
  30002. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30003. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30004. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30005. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30006. * @param p the number of windings on X axis (positive integers, default 2)
  30007. * @param q the number of windings on Y axis (positive integers, default 3)
  30008. * @param scene defines the hosting scene
  30009. * @param updatable defines if the mesh must be flagged as updatable
  30010. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30011. * @returns a new Mesh
  30012. */
  30013. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30014. /**
  30015. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30016. * @param name defines the name of the mesh to create
  30017. * @param points is an array successive Vector3
  30018. * @param scene defines the hosting scene
  30019. * @param updatable defines if the mesh must be flagged as updatable
  30020. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  30021. * @returns a new Mesh
  30022. */
  30023. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30024. /**
  30025. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30026. * @param name defines the name of the mesh to create
  30027. * @param points is an array successive Vector3
  30028. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30029. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30030. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30031. * @param scene defines the hosting scene
  30032. * @param updatable defines if the mesh must be flagged as updatable
  30033. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  30034. * @returns a new Mesh
  30035. */
  30036. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30037. /**
  30038. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30039. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30040. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  30041. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30042. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30043. * Remember you can only change the shape positions, not their number when updating a polygon.
  30044. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30045. * @param name defines the name of the mesh to create
  30046. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30047. * @param scene defines the hosting scene
  30048. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30049. * @param updatable defines if the mesh must be flagged as updatable
  30050. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30051. * @param earcutInjection can be used to inject your own earcut reference
  30052. * @returns a new Mesh
  30053. */
  30054. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30055. /**
  30056. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30057. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30058. * @param name defines the name of the mesh to create
  30059. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  30060. * @param depth defines the height of extrusion
  30061. * @param scene defines the hosting scene
  30062. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30063. * @param updatable defines if the mesh must be flagged as updatable
  30064. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30065. * @param earcutInjection can be used to inject your own earcut reference
  30066. * @returns a new Mesh
  30067. */
  30068. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30069. /**
  30070. * Creates an extruded shape mesh.
  30071. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  30072. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30073. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30074. * @param name defines the name of the mesh to create
  30075. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30076. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30077. * @param scale is the value to scale the shape
  30078. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  30079. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30080. * @param scene defines the hosting scene
  30081. * @param updatable defines if the mesh must be flagged as updatable
  30082. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30083. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  30084. * @returns a new Mesh
  30085. */
  30086. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30087. /**
  30088. * Creates an custom extruded shape mesh.
  30089. * The custom extrusion is a parametric shape.
  30090. * It has no predefined shape. Its final shape will depend on the input parameters.
  30091. * Please consider using the same method from the MeshBuilder class instead
  30092. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30093. * @param name defines the name of the mesh to create
  30094. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  30095. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30096. * @param scaleFunction is a custom Javascript function called on each path point
  30097. * @param rotationFunction is a custom Javascript function called on each path point
  30098. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30099. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30100. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30101. * @param scene defines the hosting scene
  30102. * @param updatable defines if the mesh must be flagged as updatable
  30103. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30104. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  30105. * @returns a new Mesh
  30106. */
  30107. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30108. /**
  30109. * Creates lathe mesh.
  30110. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30111. * Please consider using the same method from the MeshBuilder class instead
  30112. * @param name defines the name of the mesh to create
  30113. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  30114. * @param radius is the radius value of the lathe
  30115. * @param tessellation is the side number of the lathe.
  30116. * @param scene defines the hosting scene
  30117. * @param updatable defines if the mesh must be flagged as updatable
  30118. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30119. * @returns a new Mesh
  30120. */
  30121. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30122. /**
  30123. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30124. * @param name defines the name of the mesh to create
  30125. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30126. * @param scene defines the hosting scene
  30127. * @param updatable defines if the mesh must be flagged as updatable
  30128. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30129. * @returns a new Mesh
  30130. */
  30131. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30132. /**
  30133. * Creates a ground mesh.
  30134. * Please consider using the same method from the MeshBuilder class instead
  30135. * @param name defines the name of the mesh to create
  30136. * @param width set the width of the ground
  30137. * @param height set the height of the ground
  30138. * @param subdivisions sets the number of subdivisions per side
  30139. * @param scene defines the hosting scene
  30140. * @param updatable defines if the mesh must be flagged as updatable
  30141. * @returns a new Mesh
  30142. */
  30143. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30144. /**
  30145. * Creates a tiled ground mesh.
  30146. * Please consider using the same method from the MeshBuilder class instead
  30147. * @param name defines the name of the mesh to create
  30148. * @param xmin set the ground minimum X coordinate
  30149. * @param zmin set the ground minimum Y coordinate
  30150. * @param xmax set the ground maximum X coordinate
  30151. * @param zmax set the ground maximum Z coordinate
  30152. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  30153. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  30154. * @param scene defines the hosting scene
  30155. * @param updatable defines if the mesh must be flagged as updatable
  30156. * @returns a new Mesh
  30157. */
  30158. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30159. w: number;
  30160. h: number;
  30161. }, precision: {
  30162. w: number;
  30163. h: number;
  30164. }, scene: Scene, updatable?: boolean): Mesh;
  30165. /**
  30166. * Creates a ground mesh from a height map.
  30167. * Please consider using the same method from the MeshBuilder class instead
  30168. * @see https://doc.babylonjs.com/babylon101/height_map
  30169. * @param name defines the name of the mesh to create
  30170. * @param url sets the URL of the height map image resource
  30171. * @param width set the ground width size
  30172. * @param height set the ground height size
  30173. * @param subdivisions sets the number of subdivision per side
  30174. * @param minHeight is the minimum altitude on the ground
  30175. * @param maxHeight is the maximum altitude on the ground
  30176. * @param scene defines the hosting scene
  30177. * @param updatable defines if the mesh must be flagged as updatable
  30178. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30179. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30180. * @returns a new Mesh
  30181. */
  30182. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  30183. /**
  30184. * Creates a tube mesh.
  30185. * The tube is a parametric shape.
  30186. * It has no predefined shape. Its final shape will depend on the input parameters.
  30187. * Please consider using the same method from the MeshBuilder class instead
  30188. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30189. * @param name defines the name of the mesh to create
  30190. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30191. * @param radius sets the tube radius size
  30192. * @param tessellation is the number of sides on the tubular surface
  30193. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  30194. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  30195. * @param scene defines the hosting scene
  30196. * @param updatable defines if the mesh must be flagged as updatable
  30197. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30198. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  30199. * @returns a new Mesh
  30200. */
  30201. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30202. (i: number, distance: number): number;
  30203. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30204. /**
  30205. * Creates a polyhedron mesh.
  30206. * Please consider using the same method from the MeshBuilder class instead.
  30207. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  30208. * * The parameter `size` (positive float, default 1) sets the polygon size
  30209. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30210. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  30211. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  30212. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  30213. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  30214. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  30215. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30216. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30217. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30218. * @param name defines the name of the mesh to create
  30219. * @param options defines the options used to create the mesh
  30220. * @param scene defines the hosting scene
  30221. * @returns a new Mesh
  30222. */
  30223. static CreatePolyhedron(name: string, options: {
  30224. type?: number;
  30225. size?: number;
  30226. sizeX?: number;
  30227. sizeY?: number;
  30228. sizeZ?: number;
  30229. custom?: any;
  30230. faceUV?: Vector4[];
  30231. faceColors?: Color4[];
  30232. updatable?: boolean;
  30233. sideOrientation?: number;
  30234. }, scene: Scene): Mesh;
  30235. /**
  30236. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30237. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30238. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  30239. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30240. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  30241. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30242. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30243. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30244. * @param name defines the name of the mesh
  30245. * @param options defines the options used to create the mesh
  30246. * @param scene defines the hosting scene
  30247. * @returns a new Mesh
  30248. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30249. */
  30250. static CreateIcoSphere(name: string, options: {
  30251. radius?: number;
  30252. flat?: boolean;
  30253. subdivisions?: number;
  30254. sideOrientation?: number;
  30255. updatable?: boolean;
  30256. }, scene: Scene): Mesh;
  30257. /**
  30258. * Creates a decal mesh.
  30259. * Please consider using the same method from the MeshBuilder class instead.
  30260. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30261. * @param name defines the name of the mesh
  30262. * @param sourceMesh defines the mesh receiving the decal
  30263. * @param position sets the position of the decal in world coordinates
  30264. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30265. * @param size sets the decal scaling
  30266. * @param angle sets the angle to rotate the decal
  30267. * @returns a new Mesh
  30268. */
  30269. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30270. /**
  30271. * Prepare internal position array for software CPU skinning
  30272. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30273. */
  30274. setPositionsForCPUSkinning(): Float32Array;
  30275. /**
  30276. * Prepare internal normal array for software CPU skinning
  30277. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30278. */
  30279. setNormalsForCPUSkinning(): Float32Array;
  30280. /**
  30281. * Updates the vertex buffer by applying transformation from the bones
  30282. * @param skeleton defines the skeleton to apply to current mesh
  30283. * @returns the current mesh
  30284. */
  30285. applySkeleton(skeleton: Skeleton): Mesh;
  30286. /**
  30287. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  30288. * @param meshes defines the list of meshes to scan
  30289. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30290. */
  30291. static MinMax(meshes: AbstractMesh[]): {
  30292. min: Vector3;
  30293. max: Vector3;
  30294. };
  30295. /**
  30296. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30297. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30298. * @returns a vector3
  30299. */
  30300. static Center(meshesOrMinMaxVector: {
  30301. min: Vector3;
  30302. max: Vector3;
  30303. } | AbstractMesh[]): Vector3;
  30304. /**
  30305. * Merge the array of meshes into a single mesh for performance reasons.
  30306. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30307. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30308. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30309. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30310. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30311. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30312. * @returns a new mesh
  30313. */
  30314. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30315. /** @hidden */
  30316. addInstance(instance: InstancedMesh): void;
  30317. /** @hidden */
  30318. removeInstance(instance: InstancedMesh): void;
  30319. }
  30320. }
  30321. declare module "babylonjs/Cameras/camera" {
  30322. import { SmartArray } from "babylonjs/Misc/smartArray";
  30323. import { Observable } from "babylonjs/Misc/observable";
  30324. import { Nullable } from "babylonjs/types";
  30325. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30326. import { Scene } from "babylonjs/scene";
  30327. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30328. import { Node } from "babylonjs/node";
  30329. import { Mesh } from "babylonjs/Meshes/mesh";
  30330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30331. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30332. import { Viewport } from "babylonjs/Maths/math.viewport";
  30333. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30334. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30335. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30336. import { Ray } from "babylonjs/Culling/ray";
  30337. /**
  30338. * This is the base class of all the camera used in the application.
  30339. * @see https://doc.babylonjs.com/features/cameras
  30340. */
  30341. export class Camera extends Node {
  30342. /** @hidden */
  30343. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30344. /**
  30345. * This is the default projection mode used by the cameras.
  30346. * It helps recreating a feeling of perspective and better appreciate depth.
  30347. * This is the best way to simulate real life cameras.
  30348. */
  30349. static readonly PERSPECTIVE_CAMERA: number;
  30350. /**
  30351. * This helps creating camera with an orthographic mode.
  30352. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  30353. */
  30354. static readonly ORTHOGRAPHIC_CAMERA: number;
  30355. /**
  30356. * This is the default FOV mode for perspective cameras.
  30357. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30358. */
  30359. static readonly FOVMODE_VERTICAL_FIXED: number;
  30360. /**
  30361. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30362. */
  30363. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30364. /**
  30365. * This specifies ther is no need for a camera rig.
  30366. * Basically only one eye is rendered corresponding to the camera.
  30367. */
  30368. static readonly RIG_MODE_NONE: number;
  30369. /**
  30370. * Simulates a camera Rig with one blue eye and one red eye.
  30371. * This can be use with 3d blue and red glasses.
  30372. */
  30373. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30374. /**
  30375. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30376. */
  30377. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30378. /**
  30379. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30380. */
  30381. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30382. /**
  30383. * Defines that both eyes of the camera will be rendered over under each other.
  30384. */
  30385. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30386. /**
  30387. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30388. */
  30389. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30390. /**
  30391. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30392. */
  30393. static readonly RIG_MODE_VR: number;
  30394. /**
  30395. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30396. */
  30397. static readonly RIG_MODE_WEBVR: number;
  30398. /**
  30399. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30400. */
  30401. static readonly RIG_MODE_CUSTOM: number;
  30402. /**
  30403. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30404. */
  30405. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30406. /**
  30407. * Define the input manager associated with the camera.
  30408. */
  30409. inputs: CameraInputsManager<Camera>;
  30410. /** @hidden */
  30411. _position: Vector3;
  30412. /**
  30413. * Define the current local position of the camera in the scene
  30414. */
  30415. get position(): Vector3;
  30416. set position(newPosition: Vector3);
  30417. protected _upVector: Vector3;
  30418. /**
  30419. * The vector the camera should consider as up.
  30420. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30421. */
  30422. set upVector(vec: Vector3);
  30423. get upVector(): Vector3;
  30424. /**
  30425. * Define the current limit on the left side for an orthographic camera
  30426. * In scene unit
  30427. */
  30428. orthoLeft: Nullable<number>;
  30429. /**
  30430. * Define the current limit on the right side for an orthographic camera
  30431. * In scene unit
  30432. */
  30433. orthoRight: Nullable<number>;
  30434. /**
  30435. * Define the current limit on the bottom side for an orthographic camera
  30436. * In scene unit
  30437. */
  30438. orthoBottom: Nullable<number>;
  30439. /**
  30440. * Define the current limit on the top side for an orthographic camera
  30441. * In scene unit
  30442. */
  30443. orthoTop: Nullable<number>;
  30444. /**
  30445. * Field Of View is set in Radians. (default is 0.8)
  30446. */
  30447. fov: number;
  30448. /**
  30449. * Define the minimum distance the camera can see from.
  30450. * This is important to note that the depth buffer are not infinite and the closer it starts
  30451. * the more your scene might encounter depth fighting issue.
  30452. */
  30453. minZ: number;
  30454. /**
  30455. * Define the maximum distance the camera can see to.
  30456. * This is important to note that the depth buffer are not infinite and the further it end
  30457. * the more your scene might encounter depth fighting issue.
  30458. */
  30459. maxZ: number;
  30460. /**
  30461. * Define the default inertia of the camera.
  30462. * This helps giving a smooth feeling to the camera movement.
  30463. */
  30464. inertia: number;
  30465. /**
  30466. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30467. */
  30468. mode: number;
  30469. /**
  30470. * Define whether the camera is intermediate.
  30471. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30472. */
  30473. isIntermediate: boolean;
  30474. /**
  30475. * Define the viewport of the camera.
  30476. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30477. */
  30478. viewport: Viewport;
  30479. /**
  30480. * Restricts the camera to viewing objects with the same layerMask.
  30481. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30482. */
  30483. layerMask: number;
  30484. /**
  30485. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30486. */
  30487. fovMode: number;
  30488. /**
  30489. * Rig mode of the camera.
  30490. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30491. * This is normally controlled byt the camera themselves as internal use.
  30492. */
  30493. cameraRigMode: number;
  30494. /**
  30495. * Defines the distance between both "eyes" in case of a RIG
  30496. */
  30497. interaxialDistance: number;
  30498. /**
  30499. * Defines if stereoscopic rendering is done side by side or over under.
  30500. */
  30501. isStereoscopicSideBySide: boolean;
  30502. /**
  30503. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  30504. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30505. * else in the scene. (Eg. security camera)
  30506. *
  30507. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  30508. */
  30509. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30510. /**
  30511. * When set, the camera will render to this render target instead of the default canvas
  30512. *
  30513. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30514. */
  30515. outputRenderTarget: Nullable<RenderTargetTexture>;
  30516. /**
  30517. * Observable triggered when the camera view matrix has changed.
  30518. */
  30519. onViewMatrixChangedObservable: Observable<Camera>;
  30520. /**
  30521. * Observable triggered when the camera Projection matrix has changed.
  30522. */
  30523. onProjectionMatrixChangedObservable: Observable<Camera>;
  30524. /**
  30525. * Observable triggered when the inputs have been processed.
  30526. */
  30527. onAfterCheckInputsObservable: Observable<Camera>;
  30528. /**
  30529. * Observable triggered when reset has been called and applied to the camera.
  30530. */
  30531. onRestoreStateObservable: Observable<Camera>;
  30532. /**
  30533. * Is this camera a part of a rig system?
  30534. */
  30535. isRigCamera: boolean;
  30536. /**
  30537. * If isRigCamera set to true this will be set with the parent camera.
  30538. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30539. */
  30540. rigParent?: Camera;
  30541. /** @hidden */
  30542. _cameraRigParams: any;
  30543. /** @hidden */
  30544. _rigCameras: Camera[];
  30545. /** @hidden */
  30546. _rigPostProcess: Nullable<PostProcess>;
  30547. protected _webvrViewMatrix: Matrix;
  30548. /** @hidden */
  30549. _skipRendering: boolean;
  30550. /** @hidden */
  30551. _projectionMatrix: Matrix;
  30552. /** @hidden */
  30553. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30554. /** @hidden */
  30555. _activeMeshes: SmartArray<AbstractMesh>;
  30556. protected _globalPosition: Vector3;
  30557. /** @hidden */
  30558. _computedViewMatrix: Matrix;
  30559. private _doNotComputeProjectionMatrix;
  30560. private _transformMatrix;
  30561. private _frustumPlanes;
  30562. private _refreshFrustumPlanes;
  30563. private _storedFov;
  30564. private _stateStored;
  30565. /**
  30566. * Instantiates a new camera object.
  30567. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30568. * @see https://doc.babylonjs.com/features/cameras
  30569. * @param name Defines the name of the camera in the scene
  30570. * @param position Defines the position of the camera
  30571. * @param scene Defines the scene the camera belongs too
  30572. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30573. */
  30574. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30575. /**
  30576. * Store current camera state (fov, position, etc..)
  30577. * @returns the camera
  30578. */
  30579. storeState(): Camera;
  30580. /**
  30581. * Restores the camera state values if it has been stored. You must call storeState() first
  30582. */
  30583. protected _restoreStateValues(): boolean;
  30584. /**
  30585. * Restored camera state. You must call storeState() first.
  30586. * @returns true if restored and false otherwise
  30587. */
  30588. restoreState(): boolean;
  30589. /**
  30590. * Gets the class name of the camera.
  30591. * @returns the class name
  30592. */
  30593. getClassName(): string;
  30594. /** @hidden */
  30595. readonly _isCamera: boolean;
  30596. /**
  30597. * Gets a string representation of the camera useful for debug purpose.
  30598. * @param fullDetails Defines that a more verboe level of logging is required
  30599. * @returns the string representation
  30600. */
  30601. toString(fullDetails?: boolean): string;
  30602. /**
  30603. * Gets the current world space position of the camera.
  30604. */
  30605. get globalPosition(): Vector3;
  30606. /**
  30607. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30608. * @returns the active meshe list
  30609. */
  30610. getActiveMeshes(): SmartArray<AbstractMesh>;
  30611. /**
  30612. * Check whether a mesh is part of the current active mesh list of the camera
  30613. * @param mesh Defines the mesh to check
  30614. * @returns true if active, false otherwise
  30615. */
  30616. isActiveMesh(mesh: Mesh): boolean;
  30617. /**
  30618. * Is this camera ready to be used/rendered
  30619. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30620. * @return true if the camera is ready
  30621. */
  30622. isReady(completeCheck?: boolean): boolean;
  30623. /** @hidden */
  30624. _initCache(): void;
  30625. /** @hidden */
  30626. _updateCache(ignoreParentClass?: boolean): void;
  30627. /** @hidden */
  30628. _isSynchronized(): boolean;
  30629. /** @hidden */
  30630. _isSynchronizedViewMatrix(): boolean;
  30631. /** @hidden */
  30632. _isSynchronizedProjectionMatrix(): boolean;
  30633. /**
  30634. * Attach the input controls to a specific dom element to get the input from.
  30635. * @param element Defines the element the controls should be listened from
  30636. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30637. */
  30638. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30639. /**
  30640. * Detach the current controls from the specified dom element.
  30641. * @param element Defines the element to stop listening the inputs from
  30642. */
  30643. detachControl(element: HTMLElement): void;
  30644. /**
  30645. * Update the camera state according to the different inputs gathered during the frame.
  30646. */
  30647. update(): void;
  30648. /** @hidden */
  30649. _checkInputs(): void;
  30650. /** @hidden */
  30651. get rigCameras(): Camera[];
  30652. /**
  30653. * Gets the post process used by the rig cameras
  30654. */
  30655. get rigPostProcess(): Nullable<PostProcess>;
  30656. /**
  30657. * Internal, gets the first post proces.
  30658. * @returns the first post process to be run on this camera.
  30659. */
  30660. _getFirstPostProcess(): Nullable<PostProcess>;
  30661. private _cascadePostProcessesToRigCams;
  30662. /**
  30663. * Attach a post process to the camera.
  30664. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30665. * @param postProcess The post process to attach to the camera
  30666. * @param insertAt The position of the post process in case several of them are in use in the scene
  30667. * @returns the position the post process has been inserted at
  30668. */
  30669. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30670. /**
  30671. * Detach a post process to the camera.
  30672. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30673. * @param postProcess The post process to detach from the camera
  30674. */
  30675. detachPostProcess(postProcess: PostProcess): void;
  30676. /**
  30677. * Gets the current world matrix of the camera
  30678. */
  30679. getWorldMatrix(): Matrix;
  30680. /** @hidden */
  30681. _getViewMatrix(): Matrix;
  30682. /**
  30683. * Gets the current view matrix of the camera.
  30684. * @param force forces the camera to recompute the matrix without looking at the cached state
  30685. * @returns the view matrix
  30686. */
  30687. getViewMatrix(force?: boolean): Matrix;
  30688. /**
  30689. * Freeze the projection matrix.
  30690. * It will prevent the cache check of the camera projection compute and can speed up perf
  30691. * if no parameter of the camera are meant to change
  30692. * @param projection Defines manually a projection if necessary
  30693. */
  30694. freezeProjectionMatrix(projection?: Matrix): void;
  30695. /**
  30696. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30697. */
  30698. unfreezeProjectionMatrix(): void;
  30699. /**
  30700. * Gets the current projection matrix of the camera.
  30701. * @param force forces the camera to recompute the matrix without looking at the cached state
  30702. * @returns the projection matrix
  30703. */
  30704. getProjectionMatrix(force?: boolean): Matrix;
  30705. /**
  30706. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30707. * @returns a Matrix
  30708. */
  30709. getTransformationMatrix(): Matrix;
  30710. private _updateFrustumPlanes;
  30711. /**
  30712. * Checks if a cullable object (mesh...) is in the camera frustum
  30713. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30714. * @param target The object to check
  30715. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30716. * @returns true if the object is in frustum otherwise false
  30717. */
  30718. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30719. /**
  30720. * Checks if a cullable object (mesh...) is in the camera frustum
  30721. * Unlike isInFrustum this cheks the full bounding box
  30722. * @param target The object to check
  30723. * @returns true if the object is in frustum otherwise false
  30724. */
  30725. isCompletelyInFrustum(target: ICullable): boolean;
  30726. /**
  30727. * Gets a ray in the forward direction from the camera.
  30728. * @param length Defines the length of the ray to create
  30729. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30730. * @param origin Defines the start point of the ray which defaults to the camera position
  30731. * @returns the forward ray
  30732. */
  30733. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30734. /**
  30735. * Gets a ray in the forward direction from the camera.
  30736. * @param refRay the ray to (re)use when setting the values
  30737. * @param length Defines the length of the ray to create
  30738. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30739. * @param origin Defines the start point of the ray which defaults to the camera position
  30740. * @returns the forward ray
  30741. */
  30742. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30743. /**
  30744. * Releases resources associated with this node.
  30745. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30746. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30747. */
  30748. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30749. /** @hidden */
  30750. _isLeftCamera: boolean;
  30751. /**
  30752. * Gets the left camera of a rig setup in case of Rigged Camera
  30753. */
  30754. get isLeftCamera(): boolean;
  30755. /** @hidden */
  30756. _isRightCamera: boolean;
  30757. /**
  30758. * Gets the right camera of a rig setup in case of Rigged Camera
  30759. */
  30760. get isRightCamera(): boolean;
  30761. /**
  30762. * Gets the left camera of a rig setup in case of Rigged Camera
  30763. */
  30764. get leftCamera(): Nullable<FreeCamera>;
  30765. /**
  30766. * Gets the right camera of a rig setup in case of Rigged Camera
  30767. */
  30768. get rightCamera(): Nullable<FreeCamera>;
  30769. /**
  30770. * Gets the left camera target of a rig setup in case of Rigged Camera
  30771. * @returns the target position
  30772. */
  30773. getLeftTarget(): Nullable<Vector3>;
  30774. /**
  30775. * Gets the right camera target of a rig setup in case of Rigged Camera
  30776. * @returns the target position
  30777. */
  30778. getRightTarget(): Nullable<Vector3>;
  30779. /**
  30780. * @hidden
  30781. */
  30782. setCameraRigMode(mode: number, rigParams: any): void;
  30783. /** @hidden */
  30784. static _setStereoscopicRigMode(camera: Camera): void;
  30785. /** @hidden */
  30786. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30787. /** @hidden */
  30788. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30789. /** @hidden */
  30790. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30791. /** @hidden */
  30792. _getVRProjectionMatrix(): Matrix;
  30793. protected _updateCameraRotationMatrix(): void;
  30794. protected _updateWebVRCameraRotationMatrix(): void;
  30795. /**
  30796. * This function MUST be overwritten by the different WebVR cameras available.
  30797. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30798. * @hidden
  30799. */
  30800. _getWebVRProjectionMatrix(): Matrix;
  30801. /**
  30802. * This function MUST be overwritten by the different WebVR cameras available.
  30803. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30804. * @hidden
  30805. */
  30806. _getWebVRViewMatrix(): Matrix;
  30807. /** @hidden */
  30808. setCameraRigParameter(name: string, value: any): void;
  30809. /**
  30810. * needs to be overridden by children so sub has required properties to be copied
  30811. * @hidden
  30812. */
  30813. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30814. /**
  30815. * May need to be overridden by children
  30816. * @hidden
  30817. */
  30818. _updateRigCameras(): void;
  30819. /** @hidden */
  30820. _setupInputs(): void;
  30821. /**
  30822. * Serialiaze the camera setup to a json represention
  30823. * @returns the JSON representation
  30824. */
  30825. serialize(): any;
  30826. /**
  30827. * Clones the current camera.
  30828. * @param name The cloned camera name
  30829. * @returns the cloned camera
  30830. */
  30831. clone(name: string): Camera;
  30832. /**
  30833. * Gets the direction of the camera relative to a given local axis.
  30834. * @param localAxis Defines the reference axis to provide a relative direction.
  30835. * @return the direction
  30836. */
  30837. getDirection(localAxis: Vector3): Vector3;
  30838. /**
  30839. * Returns the current camera absolute rotation
  30840. */
  30841. get absoluteRotation(): Quaternion;
  30842. /**
  30843. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30844. * @param localAxis Defines the reference axis to provide a relative direction.
  30845. * @param result Defines the vector to store the result in
  30846. */
  30847. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30848. /**
  30849. * Gets a camera constructor for a given camera type
  30850. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30851. * @param name The name of the camera the result will be able to instantiate
  30852. * @param scene The scene the result will construct the camera in
  30853. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30854. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30855. * @returns a factory method to construc the camera
  30856. */
  30857. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30858. /**
  30859. * Compute the world matrix of the camera.
  30860. * @returns the camera world matrix
  30861. */
  30862. computeWorldMatrix(): Matrix;
  30863. /**
  30864. * Parse a JSON and creates the camera from the parsed information
  30865. * @param parsedCamera The JSON to parse
  30866. * @param scene The scene to instantiate the camera in
  30867. * @returns the newly constructed camera
  30868. */
  30869. static Parse(parsedCamera: any, scene: Scene): Camera;
  30870. }
  30871. }
  30872. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30873. import { Nullable } from "babylonjs/types";
  30874. import { Scene } from "babylonjs/scene";
  30875. import { Vector4 } from "babylonjs/Maths/math.vector";
  30876. import { Mesh } from "babylonjs/Meshes/mesh";
  30877. /**
  30878. * Class containing static functions to help procedurally build meshes
  30879. */
  30880. export class DiscBuilder {
  30881. /**
  30882. * Creates a plane polygonal mesh. By default, this is a disc
  30883. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30884. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  30885. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  30886. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30887. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30888. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30889. * @param name defines the name of the mesh
  30890. * @param options defines the options used to create the mesh
  30891. * @param scene defines the hosting scene
  30892. * @returns the plane polygonal mesh
  30893. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30894. */
  30895. static CreateDisc(name: string, options: {
  30896. radius?: number;
  30897. tessellation?: number;
  30898. arc?: number;
  30899. updatable?: boolean;
  30900. sideOrientation?: number;
  30901. frontUVs?: Vector4;
  30902. backUVs?: Vector4;
  30903. }, scene?: Nullable<Scene>): Mesh;
  30904. }
  30905. }
  30906. declare module "babylonjs/Materials/fresnelParameters" {
  30907. import { DeepImmutable } from "babylonjs/types";
  30908. import { Color3 } from "babylonjs/Maths/math.color";
  30909. /**
  30910. * Options to be used when creating a FresnelParameters.
  30911. */
  30912. export type IFresnelParametersCreationOptions = {
  30913. /**
  30914. * Define the color used on edges (grazing angle)
  30915. */
  30916. leftColor?: Color3;
  30917. /**
  30918. * Define the color used on center
  30919. */
  30920. rightColor?: Color3;
  30921. /**
  30922. * Define bias applied to computed fresnel term
  30923. */
  30924. bias?: number;
  30925. /**
  30926. * Defined the power exponent applied to fresnel term
  30927. */
  30928. power?: number;
  30929. /**
  30930. * Define if the fresnel effect is enable or not.
  30931. */
  30932. isEnabled?: boolean;
  30933. };
  30934. /**
  30935. * Serialized format for FresnelParameters.
  30936. */
  30937. export type IFresnelParametersSerialized = {
  30938. /**
  30939. * Define the color used on edges (grazing angle) [as an array]
  30940. */
  30941. leftColor: number[];
  30942. /**
  30943. * Define the color used on center [as an array]
  30944. */
  30945. rightColor: number[];
  30946. /**
  30947. * Define bias applied to computed fresnel term
  30948. */
  30949. bias: number;
  30950. /**
  30951. * Defined the power exponent applied to fresnel term
  30952. */
  30953. power?: number;
  30954. /**
  30955. * Define if the fresnel effect is enable or not.
  30956. */
  30957. isEnabled: boolean;
  30958. };
  30959. /**
  30960. * This represents all the required information to add a fresnel effect on a material:
  30961. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30962. */
  30963. export class FresnelParameters {
  30964. private _isEnabled;
  30965. /**
  30966. * Define if the fresnel effect is enable or not.
  30967. */
  30968. get isEnabled(): boolean;
  30969. set isEnabled(value: boolean);
  30970. /**
  30971. * Define the color used on edges (grazing angle)
  30972. */
  30973. leftColor: Color3;
  30974. /**
  30975. * Define the color used on center
  30976. */
  30977. rightColor: Color3;
  30978. /**
  30979. * Define bias applied to computed fresnel term
  30980. */
  30981. bias: number;
  30982. /**
  30983. * Defined the power exponent applied to fresnel term
  30984. */
  30985. power: number;
  30986. /**
  30987. * Creates a new FresnelParameters object.
  30988. *
  30989. * @param options provide your own settings to optionally to override defaults
  30990. */
  30991. constructor(options?: IFresnelParametersCreationOptions);
  30992. /**
  30993. * Clones the current fresnel and its valuues
  30994. * @returns a clone fresnel configuration
  30995. */
  30996. clone(): FresnelParameters;
  30997. /**
  30998. * Determines equality between FresnelParameters objects
  30999. * @param otherFresnelParameters defines the second operand
  31000. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31001. */
  31002. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31003. /**
  31004. * Serializes the current fresnel parameters to a JSON representation.
  31005. * @return the JSON serialization
  31006. */
  31007. serialize(): IFresnelParametersSerialized;
  31008. /**
  31009. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31010. * @param parsedFresnelParameters Define the JSON representation
  31011. * @returns the parsed parameters
  31012. */
  31013. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31014. }
  31015. }
  31016. declare module "babylonjs/Materials/materialFlags" {
  31017. /**
  31018. * This groups all the flags used to control the materials channel.
  31019. */
  31020. export class MaterialFlags {
  31021. private static _DiffuseTextureEnabled;
  31022. /**
  31023. * Are diffuse textures enabled in the application.
  31024. */
  31025. static get DiffuseTextureEnabled(): boolean;
  31026. static set DiffuseTextureEnabled(value: boolean);
  31027. private static _DetailTextureEnabled;
  31028. /**
  31029. * Are detail textures enabled in the application.
  31030. */
  31031. static get DetailTextureEnabled(): boolean;
  31032. static set DetailTextureEnabled(value: boolean);
  31033. private static _AmbientTextureEnabled;
  31034. /**
  31035. * Are ambient textures enabled in the application.
  31036. */
  31037. static get AmbientTextureEnabled(): boolean;
  31038. static set AmbientTextureEnabled(value: boolean);
  31039. private static _OpacityTextureEnabled;
  31040. /**
  31041. * Are opacity textures enabled in the application.
  31042. */
  31043. static get OpacityTextureEnabled(): boolean;
  31044. static set OpacityTextureEnabled(value: boolean);
  31045. private static _ReflectionTextureEnabled;
  31046. /**
  31047. * Are reflection textures enabled in the application.
  31048. */
  31049. static get ReflectionTextureEnabled(): boolean;
  31050. static set ReflectionTextureEnabled(value: boolean);
  31051. private static _EmissiveTextureEnabled;
  31052. /**
  31053. * Are emissive textures enabled in the application.
  31054. */
  31055. static get EmissiveTextureEnabled(): boolean;
  31056. static set EmissiveTextureEnabled(value: boolean);
  31057. private static _SpecularTextureEnabled;
  31058. /**
  31059. * Are specular textures enabled in the application.
  31060. */
  31061. static get SpecularTextureEnabled(): boolean;
  31062. static set SpecularTextureEnabled(value: boolean);
  31063. private static _BumpTextureEnabled;
  31064. /**
  31065. * Are bump textures enabled in the application.
  31066. */
  31067. static get BumpTextureEnabled(): boolean;
  31068. static set BumpTextureEnabled(value: boolean);
  31069. private static _LightmapTextureEnabled;
  31070. /**
  31071. * Are lightmap textures enabled in the application.
  31072. */
  31073. static get LightmapTextureEnabled(): boolean;
  31074. static set LightmapTextureEnabled(value: boolean);
  31075. private static _RefractionTextureEnabled;
  31076. /**
  31077. * Are refraction textures enabled in the application.
  31078. */
  31079. static get RefractionTextureEnabled(): boolean;
  31080. static set RefractionTextureEnabled(value: boolean);
  31081. private static _ColorGradingTextureEnabled;
  31082. /**
  31083. * Are color grading textures enabled in the application.
  31084. */
  31085. static get ColorGradingTextureEnabled(): boolean;
  31086. static set ColorGradingTextureEnabled(value: boolean);
  31087. private static _FresnelEnabled;
  31088. /**
  31089. * Are fresnels enabled in the application.
  31090. */
  31091. static get FresnelEnabled(): boolean;
  31092. static set FresnelEnabled(value: boolean);
  31093. private static _ClearCoatTextureEnabled;
  31094. /**
  31095. * Are clear coat textures enabled in the application.
  31096. */
  31097. static get ClearCoatTextureEnabled(): boolean;
  31098. static set ClearCoatTextureEnabled(value: boolean);
  31099. private static _ClearCoatBumpTextureEnabled;
  31100. /**
  31101. * Are clear coat bump textures enabled in the application.
  31102. */
  31103. static get ClearCoatBumpTextureEnabled(): boolean;
  31104. static set ClearCoatBumpTextureEnabled(value: boolean);
  31105. private static _ClearCoatTintTextureEnabled;
  31106. /**
  31107. * Are clear coat tint textures enabled in the application.
  31108. */
  31109. static get ClearCoatTintTextureEnabled(): boolean;
  31110. static set ClearCoatTintTextureEnabled(value: boolean);
  31111. private static _SheenTextureEnabled;
  31112. /**
  31113. * Are sheen textures enabled in the application.
  31114. */
  31115. static get SheenTextureEnabled(): boolean;
  31116. static set SheenTextureEnabled(value: boolean);
  31117. private static _AnisotropicTextureEnabled;
  31118. /**
  31119. * Are anisotropic textures enabled in the application.
  31120. */
  31121. static get AnisotropicTextureEnabled(): boolean;
  31122. static set AnisotropicTextureEnabled(value: boolean);
  31123. private static _ThicknessTextureEnabled;
  31124. /**
  31125. * Are thickness textures enabled in the application.
  31126. */
  31127. static get ThicknessTextureEnabled(): boolean;
  31128. static set ThicknessTextureEnabled(value: boolean);
  31129. }
  31130. }
  31131. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31132. /** @hidden */
  31133. export var defaultFragmentDeclaration: {
  31134. name: string;
  31135. shader: string;
  31136. };
  31137. }
  31138. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31139. /** @hidden */
  31140. export var defaultUboDeclaration: {
  31141. name: string;
  31142. shader: string;
  31143. };
  31144. }
  31145. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31146. /** @hidden */
  31147. export var prePassDeclaration: {
  31148. name: string;
  31149. shader: string;
  31150. };
  31151. }
  31152. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31153. /** @hidden */
  31154. export var lightFragmentDeclaration: {
  31155. name: string;
  31156. shader: string;
  31157. };
  31158. }
  31159. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31160. /** @hidden */
  31161. export var lightUboDeclaration: {
  31162. name: string;
  31163. shader: string;
  31164. };
  31165. }
  31166. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31167. /** @hidden */
  31168. export var lightsFragmentFunctions: {
  31169. name: string;
  31170. shader: string;
  31171. };
  31172. }
  31173. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31174. /** @hidden */
  31175. export var shadowsFragmentFunctions: {
  31176. name: string;
  31177. shader: string;
  31178. };
  31179. }
  31180. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31181. /** @hidden */
  31182. export var fresnelFunction: {
  31183. name: string;
  31184. shader: string;
  31185. };
  31186. }
  31187. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31188. /** @hidden */
  31189. export var bumpFragmentMainFunctions: {
  31190. name: string;
  31191. shader: string;
  31192. };
  31193. }
  31194. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31195. /** @hidden */
  31196. export var bumpFragmentFunctions: {
  31197. name: string;
  31198. shader: string;
  31199. };
  31200. }
  31201. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31202. /** @hidden */
  31203. export var logDepthDeclaration: {
  31204. name: string;
  31205. shader: string;
  31206. };
  31207. }
  31208. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31209. /** @hidden */
  31210. export var bumpFragment: {
  31211. name: string;
  31212. shader: string;
  31213. };
  31214. }
  31215. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31216. /** @hidden */
  31217. export var depthPrePass: {
  31218. name: string;
  31219. shader: string;
  31220. };
  31221. }
  31222. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31223. /** @hidden */
  31224. export var lightFragment: {
  31225. name: string;
  31226. shader: string;
  31227. };
  31228. }
  31229. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31230. /** @hidden */
  31231. export var logDepthFragment: {
  31232. name: string;
  31233. shader: string;
  31234. };
  31235. }
  31236. declare module "babylonjs/Shaders/default.fragment" {
  31237. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31238. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31240. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31242. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31244. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31245. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31246. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31247. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31248. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31249. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31250. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31251. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31252. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31253. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31254. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31255. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31256. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31257. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31258. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31259. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31260. /** @hidden */
  31261. export var defaultPixelShader: {
  31262. name: string;
  31263. shader: string;
  31264. };
  31265. }
  31266. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31267. /** @hidden */
  31268. export var defaultVertexDeclaration: {
  31269. name: string;
  31270. shader: string;
  31271. };
  31272. }
  31273. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31274. /** @hidden */
  31275. export var bumpVertexDeclaration: {
  31276. name: string;
  31277. shader: string;
  31278. };
  31279. }
  31280. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31281. /** @hidden */
  31282. export var bumpVertex: {
  31283. name: string;
  31284. shader: string;
  31285. };
  31286. }
  31287. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31288. /** @hidden */
  31289. export var fogVertex: {
  31290. name: string;
  31291. shader: string;
  31292. };
  31293. }
  31294. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31295. /** @hidden */
  31296. export var shadowsVertex: {
  31297. name: string;
  31298. shader: string;
  31299. };
  31300. }
  31301. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31302. /** @hidden */
  31303. export var pointCloudVertex: {
  31304. name: string;
  31305. shader: string;
  31306. };
  31307. }
  31308. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31309. /** @hidden */
  31310. export var logDepthVertex: {
  31311. name: string;
  31312. shader: string;
  31313. };
  31314. }
  31315. declare module "babylonjs/Shaders/default.vertex" {
  31316. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31319. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31322. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31323. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31326. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31327. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31328. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31329. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31330. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31331. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31332. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31333. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31334. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31335. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31336. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31337. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31338. /** @hidden */
  31339. export var defaultVertexShader: {
  31340. name: string;
  31341. shader: string;
  31342. };
  31343. }
  31344. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31345. import { Nullable } from "babylonjs/types";
  31346. import { Scene } from "babylonjs/scene";
  31347. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31348. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31349. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31350. /**
  31351. * @hidden
  31352. */
  31353. export interface IMaterialDetailMapDefines {
  31354. DETAIL: boolean;
  31355. DETAILDIRECTUV: number;
  31356. DETAIL_NORMALBLENDMETHOD: number;
  31357. /** @hidden */
  31358. _areTexturesDirty: boolean;
  31359. }
  31360. /**
  31361. * Define the code related to the detail map parameters of a material
  31362. *
  31363. * Inspired from:
  31364. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  31365. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31366. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31367. */
  31368. export class DetailMapConfiguration {
  31369. private _texture;
  31370. /**
  31371. * The detail texture of the material.
  31372. */
  31373. texture: Nullable<BaseTexture>;
  31374. /**
  31375. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31376. * Bigger values mean stronger blending
  31377. */
  31378. diffuseBlendLevel: number;
  31379. /**
  31380. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31381. * Bigger values mean stronger blending. Only used with PBR materials
  31382. */
  31383. roughnessBlendLevel: number;
  31384. /**
  31385. * Defines how strong the bump effect from the detail map is
  31386. * Bigger values mean stronger effect
  31387. */
  31388. bumpLevel: number;
  31389. private _normalBlendMethod;
  31390. /**
  31391. * The method used to blend the bump and detail normals together
  31392. */
  31393. normalBlendMethod: number;
  31394. private _isEnabled;
  31395. /**
  31396. * Enable or disable the detail map on this material
  31397. */
  31398. isEnabled: boolean;
  31399. /** @hidden */
  31400. private _internalMarkAllSubMeshesAsTexturesDirty;
  31401. /** @hidden */
  31402. _markAllSubMeshesAsTexturesDirty(): void;
  31403. /**
  31404. * Instantiate a new detail map
  31405. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31406. */
  31407. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31408. /**
  31409. * Gets whether the submesh is ready to be used or not.
  31410. * @param defines the list of "defines" to update.
  31411. * @param scene defines the scene the material belongs to.
  31412. * @returns - boolean indicating that the submesh is ready or not.
  31413. */
  31414. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31415. /**
  31416. * Update the defines for detail map usage
  31417. * @param defines the list of "defines" to update.
  31418. * @param scene defines the scene the material belongs to.
  31419. */
  31420. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31421. /**
  31422. * Binds the material data.
  31423. * @param uniformBuffer defines the Uniform buffer to fill in.
  31424. * @param scene defines the scene the material belongs to.
  31425. * @param isFrozen defines whether the material is frozen or not.
  31426. */
  31427. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31428. /**
  31429. * Checks to see if a texture is used in the material.
  31430. * @param texture - Base texture to use.
  31431. * @returns - Boolean specifying if a texture is used in the material.
  31432. */
  31433. hasTexture(texture: BaseTexture): boolean;
  31434. /**
  31435. * Returns an array of the actively used textures.
  31436. * @param activeTextures Array of BaseTextures
  31437. */
  31438. getActiveTextures(activeTextures: BaseTexture[]): void;
  31439. /**
  31440. * Returns the animatable textures.
  31441. * @param animatables Array of animatable textures.
  31442. */
  31443. getAnimatables(animatables: IAnimatable[]): void;
  31444. /**
  31445. * Disposes the resources of the material.
  31446. * @param forceDisposeTextures - Forces the disposal of all textures.
  31447. */
  31448. dispose(forceDisposeTextures?: boolean): void;
  31449. /**
  31450. * Get the current class name useful for serialization or dynamic coding.
  31451. * @returns "DetailMap"
  31452. */
  31453. getClassName(): string;
  31454. /**
  31455. * Add the required uniforms to the current list.
  31456. * @param uniforms defines the current uniform list.
  31457. */
  31458. static AddUniforms(uniforms: string[]): void;
  31459. /**
  31460. * Add the required samplers to the current list.
  31461. * @param samplers defines the current sampler list.
  31462. */
  31463. static AddSamplers(samplers: string[]): void;
  31464. /**
  31465. * Add the required uniforms to the current buffer.
  31466. * @param uniformBuffer defines the current uniform buffer.
  31467. */
  31468. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31469. /**
  31470. * Makes a duplicate of the current instance into another one.
  31471. * @param detailMap define the instance where to copy the info
  31472. */
  31473. copyTo(detailMap: DetailMapConfiguration): void;
  31474. /**
  31475. * Serializes this detail map instance
  31476. * @returns - An object with the serialized instance.
  31477. */
  31478. serialize(): any;
  31479. /**
  31480. * Parses a detail map setting from a serialized object.
  31481. * @param source - Serialized object.
  31482. * @param scene Defines the scene we are parsing for
  31483. * @param rootUrl Defines the rootUrl to load from
  31484. */
  31485. parse(source: any, scene: Scene, rootUrl: string): void;
  31486. }
  31487. }
  31488. declare module "babylonjs/Materials/standardMaterial" {
  31489. import { SmartArray } from "babylonjs/Misc/smartArray";
  31490. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31491. import { Nullable } from "babylonjs/types";
  31492. import { Scene } from "babylonjs/scene";
  31493. import { Matrix } from "babylonjs/Maths/math.vector";
  31494. import { Color3 } from "babylonjs/Maths/math.color";
  31495. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31496. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31497. import { Mesh } from "babylonjs/Meshes/mesh";
  31498. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31499. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31500. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31501. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31502. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31503. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31504. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31505. import "babylonjs/Shaders/default.fragment";
  31506. import "babylonjs/Shaders/default.vertex";
  31507. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31508. /** @hidden */
  31509. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31510. MAINUV1: boolean;
  31511. MAINUV2: boolean;
  31512. DIFFUSE: boolean;
  31513. DIFFUSEDIRECTUV: number;
  31514. DETAIL: boolean;
  31515. DETAILDIRECTUV: number;
  31516. DETAIL_NORMALBLENDMETHOD: number;
  31517. AMBIENT: boolean;
  31518. AMBIENTDIRECTUV: number;
  31519. OPACITY: boolean;
  31520. OPACITYDIRECTUV: number;
  31521. OPACITYRGB: boolean;
  31522. REFLECTION: boolean;
  31523. EMISSIVE: boolean;
  31524. EMISSIVEDIRECTUV: number;
  31525. SPECULAR: boolean;
  31526. SPECULARDIRECTUV: number;
  31527. BUMP: boolean;
  31528. BUMPDIRECTUV: number;
  31529. PARALLAX: boolean;
  31530. PARALLAXOCCLUSION: boolean;
  31531. SPECULAROVERALPHA: boolean;
  31532. CLIPPLANE: boolean;
  31533. CLIPPLANE2: boolean;
  31534. CLIPPLANE3: boolean;
  31535. CLIPPLANE4: boolean;
  31536. CLIPPLANE5: boolean;
  31537. CLIPPLANE6: boolean;
  31538. ALPHATEST: boolean;
  31539. DEPTHPREPASS: boolean;
  31540. ALPHAFROMDIFFUSE: boolean;
  31541. POINTSIZE: boolean;
  31542. FOG: boolean;
  31543. SPECULARTERM: boolean;
  31544. DIFFUSEFRESNEL: boolean;
  31545. OPACITYFRESNEL: boolean;
  31546. REFLECTIONFRESNEL: boolean;
  31547. REFRACTIONFRESNEL: boolean;
  31548. EMISSIVEFRESNEL: boolean;
  31549. FRESNEL: boolean;
  31550. NORMAL: boolean;
  31551. UV1: boolean;
  31552. UV2: boolean;
  31553. VERTEXCOLOR: boolean;
  31554. VERTEXALPHA: boolean;
  31555. NUM_BONE_INFLUENCERS: number;
  31556. BonesPerMesh: number;
  31557. BONETEXTURE: boolean;
  31558. INSTANCES: boolean;
  31559. THIN_INSTANCES: boolean;
  31560. GLOSSINESS: boolean;
  31561. ROUGHNESS: boolean;
  31562. EMISSIVEASILLUMINATION: boolean;
  31563. LINKEMISSIVEWITHDIFFUSE: boolean;
  31564. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31565. LIGHTMAP: boolean;
  31566. LIGHTMAPDIRECTUV: number;
  31567. OBJECTSPACE_NORMALMAP: boolean;
  31568. USELIGHTMAPASSHADOWMAP: boolean;
  31569. REFLECTIONMAP_3D: boolean;
  31570. REFLECTIONMAP_SPHERICAL: boolean;
  31571. REFLECTIONMAP_PLANAR: boolean;
  31572. REFLECTIONMAP_CUBIC: boolean;
  31573. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31574. REFLECTIONMAP_PROJECTION: boolean;
  31575. REFLECTIONMAP_SKYBOX: boolean;
  31576. REFLECTIONMAP_EXPLICIT: boolean;
  31577. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31578. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31579. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31580. INVERTCUBICMAP: boolean;
  31581. LOGARITHMICDEPTH: boolean;
  31582. REFRACTION: boolean;
  31583. REFRACTIONMAP_3D: boolean;
  31584. REFLECTIONOVERALPHA: boolean;
  31585. TWOSIDEDLIGHTING: boolean;
  31586. SHADOWFLOAT: boolean;
  31587. MORPHTARGETS: boolean;
  31588. MORPHTARGETS_NORMAL: boolean;
  31589. MORPHTARGETS_TANGENT: boolean;
  31590. MORPHTARGETS_UV: boolean;
  31591. NUM_MORPH_INFLUENCERS: number;
  31592. NONUNIFORMSCALING: boolean;
  31593. PREMULTIPLYALPHA: boolean;
  31594. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31595. ALPHABLEND: boolean;
  31596. PREPASS: boolean;
  31597. SCENE_MRT_COUNT: number;
  31598. RGBDLIGHTMAP: boolean;
  31599. RGBDREFLECTION: boolean;
  31600. RGBDREFRACTION: boolean;
  31601. IMAGEPROCESSING: boolean;
  31602. VIGNETTE: boolean;
  31603. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31604. VIGNETTEBLENDMODEOPAQUE: boolean;
  31605. TONEMAPPING: boolean;
  31606. TONEMAPPING_ACES: boolean;
  31607. CONTRAST: boolean;
  31608. COLORCURVES: boolean;
  31609. COLORGRADING: boolean;
  31610. COLORGRADING3D: boolean;
  31611. SAMPLER3DGREENDEPTH: boolean;
  31612. SAMPLER3DBGRMAP: boolean;
  31613. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31614. MULTIVIEW: boolean;
  31615. /**
  31616. * If the reflection texture on this material is in linear color space
  31617. * @hidden
  31618. */
  31619. IS_REFLECTION_LINEAR: boolean;
  31620. /**
  31621. * If the refraction texture on this material is in linear color space
  31622. * @hidden
  31623. */
  31624. IS_REFRACTION_LINEAR: boolean;
  31625. EXPOSURE: boolean;
  31626. constructor();
  31627. setReflectionMode(modeToEnable: string): void;
  31628. }
  31629. /**
  31630. * This is the default material used in Babylon. It is the best trade off between quality
  31631. * and performances.
  31632. * @see https://doc.babylonjs.com/babylon101/materials
  31633. */
  31634. export class StandardMaterial extends PushMaterial {
  31635. private _diffuseTexture;
  31636. /**
  31637. * The basic texture of the material as viewed under a light.
  31638. */
  31639. diffuseTexture: Nullable<BaseTexture>;
  31640. private _ambientTexture;
  31641. /**
  31642. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31643. */
  31644. ambientTexture: Nullable<BaseTexture>;
  31645. private _opacityTexture;
  31646. /**
  31647. * Define the transparency of the material from a texture.
  31648. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31649. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31650. */
  31651. opacityTexture: Nullable<BaseTexture>;
  31652. private _reflectionTexture;
  31653. /**
  31654. * Define the texture used to display the reflection.
  31655. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31656. */
  31657. reflectionTexture: Nullable<BaseTexture>;
  31658. private _emissiveTexture;
  31659. /**
  31660. * Define texture of the material as if self lit.
  31661. * This will be mixed in the final result even in the absence of light.
  31662. */
  31663. emissiveTexture: Nullable<BaseTexture>;
  31664. private _specularTexture;
  31665. /**
  31666. * Define how the color and intensity of the highlight given by the light in the material.
  31667. */
  31668. specularTexture: Nullable<BaseTexture>;
  31669. private _bumpTexture;
  31670. /**
  31671. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31672. * These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.
  31673. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31674. */
  31675. bumpTexture: Nullable<BaseTexture>;
  31676. private _lightmapTexture;
  31677. /**
  31678. * Complex lighting can be computationally expensive to compute at runtime.
  31679. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31680. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31681. */
  31682. lightmapTexture: Nullable<BaseTexture>;
  31683. private _refractionTexture;
  31684. /**
  31685. * Define the texture used to display the refraction.
  31686. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31687. */
  31688. refractionTexture: Nullable<BaseTexture>;
  31689. /**
  31690. * The color of the material lit by the environmental background lighting.
  31691. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31692. */
  31693. ambientColor: Color3;
  31694. /**
  31695. * The basic color of the material as viewed under a light.
  31696. */
  31697. diffuseColor: Color3;
  31698. /**
  31699. * Define how the color and intensity of the highlight given by the light in the material.
  31700. */
  31701. specularColor: Color3;
  31702. /**
  31703. * Define the color of the material as if self lit.
  31704. * This will be mixed in the final result even in the absence of light.
  31705. */
  31706. emissiveColor: Color3;
  31707. /**
  31708. * Defines how sharp are the highlights in the material.
  31709. * The bigger the value the sharper giving a more glossy feeling to the result.
  31710. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31711. */
  31712. specularPower: number;
  31713. private _useAlphaFromDiffuseTexture;
  31714. /**
  31715. * Does the transparency come from the diffuse texture alpha channel.
  31716. */
  31717. useAlphaFromDiffuseTexture: boolean;
  31718. private _useEmissiveAsIllumination;
  31719. /**
  31720. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31721. */
  31722. useEmissiveAsIllumination: boolean;
  31723. private _linkEmissiveWithDiffuse;
  31724. /**
  31725. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31726. * the emissive level when the final color is close to one.
  31727. */
  31728. linkEmissiveWithDiffuse: boolean;
  31729. private _useSpecularOverAlpha;
  31730. /**
  31731. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31732. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31733. */
  31734. useSpecularOverAlpha: boolean;
  31735. private _useReflectionOverAlpha;
  31736. /**
  31737. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31738. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31739. */
  31740. useReflectionOverAlpha: boolean;
  31741. private _disableLighting;
  31742. /**
  31743. * Does lights from the scene impacts this material.
  31744. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31745. */
  31746. disableLighting: boolean;
  31747. private _useObjectSpaceNormalMap;
  31748. /**
  31749. * Allows using an object space normal map (instead of tangent space).
  31750. */
  31751. useObjectSpaceNormalMap: boolean;
  31752. private _useParallax;
  31753. /**
  31754. * Is parallax enabled or not.
  31755. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31756. */
  31757. useParallax: boolean;
  31758. private _useParallaxOcclusion;
  31759. /**
  31760. * Is parallax occlusion enabled or not.
  31761. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31762. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31763. */
  31764. useParallaxOcclusion: boolean;
  31765. /**
  31766. * Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.
  31767. */
  31768. parallaxScaleBias: number;
  31769. private _roughness;
  31770. /**
  31771. * Helps to define how blurry the reflections should appears in the material.
  31772. */
  31773. roughness: number;
  31774. /**
  31775. * In case of refraction, define the value of the index of refraction.
  31776. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31777. */
  31778. indexOfRefraction: number;
  31779. /**
  31780. * Invert the refraction texture alongside the y axis.
  31781. * It can be useful with procedural textures or probe for instance.
  31782. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31783. */
  31784. invertRefractionY: boolean;
  31785. /**
  31786. * Defines the alpha limits in alpha test mode.
  31787. */
  31788. alphaCutOff: number;
  31789. private _useLightmapAsShadowmap;
  31790. /**
  31791. * In case of light mapping, define whether the map contains light or shadow informations.
  31792. */
  31793. useLightmapAsShadowmap: boolean;
  31794. private _diffuseFresnelParameters;
  31795. /**
  31796. * Define the diffuse fresnel parameters of the material.
  31797. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31798. */
  31799. diffuseFresnelParameters: FresnelParameters;
  31800. private _opacityFresnelParameters;
  31801. /**
  31802. * Define the opacity fresnel parameters of the material.
  31803. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31804. */
  31805. opacityFresnelParameters: FresnelParameters;
  31806. private _reflectionFresnelParameters;
  31807. /**
  31808. * Define the reflection fresnel parameters of the material.
  31809. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31810. */
  31811. reflectionFresnelParameters: FresnelParameters;
  31812. private _refractionFresnelParameters;
  31813. /**
  31814. * Define the refraction fresnel parameters of the material.
  31815. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31816. */
  31817. refractionFresnelParameters: FresnelParameters;
  31818. private _emissiveFresnelParameters;
  31819. /**
  31820. * Define the emissive fresnel parameters of the material.
  31821. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31822. */
  31823. emissiveFresnelParameters: FresnelParameters;
  31824. private _useReflectionFresnelFromSpecular;
  31825. /**
  31826. * If true automatically deducts the fresnels values from the material specularity.
  31827. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31828. */
  31829. useReflectionFresnelFromSpecular: boolean;
  31830. private _useGlossinessFromSpecularMapAlpha;
  31831. /**
  31832. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31833. */
  31834. useGlossinessFromSpecularMapAlpha: boolean;
  31835. private _maxSimultaneousLights;
  31836. /**
  31837. * Defines the maximum number of lights that can be used in the material
  31838. */
  31839. maxSimultaneousLights: number;
  31840. private _invertNormalMapX;
  31841. /**
  31842. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31843. */
  31844. invertNormalMapX: boolean;
  31845. private _invertNormalMapY;
  31846. /**
  31847. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31848. */
  31849. invertNormalMapY: boolean;
  31850. private _twoSidedLighting;
  31851. /**
  31852. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31853. */
  31854. twoSidedLighting: boolean;
  31855. /**
  31856. * Default configuration related to image processing available in the standard Material.
  31857. */
  31858. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31859. /**
  31860. * Gets the image processing configuration used either in this material.
  31861. */
  31862. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31863. /**
  31864. * Sets the Default image processing configuration used either in the this material.
  31865. *
  31866. * If sets to null, the scene one is in use.
  31867. */
  31868. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31869. /**
  31870. * Keep track of the image processing observer to allow dispose and replace.
  31871. */
  31872. private _imageProcessingObserver;
  31873. /**
  31874. * Attaches a new image processing configuration to the Standard Material.
  31875. * @param configuration
  31876. */
  31877. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31878. /**
  31879. * Gets wether the color curves effect is enabled.
  31880. */
  31881. get cameraColorCurvesEnabled(): boolean;
  31882. /**
  31883. * Sets wether the color curves effect is enabled.
  31884. */
  31885. set cameraColorCurvesEnabled(value: boolean);
  31886. /**
  31887. * Gets wether the color grading effect is enabled.
  31888. */
  31889. get cameraColorGradingEnabled(): boolean;
  31890. /**
  31891. * Gets wether the color grading effect is enabled.
  31892. */
  31893. set cameraColorGradingEnabled(value: boolean);
  31894. /**
  31895. * Gets wether tonemapping is enabled or not.
  31896. */
  31897. get cameraToneMappingEnabled(): boolean;
  31898. /**
  31899. * Sets wether tonemapping is enabled or not
  31900. */
  31901. set cameraToneMappingEnabled(value: boolean);
  31902. /**
  31903. * The camera exposure used on this material.
  31904. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31905. * This corresponds to a photographic exposure.
  31906. */
  31907. get cameraExposure(): number;
  31908. /**
  31909. * The camera exposure used on this material.
  31910. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31911. * This corresponds to a photographic exposure.
  31912. */
  31913. set cameraExposure(value: number);
  31914. /**
  31915. * Gets The camera contrast used on this material.
  31916. */
  31917. get cameraContrast(): number;
  31918. /**
  31919. * Sets The camera contrast used on this material.
  31920. */
  31921. set cameraContrast(value: number);
  31922. /**
  31923. * Gets the Color Grading 2D Lookup Texture.
  31924. */
  31925. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31926. /**
  31927. * Sets the Color Grading 2D Lookup Texture.
  31928. */
  31929. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31930. /**
  31931. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31932. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31933. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31934. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31935. */
  31936. get cameraColorCurves(): Nullable<ColorCurves>;
  31937. /**
  31938. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31939. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31940. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  31941. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31942. */
  31943. set cameraColorCurves(value: Nullable<ColorCurves>);
  31944. /**
  31945. * Can this material render to several textures at once
  31946. */
  31947. get canRenderToMRT(): boolean;
  31948. /**
  31949. * Defines the detail map parameters for the material.
  31950. */
  31951. readonly detailMap: DetailMapConfiguration;
  31952. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31953. protected _worldViewProjectionMatrix: Matrix;
  31954. protected _globalAmbientColor: Color3;
  31955. protected _useLogarithmicDepth: boolean;
  31956. protected _rebuildInParallel: boolean;
  31957. /**
  31958. * Instantiates a new standard material.
  31959. * This is the default material used in Babylon. It is the best trade off between quality
  31960. * and performances.
  31961. * @see https://doc.babylonjs.com/babylon101/materials
  31962. * @param name Define the name of the material in the scene
  31963. * @param scene Define the scene the material belong to
  31964. */
  31965. constructor(name: string, scene: Scene);
  31966. /**
  31967. * Gets a boolean indicating that current material needs to register RTT
  31968. */
  31969. get hasRenderTargetTextures(): boolean;
  31970. /**
  31971. * Gets the current class name of the material e.g. "StandardMaterial"
  31972. * Mainly use in serialization.
  31973. * @returns the class name
  31974. */
  31975. getClassName(): string;
  31976. /**
  31977. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31978. * You can try switching to logarithmic depth.
  31979. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31980. */
  31981. get useLogarithmicDepth(): boolean;
  31982. set useLogarithmicDepth(value: boolean);
  31983. /**
  31984. * Specifies if the material will require alpha blending
  31985. * @returns a boolean specifying if alpha blending is needed
  31986. */
  31987. needAlphaBlending(): boolean;
  31988. /**
  31989. * Specifies if this material should be rendered in alpha test mode
  31990. * @returns a boolean specifying if an alpha test is needed.
  31991. */
  31992. needAlphaTesting(): boolean;
  31993. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31994. /**
  31995. * Get the texture used for alpha test purpose.
  31996. * @returns the diffuse texture in case of the standard material.
  31997. */
  31998. getAlphaTestTexture(): Nullable<BaseTexture>;
  31999. /**
  32000. * Get if the submesh is ready to be used and all its information available.
  32001. * Child classes can use it to update shaders
  32002. * @param mesh defines the mesh to check
  32003. * @param subMesh defines which submesh to check
  32004. * @param useInstances specifies that instances should be used
  32005. * @returns a boolean indicating that the submesh is ready or not
  32006. */
  32007. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32008. /**
  32009. * Builds the material UBO layouts.
  32010. * Used internally during the effect preparation.
  32011. */
  32012. buildUniformLayout(): void;
  32013. /**
  32014. * Unbinds the material from the mesh
  32015. */
  32016. unbind(): void;
  32017. /**
  32018. * Binds the submesh to this material by preparing the effect and shader to draw
  32019. * @param world defines the world transformation matrix
  32020. * @param mesh defines the mesh containing the submesh
  32021. * @param subMesh defines the submesh to bind the material to
  32022. */
  32023. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32024. /**
  32025. * Get the list of animatables in the material.
  32026. * @returns the list of animatables object used in the material
  32027. */
  32028. getAnimatables(): IAnimatable[];
  32029. /**
  32030. * Gets the active textures from the material
  32031. * @returns an array of textures
  32032. */
  32033. getActiveTextures(): BaseTexture[];
  32034. /**
  32035. * Specifies if the material uses a texture
  32036. * @param texture defines the texture to check against the material
  32037. * @returns a boolean specifying if the material uses the texture
  32038. */
  32039. hasTexture(texture: BaseTexture): boolean;
  32040. /**
  32041. * Disposes the material
  32042. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32043. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32044. */
  32045. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32046. /**
  32047. * Makes a duplicate of the material, and gives it a new name
  32048. * @param name defines the new name for the duplicated material
  32049. * @returns the cloned material
  32050. */
  32051. clone(name: string): StandardMaterial;
  32052. /**
  32053. * Serializes this material in a JSON representation
  32054. * @returns the serialized material object
  32055. */
  32056. serialize(): any;
  32057. /**
  32058. * Creates a standard material from parsed material data
  32059. * @param source defines the JSON representation of the material
  32060. * @param scene defines the hosting scene
  32061. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32062. * @returns a new standard material
  32063. */
  32064. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32065. /**
  32066. * Are diffuse textures enabled in the application.
  32067. */
  32068. static get DiffuseTextureEnabled(): boolean;
  32069. static set DiffuseTextureEnabled(value: boolean);
  32070. /**
  32071. * Are detail textures enabled in the application.
  32072. */
  32073. static get DetailTextureEnabled(): boolean;
  32074. static set DetailTextureEnabled(value: boolean);
  32075. /**
  32076. * Are ambient textures enabled in the application.
  32077. */
  32078. static get AmbientTextureEnabled(): boolean;
  32079. static set AmbientTextureEnabled(value: boolean);
  32080. /**
  32081. * Are opacity textures enabled in the application.
  32082. */
  32083. static get OpacityTextureEnabled(): boolean;
  32084. static set OpacityTextureEnabled(value: boolean);
  32085. /**
  32086. * Are reflection textures enabled in the application.
  32087. */
  32088. static get ReflectionTextureEnabled(): boolean;
  32089. static set ReflectionTextureEnabled(value: boolean);
  32090. /**
  32091. * Are emissive textures enabled in the application.
  32092. */
  32093. static get EmissiveTextureEnabled(): boolean;
  32094. static set EmissiveTextureEnabled(value: boolean);
  32095. /**
  32096. * Are specular textures enabled in the application.
  32097. */
  32098. static get SpecularTextureEnabled(): boolean;
  32099. static set SpecularTextureEnabled(value: boolean);
  32100. /**
  32101. * Are bump textures enabled in the application.
  32102. */
  32103. static get BumpTextureEnabled(): boolean;
  32104. static set BumpTextureEnabled(value: boolean);
  32105. /**
  32106. * Are lightmap textures enabled in the application.
  32107. */
  32108. static get LightmapTextureEnabled(): boolean;
  32109. static set LightmapTextureEnabled(value: boolean);
  32110. /**
  32111. * Are refraction textures enabled in the application.
  32112. */
  32113. static get RefractionTextureEnabled(): boolean;
  32114. static set RefractionTextureEnabled(value: boolean);
  32115. /**
  32116. * Are color grading textures enabled in the application.
  32117. */
  32118. static get ColorGradingTextureEnabled(): boolean;
  32119. static set ColorGradingTextureEnabled(value: boolean);
  32120. /**
  32121. * Are fresnels enabled in the application.
  32122. */
  32123. static get FresnelEnabled(): boolean;
  32124. static set FresnelEnabled(value: boolean);
  32125. }
  32126. }
  32127. declare module "babylonjs/Particles/solidParticleSystem" {
  32128. import { Nullable } from "babylonjs/types";
  32129. import { Mesh } from "babylonjs/Meshes/mesh";
  32130. import { Scene, IDisposable } from "babylonjs/scene";
  32131. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32132. import { Material } from "babylonjs/Materials/material";
  32133. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32134. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32135. /**
  32136. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32137. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  32138. * The SPS is also a particle system. It provides some methods to manage the particles.
  32139. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32140. *
  32141. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32142. */
  32143. export class SolidParticleSystem implements IDisposable {
  32144. /**
  32145. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32146. * Example : var p = SPS.particles[i];
  32147. */
  32148. particles: SolidParticle[];
  32149. /**
  32150. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32151. */
  32152. nbParticles: number;
  32153. /**
  32154. * If the particles must ever face the camera (default false). Useful for planar particles.
  32155. */
  32156. billboard: boolean;
  32157. /**
  32158. * Recompute normals when adding a shape
  32159. */
  32160. recomputeNormals: boolean;
  32161. /**
  32162. * This a counter ofr your own usage. It's not set by any SPS functions.
  32163. */
  32164. counter: number;
  32165. /**
  32166. * The SPS name. This name is also given to the underlying mesh.
  32167. */
  32168. name: string;
  32169. /**
  32170. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32171. */
  32172. mesh: Mesh;
  32173. /**
  32174. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32175. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32176. */
  32177. vars: any;
  32178. /**
  32179. * This array is populated when the SPS is set as 'pickable'.
  32180. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32181. * Each element of this array is an object `{idx: int, faceId: int}`.
  32182. * `idx` is the picked particle index in the `SPS.particles` array
  32183. * `faceId` is the picked face index counted within this particle.
  32184. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32185. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32186. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32187. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32188. */
  32189. pickedParticles: {
  32190. idx: number;
  32191. faceId: number;
  32192. }[];
  32193. /**
  32194. * This array is populated when the SPS is set as 'pickable'
  32195. * Each key of this array is a submesh index.
  32196. * Each element of this array is a second array defined like this :
  32197. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32198. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32199. * `idx` is the picked particle index in the `SPS.particles` array
  32200. * `faceId` is the picked face index counted within this particle.
  32201. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32202. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32203. */
  32204. pickedBySubMesh: {
  32205. idx: number;
  32206. faceId: number;
  32207. }[][];
  32208. /**
  32209. * This array is populated when `enableDepthSort` is set to true.
  32210. * Each element of this array is an instance of the class DepthSortedParticle.
  32211. */
  32212. depthSortedParticles: DepthSortedParticle[];
  32213. /**
  32214. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32215. * @hidden
  32216. */
  32217. _bSphereOnly: boolean;
  32218. /**
  32219. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32220. * @hidden
  32221. */
  32222. _bSphereRadiusFactor: number;
  32223. private _scene;
  32224. private _positions;
  32225. private _indices;
  32226. private _normals;
  32227. private _colors;
  32228. private _uvs;
  32229. private _indices32;
  32230. private _positions32;
  32231. private _normals32;
  32232. private _fixedNormal32;
  32233. private _colors32;
  32234. private _uvs32;
  32235. private _index;
  32236. private _updatable;
  32237. private _pickable;
  32238. private _isVisibilityBoxLocked;
  32239. private _alwaysVisible;
  32240. private _depthSort;
  32241. private _expandable;
  32242. private _shapeCounter;
  32243. private _copy;
  32244. private _color;
  32245. private _computeParticleColor;
  32246. private _computeParticleTexture;
  32247. private _computeParticleRotation;
  32248. private _computeParticleVertex;
  32249. private _computeBoundingBox;
  32250. private _depthSortParticles;
  32251. private _camera;
  32252. private _mustUnrotateFixedNormals;
  32253. private _particlesIntersect;
  32254. private _needs32Bits;
  32255. private _isNotBuilt;
  32256. private _lastParticleId;
  32257. private _idxOfId;
  32258. private _multimaterialEnabled;
  32259. private _useModelMaterial;
  32260. private _indicesByMaterial;
  32261. private _materialIndexes;
  32262. private _depthSortFunction;
  32263. private _materialSortFunction;
  32264. private _materials;
  32265. private _multimaterial;
  32266. private _materialIndexesById;
  32267. private _defaultMaterial;
  32268. private _autoUpdateSubMeshes;
  32269. private _tmpVertex;
  32270. /**
  32271. * Creates a SPS (Solid Particle System) object.
  32272. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32273. * @param scene (Scene) is the scene in which the SPS is added.
  32274. * @param options defines the options of the sps e.g.
  32275. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32276. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32277. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32278. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  32279. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32280. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32281. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32282. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32283. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32284. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32285. */
  32286. constructor(name: string, scene: Scene, options?: {
  32287. updatable?: boolean;
  32288. isPickable?: boolean;
  32289. enableDepthSort?: boolean;
  32290. particleIntersection?: boolean;
  32291. boundingSphereOnly?: boolean;
  32292. bSphereRadiusFactor?: number;
  32293. expandable?: boolean;
  32294. useModelMaterial?: boolean;
  32295. enableMultiMaterial?: boolean;
  32296. });
  32297. /**
  32298. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32299. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32300. * @returns the created mesh
  32301. */
  32302. buildMesh(): Mesh;
  32303. /**
  32304. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32305. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32306. * Thus the particles generated from `digest()` have their property `position` set yet.
  32307. * @param mesh ( Mesh ) is the mesh to be digested
  32308. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  32309. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32310. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32311. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32312. * @returns the current SPS
  32313. */
  32314. digest(mesh: Mesh, options?: {
  32315. facetNb?: number;
  32316. number?: number;
  32317. delta?: number;
  32318. storage?: [];
  32319. }): SolidParticleSystem;
  32320. /**
  32321. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32322. * @hidden
  32323. */
  32324. private _unrotateFixedNormals;
  32325. /**
  32326. * Resets the temporary working copy particle
  32327. * @hidden
  32328. */
  32329. private _resetCopy;
  32330. /**
  32331. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32332. * @param p the current index in the positions array to be updated
  32333. * @param ind the current index in the indices array
  32334. * @param shape a Vector3 array, the shape geometry
  32335. * @param positions the positions array to be updated
  32336. * @param meshInd the shape indices array
  32337. * @param indices the indices array to be updated
  32338. * @param meshUV the shape uv array
  32339. * @param uvs the uv array to be updated
  32340. * @param meshCol the shape color array
  32341. * @param colors the color array to be updated
  32342. * @param meshNor the shape normals array
  32343. * @param normals the normals array to be updated
  32344. * @param idx the particle index
  32345. * @param idxInShape the particle index in its shape
  32346. * @param options the addShape() method passed options
  32347. * @model the particle model
  32348. * @hidden
  32349. */
  32350. private _meshBuilder;
  32351. /**
  32352. * Returns a shape Vector3 array from positions float array
  32353. * @param positions float array
  32354. * @returns a vector3 array
  32355. * @hidden
  32356. */
  32357. private _posToShape;
  32358. /**
  32359. * Returns a shapeUV array from a float uvs (array deep copy)
  32360. * @param uvs as a float array
  32361. * @returns a shapeUV array
  32362. * @hidden
  32363. */
  32364. private _uvsToShapeUV;
  32365. /**
  32366. * Adds a new particle object in the particles array
  32367. * @param idx particle index in particles array
  32368. * @param id particle id
  32369. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32370. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32371. * @param model particle ModelShape object
  32372. * @param shapeId model shape identifier
  32373. * @param idxInShape index of the particle in the current model
  32374. * @param bInfo model bounding info object
  32375. * @param storage target storage array, if any
  32376. * @hidden
  32377. */
  32378. private _addParticle;
  32379. /**
  32380. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32381. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32382. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32383. * @param nb (positive integer) the number of particles to be created from this model
  32384. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32385. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32386. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32387. * @returns the number of shapes in the system
  32388. */
  32389. addShape(mesh: Mesh, nb: number, options?: {
  32390. positionFunction?: any;
  32391. vertexFunction?: any;
  32392. storage?: [];
  32393. }): number;
  32394. /**
  32395. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32396. * @hidden
  32397. */
  32398. private _rebuildParticle;
  32399. /**
  32400. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32401. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  32402. * @returns the SPS.
  32403. */
  32404. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32405. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32406. * Returns an array with the removed particles.
  32407. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  32408. * The SPS can't be empty so at least one particle needs to remain in place.
  32409. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32410. * @param start index of the first particle to remove
  32411. * @param end index of the last particle to remove (included)
  32412. * @returns an array populated with the removed particles
  32413. */
  32414. removeParticles(start: number, end: number): SolidParticle[];
  32415. /**
  32416. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32417. * @param solidParticleArray an array populated with Solid Particles objects
  32418. * @returns the SPS
  32419. */
  32420. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32421. /**
  32422. * Creates a new particle and modifies the SPS mesh geometry :
  32423. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32424. * - calls _addParticle() to populate the particle array
  32425. * factorized code from addShape() and insertParticlesFromArray()
  32426. * @param idx particle index in the particles array
  32427. * @param i particle index in its shape
  32428. * @param modelShape particle ModelShape object
  32429. * @param shape shape vertex array
  32430. * @param meshInd shape indices array
  32431. * @param meshUV shape uv array
  32432. * @param meshCol shape color array
  32433. * @param meshNor shape normals array
  32434. * @param bbInfo shape bounding info
  32435. * @param storage target particle storage
  32436. * @options addShape() passed options
  32437. * @hidden
  32438. */
  32439. private _insertNewParticle;
  32440. /**
  32441. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32442. * This method calls `updateParticle()` for each particle of the SPS.
  32443. * For an animated SPS, it is usually called within the render loop.
  32444. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  32445. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32446. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32447. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32448. * @returns the SPS.
  32449. */
  32450. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32451. /**
  32452. * Disposes the SPS.
  32453. */
  32454. dispose(): void;
  32455. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32456. * idx is the particle index in the SPS
  32457. * faceId is the picked face index counted within this particle.
  32458. * Returns null if the pickInfo can't identify a picked particle.
  32459. * @param pickingInfo (PickingInfo object)
  32460. * @returns {idx: number, faceId: number} or null
  32461. */
  32462. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32463. idx: number;
  32464. faceId: number;
  32465. }>;
  32466. /**
  32467. * Returns a SolidParticle object from its identifier : particle.id
  32468. * @param id (integer) the particle Id
  32469. * @returns the searched particle or null if not found in the SPS.
  32470. */
  32471. getParticleById(id: number): Nullable<SolidParticle>;
  32472. /**
  32473. * Returns a new array populated with the particles having the passed shapeId.
  32474. * @param shapeId (integer) the shape identifier
  32475. * @returns a new solid particle array
  32476. */
  32477. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32478. /**
  32479. * Populates the passed array "ref" with the particles having the passed shapeId.
  32480. * @param shapeId the shape identifier
  32481. * @returns the SPS
  32482. * @param ref
  32483. */
  32484. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32485. /**
  32486. * Computes the required SubMeshes according the materials assigned to the particles.
  32487. * @returns the solid particle system.
  32488. * Does nothing if called before the SPS mesh is built.
  32489. */
  32490. computeSubMeshes(): SolidParticleSystem;
  32491. /**
  32492. * Sorts the solid particles by material when MultiMaterial is enabled.
  32493. * Updates the indices32 array.
  32494. * Updates the indicesByMaterial array.
  32495. * Updates the mesh indices array.
  32496. * @returns the SPS
  32497. * @hidden
  32498. */
  32499. private _sortParticlesByMaterial;
  32500. /**
  32501. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32502. * @hidden
  32503. */
  32504. private _setMaterialIndexesById;
  32505. /**
  32506. * Returns an array with unique values of Materials from the passed array
  32507. * @param array the material array to be checked and filtered
  32508. * @hidden
  32509. */
  32510. private _filterUniqueMaterialId;
  32511. /**
  32512. * Sets a new Standard Material as _defaultMaterial if not already set.
  32513. * @hidden
  32514. */
  32515. private _setDefaultMaterial;
  32516. /**
  32517. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32518. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32519. * @returns the SPS.
  32520. */
  32521. refreshVisibleSize(): SolidParticleSystem;
  32522. /**
  32523. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32524. * @param size the size (float) of the visibility box
  32525. * note : this doesn't lock the SPS mesh bounding box.
  32526. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32527. */
  32528. setVisibilityBox(size: number): void;
  32529. /**
  32530. * Gets whether the SPS as always visible or not
  32531. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32532. */
  32533. get isAlwaysVisible(): boolean;
  32534. /**
  32535. * Sets the SPS as always visible or not
  32536. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32537. */
  32538. set isAlwaysVisible(val: boolean);
  32539. /**
  32540. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32541. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32542. */
  32543. set isVisibilityBoxLocked(val: boolean);
  32544. /**
  32545. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32546. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32547. */
  32548. get isVisibilityBoxLocked(): boolean;
  32549. /**
  32550. * Tells to `setParticles()` to compute the particle rotations or not.
  32551. * Default value : true. The SPS is faster when it's set to false.
  32552. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32553. */
  32554. set computeParticleRotation(val: boolean);
  32555. /**
  32556. * Tells to `setParticles()` to compute the particle colors or not.
  32557. * Default value : true. The SPS is faster when it's set to false.
  32558. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32559. */
  32560. set computeParticleColor(val: boolean);
  32561. set computeParticleTexture(val: boolean);
  32562. /**
  32563. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32564. * Default value : false. The SPS is faster when it's set to false.
  32565. * Note : the particle custom vertex positions aren't stored values.
  32566. */
  32567. set computeParticleVertex(val: boolean);
  32568. /**
  32569. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32570. */
  32571. set computeBoundingBox(val: boolean);
  32572. /**
  32573. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32574. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32575. * Default : `true`
  32576. */
  32577. set depthSortParticles(val: boolean);
  32578. /**
  32579. * Gets if `setParticles()` computes the particle rotations or not.
  32580. * Default value : true. The SPS is faster when it's set to false.
  32581. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32582. */
  32583. get computeParticleRotation(): boolean;
  32584. /**
  32585. * Gets if `setParticles()` computes the particle colors or not.
  32586. * Default value : true. The SPS is faster when it's set to false.
  32587. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32588. */
  32589. get computeParticleColor(): boolean;
  32590. /**
  32591. * Gets if `setParticles()` computes the particle textures or not.
  32592. * Default value : true. The SPS is faster when it's set to false.
  32593. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32594. */
  32595. get computeParticleTexture(): boolean;
  32596. /**
  32597. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32598. * Default value : false. The SPS is faster when it's set to false.
  32599. * Note : the particle custom vertex positions aren't stored values.
  32600. */
  32601. get computeParticleVertex(): boolean;
  32602. /**
  32603. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32604. */
  32605. get computeBoundingBox(): boolean;
  32606. /**
  32607. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32608. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32609. * Default : `true`
  32610. */
  32611. get depthSortParticles(): boolean;
  32612. /**
  32613. * Gets if the SPS is created as expandable at construction time.
  32614. * Default : `false`
  32615. */
  32616. get expandable(): boolean;
  32617. /**
  32618. * Gets if the SPS supports the Multi Materials
  32619. */
  32620. get multimaterialEnabled(): boolean;
  32621. /**
  32622. * Gets if the SPS uses the model materials for its own multimaterial.
  32623. */
  32624. get useModelMaterial(): boolean;
  32625. /**
  32626. * The SPS used material array.
  32627. */
  32628. get materials(): Material[];
  32629. /**
  32630. * Sets the SPS MultiMaterial from the passed materials.
  32631. * Note : the passed array is internally copied and not used then by reference.
  32632. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32633. */
  32634. setMultiMaterial(materials: Material[]): void;
  32635. /**
  32636. * The SPS computed multimaterial object
  32637. */
  32638. get multimaterial(): MultiMaterial;
  32639. set multimaterial(mm: MultiMaterial);
  32640. /**
  32641. * If the subMeshes must be updated on the next call to setParticles()
  32642. */
  32643. get autoUpdateSubMeshes(): boolean;
  32644. set autoUpdateSubMeshes(val: boolean);
  32645. /**
  32646. * This function does nothing. It may be overwritten to set all the particle first values.
  32647. * The SPS doesn't call this function, you may have to call it by your own.
  32648. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32649. */
  32650. initParticles(): void;
  32651. /**
  32652. * This function does nothing. It may be overwritten to recycle a particle.
  32653. * The SPS doesn't call this function, you may have to call it by your own.
  32654. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32655. * @param particle The particle to recycle
  32656. * @returns the recycled particle
  32657. */
  32658. recycleParticle(particle: SolidParticle): SolidParticle;
  32659. /**
  32660. * Updates a particle : this function should be overwritten by the user.
  32661. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32662. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32663. * @example : just set a particle position or velocity and recycle conditions
  32664. * @param particle The particle to update
  32665. * @returns the updated particle
  32666. */
  32667. updateParticle(particle: SolidParticle): SolidParticle;
  32668. /**
  32669. * Updates a vertex of a particle : it can be overwritten by the user.
  32670. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32671. * @param particle the current particle
  32672. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32673. * @param pt the index of the current vertex in the particle shape
  32674. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32675. * @example : just set a vertex particle position or color
  32676. * @returns the sps
  32677. */
  32678. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32679. /**
  32680. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32681. * This does nothing and may be overwritten by the user.
  32682. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32683. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param update the boolean update value actually passed to setParticles()
  32685. */
  32686. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32687. /**
  32688. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32689. * This will be passed three parameters.
  32690. * This does nothing and may be overwritten by the user.
  32691. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32692. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32693. * @param update the boolean update value actually passed to setParticles()
  32694. */
  32695. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32696. }
  32697. }
  32698. declare module "babylonjs/Particles/solidParticle" {
  32699. import { Nullable } from "babylonjs/types";
  32700. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32701. import { Color4 } from "babylonjs/Maths/math.color";
  32702. import { Mesh } from "babylonjs/Meshes/mesh";
  32703. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32704. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32705. import { Plane } from "babylonjs/Maths/math.plane";
  32706. import { Material } from "babylonjs/Materials/material";
  32707. /**
  32708. * Represents one particle of a solid particle system.
  32709. */
  32710. export class SolidParticle {
  32711. /**
  32712. * particle global index
  32713. */
  32714. idx: number;
  32715. /**
  32716. * particle identifier
  32717. */
  32718. id: number;
  32719. /**
  32720. * The color of the particle
  32721. */
  32722. color: Nullable<Color4>;
  32723. /**
  32724. * The world space position of the particle.
  32725. */
  32726. position: Vector3;
  32727. /**
  32728. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32729. */
  32730. rotation: Vector3;
  32731. /**
  32732. * The world space rotation quaternion of the particle.
  32733. */
  32734. rotationQuaternion: Nullable<Quaternion>;
  32735. /**
  32736. * The scaling of the particle.
  32737. */
  32738. scaling: Vector3;
  32739. /**
  32740. * The uvs of the particle.
  32741. */
  32742. uvs: Vector4;
  32743. /**
  32744. * The current speed of the particle.
  32745. */
  32746. velocity: Vector3;
  32747. /**
  32748. * The pivot point in the particle local space.
  32749. */
  32750. pivot: Vector3;
  32751. /**
  32752. * Must the particle be translated from its pivot point in its local space ?
  32753. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32754. * Default : false
  32755. */
  32756. translateFromPivot: boolean;
  32757. /**
  32758. * Is the particle active or not ?
  32759. */
  32760. alive: boolean;
  32761. /**
  32762. * Is the particle visible or not ?
  32763. */
  32764. isVisible: boolean;
  32765. /**
  32766. * Index of this particle in the global "positions" array (Internal use)
  32767. * @hidden
  32768. */
  32769. _pos: number;
  32770. /**
  32771. * @hidden Index of this particle in the global "indices" array (Internal use)
  32772. */
  32773. _ind: number;
  32774. /**
  32775. * @hidden ModelShape of this particle (Internal use)
  32776. */
  32777. _model: ModelShape;
  32778. /**
  32779. * ModelShape id of this particle
  32780. */
  32781. shapeId: number;
  32782. /**
  32783. * Index of the particle in its shape id
  32784. */
  32785. idxInShape: number;
  32786. /**
  32787. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32788. */
  32789. _modelBoundingInfo: BoundingInfo;
  32790. /**
  32791. * @hidden Particle BoundingInfo object (Internal use)
  32792. */
  32793. _boundingInfo: BoundingInfo;
  32794. /**
  32795. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32796. */
  32797. _sps: SolidParticleSystem;
  32798. /**
  32799. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32800. */
  32801. _stillInvisible: boolean;
  32802. /**
  32803. * @hidden Last computed particle rotation matrix
  32804. */
  32805. _rotationMatrix: number[];
  32806. /**
  32807. * Parent particle Id, if any.
  32808. * Default null.
  32809. */
  32810. parentId: Nullable<number>;
  32811. /**
  32812. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32813. */
  32814. materialIndex: Nullable<number>;
  32815. /**
  32816. * Custom object or properties.
  32817. */
  32818. props: Nullable<any>;
  32819. /**
  32820. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32821. * The possible values are :
  32822. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32823. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32824. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32826. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32827. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32828. * */
  32829. cullingStrategy: number;
  32830. /**
  32831. * @hidden Internal global position in the SPS.
  32832. */
  32833. _globalPosition: Vector3;
  32834. /**
  32835. * Creates a Solid Particle object.
  32836. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32837. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32838. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32839. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32840. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32841. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32842. * @param shapeId (integer) is the model shape identifier in the SPS.
  32843. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32844. * @param sps defines the sps it is associated to
  32845. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32846. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32847. */
  32848. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32849. /**
  32850. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32851. * @param target the particle target
  32852. * @returns the current particle
  32853. */
  32854. copyToRef(target: SolidParticle): SolidParticle;
  32855. /**
  32856. * Legacy support, changed scale to scaling
  32857. */
  32858. get scale(): Vector3;
  32859. /**
  32860. * Legacy support, changed scale to scaling
  32861. */
  32862. set scale(scale: Vector3);
  32863. /**
  32864. * Legacy support, changed quaternion to rotationQuaternion
  32865. */
  32866. get quaternion(): Nullable<Quaternion>;
  32867. /**
  32868. * Legacy support, changed quaternion to rotationQuaternion
  32869. */
  32870. set quaternion(q: Nullable<Quaternion>);
  32871. /**
  32872. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32873. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32874. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32875. * @returns true if it intersects
  32876. */
  32877. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32878. /**
  32879. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32880. * A particle is in the frustum if its bounding box intersects the frustum
  32881. * @param frustumPlanes defines the frustum to test
  32882. * @returns true if the particle is in the frustum planes
  32883. */
  32884. isInFrustum(frustumPlanes: Plane[]): boolean;
  32885. /**
  32886. * get the rotation matrix of the particle
  32887. * @hidden
  32888. */
  32889. getRotationMatrix(m: Matrix): void;
  32890. }
  32891. /**
  32892. * Represents the shape of the model used by one particle of a solid particle system.
  32893. * SPS internal tool, don't use it manually.
  32894. */
  32895. export class ModelShape {
  32896. /**
  32897. * The shape id
  32898. * @hidden
  32899. */
  32900. shapeID: number;
  32901. /**
  32902. * flat array of model positions (internal use)
  32903. * @hidden
  32904. */
  32905. _shape: Vector3[];
  32906. /**
  32907. * flat array of model UVs (internal use)
  32908. * @hidden
  32909. */
  32910. _shapeUV: number[];
  32911. /**
  32912. * color array of the model
  32913. * @hidden
  32914. */
  32915. _shapeColors: number[];
  32916. /**
  32917. * indices array of the model
  32918. * @hidden
  32919. */
  32920. _indices: number[];
  32921. /**
  32922. * normals array of the model
  32923. * @hidden
  32924. */
  32925. _normals: number[];
  32926. /**
  32927. * length of the shape in the model indices array (internal use)
  32928. * @hidden
  32929. */
  32930. _indicesLength: number;
  32931. /**
  32932. * Custom position function (internal use)
  32933. * @hidden
  32934. */
  32935. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32936. /**
  32937. * Custom vertex function (internal use)
  32938. * @hidden
  32939. */
  32940. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32941. /**
  32942. * Model material (internal use)
  32943. * @hidden
  32944. */
  32945. _material: Nullable<Material>;
  32946. /**
  32947. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  32948. * SPS internal tool, don't use it manually.
  32949. * @hidden
  32950. */
  32951. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  32952. }
  32953. /**
  32954. * Represents a Depth Sorted Particle in the solid particle system.
  32955. * @hidden
  32956. */
  32957. export class DepthSortedParticle {
  32958. /**
  32959. * Particle index
  32960. */
  32961. idx: number;
  32962. /**
  32963. * Index of the particle in the "indices" array
  32964. */
  32965. ind: number;
  32966. /**
  32967. * Length of the particle shape in the "indices" array
  32968. */
  32969. indicesLength: number;
  32970. /**
  32971. * Squared distance from the particle to the camera
  32972. */
  32973. sqDistance: number;
  32974. /**
  32975. * Material index when used with MultiMaterials
  32976. */
  32977. materialIndex: number;
  32978. /**
  32979. * Creates a new sorted particle
  32980. * @param materialIndex
  32981. */
  32982. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32983. }
  32984. /**
  32985. * Represents a solid particle vertex
  32986. */
  32987. export class SolidParticleVertex {
  32988. /**
  32989. * Vertex position
  32990. */
  32991. position: Vector3;
  32992. /**
  32993. * Vertex color
  32994. */
  32995. color: Color4;
  32996. /**
  32997. * Vertex UV
  32998. */
  32999. uv: Vector2;
  33000. /**
  33001. * Creates a new solid particle vertex
  33002. */
  33003. constructor();
  33004. /** Vertex x coordinate */
  33005. get x(): number;
  33006. set x(val: number);
  33007. /** Vertex y coordinate */
  33008. get y(): number;
  33009. set y(val: number);
  33010. /** Vertex z coordinate */
  33011. get z(): number;
  33012. set z(val: number);
  33013. }
  33014. }
  33015. declare module "babylonjs/Collisions/meshCollisionData" {
  33016. import { Collider } from "babylonjs/Collisions/collider";
  33017. import { Vector3 } from "babylonjs/Maths/math.vector";
  33018. import { Nullable } from "babylonjs/types";
  33019. import { Observer } from "babylonjs/Misc/observable";
  33020. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33021. /**
  33022. * @hidden
  33023. */
  33024. export class _MeshCollisionData {
  33025. _checkCollisions: boolean;
  33026. _collisionMask: number;
  33027. _collisionGroup: number;
  33028. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33029. _collider: Nullable<Collider>;
  33030. _oldPositionForCollisions: Vector3;
  33031. _diffPositionForCollisions: Vector3;
  33032. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33033. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33034. }
  33035. }
  33036. declare module "babylonjs/Meshes/abstractMesh" {
  33037. import { Observable } from "babylonjs/Misc/observable";
  33038. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33039. import { Camera } from "babylonjs/Cameras/camera";
  33040. import { Scene, IDisposable } from "babylonjs/scene";
  33041. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33042. import { Node } from "babylonjs/node";
  33043. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33044. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33045. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33046. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33047. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33048. import { Material } from "babylonjs/Materials/material";
  33049. import { Light } from "babylonjs/Lights/light";
  33050. import { Skeleton } from "babylonjs/Bones/skeleton";
  33051. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33052. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33053. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33054. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33055. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33056. import { Plane } from "babylonjs/Maths/math.plane";
  33057. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33058. import { Ray } from "babylonjs/Culling/ray";
  33059. import { Collider } from "babylonjs/Collisions/collider";
  33060. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33061. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33062. /** @hidden */
  33063. class _FacetDataStorage {
  33064. facetPositions: Vector3[];
  33065. facetNormals: Vector3[];
  33066. facetPartitioning: number[][];
  33067. facetNb: number;
  33068. partitioningSubdivisions: number;
  33069. partitioningBBoxRatio: number;
  33070. facetDataEnabled: boolean;
  33071. facetParameters: any;
  33072. bbSize: Vector3;
  33073. subDiv: {
  33074. max: number;
  33075. X: number;
  33076. Y: number;
  33077. Z: number;
  33078. };
  33079. facetDepthSort: boolean;
  33080. facetDepthSortEnabled: boolean;
  33081. depthSortedIndices: IndicesArray;
  33082. depthSortedFacets: {
  33083. ind: number;
  33084. sqDistance: number;
  33085. }[];
  33086. facetDepthSortFunction: (f1: {
  33087. ind: number;
  33088. sqDistance: number;
  33089. }, f2: {
  33090. ind: number;
  33091. sqDistance: number;
  33092. }) => number;
  33093. facetDepthSortFrom: Vector3;
  33094. facetDepthSortOrigin: Vector3;
  33095. invertedMatrix: Matrix;
  33096. }
  33097. /**
  33098. * @hidden
  33099. **/
  33100. class _InternalAbstractMeshDataInfo {
  33101. _hasVertexAlpha: boolean;
  33102. _useVertexColors: boolean;
  33103. _numBoneInfluencers: number;
  33104. _applyFog: boolean;
  33105. _receiveShadows: boolean;
  33106. _facetData: _FacetDataStorage;
  33107. _visibility: number;
  33108. _skeleton: Nullable<Skeleton>;
  33109. _layerMask: number;
  33110. _computeBonesUsingShaders: boolean;
  33111. _isActive: boolean;
  33112. _onlyForInstances: boolean;
  33113. _isActiveIntermediate: boolean;
  33114. _onlyForInstancesIntermediate: boolean;
  33115. _actAsRegularMesh: boolean;
  33116. }
  33117. /**
  33118. * Class used to store all common mesh properties
  33119. */
  33120. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33121. /** No occlusion */
  33122. static OCCLUSION_TYPE_NONE: number;
  33123. /** Occlusion set to optimisitic */
  33124. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33125. /** Occlusion set to strict */
  33126. static OCCLUSION_TYPE_STRICT: number;
  33127. /** Use an accurante occlusion algorithm */
  33128. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33129. /** Use a conservative occlusion algorithm */
  33130. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33131. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33132. * Test order :
  33133. * Is the bounding sphere outside the frustum ?
  33134. * If not, are the bounding box vertices outside the frustum ?
  33135. * It not, then the cullable object is in the frustum.
  33136. */
  33137. static readonly CULLINGSTRATEGY_STANDARD: number;
  33138. /** Culling strategy : Bounding Sphere Only.
  33139. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33140. * It's also less accurate than the standard because some not visible objects can still be selected.
  33141. * Test : is the bounding sphere outside the frustum ?
  33142. * If not, then the cullable object is in the frustum.
  33143. */
  33144. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33145. /** Culling strategy : Optimistic Inclusion.
  33146. * This in an inclusion test first, then the standard exclusion test.
  33147. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33148. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  33149. * Anyway, it's as accurate as the standard strategy.
  33150. * Test :
  33151. * Is the cullable object bounding sphere center in the frustum ?
  33152. * If not, apply the default culling strategy.
  33153. */
  33154. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33155. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33156. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33157. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33158. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  33159. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33160. * Test :
  33161. * Is the cullable object bounding sphere center in the frustum ?
  33162. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33163. */
  33164. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33165. /**
  33166. * No billboard
  33167. */
  33168. static get BILLBOARDMODE_NONE(): number;
  33169. /** Billboard on X axis */
  33170. static get BILLBOARDMODE_X(): number;
  33171. /** Billboard on Y axis */
  33172. static get BILLBOARDMODE_Y(): number;
  33173. /** Billboard on Z axis */
  33174. static get BILLBOARDMODE_Z(): number;
  33175. /** Billboard on all axes */
  33176. static get BILLBOARDMODE_ALL(): number;
  33177. /** Billboard on using position instead of orientation */
  33178. static get BILLBOARDMODE_USE_POSITION(): number;
  33179. /** @hidden */
  33180. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33181. /**
  33182. * The culling strategy to use to check whether the mesh must be rendered or not.
  33183. * This value can be changed at any time and will be used on the next render mesh selection.
  33184. * The possible values are :
  33185. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33186. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33187. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33188. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33189. * Please read each static variable documentation to get details about the culling process.
  33190. * */
  33191. cullingStrategy: number;
  33192. /**
  33193. * Gets the number of facets in the mesh
  33194. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33195. */
  33196. get facetNb(): number;
  33197. /**
  33198. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33199. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33200. */
  33201. get partitioningSubdivisions(): number;
  33202. set partitioningSubdivisions(nb: number);
  33203. /**
  33204. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33205. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33206. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33207. */
  33208. get partitioningBBoxRatio(): number;
  33209. set partitioningBBoxRatio(ratio: number);
  33210. /**
  33211. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33212. * Works only for updatable meshes.
  33213. * Doesn't work with multi-materials
  33214. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33215. */
  33216. get mustDepthSortFacets(): boolean;
  33217. set mustDepthSortFacets(sort: boolean);
  33218. /**
  33219. * The location (Vector3) where the facet depth sort must be computed from.
  33220. * By default, the active camera position.
  33221. * Used only when facet depth sort is enabled
  33222. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33223. */
  33224. get facetDepthSortFrom(): Vector3;
  33225. set facetDepthSortFrom(location: Vector3);
  33226. /**
  33227. * gets a boolean indicating if facetData is enabled
  33228. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33229. */
  33230. get isFacetDataEnabled(): boolean;
  33231. /** @hidden */
  33232. _updateNonUniformScalingState(value: boolean): boolean;
  33233. /**
  33234. * An event triggered when this mesh collides with another one
  33235. */
  33236. onCollideObservable: Observable<AbstractMesh>;
  33237. /** Set a function to call when this mesh collides with another one */
  33238. set onCollide(callback: () => void);
  33239. /**
  33240. * An event triggered when the collision's position changes
  33241. */
  33242. onCollisionPositionChangeObservable: Observable<Vector3>;
  33243. /** Set a function to call when the collision's position changes */
  33244. set onCollisionPositionChange(callback: () => void);
  33245. /**
  33246. * An event triggered when material is changed
  33247. */
  33248. onMaterialChangedObservable: Observable<AbstractMesh>;
  33249. /**
  33250. * Gets or sets the orientation for POV movement & rotation
  33251. */
  33252. definedFacingForward: boolean;
  33253. /** @hidden */
  33254. _occlusionQuery: Nullable<WebGLQuery>;
  33255. /** @hidden */
  33256. _renderingGroup: Nullable<RenderingGroup>;
  33257. /**
  33258. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33259. */
  33260. get visibility(): number;
  33261. /**
  33262. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33263. */
  33264. set visibility(value: number);
  33265. /** Gets or sets the alpha index used to sort transparent meshes
  33266. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33267. */
  33268. alphaIndex: number;
  33269. /**
  33270. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33271. */
  33272. isVisible: boolean;
  33273. /**
  33274. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33275. */
  33276. isPickable: boolean;
  33277. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33278. showSubMeshesBoundingBox: boolean;
  33279. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33280. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33281. */
  33282. isBlocker: boolean;
  33283. /**
  33284. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33285. */
  33286. enablePointerMoveEvents: boolean;
  33287. private _renderingGroupId;
  33288. /**
  33289. * Specifies the rendering group id for this mesh (0 by default)
  33290. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33291. */
  33292. get renderingGroupId(): number;
  33293. set renderingGroupId(value: number);
  33294. private _material;
  33295. /** Gets or sets current material */
  33296. get material(): Nullable<Material>;
  33297. set material(value: Nullable<Material>);
  33298. /**
  33299. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33300. * @see https://doc.babylonjs.com/babylon101/shadows
  33301. */
  33302. get receiveShadows(): boolean;
  33303. set receiveShadows(value: boolean);
  33304. /** Defines color to use when rendering outline */
  33305. outlineColor: Color3;
  33306. /** Define width to use when rendering outline */
  33307. outlineWidth: number;
  33308. /** Defines color to use when rendering overlay */
  33309. overlayColor: Color3;
  33310. /** Defines alpha to use when rendering overlay */
  33311. overlayAlpha: number;
  33312. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33313. get hasVertexAlpha(): boolean;
  33314. set hasVertexAlpha(value: boolean);
  33315. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  33316. get useVertexColors(): boolean;
  33317. set useVertexColors(value: boolean);
  33318. /**
  33319. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33320. */
  33321. get computeBonesUsingShaders(): boolean;
  33322. set computeBonesUsingShaders(value: boolean);
  33323. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33324. get numBoneInfluencers(): number;
  33325. set numBoneInfluencers(value: number);
  33326. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33327. get applyFog(): boolean;
  33328. set applyFog(value: boolean);
  33329. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33330. useOctreeForRenderingSelection: boolean;
  33331. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33332. useOctreeForPicking: boolean;
  33333. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33334. useOctreeForCollisions: boolean;
  33335. /**
  33336. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33337. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33338. */
  33339. get layerMask(): number;
  33340. set layerMask(value: number);
  33341. /**
  33342. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33343. */
  33344. alwaysSelectAsActiveMesh: boolean;
  33345. /**
  33346. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33347. */
  33348. doNotSyncBoundingInfo: boolean;
  33349. /**
  33350. * Gets or sets the current action manager
  33351. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33352. */
  33353. actionManager: Nullable<AbstractActionManager>;
  33354. private _meshCollisionData;
  33355. /**
  33356. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33357. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33358. */
  33359. ellipsoid: Vector3;
  33360. /**
  33361. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33362. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33363. */
  33364. ellipsoidOffset: Vector3;
  33365. /**
  33366. * Gets or sets a collision mask used to mask collisions (default is -1).
  33367. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33368. */
  33369. get collisionMask(): number;
  33370. set collisionMask(mask: number);
  33371. /**
  33372. * Gets or sets the current collision group mask (-1 by default).
  33373. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33374. */
  33375. get collisionGroup(): number;
  33376. set collisionGroup(mask: number);
  33377. /**
  33378. * Gets or sets current surrounding meshes (null by default).
  33379. *
  33380. * By default collision detection is tested against every mesh in the scene.
  33381. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33382. * meshes will be tested for the collision.
  33383. *
  33384. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33385. */
  33386. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33387. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33388. /**
  33389. * Defines edge width used when edgesRenderer is enabled
  33390. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33391. */
  33392. edgesWidth: number;
  33393. /**
  33394. * Defines edge color used when edgesRenderer is enabled
  33395. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33396. */
  33397. edgesColor: Color4;
  33398. /** @hidden */
  33399. _edgesRenderer: Nullable<IEdgesRenderer>;
  33400. /** @hidden */
  33401. _masterMesh: Nullable<AbstractMesh>;
  33402. /** @hidden */
  33403. _boundingInfo: Nullable<BoundingInfo>;
  33404. /** @hidden */
  33405. _renderId: number;
  33406. /**
  33407. * Gets or sets the list of subMeshes
  33408. * @see https://doc.babylonjs.com/how_to/multi_materials
  33409. */
  33410. subMeshes: SubMesh[];
  33411. /** @hidden */
  33412. _intersectionsInProgress: AbstractMesh[];
  33413. /** @hidden */
  33414. _unIndexed: boolean;
  33415. /** @hidden */
  33416. _lightSources: Light[];
  33417. /** Gets the list of lights affecting that mesh */
  33418. get lightSources(): Light[];
  33419. /** @hidden */
  33420. get _positions(): Nullable<Vector3[]>;
  33421. /** @hidden */
  33422. _waitingData: {
  33423. lods: Nullable<any>;
  33424. actions: Nullable<any>;
  33425. freezeWorldMatrix: Nullable<boolean>;
  33426. };
  33427. /** @hidden */
  33428. _bonesTransformMatrices: Nullable<Float32Array>;
  33429. /** @hidden */
  33430. _transformMatrixTexture: Nullable<RawTexture>;
  33431. /**
  33432. * Gets or sets a skeleton to apply skining transformations
  33433. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33434. */
  33435. set skeleton(value: Nullable<Skeleton>);
  33436. get skeleton(): Nullable<Skeleton>;
  33437. /**
  33438. * An event triggered when the mesh is rebuilt.
  33439. */
  33440. onRebuildObservable: Observable<AbstractMesh>;
  33441. /**
  33442. * Creates a new AbstractMesh
  33443. * @param name defines the name of the mesh
  33444. * @param scene defines the hosting scene
  33445. */
  33446. constructor(name: string, scene?: Nullable<Scene>);
  33447. /**
  33448. * Returns the string "AbstractMesh"
  33449. * @returns "AbstractMesh"
  33450. */
  33451. getClassName(): string;
  33452. /**
  33453. * Gets a string representation of the current mesh
  33454. * @param fullDetails defines a boolean indicating if full details must be included
  33455. * @returns a string representation of the current mesh
  33456. */
  33457. toString(fullDetails?: boolean): string;
  33458. /**
  33459. * @hidden
  33460. */
  33461. protected _getEffectiveParent(): Nullable<Node>;
  33462. /** @hidden */
  33463. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33464. /** @hidden */
  33465. _rebuild(): void;
  33466. /** @hidden */
  33467. _resyncLightSources(): void;
  33468. /** @hidden */
  33469. _resyncLightSource(light: Light): void;
  33470. /** @hidden */
  33471. _unBindEffect(): void;
  33472. /** @hidden */
  33473. _removeLightSource(light: Light, dispose: boolean): void;
  33474. private _markSubMeshesAsDirty;
  33475. /** @hidden */
  33476. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33477. /** @hidden */
  33478. _markSubMeshesAsAttributesDirty(): void;
  33479. /** @hidden */
  33480. _markSubMeshesAsMiscDirty(): void;
  33481. /**
  33482. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33483. */
  33484. get scaling(): Vector3;
  33485. set scaling(newScaling: Vector3);
  33486. /**
  33487. * Returns true if the mesh is blocked. Implemented by child classes
  33488. */
  33489. get isBlocked(): boolean;
  33490. /**
  33491. * Returns the mesh itself by default. Implemented by child classes
  33492. * @param camera defines the camera to use to pick the right LOD level
  33493. * @returns the currentAbstractMesh
  33494. */
  33495. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33496. /**
  33497. * Returns 0 by default. Implemented by child classes
  33498. * @returns an integer
  33499. */
  33500. getTotalVertices(): number;
  33501. /**
  33502. * Returns a positive integer : the total number of indices in this mesh geometry.
  33503. * @returns the numner of indices or zero if the mesh has no geometry.
  33504. */
  33505. getTotalIndices(): number;
  33506. /**
  33507. * Returns null by default. Implemented by child classes
  33508. * @returns null
  33509. */
  33510. getIndices(): Nullable<IndicesArray>;
  33511. /**
  33512. * Returns the array of the requested vertex data kind. Implemented by child classes
  33513. * @param kind defines the vertex data kind to use
  33514. * @returns null
  33515. */
  33516. getVerticesData(kind: string): Nullable<FloatArray>;
  33517. /**
  33518. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33519. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33520. * Note that a new underlying VertexBuffer object is created each call.
  33521. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33522. * @param kind defines vertex data kind:
  33523. * * VertexBuffer.PositionKind
  33524. * * VertexBuffer.UVKind
  33525. * * VertexBuffer.UV2Kind
  33526. * * VertexBuffer.UV3Kind
  33527. * * VertexBuffer.UV4Kind
  33528. * * VertexBuffer.UV5Kind
  33529. * * VertexBuffer.UV6Kind
  33530. * * VertexBuffer.ColorKind
  33531. * * VertexBuffer.MatricesIndicesKind
  33532. * * VertexBuffer.MatricesIndicesExtraKind
  33533. * * VertexBuffer.MatricesWeightsKind
  33534. * * VertexBuffer.MatricesWeightsExtraKind
  33535. * @param data defines the data source
  33536. * @param updatable defines if the data must be flagged as updatable (or static)
  33537. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  33538. * @returns the current mesh
  33539. */
  33540. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33541. /**
  33542. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33543. * If the mesh has no geometry, it is simply returned as it is.
  33544. * @param kind defines vertex data kind:
  33545. * * VertexBuffer.PositionKind
  33546. * * VertexBuffer.UVKind
  33547. * * VertexBuffer.UV2Kind
  33548. * * VertexBuffer.UV3Kind
  33549. * * VertexBuffer.UV4Kind
  33550. * * VertexBuffer.UV5Kind
  33551. * * VertexBuffer.UV6Kind
  33552. * * VertexBuffer.ColorKind
  33553. * * VertexBuffer.MatricesIndicesKind
  33554. * * VertexBuffer.MatricesIndicesExtraKind
  33555. * * VertexBuffer.MatricesWeightsKind
  33556. * * VertexBuffer.MatricesWeightsExtraKind
  33557. * @param data defines the data source
  33558. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  33559. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33560. * @returns the current mesh
  33561. */
  33562. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33563. /**
  33564. * Sets the mesh indices,
  33565. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33566. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33567. * @param totalVertices Defines the total number of vertices
  33568. * @returns the current mesh
  33569. */
  33570. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33571. /**
  33572. * Gets a boolean indicating if specific vertex data is present
  33573. * @param kind defines the vertex data kind to use
  33574. * @returns true is data kind is present
  33575. */
  33576. isVerticesDataPresent(kind: string): boolean;
  33577. /**
  33578. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33579. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33580. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33581. * @returns a BoundingInfo
  33582. */
  33583. getBoundingInfo(): BoundingInfo;
  33584. /**
  33585. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33586. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33587. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33588. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33589. * @returns the current mesh
  33590. */
  33591. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33592. /**
  33593. * Overwrite the current bounding info
  33594. * @param boundingInfo defines the new bounding info
  33595. * @returns the current mesh
  33596. */
  33597. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33598. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33599. get useBones(): boolean;
  33600. /** @hidden */
  33601. _preActivate(): void;
  33602. /** @hidden */
  33603. _preActivateForIntermediateRendering(renderId: number): void;
  33604. /** @hidden */
  33605. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33606. /** @hidden */
  33607. _postActivate(): void;
  33608. /** @hidden */
  33609. _freeze(): void;
  33610. /** @hidden */
  33611. _unFreeze(): void;
  33612. /**
  33613. * Gets the current world matrix
  33614. * @returns a Matrix
  33615. */
  33616. getWorldMatrix(): Matrix;
  33617. /** @hidden */
  33618. _getWorldMatrixDeterminant(): number;
  33619. /**
  33620. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33621. */
  33622. get isAnInstance(): boolean;
  33623. /**
  33624. * Gets a boolean indicating if this mesh has instances
  33625. */
  33626. get hasInstances(): boolean;
  33627. /**
  33628. * Gets a boolean indicating if this mesh has thin instances
  33629. */
  33630. get hasThinInstances(): boolean;
  33631. /**
  33632. * Perform relative position change from the point of view of behind the front of the mesh.
  33633. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33634. * Supports definition of mesh facing forward or backward
  33635. * @param amountRight defines the distance on the right axis
  33636. * @param amountUp defines the distance on the up axis
  33637. * @param amountForward defines the distance on the forward axis
  33638. * @returns the current mesh
  33639. */
  33640. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33641. /**
  33642. * Calculate relative position change from the point of view of behind the front of the mesh.
  33643. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33644. * Supports definition of mesh facing forward or backward
  33645. * @param amountRight defines the distance on the right axis
  33646. * @param amountUp defines the distance on the up axis
  33647. * @param amountForward defines the distance on the forward axis
  33648. * @returns the new displacement vector
  33649. */
  33650. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33651. /**
  33652. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33653. * Supports definition of mesh facing forward or backward
  33654. * @param flipBack defines the flip
  33655. * @param twirlClockwise defines the twirl
  33656. * @param tiltRight defines the tilt
  33657. * @returns the current mesh
  33658. */
  33659. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33660. /**
  33661. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33662. * Supports definition of mesh facing forward or backward.
  33663. * @param flipBack defines the flip
  33664. * @param twirlClockwise defines the twirl
  33665. * @param tiltRight defines the tilt
  33666. * @returns the new rotation vector
  33667. */
  33668. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33669. /**
  33670. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33671. * This means the mesh underlying bounding box and sphere are recomputed.
  33672. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33673. * @returns the current mesh
  33674. */
  33675. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33676. /** @hidden */
  33677. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33678. /** @hidden */
  33679. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33680. /** @hidden */
  33681. _updateBoundingInfo(): AbstractMesh;
  33682. /** @hidden */
  33683. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33684. /** @hidden */
  33685. protected _afterComputeWorldMatrix(): void;
  33686. /** @hidden */
  33687. get _effectiveMesh(): AbstractMesh;
  33688. /**
  33689. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33690. * A mesh is in the frustum if its bounding box intersects the frustum
  33691. * @param frustumPlanes defines the frustum to test
  33692. * @returns true if the mesh is in the frustum planes
  33693. */
  33694. isInFrustum(frustumPlanes: Plane[]): boolean;
  33695. /**
  33696. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33697. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33698. * @param frustumPlanes defines the frustum to test
  33699. * @returns true if the mesh is completely in the frustum planes
  33700. */
  33701. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33702. /**
  33703. * True if the mesh intersects another mesh or a SolidParticle object
  33704. * @param mesh defines a target mesh or SolidParticle to test
  33705. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  33706. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33707. * @returns true if there is an intersection
  33708. */
  33709. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33710. /**
  33711. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33712. * @param point defines the point to test
  33713. * @returns true if there is an intersection
  33714. */
  33715. intersectsPoint(point: Vector3): boolean;
  33716. /**
  33717. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33718. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33719. */
  33720. get checkCollisions(): boolean;
  33721. set checkCollisions(collisionEnabled: boolean);
  33722. /**
  33723. * Gets Collider object used to compute collisions (not physics)
  33724. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33725. */
  33726. get collider(): Nullable<Collider>;
  33727. /**
  33728. * Move the mesh using collision engine
  33729. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33730. * @param displacement defines the requested displacement vector
  33731. * @returns the current mesh
  33732. */
  33733. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33734. private _onCollisionPositionChange;
  33735. /** @hidden */
  33736. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33737. /** @hidden */
  33738. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33739. /** @hidden */
  33740. _checkCollision(collider: Collider): AbstractMesh;
  33741. /** @hidden */
  33742. _generatePointsArray(): boolean;
  33743. /**
  33744. * Checks if the passed Ray intersects with the mesh
  33745. * @param ray defines the ray to use
  33746. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33747. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33748. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33749. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33750. * @returns the picking info
  33751. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33752. */
  33753. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33754. /**
  33755. * Clones the current mesh
  33756. * @param name defines the mesh name
  33757. * @param newParent defines the new mesh parent
  33758. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33759. * @returns the new mesh
  33760. */
  33761. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33762. /**
  33763. * Disposes all the submeshes of the current meshnp
  33764. * @returns the current mesh
  33765. */
  33766. releaseSubMeshes(): AbstractMesh;
  33767. /**
  33768. * Releases resources associated with this abstract mesh.
  33769. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33770. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33771. */
  33772. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33773. /**
  33774. * Adds the passed mesh as a child to the current mesh
  33775. * @param mesh defines the child mesh
  33776. * @returns the current mesh
  33777. */
  33778. addChild(mesh: AbstractMesh): AbstractMesh;
  33779. /**
  33780. * Removes the passed mesh from the current mesh children list
  33781. * @param mesh defines the child mesh
  33782. * @returns the current mesh
  33783. */
  33784. removeChild(mesh: AbstractMesh): AbstractMesh;
  33785. /** @hidden */
  33786. private _initFacetData;
  33787. /**
  33788. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33789. * This method can be called within the render loop.
  33790. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  33791. * @returns the current mesh
  33792. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33793. */
  33794. updateFacetData(): AbstractMesh;
  33795. /**
  33796. * Returns the facetLocalNormals array.
  33797. * The normals are expressed in the mesh local spac
  33798. * @returns an array of Vector3
  33799. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33800. */
  33801. getFacetLocalNormals(): Vector3[];
  33802. /**
  33803. * Returns the facetLocalPositions array.
  33804. * The facet positions are expressed in the mesh local space
  33805. * @returns an array of Vector3
  33806. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33807. */
  33808. getFacetLocalPositions(): Vector3[];
  33809. /**
  33810. * Returns the facetLocalPartioning array
  33811. * @returns an array of array of numbers
  33812. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33813. */
  33814. getFacetLocalPartitioning(): number[][];
  33815. /**
  33816. * Returns the i-th facet position in the world system.
  33817. * This method allocates a new Vector3 per call
  33818. * @param i defines the facet index
  33819. * @returns a new Vector3
  33820. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33821. */
  33822. getFacetPosition(i: number): Vector3;
  33823. /**
  33824. * Sets the reference Vector3 with the i-th facet position in the world system
  33825. * @param i defines the facet index
  33826. * @param ref defines the target vector
  33827. * @returns the current mesh
  33828. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33829. */
  33830. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33831. /**
  33832. * Returns the i-th facet normal in the world system.
  33833. * This method allocates a new Vector3 per call
  33834. * @param i defines the facet index
  33835. * @returns a new Vector3
  33836. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33837. */
  33838. getFacetNormal(i: number): Vector3;
  33839. /**
  33840. * Sets the reference Vector3 with the i-th facet normal in the world system
  33841. * @param i defines the facet index
  33842. * @param ref defines the target vector
  33843. * @returns the current mesh
  33844. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33845. */
  33846. getFacetNormalToRef(i: number, ref: Vector3): this;
  33847. /**
  33848. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  33849. * @param x defines x coordinate
  33850. * @param y defines y coordinate
  33851. * @param z defines z coordinate
  33852. * @returns the array of facet indexes
  33853. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33854. */
  33855. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33856. /**
  33857. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33858. * @param projected sets as the (x,y,z) world projection on the facet
  33859. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33860. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33861. * @param x defines x coordinate
  33862. * @param y defines y coordinate
  33863. * @param z defines z coordinate
  33864. * @returns the face index if found (or null instead)
  33865. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33866. */
  33867. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33868. /**
  33869. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33870. * @param projected sets as the (x,y,z) local projection on the facet
  33871. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  33872. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  33873. * @param x defines x coordinate
  33874. * @param y defines y coordinate
  33875. * @param z defines z coordinate
  33876. * @returns the face index if found (or null instead)
  33877. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33878. */
  33879. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33880. /**
  33881. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33882. * @returns the parameters
  33883. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33884. */
  33885. getFacetDataParameters(): any;
  33886. /**
  33887. * Disables the feature FacetData and frees the related memory
  33888. * @returns the current mesh
  33889. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33890. */
  33891. disableFacetData(): AbstractMesh;
  33892. /**
  33893. * Updates the AbstractMesh indices array
  33894. * @param indices defines the data source
  33895. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33896. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  33897. * @returns the current mesh
  33898. */
  33899. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33900. /**
  33901. * Creates new normals data for the mesh
  33902. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33903. * @returns the current mesh
  33904. */
  33905. createNormals(updatable: boolean): AbstractMesh;
  33906. /**
  33907. * Align the mesh with a normal
  33908. * @param normal defines the normal to use
  33909. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33910. * @returns the current mesh
  33911. */
  33912. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33913. /** @hidden */
  33914. _checkOcclusionQuery(): boolean;
  33915. /**
  33916. * Disables the mesh edge rendering mode
  33917. * @returns the currentAbstractMesh
  33918. */
  33919. disableEdgesRendering(): AbstractMesh;
  33920. /**
  33921. * Enables the edge rendering mode on the mesh.
  33922. * This mode makes the mesh edges visible
  33923. * @param epsilon defines the maximal distance between two angles to detect a face
  33924. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33925. * @returns the currentAbstractMesh
  33926. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33927. */
  33928. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33929. /**
  33930. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33931. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33932. */
  33933. getConnectedParticleSystems(): IParticleSystem[];
  33934. }
  33935. }
  33936. declare module "babylonjs/Actions/actionEvent" {
  33937. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33938. import { Nullable } from "babylonjs/types";
  33939. import { Sprite } from "babylonjs/Sprites/sprite";
  33940. import { Scene } from "babylonjs/scene";
  33941. import { Vector2 } from "babylonjs/Maths/math.vector";
  33942. /**
  33943. * Interface used to define ActionEvent
  33944. */
  33945. export interface IActionEvent {
  33946. /** The mesh or sprite that triggered the action */
  33947. source: any;
  33948. /** The X mouse cursor position at the time of the event */
  33949. pointerX: number;
  33950. /** The Y mouse cursor position at the time of the event */
  33951. pointerY: number;
  33952. /** The mesh that is currently pointed at (can be null) */
  33953. meshUnderPointer: Nullable<AbstractMesh>;
  33954. /** the original (browser) event that triggered the ActionEvent */
  33955. sourceEvent?: any;
  33956. /** additional data for the event */
  33957. additionalData?: any;
  33958. }
  33959. /**
  33960. * ActionEvent is the event being sent when an action is triggered.
  33961. */
  33962. export class ActionEvent implements IActionEvent {
  33963. /** The mesh or sprite that triggered the action */
  33964. source: any;
  33965. /** The X mouse cursor position at the time of the event */
  33966. pointerX: number;
  33967. /** The Y mouse cursor position at the time of the event */
  33968. pointerY: number;
  33969. /** The mesh that is currently pointed at (can be null) */
  33970. meshUnderPointer: Nullable<AbstractMesh>;
  33971. /** the original (browser) event that triggered the ActionEvent */
  33972. sourceEvent?: any;
  33973. /** additional data for the event */
  33974. additionalData?: any;
  33975. /**
  33976. * Creates a new ActionEvent
  33977. * @param source The mesh or sprite that triggered the action
  33978. * @param pointerX The X mouse cursor position at the time of the event
  33979. * @param pointerY The Y mouse cursor position at the time of the event
  33980. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33981. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33982. * @param additionalData additional data for the event
  33983. */
  33984. constructor(
  33985. /** The mesh or sprite that triggered the action */
  33986. source: any,
  33987. /** The X mouse cursor position at the time of the event */
  33988. pointerX: number,
  33989. /** The Y mouse cursor position at the time of the event */
  33990. pointerY: number,
  33991. /** The mesh that is currently pointed at (can be null) */
  33992. meshUnderPointer: Nullable<AbstractMesh>,
  33993. /** the original (browser) event that triggered the ActionEvent */
  33994. sourceEvent?: any,
  33995. /** additional data for the event */
  33996. additionalData?: any);
  33997. /**
  33998. * Helper function to auto-create an ActionEvent from a source mesh.
  33999. * @param source The source mesh that triggered the event
  34000. * @param evt The original (browser) event
  34001. * @param additionalData additional data for the event
  34002. * @returns the new ActionEvent
  34003. */
  34004. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34005. /**
  34006. * Helper function to auto-create an ActionEvent from a source sprite
  34007. * @param source The source sprite that triggered the event
  34008. * @param scene Scene associated with the sprite
  34009. * @param evt The original (browser) event
  34010. * @param additionalData additional data for the event
  34011. * @returns the new ActionEvent
  34012. */
  34013. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34014. /**
  34015. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34016. * @param scene the scene where the event occurred
  34017. * @param evt The original (browser) event
  34018. * @returns the new ActionEvent
  34019. */
  34020. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34021. /**
  34022. * Helper function to auto-create an ActionEvent from a primitive
  34023. * @param prim defines the target primitive
  34024. * @param pointerPos defines the pointer position
  34025. * @param evt The original (browser) event
  34026. * @param additionalData additional data for the event
  34027. * @returns the new ActionEvent
  34028. */
  34029. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34030. }
  34031. }
  34032. declare module "babylonjs/Actions/abstractActionManager" {
  34033. import { IDisposable } from "babylonjs/scene";
  34034. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34035. import { IAction } from "babylonjs/Actions/action";
  34036. import { Nullable } from "babylonjs/types";
  34037. /**
  34038. * Abstract class used to decouple action Manager from scene and meshes.
  34039. * Do not instantiate.
  34040. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34041. */
  34042. export abstract class AbstractActionManager implements IDisposable {
  34043. /** Gets the list of active triggers */
  34044. static Triggers: {
  34045. [key: string]: number;
  34046. };
  34047. /** Gets the cursor to use when hovering items */
  34048. hoverCursor: string;
  34049. /** Gets the list of actions */
  34050. actions: IAction[];
  34051. /**
  34052. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34053. */
  34054. isRecursive: boolean;
  34055. /**
  34056. * Releases all associated resources
  34057. */
  34058. abstract dispose(): void;
  34059. /**
  34060. * Does this action manager has pointer triggers
  34061. */
  34062. abstract get hasPointerTriggers(): boolean;
  34063. /**
  34064. * Does this action manager has pick triggers
  34065. */
  34066. abstract get hasPickTriggers(): boolean;
  34067. /**
  34068. * Process a specific trigger
  34069. * @param trigger defines the trigger to process
  34070. * @param evt defines the event details to be processed
  34071. */
  34072. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34073. /**
  34074. * Does this action manager handles actions of any of the given triggers
  34075. * @param triggers defines the triggers to be tested
  34076. * @return a boolean indicating whether one (or more) of the triggers is handled
  34077. */
  34078. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34079. /**
  34080. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34081. * speed.
  34082. * @param triggerA defines the trigger to be tested
  34083. * @param triggerB defines the trigger to be tested
  34084. * @return a boolean indicating whether one (or more) of the triggers is handled
  34085. */
  34086. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34087. /**
  34088. * Does this action manager handles actions of a given trigger
  34089. * @param trigger defines the trigger to be tested
  34090. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34091. * @return whether the trigger is handled
  34092. */
  34093. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34094. /**
  34095. * Serialize this manager to a JSON object
  34096. * @param name defines the property name to store this manager
  34097. * @returns a JSON representation of this manager
  34098. */
  34099. abstract serialize(name: string): any;
  34100. /**
  34101. * Registers an action to this action manager
  34102. * @param action defines the action to be registered
  34103. * @return the action amended (prepared) after registration
  34104. */
  34105. abstract registerAction(action: IAction): Nullable<IAction>;
  34106. /**
  34107. * Unregisters an action to this action manager
  34108. * @param action defines the action to be unregistered
  34109. * @return a boolean indicating whether the action has been unregistered
  34110. */
  34111. abstract unregisterAction(action: IAction): Boolean;
  34112. /**
  34113. * Does exist one action manager with at least one trigger
  34114. **/
  34115. static get HasTriggers(): boolean;
  34116. /**
  34117. * Does exist one action manager with at least one pick trigger
  34118. **/
  34119. static get HasPickTriggers(): boolean;
  34120. /**
  34121. * Does exist one action manager that handles actions of a given trigger
  34122. * @param trigger defines the trigger to be tested
  34123. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34124. **/
  34125. static HasSpecificTrigger(trigger: number): boolean;
  34126. }
  34127. }
  34128. declare module "babylonjs/node" {
  34129. import { Scene } from "babylonjs/scene";
  34130. import { Nullable } from "babylonjs/types";
  34131. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34132. import { Engine } from "babylonjs/Engines/engine";
  34133. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34134. import { Observable } from "babylonjs/Misc/observable";
  34135. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34136. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34137. import { Animatable } from "babylonjs/Animations/animatable";
  34138. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34139. import { Animation } from "babylonjs/Animations/animation";
  34140. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34141. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34142. /**
  34143. * Defines how a node can be built from a string name.
  34144. */
  34145. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34146. /**
  34147. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34148. */
  34149. export class Node implements IBehaviorAware<Node> {
  34150. /** @hidden */
  34151. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34152. private static _NodeConstructors;
  34153. /**
  34154. * Add a new node constructor
  34155. * @param type defines the type name of the node to construct
  34156. * @param constructorFunc defines the constructor function
  34157. */
  34158. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34159. /**
  34160. * Returns a node constructor based on type name
  34161. * @param type defines the type name
  34162. * @param name defines the new node name
  34163. * @param scene defines the hosting scene
  34164. * @param options defines optional options to transmit to constructors
  34165. * @returns the new constructor or null
  34166. */
  34167. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34168. /**
  34169. * Gets or sets the name of the node
  34170. */
  34171. name: string;
  34172. /**
  34173. * Gets or sets the id of the node
  34174. */
  34175. id: string;
  34176. /**
  34177. * Gets or sets the unique id of the node
  34178. */
  34179. uniqueId: number;
  34180. /**
  34181. * Gets or sets a string used to store user defined state for the node
  34182. */
  34183. state: string;
  34184. /**
  34185. * Gets or sets an object used to store user defined information for the node
  34186. */
  34187. metadata: any;
  34188. /**
  34189. * For internal use only. Please do not use.
  34190. */
  34191. reservedDataStore: any;
  34192. /**
  34193. * List of inspectable custom properties (used by the Inspector)
  34194. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34195. */
  34196. inspectableCustomProperties: IInspectable[];
  34197. private _doNotSerialize;
  34198. /**
  34199. * Gets or sets a boolean used to define if the node must be serialized
  34200. */
  34201. get doNotSerialize(): boolean;
  34202. set doNotSerialize(value: boolean);
  34203. /** @hidden */
  34204. _isDisposed: boolean;
  34205. /**
  34206. * Gets a list of Animations associated with the node
  34207. */
  34208. animations: import("babylonjs/Animations/animation").Animation[];
  34209. protected _ranges: {
  34210. [name: string]: Nullable<AnimationRange>;
  34211. };
  34212. /**
  34213. * Callback raised when the node is ready to be used
  34214. */
  34215. onReady: Nullable<(node: Node) => void>;
  34216. private _isEnabled;
  34217. private _isParentEnabled;
  34218. private _isReady;
  34219. /** @hidden */
  34220. _currentRenderId: number;
  34221. private _parentUpdateId;
  34222. /** @hidden */
  34223. _childUpdateId: number;
  34224. /** @hidden */
  34225. _waitingParentId: Nullable<string>;
  34226. /** @hidden */
  34227. _scene: Scene;
  34228. /** @hidden */
  34229. _cache: any;
  34230. private _parentNode;
  34231. private _children;
  34232. /** @hidden */
  34233. _worldMatrix: Matrix;
  34234. /** @hidden */
  34235. _worldMatrixDeterminant: number;
  34236. /** @hidden */
  34237. _worldMatrixDeterminantIsDirty: boolean;
  34238. /** @hidden */
  34239. private _sceneRootNodesIndex;
  34240. /**
  34241. * Gets a boolean indicating if the node has been disposed
  34242. * @returns true if the node was disposed
  34243. */
  34244. isDisposed(): boolean;
  34245. /**
  34246. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34247. * @see https://doc.babylonjs.com/how_to/parenting
  34248. */
  34249. set parent(parent: Nullable<Node>);
  34250. get parent(): Nullable<Node>;
  34251. /** @hidden */
  34252. _addToSceneRootNodes(): void;
  34253. /** @hidden */
  34254. _removeFromSceneRootNodes(): void;
  34255. private _animationPropertiesOverride;
  34256. /**
  34257. * Gets or sets the animation properties override
  34258. */
  34259. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34260. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34261. /**
  34262. * Gets a string identifying the name of the class
  34263. * @returns "Node" string
  34264. */
  34265. getClassName(): string;
  34266. /** @hidden */
  34267. readonly _isNode: boolean;
  34268. /**
  34269. * An event triggered when the mesh is disposed
  34270. */
  34271. onDisposeObservable: Observable<Node>;
  34272. private _onDisposeObserver;
  34273. /**
  34274. * Sets a callback that will be raised when the node will be disposed
  34275. */
  34276. set onDispose(callback: () => void);
  34277. /**
  34278. * Creates a new Node
  34279. * @param name the name and id to be given to this node
  34280. * @param scene the scene this node will be added to
  34281. */
  34282. constructor(name: string, scene?: Nullable<Scene>);
  34283. /**
  34284. * Gets the scene of the node
  34285. * @returns a scene
  34286. */
  34287. getScene(): Scene;
  34288. /**
  34289. * Gets the engine of the node
  34290. * @returns a Engine
  34291. */
  34292. getEngine(): Engine;
  34293. private _behaviors;
  34294. /**
  34295. * Attach a behavior to the node
  34296. * @see https://doc.babylonjs.com/features/behaviour
  34297. * @param behavior defines the behavior to attach
  34298. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34299. * @returns the current Node
  34300. */
  34301. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34302. /**
  34303. * Remove an attached behavior
  34304. * @see https://doc.babylonjs.com/features/behaviour
  34305. * @param behavior defines the behavior to attach
  34306. * @returns the current Node
  34307. */
  34308. removeBehavior(behavior: Behavior<Node>): Node;
  34309. /**
  34310. * Gets the list of attached behaviors
  34311. * @see https://doc.babylonjs.com/features/behaviour
  34312. */
  34313. get behaviors(): Behavior<Node>[];
  34314. /**
  34315. * Gets an attached behavior by name
  34316. * @param name defines the name of the behavior to look for
  34317. * @see https://doc.babylonjs.com/features/behaviour
  34318. * @returns null if behavior was not found else the requested behavior
  34319. */
  34320. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34321. /**
  34322. * Returns the latest update of the World matrix
  34323. * @returns a Matrix
  34324. */
  34325. getWorldMatrix(): Matrix;
  34326. /** @hidden */
  34327. _getWorldMatrixDeterminant(): number;
  34328. /**
  34329. * Returns directly the latest state of the mesh World matrix.
  34330. * A Matrix is returned.
  34331. */
  34332. get worldMatrixFromCache(): Matrix;
  34333. /** @hidden */
  34334. _initCache(): void;
  34335. /** @hidden */
  34336. updateCache(force?: boolean): void;
  34337. /** @hidden */
  34338. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34339. /** @hidden */
  34340. _updateCache(ignoreParentClass?: boolean): void;
  34341. /** @hidden */
  34342. _isSynchronized(): boolean;
  34343. /** @hidden */
  34344. _markSyncedWithParent(): void;
  34345. /** @hidden */
  34346. isSynchronizedWithParent(): boolean;
  34347. /** @hidden */
  34348. isSynchronized(): boolean;
  34349. /**
  34350. * Is this node ready to be used/rendered
  34351. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34352. * @return true if the node is ready
  34353. */
  34354. isReady(completeCheck?: boolean): boolean;
  34355. /**
  34356. * Is this node enabled?
  34357. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  34358. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  34359. * @return whether this node (and its parent) is enabled
  34360. */
  34361. isEnabled(checkAncestors?: boolean): boolean;
  34362. /** @hidden */
  34363. protected _syncParentEnabledState(): void;
  34364. /**
  34365. * Set the enabled state of this node
  34366. * @param value defines the new enabled state
  34367. */
  34368. setEnabled(value: boolean): void;
  34369. /**
  34370. * Is this node a descendant of the given node?
  34371. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34372. * @param ancestor defines the parent node to inspect
  34373. * @returns a boolean indicating if this node is a descendant of the given node
  34374. */
  34375. isDescendantOf(ancestor: Node): boolean;
  34376. /** @hidden */
  34377. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34378. /**
  34379. * Will return all nodes that have this node as ascendant
  34380. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  34381. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34382. * @return all children nodes of all types
  34383. */
  34384. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34385. /**
  34386. * Get all child-meshes of this node
  34387. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
  34388. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34389. * @returns an array of AbstractMesh
  34390. */
  34391. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34392. /**
  34393. * Get all direct children of this node
  34394. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  34395. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
  34396. * @returns an array of Node
  34397. */
  34398. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34399. /** @hidden */
  34400. _setReady(state: boolean): void;
  34401. /**
  34402. * Get an animation by name
  34403. * @param name defines the name of the animation to look for
  34404. * @returns null if not found else the requested animation
  34405. */
  34406. getAnimationByName(name: string): Nullable<Animation>;
  34407. /**
  34408. * Creates an animation range for this node
  34409. * @param name defines the name of the range
  34410. * @param from defines the starting key
  34411. * @param to defines the end key
  34412. */
  34413. createAnimationRange(name: string, from: number, to: number): void;
  34414. /**
  34415. * Delete a specific animation range
  34416. * @param name defines the name of the range to delete
  34417. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34418. */
  34419. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34420. /**
  34421. * Get an animation range by name
  34422. * @param name defines the name of the animation range to look for
  34423. * @returns null if not found else the requested animation range
  34424. */
  34425. getAnimationRange(name: string): Nullable<AnimationRange>;
  34426. /**
  34427. * Gets the list of all animation ranges defined on this node
  34428. * @returns an array
  34429. */
  34430. getAnimationRanges(): Nullable<AnimationRange>[];
  34431. /**
  34432. * Will start the animation sequence
  34433. * @param name defines the range frames for animation sequence
  34434. * @param loop defines if the animation should loop (false by default)
  34435. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34436. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34437. * @returns the object created for this animation. If range does not exist, it will return null
  34438. */
  34439. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34440. /**
  34441. * Serialize animation ranges into a JSON compatible object
  34442. * @returns serialization object
  34443. */
  34444. serializeAnimationRanges(): any;
  34445. /**
  34446. * Computes the world matrix of the node
  34447. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34448. * @returns the world matrix
  34449. */
  34450. computeWorldMatrix(force?: boolean): Matrix;
  34451. /**
  34452. * Releases resources associated with this node.
  34453. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34454. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34455. */
  34456. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34457. /**
  34458. * Parse animation range data from a serialization object and store them into a given node
  34459. * @param node defines where to store the animation ranges
  34460. * @param parsedNode defines the serialization object to read data from
  34461. * @param scene defines the hosting scene
  34462. */
  34463. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34464. /**
  34465. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34466. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34467. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  34468. * @returns the new bounding vectors
  34469. */
  34470. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34471. min: Vector3;
  34472. max: Vector3;
  34473. };
  34474. }
  34475. }
  34476. declare module "babylonjs/Animations/animation" {
  34477. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34478. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34479. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34480. import { Nullable } from "babylonjs/types";
  34481. import { Scene } from "babylonjs/scene";
  34482. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34483. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34484. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34485. import { Node } from "babylonjs/node";
  34486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34487. import { Size } from "babylonjs/Maths/math.size";
  34488. import { Animatable } from "babylonjs/Animations/animatable";
  34489. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34490. /**
  34491. * @hidden
  34492. */
  34493. export class _IAnimationState {
  34494. key: number;
  34495. repeatCount: number;
  34496. workValue?: any;
  34497. loopMode?: number;
  34498. offsetValue?: any;
  34499. highLimitValue?: any;
  34500. }
  34501. /**
  34502. * Class used to store any kind of animation
  34503. */
  34504. export class Animation {
  34505. /**Name of the animation */
  34506. name: string;
  34507. /**Property to animate */
  34508. targetProperty: string;
  34509. /**The frames per second of the animation */
  34510. framePerSecond: number;
  34511. /**The data type of the animation */
  34512. dataType: number;
  34513. /**The loop mode of the animation */
  34514. loopMode?: number | undefined;
  34515. /**Specifies if blending should be enabled */
  34516. enableBlending?: boolean | undefined;
  34517. /**
  34518. * Use matrix interpolation instead of using direct key value when animating matrices
  34519. */
  34520. static AllowMatricesInterpolation: boolean;
  34521. /**
  34522. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34523. */
  34524. static AllowMatrixDecomposeForInterpolation: boolean;
  34525. /** Define the Url to load snippets */
  34526. static SnippetUrl: string;
  34527. /** Snippet ID if the animation was created from the snippet server */
  34528. snippetId: string;
  34529. /**
  34530. * Stores the key frames of the animation
  34531. */
  34532. private _keys;
  34533. /**
  34534. * Stores the easing function of the animation
  34535. */
  34536. private _easingFunction;
  34537. /**
  34538. * @hidden Internal use only
  34539. */
  34540. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34541. /**
  34542. * The set of event that will be linked to this animation
  34543. */
  34544. private _events;
  34545. /**
  34546. * Stores an array of target property paths
  34547. */
  34548. targetPropertyPath: string[];
  34549. /**
  34550. * Stores the blending speed of the animation
  34551. */
  34552. blendingSpeed: number;
  34553. /**
  34554. * Stores the animation ranges for the animation
  34555. */
  34556. private _ranges;
  34557. /**
  34558. * @hidden Internal use
  34559. */
  34560. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34561. /**
  34562. * Sets up an animation
  34563. * @param property The property to animate
  34564. * @param animationType The animation type to apply
  34565. * @param framePerSecond The frames per second of the animation
  34566. * @param easingFunction The easing function used in the animation
  34567. * @returns The created animation
  34568. */
  34569. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34570. /**
  34571. * Create and start an animation on a node
  34572. * @param name defines the name of the global animation that will be run on all nodes
  34573. * @param node defines the root node where the animation will take place
  34574. * @param targetProperty defines property to animate
  34575. * @param framePerSecond defines the number of frame per second yo use
  34576. * @param totalFrame defines the number of frames in total
  34577. * @param from defines the initial value
  34578. * @param to defines the final value
  34579. * @param loopMode defines which loop mode you want to use (off by default)
  34580. * @param easingFunction defines the easing function to use (linear by default)
  34581. * @param onAnimationEnd defines the callback to call when animation end
  34582. * @returns the animatable created for this animation
  34583. */
  34584. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34585. /**
  34586. * Create and start an animation on a node and its descendants
  34587. * @param name defines the name of the global animation that will be run on all nodes
  34588. * @param node defines the root node where the animation will take place
  34589. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  34590. * @param targetProperty defines property to animate
  34591. * @param framePerSecond defines the number of frame per second to use
  34592. * @param totalFrame defines the number of frames in total
  34593. * @param from defines the initial value
  34594. * @param to defines the final value
  34595. * @param loopMode defines which loop mode you want to use (off by default)
  34596. * @param easingFunction defines the easing function to use (linear by default)
  34597. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34598. * @returns the list of animatables created for all nodes
  34599. * @example https://www.babylonjs-playground.com/#MH0VLI
  34600. */
  34601. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  34602. /**
  34603. * Creates a new animation, merges it with the existing animations and starts it
  34604. * @param name Name of the animation
  34605. * @param node Node which contains the scene that begins the animations
  34606. * @param targetProperty Specifies which property to animate
  34607. * @param framePerSecond The frames per second of the animation
  34608. * @param totalFrame The total number of frames
  34609. * @param from The frame at the beginning of the animation
  34610. * @param to The frame at the end of the animation
  34611. * @param loopMode Specifies the loop mode of the animation
  34612. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34613. * @param onAnimationEnd Callback to run once the animation is complete
  34614. * @returns Nullable animation
  34615. */
  34616. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34617. /**
  34618. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34619. * @param sourceAnimation defines the Animation containing keyframes to convert
  34620. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34621. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34622. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34623. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34624. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34625. */
  34626. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34627. /**
  34628. * Transition property of an host to the target Value
  34629. * @param property The property to transition
  34630. * @param targetValue The target Value of the property
  34631. * @param host The object where the property to animate belongs
  34632. * @param scene Scene used to run the animation
  34633. * @param frameRate Framerate (in frame/s) to use
  34634. * @param transition The transition type we want to use
  34635. * @param duration The duration of the animation, in milliseconds
  34636. * @param onAnimationEnd Callback trigger at the end of the animation
  34637. * @returns Nullable animation
  34638. */
  34639. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34640. /**
  34641. * Return the array of runtime animations currently using this animation
  34642. */
  34643. get runtimeAnimations(): RuntimeAnimation[];
  34644. /**
  34645. * Specifies if any of the runtime animations are currently running
  34646. */
  34647. get hasRunningRuntimeAnimations(): boolean;
  34648. /**
  34649. * Initializes the animation
  34650. * @param name Name of the animation
  34651. * @param targetProperty Property to animate
  34652. * @param framePerSecond The frames per second of the animation
  34653. * @param dataType The data type of the animation
  34654. * @param loopMode The loop mode of the animation
  34655. * @param enableBlending Specifies if blending should be enabled
  34656. */
  34657. constructor(
  34658. /**Name of the animation */
  34659. name: string,
  34660. /**Property to animate */
  34661. targetProperty: string,
  34662. /**The frames per second of the animation */
  34663. framePerSecond: number,
  34664. /**The data type of the animation */
  34665. dataType: number,
  34666. /**The loop mode of the animation */
  34667. loopMode?: number | undefined,
  34668. /**Specifies if blending should be enabled */
  34669. enableBlending?: boolean | undefined);
  34670. /**
  34671. * Converts the animation to a string
  34672. * @param fullDetails support for multiple levels of logging within scene loading
  34673. * @returns String form of the animation
  34674. */
  34675. toString(fullDetails?: boolean): string;
  34676. /**
  34677. * Add an event to this animation
  34678. * @param event Event to add
  34679. */
  34680. addEvent(event: AnimationEvent): void;
  34681. /**
  34682. * Remove all events found at the given frame
  34683. * @param frame The frame to remove events from
  34684. */
  34685. removeEvents(frame: number): void;
  34686. /**
  34687. * Retrieves all the events from the animation
  34688. * @returns Events from the animation
  34689. */
  34690. getEvents(): AnimationEvent[];
  34691. /**
  34692. * Creates an animation range
  34693. * @param name Name of the animation range
  34694. * @param from Starting frame of the animation range
  34695. * @param to Ending frame of the animation
  34696. */
  34697. createRange(name: string, from: number, to: number): void;
  34698. /**
  34699. * Deletes an animation range by name
  34700. * @param name Name of the animation range to delete
  34701. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34702. */
  34703. deleteRange(name: string, deleteFrames?: boolean): void;
  34704. /**
  34705. * Gets the animation range by name, or null if not defined
  34706. * @param name Name of the animation range
  34707. * @returns Nullable animation range
  34708. */
  34709. getRange(name: string): Nullable<AnimationRange>;
  34710. /**
  34711. * Gets the key frames from the animation
  34712. * @returns The key frames of the animation
  34713. */
  34714. getKeys(): Array<IAnimationKey>;
  34715. /**
  34716. * Gets the highest frame rate of the animation
  34717. * @returns Highest frame rate of the animation
  34718. */
  34719. getHighestFrame(): number;
  34720. /**
  34721. * Gets the easing function of the animation
  34722. * @returns Easing function of the animation
  34723. */
  34724. getEasingFunction(): IEasingFunction;
  34725. /**
  34726. * Sets the easing function of the animation
  34727. * @param easingFunction A custom mathematical formula for animation
  34728. */
  34729. setEasingFunction(easingFunction: EasingFunction): void;
  34730. /**
  34731. * Interpolates a scalar linearly
  34732. * @param startValue Start value of the animation curve
  34733. * @param endValue End value of the animation curve
  34734. * @param gradient Scalar amount to interpolate
  34735. * @returns Interpolated scalar value
  34736. */
  34737. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34738. /**
  34739. * Interpolates a scalar cubically
  34740. * @param startValue Start value of the animation curve
  34741. * @param outTangent End tangent of the animation
  34742. * @param endValue End value of the animation curve
  34743. * @param inTangent Start tangent of the animation curve
  34744. * @param gradient Scalar amount to interpolate
  34745. * @returns Interpolated scalar value
  34746. */
  34747. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34748. /**
  34749. * Interpolates a quaternion using a spherical linear interpolation
  34750. * @param startValue Start value of the animation curve
  34751. * @param endValue End value of the animation curve
  34752. * @param gradient Scalar amount to interpolate
  34753. * @returns Interpolated quaternion value
  34754. */
  34755. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34756. /**
  34757. * Interpolates a quaternion cubically
  34758. * @param startValue Start value of the animation curve
  34759. * @param outTangent End tangent of the animation curve
  34760. * @param endValue End value of the animation curve
  34761. * @param inTangent Start tangent of the animation curve
  34762. * @param gradient Scalar amount to interpolate
  34763. * @returns Interpolated quaternion value
  34764. */
  34765. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34766. /**
  34767. * Interpolates a Vector3 linearl
  34768. * @param startValue Start value of the animation curve
  34769. * @param endValue End value of the animation curve
  34770. * @param gradient Scalar amount to interpolate
  34771. * @returns Interpolated scalar value
  34772. */
  34773. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34774. /**
  34775. * Interpolates a Vector3 cubically
  34776. * @param startValue Start value of the animation curve
  34777. * @param outTangent End tangent of the animation
  34778. * @param endValue End value of the animation curve
  34779. * @param inTangent Start tangent of the animation curve
  34780. * @param gradient Scalar amount to interpolate
  34781. * @returns InterpolatedVector3 value
  34782. */
  34783. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34784. /**
  34785. * Interpolates a Vector2 linearly
  34786. * @param startValue Start value of the animation curve
  34787. * @param endValue End value of the animation curve
  34788. * @param gradient Scalar amount to interpolate
  34789. * @returns Interpolated Vector2 value
  34790. */
  34791. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34792. /**
  34793. * Interpolates a Vector2 cubically
  34794. * @param startValue Start value of the animation curve
  34795. * @param outTangent End tangent of the animation
  34796. * @param endValue End value of the animation curve
  34797. * @param inTangent Start tangent of the animation curve
  34798. * @param gradient Scalar amount to interpolate
  34799. * @returns Interpolated Vector2 value
  34800. */
  34801. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34802. /**
  34803. * Interpolates a size linearly
  34804. * @param startValue Start value of the animation curve
  34805. * @param endValue End value of the animation curve
  34806. * @param gradient Scalar amount to interpolate
  34807. * @returns Interpolated Size value
  34808. */
  34809. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34810. /**
  34811. * Interpolates a Color3 linearly
  34812. * @param startValue Start value of the animation curve
  34813. * @param endValue End value of the animation curve
  34814. * @param gradient Scalar amount to interpolate
  34815. * @returns Interpolated Color3 value
  34816. */
  34817. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34818. /**
  34819. * Interpolates a Color4 linearly
  34820. * @param startValue Start value of the animation curve
  34821. * @param endValue End value of the animation curve
  34822. * @param gradient Scalar amount to interpolate
  34823. * @returns Interpolated Color3 value
  34824. */
  34825. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34826. /**
  34827. * @hidden Internal use only
  34828. */
  34829. _getKeyValue(value: any): any;
  34830. /**
  34831. * @hidden Internal use only
  34832. */
  34833. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34834. /**
  34835. * Defines the function to use to interpolate matrices
  34836. * @param startValue defines the start matrix
  34837. * @param endValue defines the end matrix
  34838. * @param gradient defines the gradient between both matrices
  34839. * @param result defines an optional target matrix where to store the interpolation
  34840. * @returns the interpolated matrix
  34841. */
  34842. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34843. /**
  34844. * Makes a copy of the animation
  34845. * @returns Cloned animation
  34846. */
  34847. clone(): Animation;
  34848. /**
  34849. * Sets the key frames of the animation
  34850. * @param values The animation key frames to set
  34851. */
  34852. setKeys(values: Array<IAnimationKey>): void;
  34853. /**
  34854. * Serializes the animation to an object
  34855. * @returns Serialized object
  34856. */
  34857. serialize(): any;
  34858. /**
  34859. * Float animation type
  34860. */
  34861. static readonly ANIMATIONTYPE_FLOAT: number;
  34862. /**
  34863. * Vector3 animation type
  34864. */
  34865. static readonly ANIMATIONTYPE_VECTOR3: number;
  34866. /**
  34867. * Quaternion animation type
  34868. */
  34869. static readonly ANIMATIONTYPE_QUATERNION: number;
  34870. /**
  34871. * Matrix animation type
  34872. */
  34873. static readonly ANIMATIONTYPE_MATRIX: number;
  34874. /**
  34875. * Color3 animation type
  34876. */
  34877. static readonly ANIMATIONTYPE_COLOR3: number;
  34878. /**
  34879. * Color3 animation type
  34880. */
  34881. static readonly ANIMATIONTYPE_COLOR4: number;
  34882. /**
  34883. * Vector2 animation type
  34884. */
  34885. static readonly ANIMATIONTYPE_VECTOR2: number;
  34886. /**
  34887. * Size animation type
  34888. */
  34889. static readonly ANIMATIONTYPE_SIZE: number;
  34890. /**
  34891. * Relative Loop Mode
  34892. */
  34893. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34894. /**
  34895. * Cycle Loop Mode
  34896. */
  34897. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34898. /**
  34899. * Constant Loop Mode
  34900. */
  34901. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34902. /** @hidden */
  34903. static _UniversalLerp(left: any, right: any, amount: number): any;
  34904. /**
  34905. * Parses an animation object and creates an animation
  34906. * @param parsedAnimation Parsed animation object
  34907. * @returns Animation object
  34908. */
  34909. static Parse(parsedAnimation: any): Animation;
  34910. /**
  34911. * Appends the serialized animations from the source animations
  34912. * @param source Source containing the animations
  34913. * @param destination Target to store the animations
  34914. */
  34915. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34916. /**
  34917. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34918. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34919. * @param url defines the url to load from
  34920. * @returns a promise that will resolve to the new animation or an array of animations
  34921. */
  34922. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34923. /**
  34924. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34925. * @param snippetId defines the snippet to load
  34926. * @returns a promise that will resolve to the new animation or a new array of animations
  34927. */
  34928. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34929. }
  34930. }
  34931. declare module "babylonjs/Animations/animatable.interface" {
  34932. import { Nullable } from "babylonjs/types";
  34933. import { Animation } from "babylonjs/Animations/animation";
  34934. /**
  34935. * Interface containing an array of animations
  34936. */
  34937. export interface IAnimatable {
  34938. /**
  34939. * Array of animations
  34940. */
  34941. animations: Nullable<Array<Animation>>;
  34942. }
  34943. }
  34944. declare module "babylonjs/Misc/decorators" {
  34945. import { Nullable } from "babylonjs/types";
  34946. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34947. import { Scene } from "babylonjs/scene";
  34948. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34949. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34950. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34951. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34952. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34953. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34956. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34957. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34958. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34960. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34961. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34962. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34963. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34964. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34965. /**
  34966. * Decorator used to define property that can be serialized as reference to a camera
  34967. * @param sourceName defines the name of the property to decorate
  34968. */
  34969. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34970. /**
  34971. * Class used to help serialization objects
  34972. */
  34973. export class SerializationHelper {
  34974. /** @hidden */
  34975. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34976. /** @hidden */
  34977. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34978. /** @hidden */
  34979. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34980. /** @hidden */
  34981. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34982. /**
  34983. * Appends the serialized animations from the source animations
  34984. * @param source Source containing the animations
  34985. * @param destination Target to store the animations
  34986. */
  34987. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34988. /**
  34989. * Static function used to serialized a specific entity
  34990. * @param entity defines the entity to serialize
  34991. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34992. * @returns a JSON compatible object representing the serialization of the entity
  34993. */
  34994. static Serialize<T>(entity: T, serializationObject?: any): any;
  34995. /**
  34996. * Creates a new entity from a serialization data object
  34997. * @param creationFunction defines a function used to instanciated the new entity
  34998. * @param source defines the source serialization data
  34999. * @param scene defines the hosting scene
  35000. * @param rootUrl defines the root url for resources
  35001. * @returns a new entity
  35002. */
  35003. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35004. /**
  35005. * Clones an object
  35006. * @param creationFunction defines the function used to instanciate the new object
  35007. * @param source defines the source object
  35008. * @returns the cloned object
  35009. */
  35010. static Clone<T>(creationFunction: () => T, source: T): T;
  35011. /**
  35012. * Instanciates a new object based on a source one (some data will be shared between both object)
  35013. * @param creationFunction defines the function used to instanciate the new object
  35014. * @param source defines the source object
  35015. * @returns the new object
  35016. */
  35017. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35018. }
  35019. }
  35020. declare module "babylonjs/Materials/Textures/baseTexture" {
  35021. import { Observable } from "babylonjs/Misc/observable";
  35022. import { Nullable } from "babylonjs/types";
  35023. import { Scene } from "babylonjs/scene";
  35024. import { Matrix } from "babylonjs/Maths/math.vector";
  35025. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35026. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35027. import { ISize } from "babylonjs/Maths/math.size";
  35028. import "babylonjs/Misc/fileTools";
  35029. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35030. /**
  35031. * Base class of all the textures in babylon.
  35032. * It groups all the common properties the materials, post process, lights... might need
  35033. * in order to make a correct use of the texture.
  35034. */
  35035. export class BaseTexture implements IAnimatable {
  35036. /**
  35037. * Default anisotropic filtering level for the application.
  35038. * It is set to 4 as a good tradeoff between perf and quality.
  35039. */
  35040. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35041. /**
  35042. * Gets or sets the unique id of the texture
  35043. */
  35044. uniqueId: number;
  35045. /**
  35046. * Define the name of the texture.
  35047. */
  35048. name: string;
  35049. /**
  35050. * Gets or sets an object used to store user defined information.
  35051. */
  35052. metadata: any;
  35053. /**
  35054. * For internal use only. Please do not use.
  35055. */
  35056. reservedDataStore: any;
  35057. private _hasAlpha;
  35058. /**
  35059. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35060. */
  35061. set hasAlpha(value: boolean);
  35062. get hasAlpha(): boolean;
  35063. /**
  35064. * Defines if the alpha value should be determined via the rgb values.
  35065. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35066. */
  35067. getAlphaFromRGB: boolean;
  35068. /**
  35069. * Intensity or strength of the texture.
  35070. * It is commonly used by materials to fine tune the intensity of the texture
  35071. */
  35072. level: number;
  35073. /**
  35074. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35075. * This is part of the texture as textures usually maps to one uv set.
  35076. */
  35077. coordinatesIndex: number;
  35078. protected _coordinatesMode: number;
  35079. /**
  35080. * How a texture is mapped.
  35081. *
  35082. * | Value | Type | Description |
  35083. * | ----- | ----------------------------------- | ----------- |
  35084. * | 0 | EXPLICIT_MODE | |
  35085. * | 1 | SPHERICAL_MODE | |
  35086. * | 2 | PLANAR_MODE | |
  35087. * | 3 | CUBIC_MODE | |
  35088. * | 4 | PROJECTION_MODE | |
  35089. * | 5 | SKYBOX_MODE | |
  35090. * | 6 | INVCUBIC_MODE | |
  35091. * | 7 | EQUIRECTANGULAR_MODE | |
  35092. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35093. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35094. */
  35095. set coordinatesMode(value: number);
  35096. get coordinatesMode(): number;
  35097. private _wrapU;
  35098. /**
  35099. * | Value | Type | Description |
  35100. * | ----- | ------------------ | ----------- |
  35101. * | 0 | CLAMP_ADDRESSMODE | |
  35102. * | 1 | WRAP_ADDRESSMODE | |
  35103. * | 2 | MIRROR_ADDRESSMODE | |
  35104. */
  35105. get wrapU(): number;
  35106. set wrapU(value: number);
  35107. private _wrapV;
  35108. /**
  35109. * | Value | Type | Description |
  35110. * | ----- | ------------------ | ----------- |
  35111. * | 0 | CLAMP_ADDRESSMODE | |
  35112. * | 1 | WRAP_ADDRESSMODE | |
  35113. * | 2 | MIRROR_ADDRESSMODE | |
  35114. */
  35115. get wrapV(): number;
  35116. set wrapV(value: number);
  35117. /**
  35118. * | Value | Type | Description |
  35119. * | ----- | ------------------ | ----------- |
  35120. * | 0 | CLAMP_ADDRESSMODE | |
  35121. * | 1 | WRAP_ADDRESSMODE | |
  35122. * | 2 | MIRROR_ADDRESSMODE | |
  35123. */
  35124. wrapR: number;
  35125. /**
  35126. * With compliant hardware and browser (supporting anisotropic filtering)
  35127. * this defines the level of anisotropic filtering in the texture.
  35128. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35129. */
  35130. anisotropicFilteringLevel: number;
  35131. /**
  35132. * Define if the texture is a cube texture or if false a 2d texture.
  35133. */
  35134. get isCube(): boolean;
  35135. set isCube(value: boolean);
  35136. /**
  35137. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35138. */
  35139. get is3D(): boolean;
  35140. set is3D(value: boolean);
  35141. /**
  35142. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35143. */
  35144. get is2DArray(): boolean;
  35145. set is2DArray(value: boolean);
  35146. /**
  35147. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35148. * HDR texture are usually stored in linear space.
  35149. * This only impacts the PBR and Background materials
  35150. */
  35151. gammaSpace: boolean;
  35152. /**
  35153. * Gets or sets whether or not the texture contains RGBD data.
  35154. */
  35155. get isRGBD(): boolean;
  35156. set isRGBD(value: boolean);
  35157. /**
  35158. * Is Z inverted in the texture (useful in a cube texture).
  35159. */
  35160. invertZ: boolean;
  35161. /**
  35162. * Are mip maps generated for this texture or not.
  35163. */
  35164. get noMipmap(): boolean;
  35165. /**
  35166. * @hidden
  35167. */
  35168. lodLevelInAlpha: boolean;
  35169. /**
  35170. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35171. */
  35172. get lodGenerationOffset(): number;
  35173. set lodGenerationOffset(value: number);
  35174. /**
  35175. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35176. */
  35177. get lodGenerationScale(): number;
  35178. set lodGenerationScale(value: number);
  35179. /**
  35180. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35181. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35182. * average roughness values.
  35183. */
  35184. get linearSpecularLOD(): boolean;
  35185. set linearSpecularLOD(value: boolean);
  35186. /**
  35187. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35188. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35189. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35190. */
  35191. get irradianceTexture(): Nullable<BaseTexture>;
  35192. set irradianceTexture(value: Nullable<BaseTexture>);
  35193. /**
  35194. * Define if the texture is a render target.
  35195. */
  35196. isRenderTarget: boolean;
  35197. /**
  35198. * Define the unique id of the texture in the scene.
  35199. */
  35200. get uid(): string;
  35201. /** @hidden */
  35202. _prefiltered: boolean;
  35203. /**
  35204. * Return a string representation of the texture.
  35205. * @returns the texture as a string
  35206. */
  35207. toString(): string;
  35208. /**
  35209. * Get the class name of the texture.
  35210. * @returns "BaseTexture"
  35211. */
  35212. getClassName(): string;
  35213. /**
  35214. * Define the list of animation attached to the texture.
  35215. */
  35216. animations: import("babylonjs/Animations/animation").Animation[];
  35217. /**
  35218. * An event triggered when the texture is disposed.
  35219. */
  35220. onDisposeObservable: Observable<BaseTexture>;
  35221. private _onDisposeObserver;
  35222. /**
  35223. * Callback triggered when the texture has been disposed.
  35224. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35225. */
  35226. set onDispose(callback: () => void);
  35227. /**
  35228. * Define the current state of the loading sequence when in delayed load mode.
  35229. */
  35230. delayLoadState: number;
  35231. protected _scene: Nullable<Scene>;
  35232. protected _engine: Nullable<ThinEngine>;
  35233. /** @hidden */
  35234. _texture: Nullable<InternalTexture>;
  35235. private _uid;
  35236. /**
  35237. * Define if the texture is preventinga material to render or not.
  35238. * If not and the texture is not ready, the engine will use a default black texture instead.
  35239. */
  35240. get isBlocking(): boolean;
  35241. /**
  35242. * Instantiates a new BaseTexture.
  35243. * Base class of all the textures in babylon.
  35244. * It groups all the common properties the materials, post process, lights... might need
  35245. * in order to make a correct use of the texture.
  35246. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35247. */
  35248. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35249. /**
  35250. * Get the scene the texture belongs to.
  35251. * @returns the scene or null if undefined
  35252. */
  35253. getScene(): Nullable<Scene>;
  35254. /** @hidden */
  35255. protected _getEngine(): Nullable<ThinEngine>;
  35256. /**
  35257. * Get the texture transform matrix used to offset tile the texture for istance.
  35258. * @returns the transformation matrix
  35259. */
  35260. getTextureMatrix(): Matrix;
  35261. /**
  35262. * Get the texture reflection matrix used to rotate/transform the reflection.
  35263. * @returns the reflection matrix
  35264. */
  35265. getReflectionTextureMatrix(): Matrix;
  35266. /**
  35267. * Get the underlying lower level texture from Babylon.
  35268. * @returns the insternal texture
  35269. */
  35270. getInternalTexture(): Nullable<InternalTexture>;
  35271. /**
  35272. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35273. * @returns true if ready or not blocking
  35274. */
  35275. isReadyOrNotBlocking(): boolean;
  35276. /**
  35277. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35278. * @returns true if fully ready
  35279. */
  35280. isReady(): boolean;
  35281. private _cachedSize;
  35282. /**
  35283. * Get the size of the texture.
  35284. * @returns the texture size.
  35285. */
  35286. getSize(): ISize;
  35287. /**
  35288. * Get the base size of the texture.
  35289. * It can be different from the size if the texture has been resized for POT for instance
  35290. * @returns the base size
  35291. */
  35292. getBaseSize(): ISize;
  35293. /**
  35294. * Update the sampling mode of the texture.
  35295. * Default is Trilinear mode.
  35296. *
  35297. * | Value | Type | Description |
  35298. * | ----- | ------------------ | ----------- |
  35299. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35300. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35301. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35302. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35303. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35304. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35305. * | 7 | NEAREST_LINEAR | |
  35306. * | 8 | NEAREST_NEAREST | |
  35307. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35308. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35309. * | 11 | LINEAR_LINEAR | |
  35310. * | 12 | LINEAR_NEAREST | |
  35311. *
  35312. * > _mag_: magnification filter (close to the viewer)
  35313. * > _min_: minification filter (far from the viewer)
  35314. * > _mip_: filter used between mip map levels
  35315. *@param samplingMode Define the new sampling mode of the texture
  35316. */
  35317. updateSamplingMode(samplingMode: number): void;
  35318. /**
  35319. * Scales the texture if is `canRescale()`
  35320. * @param ratio the resize factor we want to use to rescale
  35321. */
  35322. scale(ratio: number): void;
  35323. /**
  35324. * Get if the texture can rescale.
  35325. */
  35326. get canRescale(): boolean;
  35327. /** @hidden */
  35328. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35329. /** @hidden */
  35330. _rebuild(): void;
  35331. /**
  35332. * Triggers the load sequence in delayed load mode.
  35333. */
  35334. delayLoad(): void;
  35335. /**
  35336. * Clones the texture.
  35337. * @returns the cloned texture
  35338. */
  35339. clone(): Nullable<BaseTexture>;
  35340. /**
  35341. * Get the texture underlying type (INT, FLOAT...)
  35342. */
  35343. get textureType(): number;
  35344. /**
  35345. * Get the texture underlying format (RGB, RGBA...)
  35346. */
  35347. get textureFormat(): number;
  35348. /**
  35349. * Indicates that textures need to be re-calculated for all materials
  35350. */
  35351. protected _markAllSubMeshesAsTexturesDirty(): void;
  35352. /**
  35353. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35354. * This will returns an RGBA array buffer containing either in values (0-255) or
  35355. * float values (0-1) depending of the underlying buffer type.
  35356. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35357. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35358. * @param buffer defines a user defined buffer to fill with data (can be null)
  35359. * @returns The Array buffer containing the pixels data.
  35360. */
  35361. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35362. /**
  35363. * Release and destroy the underlying lower level texture aka internalTexture.
  35364. */
  35365. releaseInternalTexture(): void;
  35366. /** @hidden */
  35367. get _lodTextureHigh(): Nullable<BaseTexture>;
  35368. /** @hidden */
  35369. get _lodTextureMid(): Nullable<BaseTexture>;
  35370. /** @hidden */
  35371. get _lodTextureLow(): Nullable<BaseTexture>;
  35372. /**
  35373. * Dispose the texture and release its associated resources.
  35374. */
  35375. dispose(): void;
  35376. /**
  35377. * Serialize the texture into a JSON representation that can be parsed later on.
  35378. * @returns the JSON representation of the texture
  35379. */
  35380. serialize(): any;
  35381. /**
  35382. * Helper function to be called back once a list of texture contains only ready textures.
  35383. * @param textures Define the list of textures to wait for
  35384. * @param callback Define the callback triggered once the entire list will be ready
  35385. */
  35386. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35387. private static _isScene;
  35388. }
  35389. }
  35390. declare module "babylonjs/Materials/effect" {
  35391. import { Observable } from "babylonjs/Misc/observable";
  35392. import { Nullable } from "babylonjs/types";
  35393. import { IDisposable } from "babylonjs/scene";
  35394. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35395. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35396. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35397. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35398. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35399. import { Engine } from "babylonjs/Engines/engine";
  35400. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35401. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35402. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35403. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35404. /**
  35405. * Options to be used when creating an effect.
  35406. */
  35407. export interface IEffectCreationOptions {
  35408. /**
  35409. * Atrributes that will be used in the shader.
  35410. */
  35411. attributes: string[];
  35412. /**
  35413. * Uniform varible names that will be set in the shader.
  35414. */
  35415. uniformsNames: string[];
  35416. /**
  35417. * Uniform buffer variable names that will be set in the shader.
  35418. */
  35419. uniformBuffersNames: string[];
  35420. /**
  35421. * Sampler texture variable names that will be set in the shader.
  35422. */
  35423. samplers: string[];
  35424. /**
  35425. * Define statements that will be set in the shader.
  35426. */
  35427. defines: any;
  35428. /**
  35429. * Possible fallbacks for this effect to improve performance when needed.
  35430. */
  35431. fallbacks: Nullable<IEffectFallbacks>;
  35432. /**
  35433. * Callback that will be called when the shader is compiled.
  35434. */
  35435. onCompiled: Nullable<(effect: Effect) => void>;
  35436. /**
  35437. * Callback that will be called if an error occurs during shader compilation.
  35438. */
  35439. onError: Nullable<(effect: Effect, errors: string) => void>;
  35440. /**
  35441. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35442. */
  35443. indexParameters?: any;
  35444. /**
  35445. * Max number of lights that can be used in the shader.
  35446. */
  35447. maxSimultaneousLights?: number;
  35448. /**
  35449. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35450. */
  35451. transformFeedbackVaryings?: Nullable<string[]>;
  35452. /**
  35453. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  35454. */
  35455. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35456. /**
  35457. * Is this effect rendering to several color attachments ?
  35458. */
  35459. multiTarget?: boolean;
  35460. }
  35461. /**
  35462. * Effect containing vertex and fragment shader that can be executed on an object.
  35463. */
  35464. export class Effect implements IDisposable {
  35465. /**
  35466. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35467. */
  35468. static ShadersRepository: string;
  35469. /**
  35470. * Enable logging of the shader code when a compilation error occurs
  35471. */
  35472. static LogShaderCodeOnCompilationError: boolean;
  35473. /**
  35474. * Name of the effect.
  35475. */
  35476. name: any;
  35477. /**
  35478. * String container all the define statements that should be set on the shader.
  35479. */
  35480. defines: string;
  35481. /**
  35482. * Callback that will be called when the shader is compiled.
  35483. */
  35484. onCompiled: Nullable<(effect: Effect) => void>;
  35485. /**
  35486. * Callback that will be called if an error occurs during shader compilation.
  35487. */
  35488. onError: Nullable<(effect: Effect, errors: string) => void>;
  35489. /**
  35490. * Callback that will be called when effect is bound.
  35491. */
  35492. onBind: Nullable<(effect: Effect) => void>;
  35493. /**
  35494. * Unique ID of the effect.
  35495. */
  35496. uniqueId: number;
  35497. /**
  35498. * Observable that will be called when the shader is compiled.
  35499. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35500. */
  35501. onCompileObservable: Observable<Effect>;
  35502. /**
  35503. * Observable that will be called if an error occurs during shader compilation.
  35504. */
  35505. onErrorObservable: Observable<Effect>;
  35506. /** @hidden */
  35507. _onBindObservable: Nullable<Observable<Effect>>;
  35508. /**
  35509. * @hidden
  35510. * Specifies if the effect was previously ready
  35511. */
  35512. _wasPreviouslyReady: boolean;
  35513. /**
  35514. * Observable that will be called when effect is bound.
  35515. */
  35516. get onBindObservable(): Observable<Effect>;
  35517. /** @hidden */
  35518. _bonesComputationForcedToCPU: boolean;
  35519. /** @hidden */
  35520. _multiTarget: boolean;
  35521. private static _uniqueIdSeed;
  35522. private _engine;
  35523. private _uniformBuffersNames;
  35524. private _uniformBuffersNamesList;
  35525. private _uniformsNames;
  35526. private _samplerList;
  35527. private _samplers;
  35528. private _isReady;
  35529. private _compilationError;
  35530. private _allFallbacksProcessed;
  35531. private _attributesNames;
  35532. private _attributes;
  35533. private _attributeLocationByName;
  35534. private _uniforms;
  35535. /**
  35536. * Key for the effect.
  35537. * @hidden
  35538. */
  35539. _key: string;
  35540. private _indexParameters;
  35541. private _fallbacks;
  35542. private _vertexSourceCode;
  35543. private _fragmentSourceCode;
  35544. private _vertexSourceCodeOverride;
  35545. private _fragmentSourceCodeOverride;
  35546. private _transformFeedbackVaryings;
  35547. /**
  35548. * Compiled shader to webGL program.
  35549. * @hidden
  35550. */
  35551. _pipelineContext: Nullable<IPipelineContext>;
  35552. private _valueCache;
  35553. private static _baseCache;
  35554. /**
  35555. * Instantiates an effect.
  35556. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35557. * @param baseName Name of the effect.
  35558. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35559. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35560. * @param samplers List of sampler variables that will be passed to the shader.
  35561. * @param engine Engine to be used to render the effect
  35562. * @param defines Define statements to be added to the shader.
  35563. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35564. * @param onCompiled Callback that will be called when the shader is compiled.
  35565. * @param onError Callback that will be called if an error occurs during shader compilation.
  35566. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35567. */
  35568. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  35569. private _useFinalCode;
  35570. /**
  35571. * Unique key for this effect
  35572. */
  35573. get key(): string;
  35574. /**
  35575. * If the effect has been compiled and prepared.
  35576. * @returns if the effect is compiled and prepared.
  35577. */
  35578. isReady(): boolean;
  35579. private _isReadyInternal;
  35580. /**
  35581. * The engine the effect was initialized with.
  35582. * @returns the engine.
  35583. */
  35584. getEngine(): Engine;
  35585. /**
  35586. * The pipeline context for this effect
  35587. * @returns the associated pipeline context
  35588. */
  35589. getPipelineContext(): Nullable<IPipelineContext>;
  35590. /**
  35591. * The set of names of attribute variables for the shader.
  35592. * @returns An array of attribute names.
  35593. */
  35594. getAttributesNames(): string[];
  35595. /**
  35596. * Returns the attribute at the given index.
  35597. * @param index The index of the attribute.
  35598. * @returns The location of the attribute.
  35599. */
  35600. getAttributeLocation(index: number): number;
  35601. /**
  35602. * Returns the attribute based on the name of the variable.
  35603. * @param name of the attribute to look up.
  35604. * @returns the attribute location.
  35605. */
  35606. getAttributeLocationByName(name: string): number;
  35607. /**
  35608. * The number of attributes.
  35609. * @returns the numnber of attributes.
  35610. */
  35611. getAttributesCount(): number;
  35612. /**
  35613. * Gets the index of a uniform variable.
  35614. * @param uniformName of the uniform to look up.
  35615. * @returns the index.
  35616. */
  35617. getUniformIndex(uniformName: string): number;
  35618. /**
  35619. * Returns the attribute based on the name of the variable.
  35620. * @param uniformName of the uniform to look up.
  35621. * @returns the location of the uniform.
  35622. */
  35623. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35624. /**
  35625. * Returns an array of sampler variable names
  35626. * @returns The array of sampler variable names.
  35627. */
  35628. getSamplers(): string[];
  35629. /**
  35630. * Returns an array of uniform variable names
  35631. * @returns The array of uniform variable names.
  35632. */
  35633. getUniformNames(): string[];
  35634. /**
  35635. * Returns an array of uniform buffer variable names
  35636. * @returns The array of uniform buffer variable names.
  35637. */
  35638. getUniformBuffersNames(): string[];
  35639. /**
  35640. * Returns the index parameters used to create the effect
  35641. * @returns The index parameters object
  35642. */
  35643. getIndexParameters(): any;
  35644. /**
  35645. * The error from the last compilation.
  35646. * @returns the error string.
  35647. */
  35648. getCompilationError(): string;
  35649. /**
  35650. * Gets a boolean indicating that all fallbacks were used during compilation
  35651. * @returns true if all fallbacks were used
  35652. */
  35653. allFallbacksProcessed(): boolean;
  35654. /**
  35655. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35656. * @param func The callback to be used.
  35657. */
  35658. executeWhenCompiled(func: (effect: Effect) => void): void;
  35659. private _checkIsReady;
  35660. private _loadShader;
  35661. /**
  35662. * Gets the vertex shader source code of this effect
  35663. */
  35664. get vertexSourceCode(): string;
  35665. /**
  35666. * Gets the fragment shader source code of this effect
  35667. */
  35668. get fragmentSourceCode(): string;
  35669. /**
  35670. * Recompiles the webGL program
  35671. * @param vertexSourceCode The source code for the vertex shader.
  35672. * @param fragmentSourceCode The source code for the fragment shader.
  35673. * @param onCompiled Callback called when completed.
  35674. * @param onError Callback called on error.
  35675. * @hidden
  35676. */
  35677. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35678. /**
  35679. * Prepares the effect
  35680. * @hidden
  35681. */
  35682. _prepareEffect(): void;
  35683. private _getShaderCodeAndErrorLine;
  35684. private _processCompilationErrors;
  35685. /**
  35686. * Checks if the effect is supported. (Must be called after compilation)
  35687. */
  35688. get isSupported(): boolean;
  35689. /**
  35690. * Binds a texture to the engine to be used as output of the shader.
  35691. * @param channel Name of the output variable.
  35692. * @param texture Texture to bind.
  35693. * @hidden
  35694. */
  35695. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35696. /**
  35697. * Sets a texture on the engine to be used in the shader.
  35698. * @param channel Name of the sampler variable.
  35699. * @param texture Texture to set.
  35700. */
  35701. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35702. /**
  35703. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35704. * @param channel Name of the sampler variable.
  35705. * @param texture Texture to set.
  35706. */
  35707. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35708. /**
  35709. * Sets an array of textures on the engine to be used in the shader.
  35710. * @param channel Name of the variable.
  35711. * @param textures Textures to set.
  35712. */
  35713. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35714. /**
  35715. * Sets a texture to be the input of the specified post process. (To use the output, pass in the next post process in the pipeline)
  35716. * @param channel Name of the sampler variable.
  35717. * @param postProcess Post process to get the input texture from.
  35718. */
  35719. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35720. /**
  35721. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35722. * Sets the input texture of the passed in post process to be input of this effect. (To use the output of the passed in post process use setTextureFromPostProcessOutput)
  35723. * @param channel Name of the sampler variable.
  35724. * @param postProcess Post process to get the output texture from.
  35725. */
  35726. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35727. /** @hidden */
  35728. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35729. /** @hidden */
  35730. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35731. /** @hidden */
  35732. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35733. /** @hidden */
  35734. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35735. /**
  35736. * Binds a buffer to a uniform.
  35737. * @param buffer Buffer to bind.
  35738. * @param name Name of the uniform variable to bind to.
  35739. */
  35740. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35741. /**
  35742. * Binds block to a uniform.
  35743. * @param blockName Name of the block to bind.
  35744. * @param index Index to bind.
  35745. */
  35746. bindUniformBlock(blockName: string, index: number): void;
  35747. /**
  35748. * Sets an interger value on a uniform variable.
  35749. * @param uniformName Name of the variable.
  35750. * @param value Value to be set.
  35751. * @returns this effect.
  35752. */
  35753. setInt(uniformName: string, value: number): Effect;
  35754. /**
  35755. * Sets an int array on a uniform variable.
  35756. * @param uniformName Name of the variable.
  35757. * @param array array to be set.
  35758. * @returns this effect.
  35759. */
  35760. setIntArray(uniformName: string, array: Int32Array): Effect;
  35761. /**
  35762. * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35763. * @param uniformName Name of the variable.
  35764. * @param array array to be set.
  35765. * @returns this effect.
  35766. */
  35767. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35768. /**
  35769. * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35770. * @param uniformName Name of the variable.
  35771. * @param array array to be set.
  35772. * @returns this effect.
  35773. */
  35774. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35775. /**
  35776. * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35777. * @param uniformName Name of the variable.
  35778. * @param array array to be set.
  35779. * @returns this effect.
  35780. */
  35781. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35782. /**
  35783. * Sets an float array on a uniform variable.
  35784. * @param uniformName Name of the variable.
  35785. * @param array array to be set.
  35786. * @returns this effect.
  35787. */
  35788. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35789. /**
  35790. * Sets an float array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35791. * @param uniformName Name of the variable.
  35792. * @param array array to be set.
  35793. * @returns this effect.
  35794. */
  35795. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35796. /**
  35797. * Sets an float array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35798. * @param uniformName Name of the variable.
  35799. * @param array array to be set.
  35800. * @returns this effect.
  35801. */
  35802. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35803. /**
  35804. * Sets an float array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35805. * @param uniformName Name of the variable.
  35806. * @param array array to be set.
  35807. * @returns this effect.
  35808. */
  35809. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35810. /**
  35811. * Sets an array on a uniform variable.
  35812. * @param uniformName Name of the variable.
  35813. * @param array array to be set.
  35814. * @returns this effect.
  35815. */
  35816. setArray(uniformName: string, array: number[]): Effect;
  35817. /**
  35818. * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  35819. * @param uniformName Name of the variable.
  35820. * @param array array to be set.
  35821. * @returns this effect.
  35822. */
  35823. setArray2(uniformName: string, array: number[]): Effect;
  35824. /**
  35825. * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  35826. * @param uniformName Name of the variable.
  35827. * @param array array to be set.
  35828. * @returns this effect.
  35829. */
  35830. setArray3(uniformName: string, array: number[]): Effect;
  35831. /**
  35832. * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  35833. * @param uniformName Name of the variable.
  35834. * @param array array to be set.
  35835. * @returns this effect.
  35836. */
  35837. setArray4(uniformName: string, array: number[]): Effect;
  35838. /**
  35839. * Sets matrices on a uniform variable.
  35840. * @param uniformName Name of the variable.
  35841. * @param matrices matrices to be set.
  35842. * @returns this effect.
  35843. */
  35844. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35845. /**
  35846. * Sets matrix on a uniform variable.
  35847. * @param uniformName Name of the variable.
  35848. * @param matrix matrix to be set.
  35849. * @returns this effect.
  35850. */
  35851. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35852. /**
  35853. * Sets a 3x3 matrix on a uniform variable. (Speicified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
  35854. * @param uniformName Name of the variable.
  35855. * @param matrix matrix to be set.
  35856. * @returns this effect.
  35857. */
  35858. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35859. /**
  35860. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35861. * @param uniformName Name of the variable.
  35862. * @param matrix matrix to be set.
  35863. * @returns this effect.
  35864. */
  35865. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35866. /**
  35867. * Sets a float on a uniform variable.
  35868. * @param uniformName Name of the variable.
  35869. * @param value value to be set.
  35870. * @returns this effect.
  35871. */
  35872. setFloat(uniformName: string, value: number): Effect;
  35873. /**
  35874. * Sets a boolean on a uniform variable.
  35875. * @param uniformName Name of the variable.
  35876. * @param bool value to be set.
  35877. * @returns this effect.
  35878. */
  35879. setBool(uniformName: string, bool: boolean): Effect;
  35880. /**
  35881. * Sets a Vector2 on a uniform variable.
  35882. * @param uniformName Name of the variable.
  35883. * @param vector2 vector2 to be set.
  35884. * @returns this effect.
  35885. */
  35886. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35887. /**
  35888. * Sets a float2 on a uniform variable.
  35889. * @param uniformName Name of the variable.
  35890. * @param x First float in float2.
  35891. * @param y Second float in float2.
  35892. * @returns this effect.
  35893. */
  35894. setFloat2(uniformName: string, x: number, y: number): Effect;
  35895. /**
  35896. * Sets a Vector3 on a uniform variable.
  35897. * @param uniformName Name of the variable.
  35898. * @param vector3 Value to be set.
  35899. * @returns this effect.
  35900. */
  35901. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35902. /**
  35903. * Sets a float3 on a uniform variable.
  35904. * @param uniformName Name of the variable.
  35905. * @param x First float in float3.
  35906. * @param y Second float in float3.
  35907. * @param z Third float in float3.
  35908. * @returns this effect.
  35909. */
  35910. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35911. /**
  35912. * Sets a Vector4 on a uniform variable.
  35913. * @param uniformName Name of the variable.
  35914. * @param vector4 Value to be set.
  35915. * @returns this effect.
  35916. */
  35917. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35918. /**
  35919. * Sets a float4 on a uniform variable.
  35920. * @param uniformName Name of the variable.
  35921. * @param x First float in float4.
  35922. * @param y Second float in float4.
  35923. * @param z Third float in float4.
  35924. * @param w Fourth float in float4.
  35925. * @returns this effect.
  35926. */
  35927. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35928. /**
  35929. * Sets a Color3 on a uniform variable.
  35930. * @param uniformName Name of the variable.
  35931. * @param color3 Value to be set.
  35932. * @returns this effect.
  35933. */
  35934. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35935. /**
  35936. * Sets a Color4 on a uniform variable.
  35937. * @param uniformName Name of the variable.
  35938. * @param color3 Value to be set.
  35939. * @param alpha Alpha value to be set.
  35940. * @returns this effect.
  35941. */
  35942. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35943. /**
  35944. * Sets a Color4 on a uniform variable
  35945. * @param uniformName defines the name of the variable
  35946. * @param color4 defines the value to be set
  35947. * @returns this effect.
  35948. */
  35949. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35950. /** Release all associated resources */
  35951. dispose(): void;
  35952. /**
  35953. * This function will add a new shader to the shader store
  35954. * @param name the name of the shader
  35955. * @param pixelShader optional pixel shader content
  35956. * @param vertexShader optional vertex shader content
  35957. */
  35958. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35959. /**
  35960. * Store of each shader (The can be looked up using effect.key)
  35961. */
  35962. static ShadersStore: {
  35963. [key: string]: string;
  35964. };
  35965. /**
  35966. * Store of each included file for a shader (The can be looked up using effect.key)
  35967. */
  35968. static IncludesShadersStore: {
  35969. [key: string]: string;
  35970. };
  35971. /**
  35972. * Resets the cache of effects.
  35973. */
  35974. static ResetCache(): void;
  35975. }
  35976. }
  35977. declare module "babylonjs/Engines/engineCapabilities" {
  35978. /**
  35979. * Interface used to describe the capabilities of the engine relatively to the current browser
  35980. */
  35981. export interface EngineCapabilities {
  35982. /** Maximum textures units per fragment shader */
  35983. maxTexturesImageUnits: number;
  35984. /** Maximum texture units per vertex shader */
  35985. maxVertexTextureImageUnits: number;
  35986. /** Maximum textures units in the entire pipeline */
  35987. maxCombinedTexturesImageUnits: number;
  35988. /** Maximum texture size */
  35989. maxTextureSize: number;
  35990. /** Maximum texture samples */
  35991. maxSamples?: number;
  35992. /** Maximum cube texture size */
  35993. maxCubemapTextureSize: number;
  35994. /** Maximum render texture size */
  35995. maxRenderTextureSize: number;
  35996. /** Maximum number of vertex attributes */
  35997. maxVertexAttribs: number;
  35998. /** Maximum number of varyings */
  35999. maxVaryingVectors: number;
  36000. /** Maximum number of uniforms per vertex shader */
  36001. maxVertexUniformVectors: number;
  36002. /** Maximum number of uniforms per fragment shader */
  36003. maxFragmentUniformVectors: number;
  36004. /** Defines if standard derivates (dx/dy) are supported */
  36005. standardDerivatives: boolean;
  36006. /** Defines if s3tc texture compression is supported */
  36007. s3tc?: WEBGL_compressed_texture_s3tc;
  36008. /** Defines if pvrtc texture compression is supported */
  36009. pvrtc: any;
  36010. /** Defines if etc1 texture compression is supported */
  36011. etc1: any;
  36012. /** Defines if etc2 texture compression is supported */
  36013. etc2: any;
  36014. /** Defines if astc texture compression is supported */
  36015. astc: any;
  36016. /** Defines if float textures are supported */
  36017. textureFloat: boolean;
  36018. /** Defines if vertex array objects are supported */
  36019. vertexArrayObject: boolean;
  36020. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36021. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36022. /** Gets the maximum level of anisotropy supported */
  36023. maxAnisotropy: number;
  36024. /** Defines if instancing is supported */
  36025. instancedArrays: boolean;
  36026. /** Defines if 32 bits indices are supported */
  36027. uintIndices: boolean;
  36028. /** Defines if high precision shaders are supported */
  36029. highPrecisionShaderSupported: boolean;
  36030. /** Defines if depth reading in the fragment shader is supported */
  36031. fragmentDepthSupported: boolean;
  36032. /** Defines if float texture linear filtering is supported*/
  36033. textureFloatLinearFiltering: boolean;
  36034. /** Defines if rendering to float textures is supported */
  36035. textureFloatRender: boolean;
  36036. /** Defines if half float textures are supported*/
  36037. textureHalfFloat: boolean;
  36038. /** Defines if half float texture linear filtering is supported*/
  36039. textureHalfFloatLinearFiltering: boolean;
  36040. /** Defines if rendering to half float textures is supported */
  36041. textureHalfFloatRender: boolean;
  36042. /** Defines if textureLOD shader command is supported */
  36043. textureLOD: boolean;
  36044. /** Defines if draw buffers extension is supported */
  36045. drawBuffersExtension: boolean;
  36046. /** Defines if depth textures are supported */
  36047. depthTextureExtension: boolean;
  36048. /** Defines if float color buffer are supported */
  36049. colorBufferFloat: boolean;
  36050. /** Gets disjoint timer query extension (null if not supported) */
  36051. timerQuery?: EXT_disjoint_timer_query;
  36052. /** Defines if timestamp can be used with timer query */
  36053. canUseTimestampForTimerQuery: boolean;
  36054. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36055. multiview?: any;
  36056. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36057. oculusMultiview?: any;
  36058. /** Function used to let the system compiles shaders in background */
  36059. parallelShaderCompile?: {
  36060. COMPLETION_STATUS_KHR: number;
  36061. };
  36062. /** Max number of texture samples for MSAA */
  36063. maxMSAASamples: number;
  36064. /** Defines if the blend min max extension is supported */
  36065. blendMinMax: boolean;
  36066. }
  36067. }
  36068. declare module "babylonjs/States/depthCullingState" {
  36069. import { Nullable } from "babylonjs/types";
  36070. /**
  36071. * @hidden
  36072. **/
  36073. export class DepthCullingState {
  36074. private _isDepthTestDirty;
  36075. private _isDepthMaskDirty;
  36076. private _isDepthFuncDirty;
  36077. private _isCullFaceDirty;
  36078. private _isCullDirty;
  36079. private _isZOffsetDirty;
  36080. private _isFrontFaceDirty;
  36081. private _depthTest;
  36082. private _depthMask;
  36083. private _depthFunc;
  36084. private _cull;
  36085. private _cullFace;
  36086. private _zOffset;
  36087. private _frontFace;
  36088. /**
  36089. * Initializes the state.
  36090. */
  36091. constructor();
  36092. get isDirty(): boolean;
  36093. get zOffset(): number;
  36094. set zOffset(value: number);
  36095. get cullFace(): Nullable<number>;
  36096. set cullFace(value: Nullable<number>);
  36097. get cull(): Nullable<boolean>;
  36098. set cull(value: Nullable<boolean>);
  36099. get depthFunc(): Nullable<number>;
  36100. set depthFunc(value: Nullable<number>);
  36101. get depthMask(): boolean;
  36102. set depthMask(value: boolean);
  36103. get depthTest(): boolean;
  36104. set depthTest(value: boolean);
  36105. get frontFace(): Nullable<number>;
  36106. set frontFace(value: Nullable<number>);
  36107. reset(): void;
  36108. apply(gl: WebGLRenderingContext): void;
  36109. }
  36110. }
  36111. declare module "babylonjs/States/stencilState" {
  36112. /**
  36113. * @hidden
  36114. **/
  36115. export class StencilState {
  36116. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  36117. static readonly ALWAYS: number;
  36118. /** Passed to stencilOperation to specify that stencil value must be kept */
  36119. static readonly KEEP: number;
  36120. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36121. static readonly REPLACE: number;
  36122. private _isStencilTestDirty;
  36123. private _isStencilMaskDirty;
  36124. private _isStencilFuncDirty;
  36125. private _isStencilOpDirty;
  36126. private _stencilTest;
  36127. private _stencilMask;
  36128. private _stencilFunc;
  36129. private _stencilFuncRef;
  36130. private _stencilFuncMask;
  36131. private _stencilOpStencilFail;
  36132. private _stencilOpDepthFail;
  36133. private _stencilOpStencilDepthPass;
  36134. get isDirty(): boolean;
  36135. get stencilFunc(): number;
  36136. set stencilFunc(value: number);
  36137. get stencilFuncRef(): number;
  36138. set stencilFuncRef(value: number);
  36139. get stencilFuncMask(): number;
  36140. set stencilFuncMask(value: number);
  36141. get stencilOpStencilFail(): number;
  36142. set stencilOpStencilFail(value: number);
  36143. get stencilOpDepthFail(): number;
  36144. set stencilOpDepthFail(value: number);
  36145. get stencilOpStencilDepthPass(): number;
  36146. set stencilOpStencilDepthPass(value: number);
  36147. get stencilMask(): number;
  36148. set stencilMask(value: number);
  36149. get stencilTest(): boolean;
  36150. set stencilTest(value: boolean);
  36151. constructor();
  36152. reset(): void;
  36153. apply(gl: WebGLRenderingContext): void;
  36154. }
  36155. }
  36156. declare module "babylonjs/States/alphaCullingState" {
  36157. /**
  36158. * @hidden
  36159. **/
  36160. export class AlphaState {
  36161. private _isAlphaBlendDirty;
  36162. private _isBlendFunctionParametersDirty;
  36163. private _isBlendEquationParametersDirty;
  36164. private _isBlendConstantsDirty;
  36165. private _alphaBlend;
  36166. private _blendFunctionParameters;
  36167. private _blendEquationParameters;
  36168. private _blendConstants;
  36169. /**
  36170. * Initializes the state.
  36171. */
  36172. constructor();
  36173. get isDirty(): boolean;
  36174. get alphaBlend(): boolean;
  36175. set alphaBlend(value: boolean);
  36176. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36177. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36178. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36179. reset(): void;
  36180. apply(gl: WebGLRenderingContext): void;
  36181. }
  36182. }
  36183. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36184. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36185. /** @hidden */
  36186. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36187. attributeProcessor(attribute: string): string;
  36188. varyingProcessor(varying: string, isFragment: boolean): string;
  36189. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36190. }
  36191. }
  36192. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36193. /**
  36194. * Interface for attribute information associated with buffer instanciation
  36195. */
  36196. export interface InstancingAttributeInfo {
  36197. /**
  36198. * Name of the GLSL attribute
  36199. * if attribute index is not specified, this is used to retrieve the index from the effect
  36200. */
  36201. attributeName: string;
  36202. /**
  36203. * Index/offset of the attribute in the vertex shader
  36204. * if not specified, this will be computes from the name.
  36205. */
  36206. index?: number;
  36207. /**
  36208. * size of the attribute, 1, 2, 3 or 4
  36209. */
  36210. attributeSize: number;
  36211. /**
  36212. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36213. */
  36214. offset: number;
  36215. /**
  36216. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36217. * default to 1
  36218. */
  36219. divisor?: number;
  36220. /**
  36221. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36222. * default is FLOAT
  36223. */
  36224. attributeType?: number;
  36225. /**
  36226. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36227. */
  36228. normalized?: boolean;
  36229. }
  36230. }
  36231. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36232. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36233. import { Nullable } from "babylonjs/types";
  36234. module "babylonjs/Engines/thinEngine" {
  36235. interface ThinEngine {
  36236. /**
  36237. * Update a video texture
  36238. * @param texture defines the texture to update
  36239. * @param video defines the video element to use
  36240. * @param invertY defines if data must be stored with Y axis inverted
  36241. */
  36242. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36243. }
  36244. }
  36245. }
  36246. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36247. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36248. import { Nullable } from "babylonjs/types";
  36249. module "babylonjs/Engines/thinEngine" {
  36250. interface ThinEngine {
  36251. /**
  36252. * Creates a dynamic texture
  36253. * @param width defines the width of the texture
  36254. * @param height defines the height of the texture
  36255. * @param generateMipMaps defines if the engine should generate the mip levels
  36256. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36257. * @returns the dynamic texture inside an InternalTexture
  36258. */
  36259. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36260. /**
  36261. * Update the content of a dynamic texture
  36262. * @param texture defines the texture to update
  36263. * @param canvas defines the canvas containing the source
  36264. * @param invertY defines if data must be stored with Y axis inverted
  36265. * @param premulAlpha defines if alpha is stored as premultiplied
  36266. * @param format defines the format of the data
  36267. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36268. */
  36269. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36270. }
  36271. }
  36272. }
  36273. declare module "babylonjs/Materials/Textures/videoTexture" {
  36274. import { Observable } from "babylonjs/Misc/observable";
  36275. import { Nullable } from "babylonjs/types";
  36276. import { Scene } from "babylonjs/scene";
  36277. import { Texture } from "babylonjs/Materials/Textures/texture";
  36278. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36279. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36280. /**
  36281. * Settings for finer control over video usage
  36282. */
  36283. export interface VideoTextureSettings {
  36284. /**
  36285. * Applies `autoplay` to video, if specified
  36286. */
  36287. autoPlay?: boolean;
  36288. /**
  36289. * Applies `loop` to video, if specified
  36290. */
  36291. loop?: boolean;
  36292. /**
  36293. * Automatically updates internal texture from video at every frame in the render loop
  36294. */
  36295. autoUpdateTexture: boolean;
  36296. /**
  36297. * Image src displayed during the video loading or until the user interacts with the video.
  36298. */
  36299. poster?: string;
  36300. }
  36301. /**
  36302. * If you want to display a video in your scene, this is the special texture for that.
  36303. * This special texture works similar to other textures, with the exception of a few parameters.
  36304. * @see https://doc.babylonjs.com/how_to/video_texture
  36305. */
  36306. export class VideoTexture extends Texture {
  36307. /**
  36308. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36309. */
  36310. readonly autoUpdateTexture: boolean;
  36311. /**
  36312. * The video instance used by the texture internally
  36313. */
  36314. readonly video: HTMLVideoElement;
  36315. private _onUserActionRequestedObservable;
  36316. /**
  36317. * Event triggerd when a dom action is required by the user to play the video.
  36318. * This happens due to recent changes in browser policies preventing video to auto start.
  36319. */
  36320. get onUserActionRequestedObservable(): Observable<Texture>;
  36321. private _generateMipMaps;
  36322. private _stillImageCaptured;
  36323. private _displayingPosterTexture;
  36324. private _settings;
  36325. private _createInternalTextureOnEvent;
  36326. private _frameId;
  36327. private _currentSrc;
  36328. /**
  36329. * Creates a video texture.
  36330. * If you want to display a video in your scene, this is the special texture for that.
  36331. * This special texture works similar to other textures, with the exception of a few parameters.
  36332. * @see https://doc.babylonjs.com/how_to/video_texture
  36333. * @param name optional name, will detect from video source, if not defined
  36334. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36335. * @param scene is obviously the current scene.
  36336. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36337. * @param invertY is false by default but can be used to invert video on Y axis
  36338. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36339. * @param settings allows finer control over video usage
  36340. */
  36341. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36342. private _getName;
  36343. private _getVideo;
  36344. private _createInternalTexture;
  36345. private reset;
  36346. /**
  36347. * @hidden Internal method to initiate `update`.
  36348. */
  36349. _rebuild(): void;
  36350. /**
  36351. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36352. */
  36353. update(): void;
  36354. /**
  36355. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36356. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36357. */
  36358. updateTexture(isVisible: boolean): void;
  36359. protected _updateInternalTexture: () => void;
  36360. /**
  36361. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36362. * @param url New url.
  36363. */
  36364. updateURL(url: string): void;
  36365. /**
  36366. * Clones the texture.
  36367. * @returns the cloned texture
  36368. */
  36369. clone(): VideoTexture;
  36370. /**
  36371. * Dispose the texture and release its associated resources.
  36372. */
  36373. dispose(): void;
  36374. /**
  36375. * Creates a video texture straight from a stream.
  36376. * @param scene Define the scene the texture should be created in
  36377. * @param stream Define the stream the texture should be created from
  36378. * @returns The created video texture as a promise
  36379. */
  36380. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36381. /**
  36382. * Creates a video texture straight from your WebCam video feed.
  36383. * @param scene Define the scene the texture should be created in
  36384. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36385. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36386. * @returns The created video texture as a promise
  36387. */
  36388. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36389. minWidth: number;
  36390. maxWidth: number;
  36391. minHeight: number;
  36392. maxHeight: number;
  36393. deviceId: string;
  36394. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36395. /**
  36396. * Creates a video texture straight from your WebCam video feed.
  36397. * @param scene Define the scene the texture should be created in
  36398. * @param onReady Define a callback to triggered once the texture will be ready
  36399. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36400. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36401. */
  36402. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36403. minWidth: number;
  36404. maxWidth: number;
  36405. minHeight: number;
  36406. maxHeight: number;
  36407. deviceId: string;
  36408. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36409. }
  36410. }
  36411. declare module "babylonjs/Engines/thinEngine" {
  36412. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36413. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36414. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36415. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36416. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36417. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36418. import { Observable } from "babylonjs/Misc/observable";
  36419. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36420. import { StencilState } from "babylonjs/States/stencilState";
  36421. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36422. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36423. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36424. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36425. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36426. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36427. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36428. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36429. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36430. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36431. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36432. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36433. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36434. import { WebRequest } from "babylonjs/Misc/webRequest";
  36435. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36436. /**
  36437. * Defines the interface used by objects working like Scene
  36438. * @hidden
  36439. */
  36440. export interface ISceneLike {
  36441. _addPendingData(data: any): void;
  36442. _removePendingData(data: any): void;
  36443. offlineProvider: IOfflineProvider;
  36444. }
  36445. /**
  36446. * Information about the current host
  36447. */
  36448. export interface HostInformation {
  36449. /**
  36450. * Defines if the current host is a mobile
  36451. */
  36452. isMobile: boolean;
  36453. }
  36454. /** Interface defining initialization parameters for Engine class */
  36455. export interface EngineOptions extends WebGLContextAttributes {
  36456. /**
  36457. * Defines if the engine should no exceed a specified device ratio
  36458. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36459. */
  36460. limitDeviceRatio?: number;
  36461. /**
  36462. * Defines if webvr should be enabled automatically
  36463. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36464. */
  36465. autoEnableWebVR?: boolean;
  36466. /**
  36467. * Defines if webgl2 should be turned off even if supported
  36468. * @see https://doc.babylonjs.com/features/webgl2
  36469. */
  36470. disableWebGL2Support?: boolean;
  36471. /**
  36472. * Defines if webaudio should be initialized as well
  36473. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36474. */
  36475. audioEngine?: boolean;
  36476. /**
  36477. * Defines if animations should run using a deterministic lock step
  36478. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36479. */
  36480. deterministicLockstep?: boolean;
  36481. /** Defines the maximum steps to use with deterministic lock step mode */
  36482. lockstepMaxSteps?: number;
  36483. /** Defines the seconds between each deterministic lock step */
  36484. timeStep?: number;
  36485. /**
  36486. * Defines that engine should ignore context lost events
  36487. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36488. */
  36489. doNotHandleContextLost?: boolean;
  36490. /**
  36491. * Defines that engine should ignore modifying touch action attribute and style
  36492. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36493. */
  36494. doNotHandleTouchAction?: boolean;
  36495. /**
  36496. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36497. */
  36498. useHighPrecisionFloats?: boolean;
  36499. /**
  36500. * Make the canvas XR Compatible for XR sessions
  36501. */
  36502. xrCompatible?: boolean;
  36503. /**
  36504. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36505. */
  36506. useHighPrecisionMatrix?: boolean;
  36507. }
  36508. /**
  36509. * The base engine class (root of all engines)
  36510. */
  36511. export class ThinEngine {
  36512. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36513. static ExceptionList: ({
  36514. key: string;
  36515. capture: string;
  36516. captureConstraint: number;
  36517. targets: string[];
  36518. } | {
  36519. key: string;
  36520. capture: null;
  36521. captureConstraint: null;
  36522. targets: string[];
  36523. })[];
  36524. /** @hidden */
  36525. static _TextureLoaders: IInternalTextureLoader[];
  36526. /**
  36527. * Returns the current npm package of the sdk
  36528. */
  36529. static get NpmPackage(): string;
  36530. /**
  36531. * Returns the current version of the framework
  36532. */
  36533. static get Version(): string;
  36534. /**
  36535. * Returns a string describing the current engine
  36536. */
  36537. get description(): string;
  36538. /**
  36539. * Gets or sets the epsilon value used by collision engine
  36540. */
  36541. static CollisionsEpsilon: number;
  36542. /**
  36543. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36544. */
  36545. static get ShadersRepository(): string;
  36546. static set ShadersRepository(value: string);
  36547. /** @hidden */
  36548. _shaderProcessor: IShaderProcessor;
  36549. /**
  36550. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36551. */
  36552. forcePOTTextures: boolean;
  36553. /**
  36554. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36555. */
  36556. isFullscreen: boolean;
  36557. /**
  36558. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36559. */
  36560. cullBackFaces: boolean;
  36561. /**
  36562. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36563. */
  36564. renderEvenInBackground: boolean;
  36565. /**
  36566. * Gets or sets a boolean indicating that cache can be kept between frames
  36567. */
  36568. preventCacheWipeBetweenFrames: boolean;
  36569. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36570. validateShaderPrograms: boolean;
  36571. /**
  36572. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36573. * This can provide greater z depth for distant objects.
  36574. */
  36575. useReverseDepthBuffer: boolean;
  36576. /**
  36577. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36578. */
  36579. disableUniformBuffers: boolean;
  36580. /** @hidden */
  36581. _uniformBuffers: UniformBuffer[];
  36582. /**
  36583. * Gets a boolean indicating that the engine supports uniform buffers
  36584. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36585. */
  36586. get supportsUniformBuffers(): boolean;
  36587. /** @hidden */
  36588. _gl: WebGLRenderingContext;
  36589. /** @hidden */
  36590. _webGLVersion: number;
  36591. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36592. protected _windowIsBackground: boolean;
  36593. protected _creationOptions: EngineOptions;
  36594. protected _highPrecisionShadersAllowed: boolean;
  36595. /** @hidden */
  36596. get _shouldUseHighPrecisionShader(): boolean;
  36597. /**
  36598. * Gets a boolean indicating that only power of 2 textures are supported
  36599. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36600. */
  36601. get needPOTTextures(): boolean;
  36602. /** @hidden */
  36603. _badOS: boolean;
  36604. /** @hidden */
  36605. _badDesktopOS: boolean;
  36606. private _hardwareScalingLevel;
  36607. /** @hidden */
  36608. _caps: EngineCapabilities;
  36609. private _isStencilEnable;
  36610. private _glVersion;
  36611. private _glRenderer;
  36612. private _glVendor;
  36613. /** @hidden */
  36614. _videoTextureSupported: boolean;
  36615. protected _renderingQueueLaunched: boolean;
  36616. protected _activeRenderLoops: (() => void)[];
  36617. /**
  36618. * Observable signaled when a context lost event is raised
  36619. */
  36620. onContextLostObservable: Observable<ThinEngine>;
  36621. /**
  36622. * Observable signaled when a context restored event is raised
  36623. */
  36624. onContextRestoredObservable: Observable<ThinEngine>;
  36625. private _onContextLost;
  36626. private _onContextRestored;
  36627. protected _contextWasLost: boolean;
  36628. /** @hidden */
  36629. _doNotHandleContextLost: boolean;
  36630. /**
  36631. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36632. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36633. */
  36634. get doNotHandleContextLost(): boolean;
  36635. set doNotHandleContextLost(value: boolean);
  36636. /**
  36637. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36638. */
  36639. disableVertexArrayObjects: boolean;
  36640. /** @hidden */
  36641. protected _colorWrite: boolean;
  36642. /** @hidden */
  36643. protected _colorWriteChanged: boolean;
  36644. /** @hidden */
  36645. protected _depthCullingState: DepthCullingState;
  36646. /** @hidden */
  36647. protected _stencilState: StencilState;
  36648. /** @hidden */
  36649. _alphaState: AlphaState;
  36650. /** @hidden */
  36651. _alphaMode: number;
  36652. /** @hidden */
  36653. _alphaEquation: number;
  36654. /** @hidden */
  36655. _internalTexturesCache: InternalTexture[];
  36656. /** @hidden */
  36657. protected _activeChannel: number;
  36658. private _currentTextureChannel;
  36659. /** @hidden */
  36660. protected _boundTexturesCache: {
  36661. [key: string]: Nullable<InternalTexture>;
  36662. };
  36663. /** @hidden */
  36664. protected _currentEffect: Nullable<Effect>;
  36665. /** @hidden */
  36666. protected _currentProgram: Nullable<WebGLProgram>;
  36667. private _compiledEffects;
  36668. private _vertexAttribArraysEnabled;
  36669. /** @hidden */
  36670. protected _cachedViewport: Nullable<IViewportLike>;
  36671. private _cachedVertexArrayObject;
  36672. /** @hidden */
  36673. protected _cachedVertexBuffers: any;
  36674. /** @hidden */
  36675. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36676. /** @hidden */
  36677. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36678. /** @hidden */
  36679. _currentRenderTarget: Nullable<InternalTexture>;
  36680. private _uintIndicesCurrentlySet;
  36681. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36682. /** @hidden */
  36683. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36684. /** @hidden */
  36685. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36686. private _currentBufferPointers;
  36687. private _currentInstanceLocations;
  36688. private _currentInstanceBuffers;
  36689. private _textureUnits;
  36690. /** @hidden */
  36691. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36692. /** @hidden */
  36693. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36694. /** @hidden */
  36695. _boundRenderFunction: any;
  36696. private _vaoRecordInProgress;
  36697. private _mustWipeVertexAttributes;
  36698. private _emptyTexture;
  36699. private _emptyCubeTexture;
  36700. private _emptyTexture3D;
  36701. private _emptyTexture2DArray;
  36702. /** @hidden */
  36703. _frameHandler: number;
  36704. private _nextFreeTextureSlots;
  36705. private _maxSimultaneousTextures;
  36706. private _activeRequests;
  36707. /** @hidden */
  36708. _transformTextureUrl: Nullable<(url: string) => string>;
  36709. /**
  36710. * Gets information about the current host
  36711. */
  36712. hostInformation: HostInformation;
  36713. protected get _supportsHardwareTextureRescaling(): boolean;
  36714. private _framebufferDimensionsObject;
  36715. /**
  36716. * sets the object from which width and height will be taken from when getting render width and height
  36717. * Will fallback to the gl object
  36718. * @param dimensions the framebuffer width and height that will be used.
  36719. */
  36720. set framebufferDimensionsObject(dimensions: Nullable<{
  36721. framebufferWidth: number;
  36722. framebufferHeight: number;
  36723. }>);
  36724. /**
  36725. * Gets the current viewport
  36726. */
  36727. get currentViewport(): Nullable<IViewportLike>;
  36728. /**
  36729. * Gets the default empty texture
  36730. */
  36731. get emptyTexture(): InternalTexture;
  36732. /**
  36733. * Gets the default empty 3D texture
  36734. */
  36735. get emptyTexture3D(): InternalTexture;
  36736. /**
  36737. * Gets the default empty 2D array texture
  36738. */
  36739. get emptyTexture2DArray(): InternalTexture;
  36740. /**
  36741. * Gets the default empty cube texture
  36742. */
  36743. get emptyCubeTexture(): InternalTexture;
  36744. /**
  36745. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36746. */
  36747. readonly premultipliedAlpha: boolean;
  36748. /**
  36749. * Observable event triggered before each texture is initialized
  36750. */
  36751. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36752. /**
  36753. * Creates a new engine
  36754. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  36755. * @param antialias defines enable antialiasing (default: false)
  36756. * @param options defines further options to be sent to the getContext() function
  36757. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36758. */
  36759. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36760. private _rebuildInternalTextures;
  36761. private _rebuildEffects;
  36762. /**
  36763. * Gets a boolean indicating if all created effects are ready
  36764. * @returns true if all effects are ready
  36765. */
  36766. areAllEffectsReady(): boolean;
  36767. protected _rebuildBuffers(): void;
  36768. protected _initGLContext(): void;
  36769. /**
  36770. * Gets version of the current webGL context
  36771. */
  36772. get webGLVersion(): number;
  36773. /**
  36774. * Gets a string identifying the name of the class
  36775. * @returns "Engine" string
  36776. */
  36777. getClassName(): string;
  36778. /**
  36779. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36780. */
  36781. get isStencilEnable(): boolean;
  36782. /** @hidden */
  36783. _prepareWorkingCanvas(): void;
  36784. /**
  36785. * Reset the texture cache to empty state
  36786. */
  36787. resetTextureCache(): void;
  36788. /**
  36789. * Gets an object containing information about the current webGL context
  36790. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36791. */
  36792. getGlInfo(): {
  36793. vendor: string;
  36794. renderer: string;
  36795. version: string;
  36796. };
  36797. /**
  36798. * Defines the hardware scaling level.
  36799. * By default the hardware scaling level is computed from the window device ratio.
  36800. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36801. * @param level defines the level to use
  36802. */
  36803. setHardwareScalingLevel(level: number): void;
  36804. /**
  36805. * Gets the current hardware scaling level.
  36806. * By default the hardware scaling level is computed from the window device ratio.
  36807. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36808. * @returns a number indicating the current hardware scaling level
  36809. */
  36810. getHardwareScalingLevel(): number;
  36811. /**
  36812. * Gets the list of loaded textures
  36813. * @returns an array containing all loaded textures
  36814. */
  36815. getLoadedTexturesCache(): InternalTexture[];
  36816. /**
  36817. * Gets the object containing all engine capabilities
  36818. * @returns the EngineCapabilities object
  36819. */
  36820. getCaps(): EngineCapabilities;
  36821. /**
  36822. * stop executing a render loop function and remove it from the execution array
  36823. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36824. */
  36825. stopRenderLoop(renderFunction?: () => void): void;
  36826. /** @hidden */
  36827. _renderLoop(): void;
  36828. /**
  36829. * Gets the HTML canvas attached with the current webGL context
  36830. * @returns a HTML canvas
  36831. */
  36832. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36833. /**
  36834. * Gets host window
  36835. * @returns the host window object
  36836. */
  36837. getHostWindow(): Nullable<Window>;
  36838. /**
  36839. * Gets the current render width
  36840. * @param useScreen defines if screen size must be used (or the current render target if any)
  36841. * @returns a number defining the current render width
  36842. */
  36843. getRenderWidth(useScreen?: boolean): number;
  36844. /**
  36845. * Gets the current render height
  36846. * @param useScreen defines if screen size must be used (or the current render target if any)
  36847. * @returns a number defining the current render height
  36848. */
  36849. getRenderHeight(useScreen?: boolean): number;
  36850. /**
  36851. * Can be used to override the current requestAnimationFrame requester.
  36852. * @hidden
  36853. */
  36854. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36855. /**
  36856. * Register and execute a render loop. The engine can have more than one render function
  36857. * @param renderFunction defines the function to continuously execute
  36858. */
  36859. runRenderLoop(renderFunction: () => void): void;
  36860. /**
  36861. * Clear the current render buffer or the current render target (if any is set up)
  36862. * @param color defines the color to use
  36863. * @param backBuffer defines if the back buffer must be cleared
  36864. * @param depth defines if the depth buffer must be cleared
  36865. * @param stencil defines if the stencil buffer must be cleared
  36866. */
  36867. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36868. private _viewportCached;
  36869. /** @hidden */
  36870. _viewport(x: number, y: number, width: number, height: number): void;
  36871. /**
  36872. * Set the WebGL's viewport
  36873. * @param viewport defines the viewport element to be used
  36874. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36875. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36876. */
  36877. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36878. /**
  36879. * Begin a new frame
  36880. */
  36881. beginFrame(): void;
  36882. /**
  36883. * Enf the current frame
  36884. */
  36885. endFrame(): void;
  36886. /**
  36887. * Resize the view according to the canvas' size
  36888. */
  36889. resize(): void;
  36890. /**
  36891. * Force a specific size of the canvas
  36892. * @param width defines the new canvas' width
  36893. * @param height defines the new canvas' height
  36894. * @returns true if the size was changed
  36895. */
  36896. setSize(width: number, height: number): boolean;
  36897. /**
  36898. * Binds the frame buffer to the specified texture.
  36899. * @param texture The texture to render to or null for the default canvas
  36900. * @param faceIndex The face of the texture to render to in case of cube texture
  36901. * @param requiredWidth The width of the target to render to
  36902. * @param requiredHeight The height of the target to render to
  36903. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36904. * @param lodLevel defines the lod level to bind to the frame buffer
  36905. * @param layer defines the 2d array index to bind to frame buffer to
  36906. */
  36907. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36908. /** @hidden */
  36909. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36910. /**
  36911. * Unbind the current render target texture from the webGL context
  36912. * @param texture defines the render target texture to unbind
  36913. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36914. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36915. */
  36916. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36917. /**
  36918. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36919. */
  36920. flushFramebuffer(): void;
  36921. /**
  36922. * Unbind the current render target and bind the default framebuffer
  36923. */
  36924. restoreDefaultFramebuffer(): void;
  36925. /** @hidden */
  36926. protected _resetVertexBufferBinding(): void;
  36927. /**
  36928. * Creates a vertex buffer
  36929. * @param data the data for the vertex buffer
  36930. * @returns the new WebGL static buffer
  36931. */
  36932. createVertexBuffer(data: DataArray): DataBuffer;
  36933. private _createVertexBuffer;
  36934. /**
  36935. * Creates a dynamic vertex buffer
  36936. * @param data the data for the dynamic vertex buffer
  36937. * @returns the new WebGL dynamic buffer
  36938. */
  36939. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36940. protected _resetIndexBufferBinding(): void;
  36941. /**
  36942. * Creates a new index buffer
  36943. * @param indices defines the content of the index buffer
  36944. * @param updatable defines if the index buffer must be updatable
  36945. * @returns a new webGL buffer
  36946. */
  36947. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36948. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36949. /**
  36950. * Bind a webGL buffer to the webGL context
  36951. * @param buffer defines the buffer to bind
  36952. */
  36953. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36954. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36955. private bindBuffer;
  36956. /**
  36957. * update the bound buffer with the given data
  36958. * @param data defines the data to update
  36959. */
  36960. updateArrayBuffer(data: Float32Array): void;
  36961. private _vertexAttribPointer;
  36962. /** @hidden */
  36963. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36964. private _bindVertexBuffersAttributes;
  36965. /**
  36966. * Records a vertex array object
  36967. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36968. * @param vertexBuffers defines the list of vertex buffers to store
  36969. * @param indexBuffer defines the index buffer to store
  36970. * @param effect defines the effect to store
  36971. * @returns the new vertex array object
  36972. */
  36973. recordVertexArrayObject(vertexBuffers: {
  36974. [key: string]: VertexBuffer;
  36975. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36976. /**
  36977. * Bind a specific vertex array object
  36978. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36979. * @param vertexArrayObject defines the vertex array object to bind
  36980. * @param indexBuffer defines the index buffer to bind
  36981. */
  36982. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36983. /**
  36984. * Bind webGl buffers directly to the webGL context
  36985. * @param vertexBuffer defines the vertex buffer to bind
  36986. * @param indexBuffer defines the index buffer to bind
  36987. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36988. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36989. * @param effect defines the effect associated with the vertex buffer
  36990. */
  36991. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36992. private _unbindVertexArrayObject;
  36993. /**
  36994. * Bind a list of vertex buffers to the webGL context
  36995. * @param vertexBuffers defines the list of vertex buffers to bind
  36996. * @param indexBuffer defines the index buffer to bind
  36997. * @param effect defines the effect associated with the vertex buffers
  36998. */
  36999. bindBuffers(vertexBuffers: {
  37000. [key: string]: Nullable<VertexBuffer>;
  37001. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37002. /**
  37003. * Unbind all instance attributes
  37004. */
  37005. unbindInstanceAttributes(): void;
  37006. /**
  37007. * Release and free the memory of a vertex array object
  37008. * @param vao defines the vertex array object to delete
  37009. */
  37010. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37011. /** @hidden */
  37012. _releaseBuffer(buffer: DataBuffer): boolean;
  37013. protected _deleteBuffer(buffer: DataBuffer): void;
  37014. /**
  37015. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37016. * @param instancesBuffer defines the webGL buffer to update and bind
  37017. * @param data defines the data to store in the buffer
  37018. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37019. */
  37020. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37021. /**
  37022. * Bind the content of a webGL buffer used with instantiation
  37023. * @param instancesBuffer defines the webGL buffer to bind
  37024. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37025. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37026. */
  37027. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37028. /**
  37029. * Disable the instance attribute corresponding to the name in parameter
  37030. * @param name defines the name of the attribute to disable
  37031. */
  37032. disableInstanceAttributeByName(name: string): void;
  37033. /**
  37034. * Disable the instance attribute corresponding to the location in parameter
  37035. * @param attributeLocation defines the attribute location of the attribute to disable
  37036. */
  37037. disableInstanceAttribute(attributeLocation: number): void;
  37038. /**
  37039. * Disable the attribute corresponding to the location in parameter
  37040. * @param attributeLocation defines the attribute location of the attribute to disable
  37041. */
  37042. disableAttributeByIndex(attributeLocation: number): void;
  37043. /**
  37044. * Send a draw order
  37045. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37046. * @param indexStart defines the starting index
  37047. * @param indexCount defines the number of index to draw
  37048. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37049. */
  37050. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37051. /**
  37052. * Draw a list of points
  37053. * @param verticesStart defines the index of first vertex to draw
  37054. * @param verticesCount defines the count of vertices to draw
  37055. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37056. */
  37057. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37058. /**
  37059. * Draw a list of unindexed primitives
  37060. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37061. * @param verticesStart defines the index of first vertex to draw
  37062. * @param verticesCount defines the count of vertices to draw
  37063. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37064. */
  37065. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37066. /**
  37067. * Draw a list of indexed primitives
  37068. * @param fillMode defines the primitive to use
  37069. * @param indexStart defines the starting index
  37070. * @param indexCount defines the number of index to draw
  37071. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37072. */
  37073. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37074. /**
  37075. * Draw a list of unindexed primitives
  37076. * @param fillMode defines the primitive to use
  37077. * @param verticesStart defines the index of first vertex to draw
  37078. * @param verticesCount defines the count of vertices to draw
  37079. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37080. */
  37081. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37082. private _drawMode;
  37083. /** @hidden */
  37084. protected _reportDrawCall(): void;
  37085. /** @hidden */
  37086. _releaseEffect(effect: Effect): void;
  37087. /** @hidden */
  37088. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37089. /**
  37090. * Create a new effect (used to store vertex/fragment shaders)
  37091. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37092. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37093. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37094. * @param samplers defines an array of string used to represent textures
  37095. * @param defines defines the string containing the defines to use to compile the shaders
  37096. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37097. * @param onCompiled defines a function to call when the effect creation is successful
  37098. * @param onError defines a function to call when the effect creation has failed
  37099. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37100. * @returns the new Effect
  37101. */
  37102. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  37103. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37104. private _compileShader;
  37105. private _compileRawShader;
  37106. /** @hidden */
  37107. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37108. /**
  37109. * Directly creates a webGL program
  37110. * @param pipelineContext defines the pipeline context to attach to
  37111. * @param vertexCode defines the vertex shader code to use
  37112. * @param fragmentCode defines the fragment shader code to use
  37113. * @param context defines the webGL context to use (if not set, the current one will be used)
  37114. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37115. * @returns the new webGL program
  37116. */
  37117. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37118. /**
  37119. * Creates a webGL program
  37120. * @param pipelineContext defines the pipeline context to attach to
  37121. * @param vertexCode defines the vertex shader code to use
  37122. * @param fragmentCode defines the fragment shader code to use
  37123. * @param defines defines the string containing the defines to use to compile the shaders
  37124. * @param context defines the webGL context to use (if not set, the current one will be used)
  37125. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37126. * @returns the new webGL program
  37127. */
  37128. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37129. /**
  37130. * Creates a new pipeline context
  37131. * @returns the new pipeline
  37132. */
  37133. createPipelineContext(): IPipelineContext;
  37134. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37135. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37136. /** @hidden */
  37137. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37138. /** @hidden */
  37139. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37140. /** @hidden */
  37141. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37142. /**
  37143. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37144. * @param pipelineContext defines the pipeline context to use
  37145. * @param uniformsNames defines the list of uniform names
  37146. * @returns an array of webGL uniform locations
  37147. */
  37148. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37149. /**
  37150. * Gets the lsit of active attributes for a given webGL program
  37151. * @param pipelineContext defines the pipeline context to use
  37152. * @param attributesNames defines the list of attribute names to get
  37153. * @returns an array of indices indicating the offset of each attribute
  37154. */
  37155. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37156. /**
  37157. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37158. * @param effect defines the effect to activate
  37159. */
  37160. enableEffect(effect: Nullable<Effect>): void;
  37161. /**
  37162. * Set the value of an uniform to a number (int)
  37163. * @param uniform defines the webGL uniform location where to store the value
  37164. * @param value defines the int number to store
  37165. */
  37166. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37167. /**
  37168. * Set the value of an uniform to an array of int32
  37169. * @param uniform defines the webGL uniform location where to store the value
  37170. * @param array defines the array of int32 to store
  37171. */
  37172. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37173. /**
  37174. * Set the value of an uniform to an array of int32 (stored as vec2)
  37175. * @param uniform defines the webGL uniform location where to store the value
  37176. * @param array defines the array of int32 to store
  37177. */
  37178. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37179. /**
  37180. * Set the value of an uniform to an array of int32 (stored as vec3)
  37181. * @param uniform defines the webGL uniform location where to store the value
  37182. * @param array defines the array of int32 to store
  37183. */
  37184. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37185. /**
  37186. * Set the value of an uniform to an array of int32 (stored as vec4)
  37187. * @param uniform defines the webGL uniform location where to store the value
  37188. * @param array defines the array of int32 to store
  37189. */
  37190. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37191. /**
  37192. * Set the value of an uniform to an array of number
  37193. * @param uniform defines the webGL uniform location where to store the value
  37194. * @param array defines the array of number to store
  37195. */
  37196. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37197. /**
  37198. * Set the value of an uniform to an array of number (stored as vec2)
  37199. * @param uniform defines the webGL uniform location where to store the value
  37200. * @param array defines the array of number to store
  37201. */
  37202. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37203. /**
  37204. * Set the value of an uniform to an array of number (stored as vec3)
  37205. * @param uniform defines the webGL uniform location where to store the value
  37206. * @param array defines the array of number to store
  37207. */
  37208. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37209. /**
  37210. * Set the value of an uniform to an array of number (stored as vec4)
  37211. * @param uniform defines the webGL uniform location where to store the value
  37212. * @param array defines the array of number to store
  37213. */
  37214. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37215. /**
  37216. * Set the value of an uniform to an array of float32 (stored as matrices)
  37217. * @param uniform defines the webGL uniform location where to store the value
  37218. * @param matrices defines the array of float32 to store
  37219. */
  37220. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37221. /**
  37222. * Set the value of an uniform to a matrix (3x3)
  37223. * @param uniform defines the webGL uniform location where to store the value
  37224. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37225. */
  37226. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37227. /**
  37228. * Set the value of an uniform to a matrix (2x2)
  37229. * @param uniform defines the webGL uniform location where to store the value
  37230. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37231. */
  37232. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37233. /**
  37234. * Set the value of an uniform to a number (float)
  37235. * @param uniform defines the webGL uniform location where to store the value
  37236. * @param value defines the float number to store
  37237. */
  37238. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37239. /**
  37240. * Set the value of an uniform to a vec2
  37241. * @param uniform defines the webGL uniform location where to store the value
  37242. * @param x defines the 1st component of the value
  37243. * @param y defines the 2nd component of the value
  37244. */
  37245. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37246. /**
  37247. * Set the value of an uniform to a vec3
  37248. * @param uniform defines the webGL uniform location where to store the value
  37249. * @param x defines the 1st component of the value
  37250. * @param y defines the 2nd component of the value
  37251. * @param z defines the 3rd component of the value
  37252. */
  37253. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37254. /**
  37255. * Set the value of an uniform to a vec4
  37256. * @param uniform defines the webGL uniform location where to store the value
  37257. * @param x defines the 1st component of the value
  37258. * @param y defines the 2nd component of the value
  37259. * @param z defines the 3rd component of the value
  37260. * @param w defines the 4th component of the value
  37261. */
  37262. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37263. /**
  37264. * Apply all cached states (depth, culling, stencil and alpha)
  37265. */
  37266. applyStates(): void;
  37267. /**
  37268. * Enable or disable color writing
  37269. * @param enable defines the state to set
  37270. */
  37271. setColorWrite(enable: boolean): void;
  37272. /**
  37273. * Gets a boolean indicating if color writing is enabled
  37274. * @returns the current color writing state
  37275. */
  37276. getColorWrite(): boolean;
  37277. /**
  37278. * Gets the depth culling state manager
  37279. */
  37280. get depthCullingState(): DepthCullingState;
  37281. /**
  37282. * Gets the alpha state manager
  37283. */
  37284. get alphaState(): AlphaState;
  37285. /**
  37286. * Gets the stencil state manager
  37287. */
  37288. get stencilState(): StencilState;
  37289. /**
  37290. * Clears the list of texture accessible through engine.
  37291. * This can help preventing texture load conflict due to name collision.
  37292. */
  37293. clearInternalTexturesCache(): void;
  37294. /**
  37295. * Force the entire cache to be cleared
  37296. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37297. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37298. */
  37299. wipeCaches(bruteForce?: boolean): void;
  37300. /** @hidden */
  37301. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37302. min: number;
  37303. mag: number;
  37304. };
  37305. /** @hidden */
  37306. _createTexture(): WebGLTexture;
  37307. /**
  37308. * Usually called from Texture.ts.
  37309. * Passed information to create a WebGLTexture
  37310. * @param url defines a value which contains one of the following:
  37311. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37312. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37313. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37314. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37315. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  37316. * @param scene needed for loading to the correct scene
  37317. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37318. * @param onLoad optional callback to be called upon successful completion
  37319. * @param onError optional callback to be called upon failure
  37320. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  37321. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37322. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37323. * @param forcedExtension defines the extension to use to pick the right loader
  37324. * @param mimeType defines an optional mime type
  37325. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37326. */
  37327. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  37328. /**
  37329. * Loads an image as an HTMLImageElement.
  37330. * @param input url string, ArrayBuffer, or Blob to load
  37331. * @param onLoad callback called when the image successfully loads
  37332. * @param onError callback called when the image fails to load
  37333. * @param offlineProvider offline provider for caching
  37334. * @param mimeType optional mime type
  37335. * @returns the HTMLImageElement of the loaded image
  37336. * @hidden
  37337. */
  37338. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  37339. /**
  37340. * @hidden
  37341. */
  37342. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37343. private _unpackFlipYCached;
  37344. /**
  37345. * In case you are sharing the context with other applications, it might
  37346. * be interested to not cache the unpack flip y state to ensure a consistent
  37347. * value would be set.
  37348. */
  37349. enableUnpackFlipYCached: boolean;
  37350. /** @hidden */
  37351. _unpackFlipY(value: boolean): void;
  37352. /** @hidden */
  37353. _getUnpackAlignement(): number;
  37354. private _getTextureTarget;
  37355. /**
  37356. * Update the sampling mode of a given texture
  37357. * @param samplingMode defines the required sampling mode
  37358. * @param texture defines the texture to update
  37359. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37360. */
  37361. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37362. /**
  37363. * Update the sampling mode of a given texture
  37364. * @param texture defines the texture to update
  37365. * @param wrapU defines the texture wrap mode of the u coordinates
  37366. * @param wrapV defines the texture wrap mode of the v coordinates
  37367. * @param wrapR defines the texture wrap mode of the r coordinates
  37368. */
  37369. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37370. /** @hidden */
  37371. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37372. width: number;
  37373. height: number;
  37374. layers?: number;
  37375. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37376. /** @hidden */
  37377. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37378. /** @hidden */
  37379. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37380. /**
  37381. * Update a portion of an internal texture
  37382. * @param texture defines the texture to update
  37383. * @param imageData defines the data to store into the texture
  37384. * @param xOffset defines the x coordinates of the update rectangle
  37385. * @param yOffset defines the y coordinates of the update rectangle
  37386. * @param width defines the width of the update rectangle
  37387. * @param height defines the height of the update rectangle
  37388. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37389. * @param lod defines the lod level to update (0 by default)
  37390. */
  37391. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37392. /** @hidden */
  37393. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37394. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37395. private _prepareWebGLTexture;
  37396. /** @hidden */
  37397. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37398. private _getDepthStencilBuffer;
  37399. /** @hidden */
  37400. _releaseFramebufferObjects(texture: InternalTexture): void;
  37401. /** @hidden */
  37402. _releaseTexture(texture: InternalTexture): void;
  37403. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37404. protected _setProgram(program: WebGLProgram): void;
  37405. protected _boundUniforms: {
  37406. [key: number]: WebGLUniformLocation;
  37407. };
  37408. /**
  37409. * Binds an effect to the webGL context
  37410. * @param effect defines the effect to bind
  37411. */
  37412. bindSamplers(effect: Effect): void;
  37413. private _activateCurrentTexture;
  37414. /** @hidden */
  37415. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37416. /** @hidden */
  37417. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37418. /**
  37419. * Unbind all textures from the webGL context
  37420. */
  37421. unbindAllTextures(): void;
  37422. /**
  37423. * Sets a texture to the according uniform.
  37424. * @param channel The texture channel
  37425. * @param uniform The uniform to set
  37426. * @param texture The texture to apply
  37427. */
  37428. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37429. private _bindSamplerUniformToChannel;
  37430. private _getTextureWrapMode;
  37431. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37432. /**
  37433. * Sets an array of texture to the webGL context
  37434. * @param channel defines the channel where the texture array must be set
  37435. * @param uniform defines the associated uniform location
  37436. * @param textures defines the array of textures to bind
  37437. */
  37438. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37439. /** @hidden */
  37440. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37441. private _setTextureParameterFloat;
  37442. private _setTextureParameterInteger;
  37443. /**
  37444. * Unbind all vertex attributes from the webGL context
  37445. */
  37446. unbindAllAttributes(): void;
  37447. /**
  37448. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  37449. */
  37450. releaseEffects(): void;
  37451. /**
  37452. * Dispose and release all associated resources
  37453. */
  37454. dispose(): void;
  37455. /**
  37456. * Attach a new callback raised when context lost event is fired
  37457. * @param callback defines the callback to call
  37458. */
  37459. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37460. /**
  37461. * Attach a new callback raised when context restored event is fired
  37462. * @param callback defines the callback to call
  37463. */
  37464. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37465. /**
  37466. * Get the current error code of the webGL context
  37467. * @returns the error code
  37468. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37469. */
  37470. getError(): number;
  37471. private _canRenderToFloatFramebuffer;
  37472. private _canRenderToHalfFloatFramebuffer;
  37473. private _canRenderToFramebuffer;
  37474. /** @hidden */
  37475. _getWebGLTextureType(type: number): number;
  37476. /** @hidden */
  37477. _getInternalFormat(format: number): number;
  37478. /** @hidden */
  37479. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37480. /** @hidden */
  37481. _getRGBAMultiSampleBufferFormat(type: number): number;
  37482. /** @hidden */
  37483. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  37484. /**
  37485. * Loads a file from a url
  37486. * @param url url to load
  37487. * @param onSuccess callback called when the file successfully loads
  37488. * @param onProgress callback called while file is loading (if the server supports this mode)
  37489. * @param offlineProvider defines the offline provider for caching
  37490. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37491. * @param onError callback called when the file fails to load
  37492. * @returns a file request object
  37493. * @hidden
  37494. */
  37495. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  37496. /**
  37497. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37498. * @param x defines the x coordinate of the rectangle where pixels must be read
  37499. * @param y defines the y coordinate of the rectangle where pixels must be read
  37500. * @param width defines the width of the rectangle where pixels must be read
  37501. * @param height defines the height of the rectangle where pixels must be read
  37502. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37503. * @returns a Uint8Array containing RGBA colors
  37504. */
  37505. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37506. private static _isSupported;
  37507. /**
  37508. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37509. * @returns true if the engine can be created
  37510. * @ignorenaming
  37511. */
  37512. static isSupported(): boolean;
  37513. /**
  37514. * Find the next highest power of two.
  37515. * @param x Number to start search from.
  37516. * @return Next highest power of two.
  37517. */
  37518. static CeilingPOT(x: number): number;
  37519. /**
  37520. * Find the next lowest power of two.
  37521. * @param x Number to start search from.
  37522. * @return Next lowest power of two.
  37523. */
  37524. static FloorPOT(x: number): number;
  37525. /**
  37526. * Find the nearest power of two.
  37527. * @param x Number to start search from.
  37528. * @return Next nearest power of two.
  37529. */
  37530. static NearestPOT(x: number): number;
  37531. /**
  37532. * Get the closest exponent of two
  37533. * @param value defines the value to approximate
  37534. * @param max defines the maximum value to return
  37535. * @param mode defines how to define the closest value
  37536. * @returns closest exponent of two of the given value
  37537. */
  37538. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37539. /**
  37540. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37541. * @param func - the function to be called
  37542. * @param requester - the object that will request the next frame. Falls back to window.
  37543. * @returns frame number
  37544. */
  37545. static QueueNewFrame(func: () => void, requester?: any): number;
  37546. /**
  37547. * Gets host document
  37548. * @returns the host document object
  37549. */
  37550. getHostDocument(): Nullable<Document>;
  37551. }
  37552. }
  37553. declare module "babylonjs/Maths/sphericalPolynomial" {
  37554. import { Vector3 } from "babylonjs/Maths/math.vector";
  37555. import { Color3 } from "babylonjs/Maths/math.color";
  37556. /**
  37557. * Class representing spherical harmonics coefficients to the 3rd degree
  37558. */
  37559. export class SphericalHarmonics {
  37560. /**
  37561. * Defines whether or not the harmonics have been prescaled for rendering.
  37562. */
  37563. preScaled: boolean;
  37564. /**
  37565. * The l0,0 coefficients of the spherical harmonics
  37566. */
  37567. l00: Vector3;
  37568. /**
  37569. * The l1,-1 coefficients of the spherical harmonics
  37570. */
  37571. l1_1: Vector3;
  37572. /**
  37573. * The l1,0 coefficients of the spherical harmonics
  37574. */
  37575. l10: Vector3;
  37576. /**
  37577. * The l1,1 coefficients of the spherical harmonics
  37578. */
  37579. l11: Vector3;
  37580. /**
  37581. * The l2,-2 coefficients of the spherical harmonics
  37582. */
  37583. l2_2: Vector3;
  37584. /**
  37585. * The l2,-1 coefficients of the spherical harmonics
  37586. */
  37587. l2_1: Vector3;
  37588. /**
  37589. * The l2,0 coefficients of the spherical harmonics
  37590. */
  37591. l20: Vector3;
  37592. /**
  37593. * The l2,1 coefficients of the spherical harmonics
  37594. */
  37595. l21: Vector3;
  37596. /**
  37597. * The l2,2 coefficients of the spherical harmonics
  37598. */
  37599. l22: Vector3;
  37600. /**
  37601. * Adds a light to the spherical harmonics
  37602. * @param direction the direction of the light
  37603. * @param color the color of the light
  37604. * @param deltaSolidAngle the delta solid angle of the light
  37605. */
  37606. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37607. /**
  37608. * Scales the spherical harmonics by the given amount
  37609. * @param scale the amount to scale
  37610. */
  37611. scaleInPlace(scale: number): void;
  37612. /**
  37613. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37614. *
  37615. * ```
  37616. * E_lm = A_l * L_lm
  37617. * ```
  37618. *
  37619. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37620. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37621. * the scaling factors are given in equation 9.
  37622. */
  37623. convertIncidentRadianceToIrradiance(): void;
  37624. /**
  37625. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37626. *
  37627. * ```
  37628. * L = (1/pi) * E * rho
  37629. * ```
  37630. *
  37631. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37632. */
  37633. convertIrradianceToLambertianRadiance(): void;
  37634. /**
  37635. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37636. * required operations at run time.
  37637. *
  37638. * This is simply done by scaling back the SH with Ylm constants parameter.
  37639. * The trigonometric part being applied by the shader at run time.
  37640. */
  37641. preScaleForRendering(): void;
  37642. /**
  37643. * Constructs a spherical harmonics from an array.
  37644. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37645. * @returns the spherical harmonics
  37646. */
  37647. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37648. /**
  37649. * Gets the spherical harmonics from polynomial
  37650. * @param polynomial the spherical polynomial
  37651. * @returns the spherical harmonics
  37652. */
  37653. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37654. }
  37655. /**
  37656. * Class representing spherical polynomial coefficients to the 3rd degree
  37657. */
  37658. export class SphericalPolynomial {
  37659. private _harmonics;
  37660. /**
  37661. * The spherical harmonics used to create the polynomials.
  37662. */
  37663. get preScaledHarmonics(): SphericalHarmonics;
  37664. /**
  37665. * The x coefficients of the spherical polynomial
  37666. */
  37667. x: Vector3;
  37668. /**
  37669. * The y coefficients of the spherical polynomial
  37670. */
  37671. y: Vector3;
  37672. /**
  37673. * The z coefficients of the spherical polynomial
  37674. */
  37675. z: Vector3;
  37676. /**
  37677. * The xx coefficients of the spherical polynomial
  37678. */
  37679. xx: Vector3;
  37680. /**
  37681. * The yy coefficients of the spherical polynomial
  37682. */
  37683. yy: Vector3;
  37684. /**
  37685. * The zz coefficients of the spherical polynomial
  37686. */
  37687. zz: Vector3;
  37688. /**
  37689. * The xy coefficients of the spherical polynomial
  37690. */
  37691. xy: Vector3;
  37692. /**
  37693. * The yz coefficients of the spherical polynomial
  37694. */
  37695. yz: Vector3;
  37696. /**
  37697. * The zx coefficients of the spherical polynomial
  37698. */
  37699. zx: Vector3;
  37700. /**
  37701. * Adds an ambient color to the spherical polynomial
  37702. * @param color the color to add
  37703. */
  37704. addAmbient(color: Color3): void;
  37705. /**
  37706. * Scales the spherical polynomial by the given amount
  37707. * @param scale the amount to scale
  37708. */
  37709. scaleInPlace(scale: number): void;
  37710. /**
  37711. * Gets the spherical polynomial from harmonics
  37712. * @param harmonics the spherical harmonics
  37713. * @returns the spherical polynomial
  37714. */
  37715. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37716. /**
  37717. * Constructs a spherical polynomial from an array.
  37718. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37719. * @returns the spherical polynomial
  37720. */
  37721. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37722. }
  37723. }
  37724. declare module "babylonjs/Materials/Textures/internalTexture" {
  37725. import { Observable } from "babylonjs/Misc/observable";
  37726. import { Nullable, int } from "babylonjs/types";
  37727. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37728. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37729. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37730. /**
  37731. * Defines the source of the internal texture
  37732. */
  37733. export enum InternalTextureSource {
  37734. /**
  37735. * The source of the texture data is unknown
  37736. */
  37737. Unknown = 0,
  37738. /**
  37739. * Texture data comes from an URL
  37740. */
  37741. Url = 1,
  37742. /**
  37743. * Texture data is only used for temporary storage
  37744. */
  37745. Temp = 2,
  37746. /**
  37747. * Texture data comes from raw data (ArrayBuffer)
  37748. */
  37749. Raw = 3,
  37750. /**
  37751. * Texture content is dynamic (video or dynamic texture)
  37752. */
  37753. Dynamic = 4,
  37754. /**
  37755. * Texture content is generated by rendering to it
  37756. */
  37757. RenderTarget = 5,
  37758. /**
  37759. * Texture content is part of a multi render target process
  37760. */
  37761. MultiRenderTarget = 6,
  37762. /**
  37763. * Texture data comes from a cube data file
  37764. */
  37765. Cube = 7,
  37766. /**
  37767. * Texture data comes from a raw cube data
  37768. */
  37769. CubeRaw = 8,
  37770. /**
  37771. * Texture data come from a prefiltered cube data file
  37772. */
  37773. CubePrefiltered = 9,
  37774. /**
  37775. * Texture content is raw 3D data
  37776. */
  37777. Raw3D = 10,
  37778. /**
  37779. * Texture content is raw 2D array data
  37780. */
  37781. Raw2DArray = 11,
  37782. /**
  37783. * Texture content is a depth texture
  37784. */
  37785. Depth = 12,
  37786. /**
  37787. * Texture data comes from a raw cube data encoded with RGBD
  37788. */
  37789. CubeRawRGBD = 13
  37790. }
  37791. /**
  37792. * Class used to store data associated with WebGL texture data for the engine
  37793. * This class should not be used directly
  37794. */
  37795. export class InternalTexture {
  37796. /** @hidden */
  37797. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37798. /**
  37799. * Defines if the texture is ready
  37800. */
  37801. isReady: boolean;
  37802. /**
  37803. * Defines if the texture is a cube texture
  37804. */
  37805. isCube: boolean;
  37806. /**
  37807. * Defines if the texture contains 3D data
  37808. */
  37809. is3D: boolean;
  37810. /**
  37811. * Defines if the texture contains 2D array data
  37812. */
  37813. is2DArray: boolean;
  37814. /**
  37815. * Defines if the texture contains multiview data
  37816. */
  37817. isMultiview: boolean;
  37818. /**
  37819. * Gets the URL used to load this texture
  37820. */
  37821. url: string;
  37822. /**
  37823. * Gets the sampling mode of the texture
  37824. */
  37825. samplingMode: number;
  37826. /**
  37827. * Gets a boolean indicating if the texture needs mipmaps generation
  37828. */
  37829. generateMipMaps: boolean;
  37830. /**
  37831. * Gets the number of samples used by the texture (WebGL2+ only)
  37832. */
  37833. samples: number;
  37834. /**
  37835. * Gets the type of the texture (int, float...)
  37836. */
  37837. type: number;
  37838. /**
  37839. * Gets the format of the texture (RGB, RGBA...)
  37840. */
  37841. format: number;
  37842. /**
  37843. * Observable called when the texture is loaded
  37844. */
  37845. onLoadedObservable: Observable<InternalTexture>;
  37846. /**
  37847. * Gets the width of the texture
  37848. */
  37849. width: number;
  37850. /**
  37851. * Gets the height of the texture
  37852. */
  37853. height: number;
  37854. /**
  37855. * Gets the depth of the texture
  37856. */
  37857. depth: number;
  37858. /**
  37859. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37860. */
  37861. baseWidth: number;
  37862. /**
  37863. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37864. */
  37865. baseHeight: number;
  37866. /**
  37867. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37868. */
  37869. baseDepth: number;
  37870. /**
  37871. * Gets a boolean indicating if the texture is inverted on Y axis
  37872. */
  37873. invertY: boolean;
  37874. /** @hidden */
  37875. _invertVScale: boolean;
  37876. /** @hidden */
  37877. _associatedChannel: number;
  37878. /** @hidden */
  37879. _source: InternalTextureSource;
  37880. /** @hidden */
  37881. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37882. /** @hidden */
  37883. _bufferView: Nullable<ArrayBufferView>;
  37884. /** @hidden */
  37885. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37886. /** @hidden */
  37887. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37888. /** @hidden */
  37889. _size: number;
  37890. /** @hidden */
  37891. _extension: string;
  37892. /** @hidden */
  37893. _files: Nullable<string[]>;
  37894. /** @hidden */
  37895. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37896. /** @hidden */
  37897. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37898. /** @hidden */
  37899. _framebuffer: Nullable<WebGLFramebuffer>;
  37900. /** @hidden */
  37901. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37902. /** @hidden */
  37903. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37904. /** @hidden */
  37905. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37906. /** @hidden */
  37907. _attachments: Nullable<number[]>;
  37908. /** @hidden */
  37909. _textureArray: Nullable<InternalTexture[]>;
  37910. /** @hidden */
  37911. _cachedCoordinatesMode: Nullable<number>;
  37912. /** @hidden */
  37913. _cachedWrapU: Nullable<number>;
  37914. /** @hidden */
  37915. _cachedWrapV: Nullable<number>;
  37916. /** @hidden */
  37917. _cachedWrapR: Nullable<number>;
  37918. /** @hidden */
  37919. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37920. /** @hidden */
  37921. _isDisabled: boolean;
  37922. /** @hidden */
  37923. _compression: Nullable<string>;
  37924. /** @hidden */
  37925. _generateStencilBuffer: boolean;
  37926. /** @hidden */
  37927. _generateDepthBuffer: boolean;
  37928. /** @hidden */
  37929. _comparisonFunction: number;
  37930. /** @hidden */
  37931. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37932. /** @hidden */
  37933. _lodGenerationScale: number;
  37934. /** @hidden */
  37935. _lodGenerationOffset: number;
  37936. /** @hidden */
  37937. _depthStencilTexture: Nullable<InternalTexture>;
  37938. /** @hidden */
  37939. _colorTextureArray: Nullable<WebGLTexture>;
  37940. /** @hidden */
  37941. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37942. /** @hidden */
  37943. _lodTextureHigh: Nullable<BaseTexture>;
  37944. /** @hidden */
  37945. _lodTextureMid: Nullable<BaseTexture>;
  37946. /** @hidden */
  37947. _lodTextureLow: Nullable<BaseTexture>;
  37948. /** @hidden */
  37949. _isRGBD: boolean;
  37950. /** @hidden */
  37951. _linearSpecularLOD: boolean;
  37952. /** @hidden */
  37953. _irradianceTexture: Nullable<BaseTexture>;
  37954. /** @hidden */
  37955. _webGLTexture: Nullable<WebGLTexture>;
  37956. /** @hidden */
  37957. _references: number;
  37958. private _engine;
  37959. /**
  37960. * Gets the Engine the texture belongs to.
  37961. * @returns The babylon engine
  37962. */
  37963. getEngine(): ThinEngine;
  37964. /**
  37965. * Gets the data source type of the texture
  37966. */
  37967. get source(): InternalTextureSource;
  37968. /**
  37969. * Creates a new InternalTexture
  37970. * @param engine defines the engine to use
  37971. * @param source defines the type of data that will be used
  37972. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37973. */
  37974. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37975. /**
  37976. * Increments the number of references (ie. the number of Texture that point to it)
  37977. */
  37978. incrementReferences(): void;
  37979. /**
  37980. * Change the size of the texture (not the size of the content)
  37981. * @param width defines the new width
  37982. * @param height defines the new height
  37983. * @param depth defines the new depth (1 by default)
  37984. */
  37985. updateSize(width: int, height: int, depth?: int): void;
  37986. /** @hidden */
  37987. _rebuild(): void;
  37988. /** @hidden */
  37989. _swapAndDie(target: InternalTexture): void;
  37990. /**
  37991. * Dispose the current allocated resources
  37992. */
  37993. dispose(): void;
  37994. }
  37995. }
  37996. declare module "babylonjs/Audio/analyser" {
  37997. import { Scene } from "babylonjs/scene";
  37998. /**
  37999. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38000. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38001. */
  38002. export class Analyser {
  38003. /**
  38004. * Gets or sets the smoothing
  38005. * @ignorenaming
  38006. */
  38007. SMOOTHING: number;
  38008. /**
  38009. * Gets or sets the FFT table size
  38010. * @ignorenaming
  38011. */
  38012. FFT_SIZE: number;
  38013. /**
  38014. * Gets or sets the bar graph amplitude
  38015. * @ignorenaming
  38016. */
  38017. BARGRAPHAMPLITUDE: number;
  38018. /**
  38019. * Gets or sets the position of the debug canvas
  38020. * @ignorenaming
  38021. */
  38022. DEBUGCANVASPOS: {
  38023. x: number;
  38024. y: number;
  38025. };
  38026. /**
  38027. * Gets or sets the debug canvas size
  38028. * @ignorenaming
  38029. */
  38030. DEBUGCANVASSIZE: {
  38031. width: number;
  38032. height: number;
  38033. };
  38034. private _byteFreqs;
  38035. private _byteTime;
  38036. private _floatFreqs;
  38037. private _webAudioAnalyser;
  38038. private _debugCanvas;
  38039. private _debugCanvasContext;
  38040. private _scene;
  38041. private _registerFunc;
  38042. private _audioEngine;
  38043. /**
  38044. * Creates a new analyser
  38045. * @param scene defines hosting scene
  38046. */
  38047. constructor(scene: Scene);
  38048. /**
  38049. * Get the number of data values you will have to play with for the visualization
  38050. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38051. * @returns a number
  38052. */
  38053. getFrequencyBinCount(): number;
  38054. /**
  38055. * Gets the current frequency data as a byte array
  38056. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38057. * @returns a Uint8Array
  38058. */
  38059. getByteFrequencyData(): Uint8Array;
  38060. /**
  38061. * Gets the current waveform as a byte array
  38062. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38063. * @returns a Uint8Array
  38064. */
  38065. getByteTimeDomainData(): Uint8Array;
  38066. /**
  38067. * Gets the current frequency data as a float array
  38068. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38069. * @returns a Float32Array
  38070. */
  38071. getFloatFrequencyData(): Float32Array;
  38072. /**
  38073. * Renders the debug canvas
  38074. */
  38075. drawDebugCanvas(): void;
  38076. /**
  38077. * Stops rendering the debug canvas and removes it
  38078. */
  38079. stopDebugCanvas(): void;
  38080. /**
  38081. * Connects two audio nodes
  38082. * @param inputAudioNode defines first node to connect
  38083. * @param outputAudioNode defines second node to connect
  38084. */
  38085. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38086. /**
  38087. * Releases all associated resources
  38088. */
  38089. dispose(): void;
  38090. }
  38091. }
  38092. declare module "babylonjs/Audio/audioEngine" {
  38093. import { IDisposable } from "babylonjs/scene";
  38094. import { Analyser } from "babylonjs/Audio/analyser";
  38095. import { Nullable } from "babylonjs/types";
  38096. import { Observable } from "babylonjs/Misc/observable";
  38097. /**
  38098. * This represents an audio engine and it is responsible
  38099. * to play, synchronize and analyse sounds throughout the application.
  38100. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38101. */
  38102. export interface IAudioEngine extends IDisposable {
  38103. /**
  38104. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38105. */
  38106. readonly canUseWebAudio: boolean;
  38107. /**
  38108. * Gets the current AudioContext if available.
  38109. */
  38110. readonly audioContext: Nullable<AudioContext>;
  38111. /**
  38112. * The master gain node defines the global audio volume of your audio engine.
  38113. */
  38114. readonly masterGain: GainNode;
  38115. /**
  38116. * Gets whether or not mp3 are supported by your browser.
  38117. */
  38118. readonly isMP3supported: boolean;
  38119. /**
  38120. * Gets whether or not ogg are supported by your browser.
  38121. */
  38122. readonly isOGGsupported: boolean;
  38123. /**
  38124. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38125. * @ignoreNaming
  38126. */
  38127. WarnedWebAudioUnsupported: boolean;
  38128. /**
  38129. * Defines if the audio engine relies on a custom unlocked button.
  38130. * In this case, the embedded button will not be displayed.
  38131. */
  38132. useCustomUnlockedButton: boolean;
  38133. /**
  38134. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38135. */
  38136. readonly unlocked: boolean;
  38137. /**
  38138. * Event raised when audio has been unlocked on the browser.
  38139. */
  38140. onAudioUnlockedObservable: Observable<AudioEngine>;
  38141. /**
  38142. * Event raised when audio has been locked on the browser.
  38143. */
  38144. onAudioLockedObservable: Observable<AudioEngine>;
  38145. /**
  38146. * Flags the audio engine in Locked state.
  38147. * This happens due to new browser policies preventing audio to autoplay.
  38148. */
  38149. lock(): void;
  38150. /**
  38151. * Unlocks the audio engine once a user action has been done on the dom.
  38152. * This is helpful to resume play once browser policies have been satisfied.
  38153. */
  38154. unlock(): void;
  38155. /**
  38156. * Gets the global volume sets on the master gain.
  38157. * @returns the global volume if set or -1 otherwise
  38158. */
  38159. getGlobalVolume(): number;
  38160. /**
  38161. * Sets the global volume of your experience (sets on the master gain).
  38162. * @param newVolume Defines the new global volume of the application
  38163. */
  38164. setGlobalVolume(newVolume: number): void;
  38165. /**
  38166. * Connect the audio engine to an audio analyser allowing some amazing
  38167. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38168. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38169. * @param analyser The analyser to connect to the engine
  38170. */
  38171. connectToAnalyser(analyser: Analyser): void;
  38172. }
  38173. /**
  38174. * This represents the default audio engine used in babylon.
  38175. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38176. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38177. */
  38178. export class AudioEngine implements IAudioEngine {
  38179. private _audioContext;
  38180. private _audioContextInitialized;
  38181. private _muteButton;
  38182. private _hostElement;
  38183. /**
  38184. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38185. */
  38186. canUseWebAudio: boolean;
  38187. /**
  38188. * The master gain node defines the global audio volume of your audio engine.
  38189. */
  38190. masterGain: GainNode;
  38191. /**
  38192. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38193. * @ignoreNaming
  38194. */
  38195. WarnedWebAudioUnsupported: boolean;
  38196. /**
  38197. * Gets whether or not mp3 are supported by your browser.
  38198. */
  38199. isMP3supported: boolean;
  38200. /**
  38201. * Gets whether or not ogg are supported by your browser.
  38202. */
  38203. isOGGsupported: boolean;
  38204. /**
  38205. * Gets whether audio has been unlocked on the device.
  38206. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38207. * a user interaction has happened.
  38208. */
  38209. unlocked: boolean;
  38210. /**
  38211. * Defines if the audio engine relies on a custom unlocked button.
  38212. * In this case, the embedded button will not be displayed.
  38213. */
  38214. useCustomUnlockedButton: boolean;
  38215. /**
  38216. * Event raised when audio has been unlocked on the browser.
  38217. */
  38218. onAudioUnlockedObservable: Observable<AudioEngine>;
  38219. /**
  38220. * Event raised when audio has been locked on the browser.
  38221. */
  38222. onAudioLockedObservable: Observable<AudioEngine>;
  38223. /**
  38224. * Gets the current AudioContext if available.
  38225. */
  38226. get audioContext(): Nullable<AudioContext>;
  38227. private _connectedAnalyser;
  38228. /**
  38229. * Instantiates a new audio engine.
  38230. *
  38231. * There should be only one per page as some browsers restrict the number
  38232. * of audio contexts you can create.
  38233. * @param hostElement defines the host element where to display the mute icon if necessary
  38234. */
  38235. constructor(hostElement?: Nullable<HTMLElement>);
  38236. /**
  38237. * Flags the audio engine in Locked state.
  38238. * This happens due to new browser policies preventing audio to autoplay.
  38239. */
  38240. lock(): void;
  38241. /**
  38242. * Unlocks the audio engine once a user action has been done on the dom.
  38243. * This is helpful to resume play once browser policies have been satisfied.
  38244. */
  38245. unlock(): void;
  38246. private _resumeAudioContext;
  38247. private _initializeAudioContext;
  38248. private _tryToRun;
  38249. private _triggerRunningState;
  38250. private _triggerSuspendedState;
  38251. private _displayMuteButton;
  38252. private _moveButtonToTopLeft;
  38253. private _onResize;
  38254. private _hideMuteButton;
  38255. /**
  38256. * Destroy and release the resources associated with the audio ccontext.
  38257. */
  38258. dispose(): void;
  38259. /**
  38260. * Gets the global volume sets on the master gain.
  38261. * @returns the global volume if set or -1 otherwise
  38262. */
  38263. getGlobalVolume(): number;
  38264. /**
  38265. * Sets the global volume of your experience (sets on the master gain).
  38266. * @param newVolume Defines the new global volume of the application
  38267. */
  38268. setGlobalVolume(newVolume: number): void;
  38269. /**
  38270. * Connect the audio engine to an audio analyser allowing some amazing
  38271. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38272. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38273. * @param analyser The analyser to connect to the engine
  38274. */
  38275. connectToAnalyser(analyser: Analyser): void;
  38276. }
  38277. }
  38278. declare module "babylonjs/Loading/loadingScreen" {
  38279. /**
  38280. * Interface used to present a loading screen while loading a scene
  38281. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38282. */
  38283. export interface ILoadingScreen {
  38284. /**
  38285. * Function called to display the loading screen
  38286. */
  38287. displayLoadingUI: () => void;
  38288. /**
  38289. * Function called to hide the loading screen
  38290. */
  38291. hideLoadingUI: () => void;
  38292. /**
  38293. * Gets or sets the color to use for the background
  38294. */
  38295. loadingUIBackgroundColor: string;
  38296. /**
  38297. * Gets or sets the text to display while loading
  38298. */
  38299. loadingUIText: string;
  38300. }
  38301. /**
  38302. * Class used for the default loading screen
  38303. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38304. */
  38305. export class DefaultLoadingScreen implements ILoadingScreen {
  38306. private _renderingCanvas;
  38307. private _loadingText;
  38308. private _loadingDivBackgroundColor;
  38309. private _loadingDiv;
  38310. private _loadingTextDiv;
  38311. /** Gets or sets the logo url to use for the default loading screen */
  38312. static DefaultLogoUrl: string;
  38313. /** Gets or sets the spinner url to use for the default loading screen */
  38314. static DefaultSpinnerUrl: string;
  38315. /**
  38316. * Creates a new default loading screen
  38317. * @param _renderingCanvas defines the canvas used to render the scene
  38318. * @param _loadingText defines the default text to display
  38319. * @param _loadingDivBackgroundColor defines the default background color
  38320. */
  38321. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38322. /**
  38323. * Function called to display the loading screen
  38324. */
  38325. displayLoadingUI(): void;
  38326. /**
  38327. * Function called to hide the loading screen
  38328. */
  38329. hideLoadingUI(): void;
  38330. /**
  38331. * Gets or sets the text to display while loading
  38332. */
  38333. set loadingUIText(text: string);
  38334. get loadingUIText(): string;
  38335. /**
  38336. * Gets or sets the color to use for the background
  38337. */
  38338. get loadingUIBackgroundColor(): string;
  38339. set loadingUIBackgroundColor(color: string);
  38340. private _resizeLoadingUI;
  38341. }
  38342. }
  38343. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38344. /**
  38345. * Interface for any object that can request an animation frame
  38346. */
  38347. export interface ICustomAnimationFrameRequester {
  38348. /**
  38349. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38350. */
  38351. renderFunction?: Function;
  38352. /**
  38353. * Called to request the next frame to render to
  38354. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38355. */
  38356. requestAnimationFrame: Function;
  38357. /**
  38358. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38359. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38360. */
  38361. requestID?: number;
  38362. }
  38363. }
  38364. declare module "babylonjs/Misc/performanceMonitor" {
  38365. /**
  38366. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38367. */
  38368. export class PerformanceMonitor {
  38369. private _enabled;
  38370. private _rollingFrameTime;
  38371. private _lastFrameTimeMs;
  38372. /**
  38373. * constructor
  38374. * @param frameSampleSize The number of samples required to saturate the sliding window
  38375. */
  38376. constructor(frameSampleSize?: number);
  38377. /**
  38378. * Samples current frame
  38379. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38380. */
  38381. sampleFrame(timeMs?: number): void;
  38382. /**
  38383. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38384. */
  38385. get averageFrameTime(): number;
  38386. /**
  38387. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38388. */
  38389. get averageFrameTimeVariance(): number;
  38390. /**
  38391. * Returns the frame time of the most recent frame
  38392. */
  38393. get instantaneousFrameTime(): number;
  38394. /**
  38395. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38396. */
  38397. get averageFPS(): number;
  38398. /**
  38399. * Returns the average framerate in frames per second using the most recent frame time
  38400. */
  38401. get instantaneousFPS(): number;
  38402. /**
  38403. * Returns true if enough samples have been taken to completely fill the sliding window
  38404. */
  38405. get isSaturated(): boolean;
  38406. /**
  38407. * Enables contributions to the sliding window sample set
  38408. */
  38409. enable(): void;
  38410. /**
  38411. * Disables contributions to the sliding window sample set
  38412. * Samples will not be interpolated over the disabled period
  38413. */
  38414. disable(): void;
  38415. /**
  38416. * Returns true if sampling is enabled
  38417. */
  38418. get isEnabled(): boolean;
  38419. /**
  38420. * Resets performance monitor
  38421. */
  38422. reset(): void;
  38423. }
  38424. /**
  38425. * RollingAverage
  38426. *
  38427. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38428. */
  38429. export class RollingAverage {
  38430. /**
  38431. * Current average
  38432. */
  38433. average: number;
  38434. /**
  38435. * Current variance
  38436. */
  38437. variance: number;
  38438. protected _samples: Array<number>;
  38439. protected _sampleCount: number;
  38440. protected _pos: number;
  38441. protected _m2: number;
  38442. /**
  38443. * constructor
  38444. * @param length The number of samples required to saturate the sliding window
  38445. */
  38446. constructor(length: number);
  38447. /**
  38448. * Adds a sample to the sample set
  38449. * @param v The sample value
  38450. */
  38451. add(v: number): void;
  38452. /**
  38453. * Returns previously added values or null if outside of history or outside the sliding window domain
  38454. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38455. * @return Value previously recorded with add() or null if outside of range
  38456. */
  38457. history(i: number): number;
  38458. /**
  38459. * Returns true if enough samples have been taken to completely fill the sliding window
  38460. * @return true if sample-set saturated
  38461. */
  38462. isSaturated(): boolean;
  38463. /**
  38464. * Resets the rolling average (equivalent to 0 samples taken so far)
  38465. */
  38466. reset(): void;
  38467. /**
  38468. * Wraps a value around the sample range boundaries
  38469. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38470. * @return Wrapped position in sample range
  38471. */
  38472. protected _wrapPosition(i: number): number;
  38473. }
  38474. }
  38475. declare module "babylonjs/Misc/perfCounter" {
  38476. /**
  38477. * This class is used to track a performance counter which is number based.
  38478. * The user has access to many properties which give statistics of different nature.
  38479. *
  38480. * The implementer can track two kinds of Performance Counter: time and count.
  38481. * For time you can optionally call fetchNewFrame() to notify the start of a new frame to monitor, then call beginMonitoring() to start and endMonitoring() to record the lapsed time. endMonitoring takes a newFrame parameter for you to specify if the monitored time should be set for a new frame or accumulated to the current frame being monitored.
  38482. * For count you first have to call fetchNewFrame() to notify the start of a new frame to monitor, then call addCount() how many time required to increment the count value you monitor.
  38483. */
  38484. export class PerfCounter {
  38485. /**
  38486. * Gets or sets a global boolean to turn on and off all the counters
  38487. */
  38488. static Enabled: boolean;
  38489. /**
  38490. * Returns the smallest value ever
  38491. */
  38492. get min(): number;
  38493. /**
  38494. * Returns the biggest value ever
  38495. */
  38496. get max(): number;
  38497. /**
  38498. * Returns the average value since the performance counter is running
  38499. */
  38500. get average(): number;
  38501. /**
  38502. * Returns the average value of the last second the counter was monitored
  38503. */
  38504. get lastSecAverage(): number;
  38505. /**
  38506. * Returns the current value
  38507. */
  38508. get current(): number;
  38509. /**
  38510. * Gets the accumulated total
  38511. */
  38512. get total(): number;
  38513. /**
  38514. * Gets the total value count
  38515. */
  38516. get count(): number;
  38517. /**
  38518. * Creates a new counter
  38519. */
  38520. constructor();
  38521. /**
  38522. * Call this method to start monitoring a new frame.
  38523. * This scenario is typically used when you accumulate monitoring time many times for a single frame, you call this method at the start of the frame, then beginMonitoring to start recording and endMonitoring(false) to accumulated the recorded time to the PerfCounter or addCount() to accumulate a monitored count.
  38524. */
  38525. fetchNewFrame(): void;
  38526. /**
  38527. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38528. * @param newCount the count value to add to the monitored count
  38529. * @param fetchResult true when it's the last time in the frame you add to the counter and you wish to update the statistics properties (min/max/average), false if you only want to update statistics.
  38530. */
  38531. addCount(newCount: number, fetchResult: boolean): void;
  38532. /**
  38533. * Start monitoring this performance counter
  38534. */
  38535. beginMonitoring(): void;
  38536. /**
  38537. * Compute the time lapsed since the previous beginMonitoring() call.
  38538. * @param newFrame true by default to fetch the result and monitor a new frame, if false the time monitored will be added to the current frame counter
  38539. */
  38540. endMonitoring(newFrame?: boolean): void;
  38541. private _fetchResult;
  38542. private _startMonitoringTime;
  38543. private _min;
  38544. private _max;
  38545. private _average;
  38546. private _current;
  38547. private _totalValueCount;
  38548. private _totalAccumulated;
  38549. private _lastSecAverage;
  38550. private _lastSecAccumulated;
  38551. private _lastSecTime;
  38552. private _lastSecValueCount;
  38553. }
  38554. }
  38555. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38556. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38557. import { Nullable } from "babylonjs/types";
  38558. module "babylonjs/Engines/thinEngine" {
  38559. interface ThinEngine {
  38560. /** @hidden */
  38561. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38562. }
  38563. }
  38564. }
  38565. declare module "babylonjs/Engines/engine" {
  38566. import { Observable } from "babylonjs/Misc/observable";
  38567. import { Nullable } from "babylonjs/types";
  38568. import { Scene } from "babylonjs/scene";
  38569. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38570. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38571. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38572. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38573. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38574. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38575. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38576. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38577. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38578. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38579. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38580. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38581. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38582. import "babylonjs/Engines/Extensions/engine.alpha";
  38583. import "babylonjs/Engines/Extensions/engine.readTexture";
  38584. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38585. import { Material } from "babylonjs/Materials/material";
  38586. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38587. /**
  38588. * Defines the interface used by display changed events
  38589. */
  38590. export interface IDisplayChangedEventArgs {
  38591. /** Gets the vrDisplay object (if any) */
  38592. vrDisplay: Nullable<any>;
  38593. /** Gets a boolean indicating if webVR is supported */
  38594. vrSupported: boolean;
  38595. }
  38596. /**
  38597. * Defines the interface used by objects containing a viewport (like a camera)
  38598. */
  38599. interface IViewportOwnerLike {
  38600. /**
  38601. * Gets or sets the viewport
  38602. */
  38603. viewport: IViewportLike;
  38604. }
  38605. /**
  38606. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38607. */
  38608. export class Engine extends ThinEngine {
  38609. /** Defines that alpha blending is disabled */
  38610. static readonly ALPHA_DISABLE: number;
  38611. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38612. static readonly ALPHA_ADD: number;
  38613. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38614. static readonly ALPHA_COMBINE: number;
  38615. /** Defines that alpha blending to DEST - SRC * DEST */
  38616. static readonly ALPHA_SUBTRACT: number;
  38617. /** Defines that alpha blending to SRC * DEST */
  38618. static readonly ALPHA_MULTIPLY: number;
  38619. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38620. static readonly ALPHA_MAXIMIZED: number;
  38621. /** Defines that alpha blending to SRC + DEST */
  38622. static readonly ALPHA_ONEONE: number;
  38623. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38624. static readonly ALPHA_PREMULTIPLIED: number;
  38625. /**
  38626. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38627. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38628. */
  38629. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38630. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38631. static readonly ALPHA_INTERPOLATE: number;
  38632. /**
  38633. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38634. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38635. */
  38636. static readonly ALPHA_SCREENMODE: number;
  38637. /** Defines that the ressource is not delayed*/
  38638. static readonly DELAYLOADSTATE_NONE: number;
  38639. /** Defines that the ressource was successfully delay loaded */
  38640. static readonly DELAYLOADSTATE_LOADED: number;
  38641. /** Defines that the ressource is currently delay loading */
  38642. static readonly DELAYLOADSTATE_LOADING: number;
  38643. /** Defines that the ressource is delayed and has not started loading */
  38644. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38645. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38646. static readonly NEVER: number;
  38647. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  38648. static readonly ALWAYS: number;
  38649. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38650. static readonly LESS: number;
  38651. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38652. static readonly EQUAL: number;
  38653. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  38654. static readonly LEQUAL: number;
  38655. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38656. static readonly GREATER: number;
  38657. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  38658. static readonly GEQUAL: number;
  38659. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  38660. static readonly NOTEQUAL: number;
  38661. /** Passed to stencilOperation to specify that stencil value must be kept */
  38662. static readonly KEEP: number;
  38663. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38664. static readonly REPLACE: number;
  38665. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38666. static readonly INCR: number;
  38667. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38668. static readonly DECR: number;
  38669. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38670. static readonly INVERT: number;
  38671. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38672. static readonly INCR_WRAP: number;
  38673. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38674. static readonly DECR_WRAP: number;
  38675. /** Texture is not repeating outside of 0..1 UVs */
  38676. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38677. /** Texture is repeating outside of 0..1 UVs */
  38678. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38679. /** Texture is repeating and mirrored */
  38680. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38681. /** ALPHA */
  38682. static readonly TEXTUREFORMAT_ALPHA: number;
  38683. /** LUMINANCE */
  38684. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38685. /** LUMINANCE_ALPHA */
  38686. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38687. /** RGB */
  38688. static readonly TEXTUREFORMAT_RGB: number;
  38689. /** RGBA */
  38690. static readonly TEXTUREFORMAT_RGBA: number;
  38691. /** RED */
  38692. static readonly TEXTUREFORMAT_RED: number;
  38693. /** RED (2nd reference) */
  38694. static readonly TEXTUREFORMAT_R: number;
  38695. /** RG */
  38696. static readonly TEXTUREFORMAT_RG: number;
  38697. /** RED_INTEGER */
  38698. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38699. /** RED_INTEGER (2nd reference) */
  38700. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38701. /** RG_INTEGER */
  38702. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38703. /** RGB_INTEGER */
  38704. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38705. /** RGBA_INTEGER */
  38706. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38707. /** UNSIGNED_BYTE */
  38708. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38709. /** UNSIGNED_BYTE (2nd reference) */
  38710. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38711. /** FLOAT */
  38712. static readonly TEXTURETYPE_FLOAT: number;
  38713. /** HALF_FLOAT */
  38714. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38715. /** BYTE */
  38716. static readonly TEXTURETYPE_BYTE: number;
  38717. /** SHORT */
  38718. static readonly TEXTURETYPE_SHORT: number;
  38719. /** UNSIGNED_SHORT */
  38720. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38721. /** INT */
  38722. static readonly TEXTURETYPE_INT: number;
  38723. /** UNSIGNED_INT */
  38724. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38725. /** UNSIGNED_SHORT_4_4_4_4 */
  38726. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38727. /** UNSIGNED_SHORT_5_5_5_1 */
  38728. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38729. /** UNSIGNED_SHORT_5_6_5 */
  38730. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38731. /** UNSIGNED_INT_2_10_10_10_REV */
  38732. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38733. /** UNSIGNED_INT_24_8 */
  38734. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38735. /** UNSIGNED_INT_10F_11F_11F_REV */
  38736. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38737. /** UNSIGNED_INT_5_9_9_9_REV */
  38738. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38739. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38740. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38741. /** nearest is mag = nearest and min = nearest and mip = linear */
  38742. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38743. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38744. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38745. /** Trilinear is mag = linear and min = linear and mip = linear */
  38746. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38747. /** nearest is mag = nearest and min = nearest and mip = linear */
  38748. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38749. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38750. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38751. /** Trilinear is mag = linear and min = linear and mip = linear */
  38752. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38753. /** mag = nearest and min = nearest and mip = nearest */
  38754. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38755. /** mag = nearest and min = linear and mip = nearest */
  38756. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38757. /** mag = nearest and min = linear and mip = linear */
  38758. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38759. /** mag = nearest and min = linear and mip = none */
  38760. static readonly TEXTURE_NEAREST_LINEAR: number;
  38761. /** mag = nearest and min = nearest and mip = none */
  38762. static readonly TEXTURE_NEAREST_NEAREST: number;
  38763. /** mag = linear and min = nearest and mip = nearest */
  38764. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38765. /** mag = linear and min = nearest and mip = linear */
  38766. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38767. /** mag = linear and min = linear and mip = none */
  38768. static readonly TEXTURE_LINEAR_LINEAR: number;
  38769. /** mag = linear and min = nearest and mip = none */
  38770. static readonly TEXTURE_LINEAR_NEAREST: number;
  38771. /** Explicit coordinates mode */
  38772. static readonly TEXTURE_EXPLICIT_MODE: number;
  38773. /** Spherical coordinates mode */
  38774. static readonly TEXTURE_SPHERICAL_MODE: number;
  38775. /** Planar coordinates mode */
  38776. static readonly TEXTURE_PLANAR_MODE: number;
  38777. /** Cubic coordinates mode */
  38778. static readonly TEXTURE_CUBIC_MODE: number;
  38779. /** Projection coordinates mode */
  38780. static readonly TEXTURE_PROJECTION_MODE: number;
  38781. /** Skybox coordinates mode */
  38782. static readonly TEXTURE_SKYBOX_MODE: number;
  38783. /** Inverse Cubic coordinates mode */
  38784. static readonly TEXTURE_INVCUBIC_MODE: number;
  38785. /** Equirectangular coordinates mode */
  38786. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38787. /** Equirectangular Fixed coordinates mode */
  38788. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38789. /** Equirectangular Fixed Mirrored coordinates mode */
  38790. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38791. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38792. static readonly SCALEMODE_FLOOR: number;
  38793. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38794. static readonly SCALEMODE_NEAREST: number;
  38795. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38796. static readonly SCALEMODE_CEILING: number;
  38797. /**
  38798. * Returns the current npm package of the sdk
  38799. */
  38800. static get NpmPackage(): string;
  38801. /**
  38802. * Returns the current version of the framework
  38803. */
  38804. static get Version(): string;
  38805. /** Gets the list of created engines */
  38806. static get Instances(): Engine[];
  38807. /**
  38808. * Gets the latest created engine
  38809. */
  38810. static get LastCreatedEngine(): Nullable<Engine>;
  38811. /**
  38812. * Gets the latest created scene
  38813. */
  38814. static get LastCreatedScene(): Nullable<Scene>;
  38815. /**
  38816. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38817. * @param flag defines which part of the materials must be marked as dirty
  38818. * @param predicate defines a predicate used to filter which materials should be affected
  38819. */
  38820. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38821. /**
  38822. * Method called to create the default loading screen.
  38823. * This can be overriden in your own app.
  38824. * @param canvas The rendering canvas element
  38825. * @returns The loading screen
  38826. */
  38827. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38828. /**
  38829. * Method called to create the default rescale post process on each engine.
  38830. */
  38831. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38832. /**
  38833. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38834. **/
  38835. enableOfflineSupport: boolean;
  38836. /**
  38837. * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
  38838. **/
  38839. disableManifestCheck: boolean;
  38840. /**
  38841. * Gets the list of created scenes
  38842. */
  38843. scenes: Scene[];
  38844. /**
  38845. * Event raised when a new scene is created
  38846. */
  38847. onNewSceneAddedObservable: Observable<Scene>;
  38848. /**
  38849. * Gets the list of created postprocesses
  38850. */
  38851. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38852. /**
  38853. * Gets a boolean indicating if the pointer is currently locked
  38854. */
  38855. isPointerLock: boolean;
  38856. /**
  38857. * Observable event triggered each time the rendering canvas is resized
  38858. */
  38859. onResizeObservable: Observable<Engine>;
  38860. /**
  38861. * Observable event triggered each time the canvas loses focus
  38862. */
  38863. onCanvasBlurObservable: Observable<Engine>;
  38864. /**
  38865. * Observable event triggered each time the canvas gains focus
  38866. */
  38867. onCanvasFocusObservable: Observable<Engine>;
  38868. /**
  38869. * Observable event triggered each time the canvas receives pointerout event
  38870. */
  38871. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38872. /**
  38873. * Observable raised when the engine begins a new frame
  38874. */
  38875. onBeginFrameObservable: Observable<Engine>;
  38876. /**
  38877. * If set, will be used to request the next animation frame for the render loop
  38878. */
  38879. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38880. /**
  38881. * Observable raised when the engine ends the current frame
  38882. */
  38883. onEndFrameObservable: Observable<Engine>;
  38884. /**
  38885. * Observable raised when the engine is about to compile a shader
  38886. */
  38887. onBeforeShaderCompilationObservable: Observable<Engine>;
  38888. /**
  38889. * Observable raised when the engine has jsut compiled a shader
  38890. */
  38891. onAfterShaderCompilationObservable: Observable<Engine>;
  38892. /**
  38893. * Gets the audio engine
  38894. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38895. * @ignorenaming
  38896. */
  38897. static audioEngine: IAudioEngine;
  38898. /**
  38899. * Default AudioEngine factory responsible of creating the Audio Engine.
  38900. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38901. */
  38902. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38903. /**
  38904. * Default offline support factory responsible of creating a tool used to store data locally.
  38905. * By default, this will create a Database object if the workload has been embedded.
  38906. */
  38907. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38908. private _loadingScreen;
  38909. private _pointerLockRequested;
  38910. private _rescalePostProcess;
  38911. private _deterministicLockstep;
  38912. private _lockstepMaxSteps;
  38913. private _timeStep;
  38914. protected get _supportsHardwareTextureRescaling(): boolean;
  38915. private _fps;
  38916. private _deltaTime;
  38917. /** @hidden */
  38918. _drawCalls: PerfCounter;
  38919. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  38920. canvasTabIndex: number;
  38921. /**
  38922. * Turn this value on if you want to pause FPS computation when in background
  38923. */
  38924. disablePerformanceMonitorInBackground: boolean;
  38925. private _performanceMonitor;
  38926. /**
  38927. * Gets the performance monitor attached to this engine
  38928. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38929. */
  38930. get performanceMonitor(): PerformanceMonitor;
  38931. private _onFocus;
  38932. private _onBlur;
  38933. private _onCanvasPointerOut;
  38934. private _onCanvasBlur;
  38935. private _onCanvasFocus;
  38936. private _onFullscreenChange;
  38937. private _onPointerLockChange;
  38938. /**
  38939. * Gets the HTML element used to attach event listeners
  38940. * @returns a HTML element
  38941. */
  38942. getInputElement(): Nullable<HTMLElement>;
  38943. /**
  38944. * Creates a new engine
  38945. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  38946. * @param antialias defines enable antialiasing (default: false)
  38947. * @param options defines further options to be sent to the getContext() function
  38948. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38949. */
  38950. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38951. /**
  38952. * Gets current aspect ratio
  38953. * @param viewportOwner defines the camera to use to get the aspect ratio
  38954. * @param useScreen defines if screen size must be used (or the current render target if any)
  38955. * @returns a number defining the aspect ratio
  38956. */
  38957. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38958. /**
  38959. * Gets current screen aspect ratio
  38960. * @returns a number defining the aspect ratio
  38961. */
  38962. getScreenAspectRatio(): number;
  38963. /**
  38964. * Gets the client rect of the HTML canvas attached with the current webGL context
  38965. * @returns a client rectanglee
  38966. */
  38967. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38968. /**
  38969. * Gets the client rect of the HTML element used for events
  38970. * @returns a client rectanglee
  38971. */
  38972. getInputElementClientRect(): Nullable<ClientRect>;
  38973. /**
  38974. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38975. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38976. * @returns true if engine is in deterministic lock step mode
  38977. */
  38978. isDeterministicLockStep(): boolean;
  38979. /**
  38980. * Gets the max steps when engine is running in deterministic lock step
  38981. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38982. * @returns the max steps
  38983. */
  38984. getLockstepMaxSteps(): number;
  38985. /**
  38986. * Returns the time in ms between steps when using deterministic lock step.
  38987. * @returns time step in (ms)
  38988. */
  38989. getTimeStep(): number;
  38990. /**
  38991. * Force the mipmap generation for the given render target texture
  38992. * @param texture defines the render target texture to use
  38993. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38994. */
  38995. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38996. /** States */
  38997. /**
  38998. * Set various states to the webGL context
  38999. * @param culling defines backface culling state
  39000. * @param zOffset defines the value to apply to zOffset (0 by default)
  39001. * @param force defines if states must be applied even if cache is up to date
  39002. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39003. */
  39004. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39005. /**
  39006. * Set the z offset to apply to current rendering
  39007. * @param value defines the offset to apply
  39008. */
  39009. setZOffset(value: number): void;
  39010. /**
  39011. * Gets the current value of the zOffset
  39012. * @returns the current zOffset state
  39013. */
  39014. getZOffset(): number;
  39015. /**
  39016. * Enable or disable depth buffering
  39017. * @param enable defines the state to set
  39018. */
  39019. setDepthBuffer(enable: boolean): void;
  39020. /**
  39021. * Gets a boolean indicating if depth writing is enabled
  39022. * @returns the current depth writing state
  39023. */
  39024. getDepthWrite(): boolean;
  39025. /**
  39026. * Enable or disable depth writing
  39027. * @param enable defines the state to set
  39028. */
  39029. setDepthWrite(enable: boolean): void;
  39030. /**
  39031. * Gets a boolean indicating if stencil buffer is enabled
  39032. * @returns the current stencil buffer state
  39033. */
  39034. getStencilBuffer(): boolean;
  39035. /**
  39036. * Enable or disable the stencil buffer
  39037. * @param enable defines if the stencil buffer must be enabled or disabled
  39038. */
  39039. setStencilBuffer(enable: boolean): void;
  39040. /**
  39041. * Gets the current stencil mask
  39042. * @returns a number defining the new stencil mask to use
  39043. */
  39044. getStencilMask(): number;
  39045. /**
  39046. * Sets the current stencil mask
  39047. * @param mask defines the new stencil mask to use
  39048. */
  39049. setStencilMask(mask: number): void;
  39050. /**
  39051. * Gets the current stencil function
  39052. * @returns a number defining the stencil function to use
  39053. */
  39054. getStencilFunction(): number;
  39055. /**
  39056. * Gets the current stencil reference value
  39057. * @returns a number defining the stencil reference value to use
  39058. */
  39059. getStencilFunctionReference(): number;
  39060. /**
  39061. * Gets the current stencil mask
  39062. * @returns a number defining the stencil mask to use
  39063. */
  39064. getStencilFunctionMask(): number;
  39065. /**
  39066. * Sets the current stencil function
  39067. * @param stencilFunc defines the new stencil function to use
  39068. */
  39069. setStencilFunction(stencilFunc: number): void;
  39070. /**
  39071. * Sets the current stencil reference
  39072. * @param reference defines the new stencil reference to use
  39073. */
  39074. setStencilFunctionReference(reference: number): void;
  39075. /**
  39076. * Sets the current stencil mask
  39077. * @param mask defines the new stencil mask to use
  39078. */
  39079. setStencilFunctionMask(mask: number): void;
  39080. /**
  39081. * Gets the current stencil operation when stencil fails
  39082. * @returns a number defining stencil operation to use when stencil fails
  39083. */
  39084. getStencilOperationFail(): number;
  39085. /**
  39086. * Gets the current stencil operation when depth fails
  39087. * @returns a number defining stencil operation to use when depth fails
  39088. */
  39089. getStencilOperationDepthFail(): number;
  39090. /**
  39091. * Gets the current stencil operation when stencil passes
  39092. * @returns a number defining stencil operation to use when stencil passes
  39093. */
  39094. getStencilOperationPass(): number;
  39095. /**
  39096. * Sets the stencil operation to use when stencil fails
  39097. * @param operation defines the stencil operation to use when stencil fails
  39098. */
  39099. setStencilOperationFail(operation: number): void;
  39100. /**
  39101. * Sets the stencil operation to use when depth fails
  39102. * @param operation defines the stencil operation to use when depth fails
  39103. */
  39104. setStencilOperationDepthFail(operation: number): void;
  39105. /**
  39106. * Sets the stencil operation to use when stencil passes
  39107. * @param operation defines the stencil operation to use when stencil passes
  39108. */
  39109. setStencilOperationPass(operation: number): void;
  39110. /**
  39111. * Sets a boolean indicating if the dithering state is enabled or disabled
  39112. * @param value defines the dithering state
  39113. */
  39114. setDitheringState(value: boolean): void;
  39115. /**
  39116. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39117. * @param value defines the rasterizer state
  39118. */
  39119. setRasterizerState(value: boolean): void;
  39120. /**
  39121. * Gets the current depth function
  39122. * @returns a number defining the depth function
  39123. */
  39124. getDepthFunction(): Nullable<number>;
  39125. /**
  39126. * Sets the current depth function
  39127. * @param depthFunc defines the function to use
  39128. */
  39129. setDepthFunction(depthFunc: number): void;
  39130. /**
  39131. * Sets the current depth function to GREATER
  39132. */
  39133. setDepthFunctionToGreater(): void;
  39134. /**
  39135. * Sets the current depth function to GEQUAL
  39136. */
  39137. setDepthFunctionToGreaterOrEqual(): void;
  39138. /**
  39139. * Sets the current depth function to LESS
  39140. */
  39141. setDepthFunctionToLess(): void;
  39142. /**
  39143. * Sets the current depth function to LEQUAL
  39144. */
  39145. setDepthFunctionToLessOrEqual(): void;
  39146. private _cachedStencilBuffer;
  39147. private _cachedStencilFunction;
  39148. private _cachedStencilMask;
  39149. private _cachedStencilOperationPass;
  39150. private _cachedStencilOperationFail;
  39151. private _cachedStencilOperationDepthFail;
  39152. private _cachedStencilReference;
  39153. /**
  39154. * Caches the the state of the stencil buffer
  39155. */
  39156. cacheStencilState(): void;
  39157. /**
  39158. * Restores the state of the stencil buffer
  39159. */
  39160. restoreStencilState(): void;
  39161. /**
  39162. * Directly set the WebGL Viewport
  39163. * @param x defines the x coordinate of the viewport (in screen space)
  39164. * @param y defines the y coordinate of the viewport (in screen space)
  39165. * @param width defines the width of the viewport (in screen space)
  39166. * @param height defines the height of the viewport (in screen space)
  39167. * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
  39168. */
  39169. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39170. /**
  39171. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39172. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39173. * @param y defines the y-coordinate of the corner of the clear rectangle
  39174. * @param width defines the width of the clear rectangle
  39175. * @param height defines the height of the clear rectangle
  39176. * @param clearColor defines the clear color
  39177. */
  39178. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39179. /**
  39180. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39181. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39182. * @param y defines the y-coordinate of the corner of the clear rectangle
  39183. * @param width defines the width of the clear rectangle
  39184. * @param height defines the height of the clear rectangle
  39185. */
  39186. enableScissor(x: number, y: number, width: number, height: number): void;
  39187. /**
  39188. * Disable previously set scissor test rectangle
  39189. */
  39190. disableScissor(): void;
  39191. protected _reportDrawCall(): void;
  39192. /**
  39193. * Initializes a webVR display and starts listening to display change events
  39194. * The onVRDisplayChangedObservable will be notified upon these changes
  39195. * @returns The onVRDisplayChangedObservable
  39196. */
  39197. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39198. /** @hidden */
  39199. _prepareVRComponent(): void;
  39200. /** @hidden */
  39201. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39202. /** @hidden */
  39203. _submitVRFrame(): void;
  39204. /**
  39205. * Call this function to leave webVR mode
  39206. * Will do nothing if webVR is not supported or if there is no webVR device
  39207. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39208. */
  39209. disableVR(): void;
  39210. /**
  39211. * Gets a boolean indicating that the system is in VR mode and is presenting
  39212. * @returns true if VR mode is engaged
  39213. */
  39214. isVRPresenting(): boolean;
  39215. /** @hidden */
  39216. _requestVRFrame(): void;
  39217. /** @hidden */
  39218. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39219. /**
  39220. * Gets the source code of the vertex shader associated with a specific webGL program
  39221. * @param program defines the program to use
  39222. * @returns a string containing the source code of the vertex shader associated with the program
  39223. */
  39224. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39225. /**
  39226. * Gets the source code of the fragment shader associated with a specific webGL program
  39227. * @param program defines the program to use
  39228. * @returns a string containing the source code of the fragment shader associated with the program
  39229. */
  39230. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39231. /**
  39232. * Sets a depth stencil texture from a render target to the according uniform.
  39233. * @param channel The texture channel
  39234. * @param uniform The uniform to set
  39235. * @param texture The render target texture containing the depth stencil texture to apply
  39236. */
  39237. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39238. /**
  39239. * Sets a texture to the webGL context from a postprocess
  39240. * @param channel defines the channel to use
  39241. * @param postProcess defines the source postprocess
  39242. */
  39243. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39244. /**
  39245. * Binds the output of the passed in post process to the texture channel specified
  39246. * @param channel The channel the texture should be bound to
  39247. * @param postProcess The post process which's output should be bound
  39248. */
  39249. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39250. protected _rebuildBuffers(): void;
  39251. /** @hidden */
  39252. _renderFrame(): void;
  39253. _renderLoop(): void;
  39254. /** @hidden */
  39255. _renderViews(): boolean;
  39256. /**
  39257. * Toggle full screen mode
  39258. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39259. */
  39260. switchFullscreen(requestPointerLock: boolean): void;
  39261. /**
  39262. * Enters full screen mode
  39263. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39264. */
  39265. enterFullscreen(requestPointerLock: boolean): void;
  39266. /**
  39267. * Exits full screen mode
  39268. */
  39269. exitFullscreen(): void;
  39270. /**
  39271. * Enters Pointerlock mode
  39272. */
  39273. enterPointerlock(): void;
  39274. /**
  39275. * Exits Pointerlock mode
  39276. */
  39277. exitPointerlock(): void;
  39278. /**
  39279. * Begin a new frame
  39280. */
  39281. beginFrame(): void;
  39282. /**
  39283. * Enf the current frame
  39284. */
  39285. endFrame(): void;
  39286. resize(): void;
  39287. /**
  39288. * Force a specific size of the canvas
  39289. * @param width defines the new canvas' width
  39290. * @param height defines the new canvas' height
  39291. * @returns true if the size was changed
  39292. */
  39293. setSize(width: number, height: number): boolean;
  39294. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39295. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39296. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39297. _releaseTexture(texture: InternalTexture): void;
  39298. /**
  39299. * @hidden
  39300. * Rescales a texture
  39301. * @param source input texutre
  39302. * @param destination destination texture
  39303. * @param scene scene to use to render the resize
  39304. * @param internalFormat format to use when resizing
  39305. * @param onComplete callback to be called when resize has completed
  39306. */
  39307. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39308. /**
  39309. * Gets the current framerate
  39310. * @returns a number representing the framerate
  39311. */
  39312. getFps(): number;
  39313. /**
  39314. * Gets the time spent between current and previous frame
  39315. * @returns a number representing the delta time in ms
  39316. */
  39317. getDeltaTime(): number;
  39318. private _measureFps;
  39319. /** @hidden */
  39320. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39321. /**
  39322. * Updates the sample count of a render target texture
  39323. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39324. * @param texture defines the texture to update
  39325. * @param samples defines the sample count to set
  39326. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39327. */
  39328. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39329. /**
  39330. * Updates a depth texture Comparison Mode and Function.
  39331. * If the comparison Function is equal to 0, the mode will be set to none.
  39332. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39333. * @param texture The texture to set the comparison function for
  39334. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39335. */
  39336. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39337. /**
  39338. * Creates a webGL buffer to use with instanciation
  39339. * @param capacity defines the size of the buffer
  39340. * @returns the webGL buffer
  39341. */
  39342. createInstancesBuffer(capacity: number): DataBuffer;
  39343. /**
  39344. * Delete a webGL buffer used with instanciation
  39345. * @param buffer defines the webGL buffer to delete
  39346. */
  39347. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39348. private _clientWaitAsync;
  39349. /** @hidden */
  39350. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39351. dispose(): void;
  39352. private _disableTouchAction;
  39353. /**
  39354. * Display the loading screen
  39355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39356. */
  39357. displayLoadingUI(): void;
  39358. /**
  39359. * Hide the loading screen
  39360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39361. */
  39362. hideLoadingUI(): void;
  39363. /**
  39364. * Gets the current loading screen object
  39365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39366. */
  39367. get loadingScreen(): ILoadingScreen;
  39368. /**
  39369. * Sets the current loading screen object
  39370. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39371. */
  39372. set loadingScreen(loadingScreen: ILoadingScreen);
  39373. /**
  39374. * Sets the current loading screen text
  39375. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39376. */
  39377. set loadingUIText(text: string);
  39378. /**
  39379. * Sets the current loading screen background color
  39380. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39381. */
  39382. set loadingUIBackgroundColor(color: string);
  39383. /** Pointerlock and fullscreen */
  39384. /**
  39385. * Ask the browser to promote the current element to pointerlock mode
  39386. * @param element defines the DOM element to promote
  39387. */
  39388. static _RequestPointerlock(element: HTMLElement): void;
  39389. /**
  39390. * Asks the browser to exit pointerlock mode
  39391. */
  39392. static _ExitPointerlock(): void;
  39393. /**
  39394. * Ask the browser to promote the current element to fullscreen rendering mode
  39395. * @param element defines the DOM element to promote
  39396. */
  39397. static _RequestFullscreen(element: HTMLElement): void;
  39398. /**
  39399. * Asks the browser to exit fullscreen mode
  39400. */
  39401. static _ExitFullscreen(): void;
  39402. }
  39403. }
  39404. declare module "babylonjs/Engines/engineStore" {
  39405. import { Nullable } from "babylonjs/types";
  39406. import { Engine } from "babylonjs/Engines/engine";
  39407. import { Scene } from "babylonjs/scene";
  39408. /**
  39409. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39410. * during the life time of the application.
  39411. */
  39412. export class EngineStore {
  39413. /** Gets the list of created engines */
  39414. static Instances: import("babylonjs/Engines/engine").Engine[];
  39415. /** @hidden */
  39416. static _LastCreatedScene: Nullable<Scene>;
  39417. /**
  39418. * Gets the latest created engine
  39419. */
  39420. static get LastCreatedEngine(): Nullable<Engine>;
  39421. /**
  39422. * Gets the latest created scene
  39423. */
  39424. static get LastCreatedScene(): Nullable<Scene>;
  39425. /**
  39426. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39427. * @ignorenaming
  39428. */
  39429. static UseFallbackTexture: boolean;
  39430. /**
  39431. * Texture content used if a texture cannot loaded
  39432. * @ignorenaming
  39433. */
  39434. static FallbackTexture: string;
  39435. }
  39436. }
  39437. declare module "babylonjs/Misc/promise" {
  39438. /**
  39439. * Helper class that provides a small promise polyfill
  39440. */
  39441. export class PromisePolyfill {
  39442. /**
  39443. * Static function used to check if the polyfill is required
  39444. * If this is the case then the function will inject the polyfill to window.Promise
  39445. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39446. */
  39447. static Apply(force?: boolean): void;
  39448. }
  39449. }
  39450. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39451. /**
  39452. * Interface for screenshot methods with describe argument called `size` as object with options
  39453. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39454. */
  39455. export interface IScreenshotSize {
  39456. /**
  39457. * number in pixels for canvas height
  39458. */
  39459. height?: number;
  39460. /**
  39461. * multiplier allowing render at a higher or lower resolution
  39462. * If value is defined then height and width will be ignored and taken from camera
  39463. */
  39464. precision?: number;
  39465. /**
  39466. * number in pixels for canvas width
  39467. */
  39468. width?: number;
  39469. }
  39470. }
  39471. declare module "babylonjs/Misc/tools" {
  39472. import { Nullable, float } from "babylonjs/types";
  39473. import { DomManagement } from "babylonjs/Misc/domManagement";
  39474. import { WebRequest } from "babylonjs/Misc/webRequest";
  39475. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39476. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39477. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39478. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39479. import { Camera } from "babylonjs/Cameras/camera";
  39480. import { Engine } from "babylonjs/Engines/engine";
  39481. interface IColor4Like {
  39482. r: float;
  39483. g: float;
  39484. b: float;
  39485. a: float;
  39486. }
  39487. /**
  39488. * Class containing a set of static utilities functions
  39489. */
  39490. export class Tools {
  39491. /**
  39492. * Gets or sets the base URL to use to load assets
  39493. */
  39494. static get BaseUrl(): string;
  39495. static set BaseUrl(value: string);
  39496. /**
  39497. * Enable/Disable Custom HTTP Request Headers globally.
  39498. * default = false
  39499. * @see CustomRequestHeaders
  39500. */
  39501. static UseCustomRequestHeaders: boolean;
  39502. /**
  39503. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39504. * i.e. when loading files, where the server/service expects an Authorization header
  39505. */
  39506. static CustomRequestHeaders: {
  39507. [key: string]: string;
  39508. };
  39509. /**
  39510. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39511. */
  39512. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39513. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39514. /**
  39515. * Default behaviour for cors in the application.
  39516. * It can be a string if the expected behavior is identical in the entire app.
  39517. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39518. */
  39519. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39520. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39521. /**
  39522. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39523. * @ignorenaming
  39524. */
  39525. static get UseFallbackTexture(): boolean;
  39526. static set UseFallbackTexture(value: boolean);
  39527. /**
  39528. * Use this object to register external classes like custom textures or material
  39529. * to allow the laoders to instantiate them
  39530. */
  39531. static get RegisteredExternalClasses(): {
  39532. [key: string]: Object;
  39533. };
  39534. static set RegisteredExternalClasses(classes: {
  39535. [key: string]: Object;
  39536. });
  39537. /**
  39538. * Texture content used if a texture cannot loaded
  39539. * @ignorenaming
  39540. */
  39541. static get fallbackTexture(): string;
  39542. static set fallbackTexture(value: string);
  39543. /**
  39544. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39545. * @param u defines the coordinate on X axis
  39546. * @param v defines the coordinate on Y axis
  39547. * @param width defines the width of the source data
  39548. * @param height defines the height of the source data
  39549. * @param pixels defines the source byte array
  39550. * @param color defines the output color
  39551. */
  39552. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39553. /**
  39554. * Interpolates between a and b via alpha
  39555. * @param a The lower value (returned when alpha = 0)
  39556. * @param b The upper value (returned when alpha = 1)
  39557. * @param alpha The interpolation-factor
  39558. * @return The mixed value
  39559. */
  39560. static Mix(a: number, b: number, alpha: number): number;
  39561. /**
  39562. * Tries to instantiate a new object from a given class name
  39563. * @param className defines the class name to instantiate
  39564. * @returns the new object or null if the system was not able to do the instantiation
  39565. */
  39566. static Instantiate(className: string): any;
  39567. /**
  39568. * Provides a slice function that will work even on IE
  39569. * @param data defines the array to slice
  39570. * @param start defines the start of the data (optional)
  39571. * @param end defines the end of the data (optional)
  39572. * @returns the new sliced array
  39573. */
  39574. static Slice<T>(data: T, start?: number, end?: number): T;
  39575. /**
  39576. * Polyfill for setImmediate
  39577. * @param action defines the action to execute after the current execution block
  39578. */
  39579. static SetImmediate(action: () => void): void;
  39580. /**
  39581. * Function indicating if a number is an exponent of 2
  39582. * @param value defines the value to test
  39583. * @returns true if the value is an exponent of 2
  39584. */
  39585. static IsExponentOfTwo(value: number): boolean;
  39586. private static _tmpFloatArray;
  39587. /**
  39588. * Returns the nearest 32-bit single precision float representation of a Number
  39589. * @param value A Number. If the parameter is of a different type, it will get converted
  39590. * to a number or to NaN if it cannot be converted
  39591. * @returns number
  39592. */
  39593. static FloatRound(value: number): number;
  39594. /**
  39595. * Extracts the filename from a path
  39596. * @param path defines the path to use
  39597. * @returns the filename
  39598. */
  39599. static GetFilename(path: string): string;
  39600. /**
  39601. * Extracts the "folder" part of a path (everything before the filename).
  39602. * @param uri The URI to extract the info from
  39603. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39604. * @returns The "folder" part of the path
  39605. */
  39606. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39607. /**
  39608. * Extracts text content from a DOM element hierarchy
  39609. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39610. */
  39611. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39612. /**
  39613. * Convert an angle in radians to degrees
  39614. * @param angle defines the angle to convert
  39615. * @returns the angle in degrees
  39616. */
  39617. static ToDegrees(angle: number): number;
  39618. /**
  39619. * Convert an angle in degrees to radians
  39620. * @param angle defines the angle to convert
  39621. * @returns the angle in radians
  39622. */
  39623. static ToRadians(angle: number): number;
  39624. /**
  39625. * Returns an array if obj is not an array
  39626. * @param obj defines the object to evaluate as an array
  39627. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39628. * @returns either obj directly if obj is an array or a new array containing obj
  39629. */
  39630. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39631. /**
  39632. * Gets the pointer prefix to use
  39633. * @param engine defines the engine we are finding the prefix for
  39634. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39635. */
  39636. static GetPointerPrefix(engine: Engine): string;
  39637. /**
  39638. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39639. * @param url define the url we are trying
  39640. * @param element define the dom element where to configure the cors policy
  39641. */
  39642. static SetCorsBehavior(url: string | string[], element: {
  39643. crossOrigin: string | null;
  39644. }): void;
  39645. /**
  39646. * Removes unwanted characters from an url
  39647. * @param url defines the url to clean
  39648. * @returns the cleaned url
  39649. */
  39650. static CleanUrl(url: string): string;
  39651. /**
  39652. * Gets or sets a function used to pre-process url before using them to load assets
  39653. */
  39654. static get PreprocessUrl(): (url: string) => string;
  39655. static set PreprocessUrl(processor: (url: string) => string);
  39656. /**
  39657. * Loads an image as an HTMLImageElement.
  39658. * @param input url string, ArrayBuffer, or Blob to load
  39659. * @param onLoad callback called when the image successfully loads
  39660. * @param onError callback called when the image fails to load
  39661. * @param offlineProvider offline provider for caching
  39662. * @param mimeType optional mime type
  39663. * @returns the HTMLImageElement of the loaded image
  39664. */
  39665. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39666. /**
  39667. * Loads a file from a url
  39668. * @param url url string, ArrayBuffer, or Blob to load
  39669. * @param onSuccess callback called when the file successfully loads
  39670. * @param onProgress callback called while file is loading (if the server supports this mode)
  39671. * @param offlineProvider defines the offline provider for caching
  39672. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39673. * @param onError callback called when the file fails to load
  39674. * @returns a file request object
  39675. */
  39676. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  39677. /**
  39678. * Loads a file from a url
  39679. * @param url the file url to load
  39680. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39681. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39682. */
  39683. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39684. /**
  39685. * Load a script (identified by an url). When the url returns, the
  39686. * content of this file is added into a new script element, attached to the DOM (body element)
  39687. * @param scriptUrl defines the url of the script to laod
  39688. * @param onSuccess defines the callback called when the script is loaded
  39689. * @param onError defines the callback to call if an error occurs
  39690. * @param scriptId defines the id of the script element
  39691. */
  39692. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39693. /**
  39694. * Load an asynchronous script (identified by an url). When the url returns, the
  39695. * content of this file is added into a new script element, attached to the DOM (body element)
  39696. * @param scriptUrl defines the url of the script to laod
  39697. * @param scriptId defines the id of the script element
  39698. * @returns a promise request object
  39699. */
  39700. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39701. /**
  39702. * Loads a file from a blob
  39703. * @param fileToLoad defines the blob to use
  39704. * @param callback defines the callback to call when data is loaded
  39705. * @param progressCallback defines the callback to call during loading process
  39706. * @returns a file request object
  39707. */
  39708. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39709. /**
  39710. * Reads a file from a File object
  39711. * @param file defines the file to load
  39712. * @param onSuccess defines the callback to call when data is loaded
  39713. * @param onProgress defines the callback to call during loading process
  39714. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39715. * @param onError defines the callback to call when an error occurs
  39716. * @returns a file request object
  39717. */
  39718. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39719. /**
  39720. * Creates a data url from a given string content
  39721. * @param content defines the content to convert
  39722. * @returns the new data url link
  39723. */
  39724. static FileAsURL(content: string): string;
  39725. /**
  39726. * Format the given number to a specific decimal format
  39727. * @param value defines the number to format
  39728. * @param decimals defines the number of decimals to use
  39729. * @returns the formatted string
  39730. */
  39731. static Format(value: number, decimals?: number): string;
  39732. /**
  39733. * Tries to copy an object by duplicating every property
  39734. * @param source defines the source object
  39735. * @param destination defines the target object
  39736. * @param doNotCopyList defines a list of properties to avoid
  39737. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39738. */
  39739. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39740. /**
  39741. * Gets a boolean indicating if the given object has no own property
  39742. * @param obj defines the object to test
  39743. * @returns true if object has no own property
  39744. */
  39745. static IsEmpty(obj: any): boolean;
  39746. /**
  39747. * Function used to register events at window level
  39748. * @param windowElement defines the Window object to use
  39749. * @param events defines the events to register
  39750. */
  39751. static RegisterTopRootEvents(windowElement: Window, events: {
  39752. name: string;
  39753. handler: Nullable<(e: FocusEvent) => any>;
  39754. }[]): void;
  39755. /**
  39756. * Function used to unregister events from window level
  39757. * @param windowElement defines the Window object to use
  39758. * @param events defines the events to unregister
  39759. */
  39760. static UnregisterTopRootEvents(windowElement: Window, events: {
  39761. name: string;
  39762. handler: Nullable<(e: FocusEvent) => any>;
  39763. }[]): void;
  39764. /**
  39765. * @ignore
  39766. */
  39767. static _ScreenshotCanvas: HTMLCanvasElement;
  39768. /**
  39769. * Dumps the current bound framebuffer
  39770. * @param width defines the rendering width
  39771. * @param height defines the rendering height
  39772. * @param engine defines the hosting engine
  39773. * @param successCallback defines the callback triggered once the data are available
  39774. * @param mimeType defines the mime type of the result
  39775. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39776. */
  39777. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39778. /**
  39779. * Converts the canvas data to blob.
  39780. * This acts as a polyfill for browsers not supporting the to blob function.
  39781. * @param canvas Defines the canvas to extract the data from
  39782. * @param successCallback Defines the callback triggered once the data are available
  39783. * @param mimeType Defines the mime type of the result
  39784. */
  39785. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39786. /**
  39787. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39788. * @param successCallback defines the callback triggered once the data are available
  39789. * @param mimeType defines the mime type of the result
  39790. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39791. */
  39792. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39793. /**
  39794. * Downloads a blob in the browser
  39795. * @param blob defines the blob to download
  39796. * @param fileName defines the name of the downloaded file
  39797. */
  39798. static Download(blob: Blob, fileName: string): void;
  39799. /**
  39800. * Captures a screenshot of the current rendering
  39801. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39802. * @param engine defines the rendering engine
  39803. * @param camera defines the source camera
  39804. * @param size This parameter can be set to a single number or to an object with the
  39805. * following (optional) properties: precision, width, height. If a single number is passed,
  39806. * it will be used for both width and height. If an object is passed, the screenshot size
  39807. * will be derived from the parameters. The precision property is a multiplier allowing
  39808. * rendering at a higher or lower resolution
  39809. * @param successCallback defines the callback receives a single parameter which contains the
  39810. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39811. * src parameter of an <img> to display it
  39812. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39813. * Check your browser for supported MIME types
  39814. */
  39815. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39816. /**
  39817. * Captures a screenshot of the current rendering
  39818. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39819. * @param engine defines the rendering engine
  39820. * @param camera defines the source camera
  39821. * @param size This parameter can be set to a single number or to an object with the
  39822. * following (optional) properties: precision, width, height. If a single number is passed,
  39823. * it will be used for both width and height. If an object is passed, the screenshot size
  39824. * will be derived from the parameters. The precision property is a multiplier allowing
  39825. * rendering at a higher or lower resolution
  39826. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39827. * Check your browser for supported MIME types
  39828. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39829. * to the src parameter of an <img> to display it
  39830. */
  39831. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39832. /**
  39833. * Generates an image screenshot from the specified camera.
  39834. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39835. * @param engine The engine to use for rendering
  39836. * @param camera The camera to use for rendering
  39837. * @param size This parameter can be set to a single number or to an object with the
  39838. * following (optional) properties: precision, width, height. If a single number is passed,
  39839. * it will be used for both width and height. If an object is passed, the screenshot size
  39840. * will be derived from the parameters. The precision property is a multiplier allowing
  39841. * rendering at a higher or lower resolution
  39842. * @param successCallback The callback receives a single parameter which contains the
  39843. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39844. * src parameter of an <img> to display it
  39845. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39846. * Check your browser for supported MIME types
  39847. * @param samples Texture samples (default: 1)
  39848. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39849. * @param fileName A name for for the downloaded file.
  39850. */
  39851. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39852. /**
  39853. * Generates an image screenshot from the specified camera.
  39854. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39855. * @param engine The engine to use for rendering
  39856. * @param camera The camera to use for rendering
  39857. * @param size This parameter can be set to a single number or to an object with the
  39858. * following (optional) properties: precision, width, height. If a single number is passed,
  39859. * it will be used for both width and height. If an object is passed, the screenshot size
  39860. * will be derived from the parameters. The precision property is a multiplier allowing
  39861. * rendering at a higher or lower resolution
  39862. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39863. * Check your browser for supported MIME types
  39864. * @param samples Texture samples (default: 1)
  39865. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39866. * @param fileName A name for for the downloaded file.
  39867. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39868. * to the src parameter of an <img> to display it
  39869. */
  39870. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39871. /**
  39872. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39873. * Be aware Math.random() could cause collisions, but:
  39874. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  39875. * @returns a pseudo random id
  39876. */
  39877. static RandomId(): string;
  39878. /**
  39879. * Test if the given uri is a base64 string
  39880. * @param uri The uri to test
  39881. * @return True if the uri is a base64 string or false otherwise
  39882. */
  39883. static IsBase64(uri: string): boolean;
  39884. /**
  39885. * Decode the given base64 uri.
  39886. * @param uri The uri to decode
  39887. * @return The decoded base64 data.
  39888. */
  39889. static DecodeBase64(uri: string): ArrayBuffer;
  39890. /**
  39891. * Gets the absolute url.
  39892. * @param url the input url
  39893. * @return the absolute url
  39894. */
  39895. static GetAbsoluteUrl(url: string): string;
  39896. /**
  39897. * No log
  39898. */
  39899. static readonly NoneLogLevel: number;
  39900. /**
  39901. * Only message logs
  39902. */
  39903. static readonly MessageLogLevel: number;
  39904. /**
  39905. * Only warning logs
  39906. */
  39907. static readonly WarningLogLevel: number;
  39908. /**
  39909. * Only error logs
  39910. */
  39911. static readonly ErrorLogLevel: number;
  39912. /**
  39913. * All logs
  39914. */
  39915. static readonly AllLogLevel: number;
  39916. /**
  39917. * Gets a value indicating the number of loading errors
  39918. * @ignorenaming
  39919. */
  39920. static get errorsCount(): number;
  39921. /**
  39922. * Callback called when a new log is added
  39923. */
  39924. static OnNewCacheEntry: (entry: string) => void;
  39925. /**
  39926. * Log a message to the console
  39927. * @param message defines the message to log
  39928. */
  39929. static Log(message: string): void;
  39930. /**
  39931. * Write a warning message to the console
  39932. * @param message defines the message to log
  39933. */
  39934. static Warn(message: string): void;
  39935. /**
  39936. * Write an error message to the console
  39937. * @param message defines the message to log
  39938. */
  39939. static Error(message: string): void;
  39940. /**
  39941. * Gets current log cache (list of logs)
  39942. */
  39943. static get LogCache(): string;
  39944. /**
  39945. * Clears the log cache
  39946. */
  39947. static ClearLogCache(): void;
  39948. /**
  39949. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39950. */
  39951. static set LogLevels(level: number);
  39952. /**
  39953. * Checks if the window object exists
  39954. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39955. */
  39956. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39957. /**
  39958. * No performance log
  39959. */
  39960. static readonly PerformanceNoneLogLevel: number;
  39961. /**
  39962. * Use user marks to log performance
  39963. */
  39964. static readonly PerformanceUserMarkLogLevel: number;
  39965. /**
  39966. * Log performance to the console
  39967. */
  39968. static readonly PerformanceConsoleLogLevel: number;
  39969. private static _performance;
  39970. /**
  39971. * Sets the current performance log level
  39972. */
  39973. static set PerformanceLogLevel(level: number);
  39974. private static _StartPerformanceCounterDisabled;
  39975. private static _EndPerformanceCounterDisabled;
  39976. private static _StartUserMark;
  39977. private static _EndUserMark;
  39978. private static _StartPerformanceConsole;
  39979. private static _EndPerformanceConsole;
  39980. /**
  39981. * Starts a performance counter
  39982. */
  39983. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39984. /**
  39985. * Ends a specific performance coutner
  39986. */
  39987. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39988. /**
  39989. * Gets either window.performance.now() if supported or Date.now() else
  39990. */
  39991. static get Now(): number;
  39992. /**
  39993. * This method will return the name of the class used to create the instance of the given object.
  39994. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39995. * @param object the object to get the class name from
  39996. * @param isType defines if the object is actually a type
  39997. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39998. */
  39999. static GetClassName(object: any, isType?: boolean): string;
  40000. /**
  40001. * Gets the first element of an array satisfying a given predicate
  40002. * @param array defines the array to browse
  40003. * @param predicate defines the predicate to use
  40004. * @returns null if not found or the element
  40005. */
  40006. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40007. /**
  40008. * This method will return the name of the full name of the class, including its owning module (if any).
  40009. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator or implementing a method getClassName():string (in which case the module won't be specified).
  40010. * @param object the object to get the class name from
  40011. * @param isType defines if the object is actually a type
  40012. * @return a string that can have two forms: "moduleName.className" if module was specified when the class' Name was registered or "className" if there was not module specified.
  40013. * @ignorenaming
  40014. */
  40015. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40016. /**
  40017. * Returns a promise that resolves after the given amount of time.
  40018. * @param delay Number of milliseconds to delay
  40019. * @returns Promise that resolves after the given amount of time
  40020. */
  40021. static DelayAsync(delay: number): Promise<void>;
  40022. /**
  40023. * Utility function to detect if the current user agent is Safari
  40024. * @returns whether or not the current user agent is safari
  40025. */
  40026. static IsSafari(): boolean;
  40027. }
  40028. /**
  40029. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40030. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40031. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40032. * @param name The name of the class, case should be preserved
  40033. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40034. */
  40035. export function className(name: string, module?: string): (target: Object) => void;
  40036. /**
  40037. * An implementation of a loop for asynchronous functions.
  40038. */
  40039. export class AsyncLoop {
  40040. /**
  40041. * Defines the number of iterations for the loop
  40042. */
  40043. iterations: number;
  40044. /**
  40045. * Defines the current index of the loop.
  40046. */
  40047. index: number;
  40048. private _done;
  40049. private _fn;
  40050. private _successCallback;
  40051. /**
  40052. * Constructor.
  40053. * @param iterations the number of iterations.
  40054. * @param func the function to run each iteration
  40055. * @param successCallback the callback that will be called upon succesful execution
  40056. * @param offset starting offset.
  40057. */
  40058. constructor(
  40059. /**
  40060. * Defines the number of iterations for the loop
  40061. */
  40062. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40063. /**
  40064. * Execute the next iteration. Must be called after the last iteration was finished.
  40065. */
  40066. executeNext(): void;
  40067. /**
  40068. * Break the loop and run the success callback.
  40069. */
  40070. breakLoop(): void;
  40071. /**
  40072. * Create and run an async loop.
  40073. * @param iterations the number of iterations.
  40074. * @param fn the function to run each iteration
  40075. * @param successCallback the callback that will be called upon succesful execution
  40076. * @param offset starting offset.
  40077. * @returns the created async loop object
  40078. */
  40079. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40080. /**
  40081. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40082. * @param iterations total number of iterations
  40083. * @param syncedIterations number of synchronous iterations in each async iteration.
  40084. * @param fn the function to call each iteration.
  40085. * @param callback a success call back that will be called when iterating stops.
  40086. * @param breakFunction a break condition (optional)
  40087. * @param timeout timeout settings for the setTimeout function. default - 0.
  40088. * @returns the created async loop object
  40089. */
  40090. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40091. }
  40092. }
  40093. declare module "babylonjs/Misc/stringDictionary" {
  40094. import { Nullable } from "babylonjs/types";
  40095. /**
  40096. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40097. * The underlying implementation relies on an associative array to ensure the best performances.
  40098. * The value can be anything including 'null' but except 'undefined'
  40099. */
  40100. export class StringDictionary<T> {
  40101. /**
  40102. * This will clear this dictionary and copy the content from the 'source' one.
  40103. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40104. * @param source the dictionary to take the content from and copy to this dictionary
  40105. */
  40106. copyFrom(source: StringDictionary<T>): void;
  40107. /**
  40108. * Get a value based from its key
  40109. * @param key the given key to get the matching value from
  40110. * @return the value if found, otherwise undefined is returned
  40111. */
  40112. get(key: string): T | undefined;
  40113. /**
  40114. * Get a value from its key or add it if it doesn't exist.
  40115. * This method will ensure you that a given key/data will be present in the dictionary.
  40116. * @param key the given key to get the matching value from
  40117. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40118. * The factory will only be invoked if there's no data for the given key.
  40119. * @return the value corresponding to the key.
  40120. */
  40121. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40122. /**
  40123. * Get a value from its key if present in the dictionary otherwise add it
  40124. * @param key the key to get the value from
  40125. * @param val if there's no such key/value pair in the dictionary add it with this value
  40126. * @return the value corresponding to the key
  40127. */
  40128. getOrAdd(key: string, val: T): T;
  40129. /**
  40130. * Check if there's a given key in the dictionary
  40131. * @param key the key to check for
  40132. * @return true if the key is present, false otherwise
  40133. */
  40134. contains(key: string): boolean;
  40135. /**
  40136. * Add a new key and its corresponding value
  40137. * @param key the key to add
  40138. * @param value the value corresponding to the key
  40139. * @return true if the operation completed successfully, false if we couldn't insert the key/value because there was already this key in the dictionary
  40140. */
  40141. add(key: string, value: T): boolean;
  40142. /**
  40143. * Update a specific value associated to a key
  40144. * @param key defines the key to use
  40145. * @param value defines the value to store
  40146. * @returns true if the value was updated (or false if the key was not found)
  40147. */
  40148. set(key: string, value: T): boolean;
  40149. /**
  40150. * Get the element of the given key and remove it from the dictionary
  40151. * @param key defines the key to search
  40152. * @returns the value associated with the key or null if not found
  40153. */
  40154. getAndRemove(key: string): Nullable<T>;
  40155. /**
  40156. * Remove a key/value from the dictionary.
  40157. * @param key the key to remove
  40158. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40159. */
  40160. remove(key: string): boolean;
  40161. /**
  40162. * Clear the whole content of the dictionary
  40163. */
  40164. clear(): void;
  40165. /**
  40166. * Gets the current count
  40167. */
  40168. get count(): number;
  40169. /**
  40170. * Execute a callback on each key/val of the dictionary.
  40171. * Note that you can remove any element in this dictionary in the callback implementation
  40172. * @param callback the callback to execute on a given key/value pair
  40173. */
  40174. forEach(callback: (key: string, val: T) => void): void;
  40175. /**
  40176. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40177. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40178. * Note that you can remove any element in this dictionary in the callback implementation
  40179. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40180. * @returns the first item
  40181. */
  40182. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40183. private _count;
  40184. private _data;
  40185. }
  40186. }
  40187. declare module "babylonjs/Collisions/collisionCoordinator" {
  40188. import { Nullable } from "babylonjs/types";
  40189. import { Scene } from "babylonjs/scene";
  40190. import { Vector3 } from "babylonjs/Maths/math.vector";
  40191. import { Collider } from "babylonjs/Collisions/collider";
  40192. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40193. /** @hidden */
  40194. export interface ICollisionCoordinator {
  40195. createCollider(): Collider;
  40196. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40197. init(scene: Scene): void;
  40198. }
  40199. /** @hidden */
  40200. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40201. private _scene;
  40202. private _scaledPosition;
  40203. private _scaledVelocity;
  40204. private _finalPosition;
  40205. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40206. createCollider(): Collider;
  40207. init(scene: Scene): void;
  40208. private _collideWithWorld;
  40209. }
  40210. }
  40211. declare module "babylonjs/Inputs/scene.inputManager" {
  40212. import { Nullable } from "babylonjs/types";
  40213. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40214. import { Vector2 } from "babylonjs/Maths/math.vector";
  40215. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40216. import { Scene } from "babylonjs/scene";
  40217. /**
  40218. * Class used to manage all inputs for the scene.
  40219. */
  40220. export class InputManager {
  40221. /** The distance in pixel that you have to move to prevent some events */
  40222. static DragMovementThreshold: number;
  40223. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40224. static LongPressDelay: number;
  40225. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40226. static DoubleClickDelay: number;
  40227. /** If you need to check double click without raising a single click at first click, enable this flag */
  40228. static ExclusiveDoubleClickMode: boolean;
  40229. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  40230. private _alreadyAttached;
  40231. private _wheelEventName;
  40232. private _onPointerMove;
  40233. private _onPointerDown;
  40234. private _onPointerUp;
  40235. private _initClickEvent;
  40236. private _initActionManager;
  40237. private _delayedSimpleClick;
  40238. private _delayedSimpleClickTimeout;
  40239. private _previousDelayedSimpleClickTimeout;
  40240. private _meshPickProceed;
  40241. private _previousButtonPressed;
  40242. private _currentPickResult;
  40243. private _previousPickResult;
  40244. private _totalPointersPressed;
  40245. private _doubleClickOccured;
  40246. private _pointerOverMesh;
  40247. private _pickedDownMesh;
  40248. private _pickedUpMesh;
  40249. private _pointerX;
  40250. private _pointerY;
  40251. private _unTranslatedPointerX;
  40252. private _unTranslatedPointerY;
  40253. private _startingPointerPosition;
  40254. private _previousStartingPointerPosition;
  40255. private _startingPointerTime;
  40256. private _previousStartingPointerTime;
  40257. private _pointerCaptures;
  40258. private _meshUnderPointerId;
  40259. private _onKeyDown;
  40260. private _onKeyUp;
  40261. private _onCanvasFocusObserver;
  40262. private _onCanvasBlurObserver;
  40263. private _scene;
  40264. /**
  40265. * Creates a new InputManager
  40266. * @param scene defines the hosting scene
  40267. */
  40268. constructor(scene: Scene);
  40269. /**
  40270. * Gets the mesh that is currently under the pointer
  40271. */
  40272. get meshUnderPointer(): Nullable<AbstractMesh>;
  40273. /**
  40274. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  40275. * @param pointerId the pointer id to use
  40276. * @returns The mesh under this pointer id or null if not found
  40277. */
  40278. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  40279. /**
  40280. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40281. */
  40282. get unTranslatedPointer(): Vector2;
  40283. /**
  40284. * Gets or sets the current on-screen X position of the pointer
  40285. */
  40286. get pointerX(): number;
  40287. set pointerX(value: number);
  40288. /**
  40289. * Gets or sets the current on-screen Y position of the pointer
  40290. */
  40291. get pointerY(): number;
  40292. set pointerY(value: number);
  40293. private _updatePointerPosition;
  40294. private _processPointerMove;
  40295. private _setRayOnPointerInfo;
  40296. private _checkPrePointerObservable;
  40297. /**
  40298. * Use this method to simulate a pointer move on a mesh
  40299. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40300. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40301. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40302. */
  40303. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40304. /**
  40305. * Use this method to simulate a pointer down on a mesh
  40306. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40307. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40308. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40309. */
  40310. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40311. private _processPointerDown;
  40312. /** @hidden */
  40313. _isPointerSwiping(): boolean;
  40314. /**
  40315. * Use this method to simulate a pointer up on a mesh
  40316. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40317. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40318. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40319. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40320. */
  40321. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40322. private _processPointerUp;
  40323. /**
  40324. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40325. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40326. * @returns true if the pointer was captured
  40327. */
  40328. isPointerCaptured(pointerId?: number): boolean;
  40329. /**
  40330. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40331. * @param attachUp defines if you want to attach events to pointerup
  40332. * @param attachDown defines if you want to attach events to pointerdown
  40333. * @param attachMove defines if you want to attach events to pointermove
  40334. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40335. */
  40336. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40337. /**
  40338. * Detaches all event handlers
  40339. */
  40340. detachControl(): void;
  40341. /**
  40342. * Force the value of meshUnderPointer
  40343. * @param mesh defines the mesh to use
  40344. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  40345. */
  40346. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  40347. /**
  40348. * Gets the mesh under the pointer
  40349. * @returns a Mesh or null if no mesh is under the pointer
  40350. */
  40351. getPointerOverMesh(): Nullable<AbstractMesh>;
  40352. }
  40353. }
  40354. declare module "babylonjs/Animations/animationGroup" {
  40355. import { Animatable } from "babylonjs/Animations/animatable";
  40356. import { Animation } from "babylonjs/Animations/animation";
  40357. import { Scene, IDisposable } from "babylonjs/scene";
  40358. import { Observable } from "babylonjs/Misc/observable";
  40359. import { Nullable } from "babylonjs/types";
  40360. import "babylonjs/Animations/animatable";
  40361. /**
  40362. * This class defines the direct association between an animation and a target
  40363. */
  40364. export class TargetedAnimation {
  40365. /**
  40366. * Animation to perform
  40367. */
  40368. animation: Animation;
  40369. /**
  40370. * Target to animate
  40371. */
  40372. target: any;
  40373. /**
  40374. * Returns the string "TargetedAnimation"
  40375. * @returns "TargetedAnimation"
  40376. */
  40377. getClassName(): string;
  40378. /**
  40379. * Serialize the object
  40380. * @returns the JSON object representing the current entity
  40381. */
  40382. serialize(): any;
  40383. }
  40384. /**
  40385. * Use this class to create coordinated animations on multiple targets
  40386. */
  40387. export class AnimationGroup implements IDisposable {
  40388. /** The name of the animation group */
  40389. name: string;
  40390. private _scene;
  40391. private _targetedAnimations;
  40392. private _animatables;
  40393. private _from;
  40394. private _to;
  40395. private _isStarted;
  40396. private _isPaused;
  40397. private _speedRatio;
  40398. private _loopAnimation;
  40399. private _isAdditive;
  40400. /**
  40401. * Gets or sets the unique id of the node
  40402. */
  40403. uniqueId: number;
  40404. /**
  40405. * This observable will notify when one animation have ended
  40406. */
  40407. onAnimationEndObservable: Observable<TargetedAnimation>;
  40408. /**
  40409. * Observer raised when one animation loops
  40410. */
  40411. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40412. /**
  40413. * Observer raised when all animations have looped
  40414. */
  40415. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40416. /**
  40417. * This observable will notify when all animations have ended.
  40418. */
  40419. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40420. /**
  40421. * This observable will notify when all animations have paused.
  40422. */
  40423. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40424. /**
  40425. * This observable will notify when all animations are playing.
  40426. */
  40427. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40428. /**
  40429. * Gets the first frame
  40430. */
  40431. get from(): number;
  40432. /**
  40433. * Gets the last frame
  40434. */
  40435. get to(): number;
  40436. /**
  40437. * Define if the animations are started
  40438. */
  40439. get isStarted(): boolean;
  40440. /**
  40441. * Gets a value indicating that the current group is playing
  40442. */
  40443. get isPlaying(): boolean;
  40444. /**
  40445. * Gets or sets the speed ratio to use for all animations
  40446. */
  40447. get speedRatio(): number;
  40448. /**
  40449. * Gets or sets the speed ratio to use for all animations
  40450. */
  40451. set speedRatio(value: number);
  40452. /**
  40453. * Gets or sets if all animations should loop or not
  40454. */
  40455. get loopAnimation(): boolean;
  40456. set loopAnimation(value: boolean);
  40457. /**
  40458. * Gets or sets if all animations should be evaluated additively
  40459. */
  40460. get isAdditive(): boolean;
  40461. set isAdditive(value: boolean);
  40462. /**
  40463. * Gets the targeted animations for this animation group
  40464. */
  40465. get targetedAnimations(): Array<TargetedAnimation>;
  40466. /**
  40467. * returning the list of animatables controlled by this animation group.
  40468. */
  40469. get animatables(): Array<Animatable>;
  40470. /**
  40471. * Gets the list of target animations
  40472. */
  40473. get children(): TargetedAnimation[];
  40474. /**
  40475. * Instantiates a new Animation Group.
  40476. * This helps managing several animations at once.
  40477. * @see https://doc.babylonjs.com/how_to/group
  40478. * @param name Defines the name of the group
  40479. * @param scene Defines the scene the group belongs to
  40480. */
  40481. constructor(
  40482. /** The name of the animation group */
  40483. name: string, scene?: Nullable<Scene>);
  40484. /**
  40485. * Add an animation (with its target) in the group
  40486. * @param animation defines the animation we want to add
  40487. * @param target defines the target of the animation
  40488. * @returns the TargetedAnimation object
  40489. */
  40490. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40491. /**
  40492. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40493. * It can add constant keys at begin or end
  40494. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40495. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40496. * @returns the animation group
  40497. */
  40498. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40499. private _animationLoopCount;
  40500. private _animationLoopFlags;
  40501. private _processLoop;
  40502. /**
  40503. * Start all animations on given targets
  40504. * @param loop defines if animations must loop
  40505. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40506. * @param from defines the from key (optional)
  40507. * @param to defines the to key (optional)
  40508. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40509. * @returns the current animation group
  40510. */
  40511. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40512. /**
  40513. * Pause all animations
  40514. * @returns the animation group
  40515. */
  40516. pause(): AnimationGroup;
  40517. /**
  40518. * Play all animations to initial state
  40519. * This function will start() the animations if they were not started or will restart() them if they were paused
  40520. * @param loop defines if animations must loop
  40521. * @returns the animation group
  40522. */
  40523. play(loop?: boolean): AnimationGroup;
  40524. /**
  40525. * Reset all animations to initial state
  40526. * @returns the animation group
  40527. */
  40528. reset(): AnimationGroup;
  40529. /**
  40530. * Restart animations from key 0
  40531. * @returns the animation group
  40532. */
  40533. restart(): AnimationGroup;
  40534. /**
  40535. * Stop all animations
  40536. * @returns the animation group
  40537. */
  40538. stop(): AnimationGroup;
  40539. /**
  40540. * Set animation weight for all animatables
  40541. * @param weight defines the weight to use
  40542. * @return the animationGroup
  40543. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40544. */
  40545. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40546. /**
  40547. * Synchronize and normalize all animatables with a source animatable
  40548. * @param root defines the root animatable to synchronize with
  40549. * @return the animationGroup
  40550. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40551. */
  40552. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40553. /**
  40554. * Goes to a specific frame in this animation group
  40555. * @param frame the frame number to go to
  40556. * @return the animationGroup
  40557. */
  40558. goToFrame(frame: number): AnimationGroup;
  40559. /**
  40560. * Dispose all associated resources
  40561. */
  40562. dispose(): void;
  40563. private _checkAnimationGroupEnded;
  40564. /**
  40565. * Clone the current animation group and returns a copy
  40566. * @param newName defines the name of the new group
  40567. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40568. * @returns the new aniamtion group
  40569. */
  40570. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40571. /**
  40572. * Serializes the animationGroup to an object
  40573. * @returns Serialized object
  40574. */
  40575. serialize(): any;
  40576. /**
  40577. * Returns a new AnimationGroup object parsed from the source provided.
  40578. * @param parsedAnimationGroup defines the source
  40579. * @param scene defines the scene that will receive the animationGroup
  40580. * @returns a new AnimationGroup
  40581. */
  40582. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40583. /**
  40584. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40585. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40586. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40587. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40588. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40589. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40590. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40591. */
  40592. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40593. /**
  40594. * Returns the string "AnimationGroup"
  40595. * @returns "AnimationGroup"
  40596. */
  40597. getClassName(): string;
  40598. /**
  40599. * Creates a detailled string about the object
  40600. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40601. * @returns a string representing the object
  40602. */
  40603. toString(fullDetails?: boolean): string;
  40604. }
  40605. }
  40606. declare module "babylonjs/scene" {
  40607. import { Nullable } from "babylonjs/types";
  40608. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40609. import { Observable } from "babylonjs/Misc/observable";
  40610. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40611. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40612. import { Geometry } from "babylonjs/Meshes/geometry";
  40613. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40614. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40616. import { Mesh } from "babylonjs/Meshes/mesh";
  40617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40618. import { Bone } from "babylonjs/Bones/bone";
  40619. import { Skeleton } from "babylonjs/Bones/skeleton";
  40620. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40621. import { Camera } from "babylonjs/Cameras/camera";
  40622. import { AbstractScene } from "babylonjs/abstractScene";
  40623. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40624. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40625. import { Material } from "babylonjs/Materials/material";
  40626. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40627. import { Effect } from "babylonjs/Materials/effect";
  40628. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40629. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40630. import { Light } from "babylonjs/Lights/light";
  40631. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40632. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40633. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40634. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40635. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40636. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40637. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40638. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40639. import { Engine } from "babylonjs/Engines/engine";
  40640. import { Node } from "babylonjs/node";
  40641. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40642. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40643. import { WebRequest } from "babylonjs/Misc/webRequest";
  40644. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40645. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40646. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40647. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40648. import { Plane } from "babylonjs/Maths/math.plane";
  40649. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40650. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40651. import { Ray } from "babylonjs/Culling/ray";
  40652. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40653. import { Animation } from "babylonjs/Animations/animation";
  40654. import { Animatable } from "babylonjs/Animations/animatable";
  40655. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40656. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40657. import { Collider } from "babylonjs/Collisions/collider";
  40658. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40659. /**
  40660. * Define an interface for all classes that will hold resources
  40661. */
  40662. export interface IDisposable {
  40663. /**
  40664. * Releases all held resources
  40665. */
  40666. dispose(): void;
  40667. }
  40668. /** Interface defining initialization parameters for Scene class */
  40669. export interface SceneOptions {
  40670. /**
  40671. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40672. * It will improve performance when the number of geometries becomes important.
  40673. */
  40674. useGeometryUniqueIdsMap?: boolean;
  40675. /**
  40676. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40677. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40678. */
  40679. useMaterialMeshMap?: boolean;
  40680. /**
  40681. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40682. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40683. */
  40684. useClonedMeshMap?: boolean;
  40685. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40686. virtual?: boolean;
  40687. }
  40688. /**
  40689. * Represents a scene to be rendered by the engine.
  40690. * @see https://doc.babylonjs.com/features/scene
  40691. */
  40692. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40693. /** The fog is deactivated */
  40694. static readonly FOGMODE_NONE: number;
  40695. /** The fog density is following an exponential function */
  40696. static readonly FOGMODE_EXP: number;
  40697. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40698. static readonly FOGMODE_EXP2: number;
  40699. /** The fog density is following a linear function. */
  40700. static readonly FOGMODE_LINEAR: number;
  40701. /**
  40702. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40703. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40704. */
  40705. static MinDeltaTime: number;
  40706. /**
  40707. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40708. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40709. */
  40710. static MaxDeltaTime: number;
  40711. /**
  40712. * Factory used to create the default material.
  40713. * @param name The name of the material to create
  40714. * @param scene The scene to create the material for
  40715. * @returns The default material
  40716. */
  40717. static DefaultMaterialFactory(scene: Scene): Material;
  40718. /**
  40719. * Factory used to create the a collision coordinator.
  40720. * @returns The collision coordinator
  40721. */
  40722. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40723. /** @hidden */
  40724. _inputManager: InputManager;
  40725. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40726. cameraToUseForPointers: Nullable<Camera>;
  40727. /** @hidden */
  40728. readonly _isScene: boolean;
  40729. /** @hidden */
  40730. _blockEntityCollection: boolean;
  40731. /**
  40732. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40733. */
  40734. autoClear: boolean;
  40735. /**
  40736. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40737. */
  40738. autoClearDepthAndStencil: boolean;
  40739. /**
  40740. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40741. */
  40742. clearColor: Color4;
  40743. /**
  40744. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40745. */
  40746. ambientColor: Color3;
  40747. /**
  40748. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40749. * It should only be one of the following (if not the default embedded one):
  40750. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40751. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40752. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40753. * The material properties need to be setup according to the type of texture in use.
  40754. */
  40755. environmentBRDFTexture: BaseTexture;
  40756. /**
  40757. * Texture used in all pbr material as the reflection texture.
  40758. * As in the majority of the scene they are the same (exception for multi room and so on),
  40759. * this is easier to reference from here than from all the materials.
  40760. */
  40761. get environmentTexture(): Nullable<BaseTexture>;
  40762. /**
  40763. * Texture used in all pbr material as the reflection texture.
  40764. * As in the majority of the scene they are the same (exception for multi room and so on),
  40765. * this is easier to set here than in all the materials.
  40766. */
  40767. set environmentTexture(value: Nullable<BaseTexture>);
  40768. /** @hidden */
  40769. protected _environmentIntensity: number;
  40770. /**
  40771. * Intensity of the environment in all pbr material.
  40772. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40773. * As in the majority of the scene they are the same (exception for multi room and so on),
  40774. * this is easier to reference from here than from all the materials.
  40775. */
  40776. get environmentIntensity(): number;
  40777. /**
  40778. * Intensity of the environment in all pbr material.
  40779. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40780. * As in the majority of the scene they are the same (exception for multi room and so on),
  40781. * this is easier to set here than in all the materials.
  40782. */
  40783. set environmentIntensity(value: number);
  40784. /** @hidden */
  40785. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40786. /**
  40787. * Default image processing configuration used either in the rendering
  40788. * Forward main pass or through the imageProcessingPostProcess if present.
  40789. * As in the majority of the scene they are the same (exception for multi camera),
  40790. * this is easier to reference from here than from all the materials and post process.
  40791. *
  40792. * No setter as we it is a shared configuration, you can set the values instead.
  40793. */
  40794. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40795. private _forceWireframe;
  40796. /**
  40797. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40798. */
  40799. set forceWireframe(value: boolean);
  40800. get forceWireframe(): boolean;
  40801. private _skipFrustumClipping;
  40802. /**
  40803. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40804. */
  40805. set skipFrustumClipping(value: boolean);
  40806. get skipFrustumClipping(): boolean;
  40807. private _forcePointsCloud;
  40808. /**
  40809. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40810. */
  40811. set forcePointsCloud(value: boolean);
  40812. get forcePointsCloud(): boolean;
  40813. /**
  40814. * Gets or sets the active clipplane 1
  40815. */
  40816. clipPlane: Nullable<Plane>;
  40817. /**
  40818. * Gets or sets the active clipplane 2
  40819. */
  40820. clipPlane2: Nullable<Plane>;
  40821. /**
  40822. * Gets or sets the active clipplane 3
  40823. */
  40824. clipPlane3: Nullable<Plane>;
  40825. /**
  40826. * Gets or sets the active clipplane 4
  40827. */
  40828. clipPlane4: Nullable<Plane>;
  40829. /**
  40830. * Gets or sets the active clipplane 5
  40831. */
  40832. clipPlane5: Nullable<Plane>;
  40833. /**
  40834. * Gets or sets the active clipplane 6
  40835. */
  40836. clipPlane6: Nullable<Plane>;
  40837. /**
  40838. * Gets or sets a boolean indicating if animations are enabled
  40839. */
  40840. animationsEnabled: boolean;
  40841. private _animationPropertiesOverride;
  40842. /**
  40843. * Gets or sets the animation properties override
  40844. */
  40845. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40846. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40847. /**
  40848. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40849. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40850. */
  40851. useConstantAnimationDeltaTime: boolean;
  40852. /**
  40853. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40854. * Please note that it requires to run a ray cast through the scene on every frame
  40855. */
  40856. constantlyUpdateMeshUnderPointer: boolean;
  40857. /**
  40858. * Defines the HTML cursor to use when hovering over interactive elements
  40859. */
  40860. hoverCursor: string;
  40861. /**
  40862. * Defines the HTML default cursor to use (empty by default)
  40863. */
  40864. defaultCursor: string;
  40865. /**
  40866. * Defines whether cursors are handled by the scene.
  40867. */
  40868. doNotHandleCursors: boolean;
  40869. /**
  40870. * This is used to call preventDefault() on pointer down
  40871. * in order to block unwanted artifacts like system double clicks
  40872. */
  40873. preventDefaultOnPointerDown: boolean;
  40874. /**
  40875. * This is used to call preventDefault() on pointer up
  40876. * in order to block unwanted artifacts like system double clicks
  40877. */
  40878. preventDefaultOnPointerUp: boolean;
  40879. /**
  40880. * Gets or sets user defined metadata
  40881. */
  40882. metadata: any;
  40883. /**
  40884. * For internal use only. Please do not use.
  40885. */
  40886. reservedDataStore: any;
  40887. /**
  40888. * Gets the name of the plugin used to load this scene (null by default)
  40889. */
  40890. loadingPluginName: string;
  40891. /**
  40892. * Use this array to add regular expressions used to disable offline support for specific urls
  40893. */
  40894. disableOfflineSupportExceptionRules: RegExp[];
  40895. /**
  40896. * An event triggered when the scene is disposed.
  40897. */
  40898. onDisposeObservable: Observable<Scene>;
  40899. private _onDisposeObserver;
  40900. /** Sets a function to be executed when this scene is disposed. */
  40901. set onDispose(callback: () => void);
  40902. /**
  40903. * An event triggered before rendering the scene (right after animations and physics)
  40904. */
  40905. onBeforeRenderObservable: Observable<Scene>;
  40906. private _onBeforeRenderObserver;
  40907. /** Sets a function to be executed before rendering this scene */
  40908. set beforeRender(callback: Nullable<() => void>);
  40909. /**
  40910. * An event triggered after rendering the scene
  40911. */
  40912. onAfterRenderObservable: Observable<Scene>;
  40913. /**
  40914. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40915. */
  40916. onAfterRenderCameraObservable: Observable<Camera>;
  40917. private _onAfterRenderObserver;
  40918. /** Sets a function to be executed after rendering this scene */
  40919. set afterRender(callback: Nullable<() => void>);
  40920. /**
  40921. * An event triggered before animating the scene
  40922. */
  40923. onBeforeAnimationsObservable: Observable<Scene>;
  40924. /**
  40925. * An event triggered after animations processing
  40926. */
  40927. onAfterAnimationsObservable: Observable<Scene>;
  40928. /**
  40929. * An event triggered before draw calls are ready to be sent
  40930. */
  40931. onBeforeDrawPhaseObservable: Observable<Scene>;
  40932. /**
  40933. * An event triggered after draw calls have been sent
  40934. */
  40935. onAfterDrawPhaseObservable: Observable<Scene>;
  40936. /**
  40937. * An event triggered when the scene is ready
  40938. */
  40939. onReadyObservable: Observable<Scene>;
  40940. /**
  40941. * An event triggered before rendering a camera
  40942. */
  40943. onBeforeCameraRenderObservable: Observable<Camera>;
  40944. private _onBeforeCameraRenderObserver;
  40945. /** Sets a function to be executed before rendering a camera*/
  40946. set beforeCameraRender(callback: () => void);
  40947. /**
  40948. * An event triggered after rendering a camera
  40949. */
  40950. onAfterCameraRenderObservable: Observable<Camera>;
  40951. private _onAfterCameraRenderObserver;
  40952. /** Sets a function to be executed after rendering a camera*/
  40953. set afterCameraRender(callback: () => void);
  40954. /**
  40955. * An event triggered when active meshes evaluation is about to start
  40956. */
  40957. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40958. /**
  40959. * An event triggered when active meshes evaluation is done
  40960. */
  40961. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40962. /**
  40963. * An event triggered when particles rendering is about to start
  40964. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40965. */
  40966. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40967. /**
  40968. * An event triggered when particles rendering is done
  40969. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40970. */
  40971. onAfterParticlesRenderingObservable: Observable<Scene>;
  40972. /**
  40973. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40974. */
  40975. onDataLoadedObservable: Observable<Scene>;
  40976. /**
  40977. * An event triggered when a camera is created
  40978. */
  40979. onNewCameraAddedObservable: Observable<Camera>;
  40980. /**
  40981. * An event triggered when a camera is removed
  40982. */
  40983. onCameraRemovedObservable: Observable<Camera>;
  40984. /**
  40985. * An event triggered when a light is created
  40986. */
  40987. onNewLightAddedObservable: Observable<Light>;
  40988. /**
  40989. * An event triggered when a light is removed
  40990. */
  40991. onLightRemovedObservable: Observable<Light>;
  40992. /**
  40993. * An event triggered when a geometry is created
  40994. */
  40995. onNewGeometryAddedObservable: Observable<Geometry>;
  40996. /**
  40997. * An event triggered when a geometry is removed
  40998. */
  40999. onGeometryRemovedObservable: Observable<Geometry>;
  41000. /**
  41001. * An event triggered when a transform node is created
  41002. */
  41003. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  41004. /**
  41005. * An event triggered when a transform node is removed
  41006. */
  41007. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41008. /**
  41009. * An event triggered when a mesh is created
  41010. */
  41011. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41012. /**
  41013. * An event triggered when a mesh is removed
  41014. */
  41015. onMeshRemovedObservable: Observable<AbstractMesh>;
  41016. /**
  41017. * An event triggered when a skeleton is created
  41018. */
  41019. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41020. /**
  41021. * An event triggered when a skeleton is removed
  41022. */
  41023. onSkeletonRemovedObservable: Observable<Skeleton>;
  41024. /**
  41025. * An event triggered when a material is created
  41026. */
  41027. onNewMaterialAddedObservable: Observable<Material>;
  41028. /**
  41029. * An event triggered when a material is removed
  41030. */
  41031. onMaterialRemovedObservable: Observable<Material>;
  41032. /**
  41033. * An event triggered when a texture is created
  41034. */
  41035. onNewTextureAddedObservable: Observable<BaseTexture>;
  41036. /**
  41037. * An event triggered when a texture is removed
  41038. */
  41039. onTextureRemovedObservable: Observable<BaseTexture>;
  41040. /**
  41041. * An event triggered when render targets are about to be rendered
  41042. * Can happen multiple times per frame.
  41043. */
  41044. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41045. /**
  41046. * An event triggered when render targets were rendered.
  41047. * Can happen multiple times per frame.
  41048. */
  41049. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41050. /**
  41051. * An event triggered before calculating deterministic simulation step
  41052. */
  41053. onBeforeStepObservable: Observable<Scene>;
  41054. /**
  41055. * An event triggered after calculating deterministic simulation step
  41056. */
  41057. onAfterStepObservable: Observable<Scene>;
  41058. /**
  41059. * An event triggered when the activeCamera property is updated
  41060. */
  41061. onActiveCameraChanged: Observable<Scene>;
  41062. /**
  41063. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41064. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41065. * 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)
  41066. */
  41067. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41068. /**
  41069. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41070. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41071. * 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)
  41072. */
  41073. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41074. /**
  41075. * This Observable will when a mesh has been imported into the scene.
  41076. */
  41077. onMeshImportedObservable: Observable<AbstractMesh>;
  41078. /**
  41079. * This Observable will when an animation file has been imported into the scene.
  41080. */
  41081. onAnimationFileImportedObservable: Observable<Scene>;
  41082. /**
  41083. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41084. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41085. */
  41086. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41087. /** @hidden */
  41088. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41089. /**
  41090. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41091. */
  41092. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41093. /**
  41094. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41095. */
  41096. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41097. /**
  41098. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41099. */
  41100. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41101. /** Callback called when a pointer move is detected */
  41102. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41103. /** Callback called when a pointer down is detected */
  41104. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41105. /** Callback called when a pointer up is detected */
  41106. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41107. /** Callback called when a pointer pick is detected */
  41108. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41109. /**
  41110. * 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).
  41111. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41112. */
  41113. onPrePointerObservable: Observable<PointerInfoPre>;
  41114. /**
  41115. * Observable event triggered each time an input event is received from the rendering canvas
  41116. */
  41117. onPointerObservable: Observable<PointerInfo>;
  41118. /**
  41119. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41120. */
  41121. get unTranslatedPointer(): Vector2;
  41122. /**
  41123. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41124. */
  41125. static get DragMovementThreshold(): number;
  41126. static set DragMovementThreshold(value: number);
  41127. /**
  41128. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41129. */
  41130. static get LongPressDelay(): number;
  41131. static set LongPressDelay(value: number);
  41132. /**
  41133. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41134. */
  41135. static get DoubleClickDelay(): number;
  41136. static set DoubleClickDelay(value: number);
  41137. /** If you need to check double click without raising a single click at first click, enable this flag */
  41138. static get ExclusiveDoubleClickMode(): boolean;
  41139. static set ExclusiveDoubleClickMode(value: boolean);
  41140. /** @hidden */
  41141. _mirroredCameraPosition: Nullable<Vector3>;
  41142. /**
  41143. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41144. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41145. */
  41146. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41147. /**
  41148. * Observable event triggered each time an keyboard event is received from the hosting window
  41149. */
  41150. onKeyboardObservable: Observable<KeyboardInfo>;
  41151. private _useRightHandedSystem;
  41152. /**
  41153. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41154. */
  41155. set useRightHandedSystem(value: boolean);
  41156. get useRightHandedSystem(): boolean;
  41157. private _timeAccumulator;
  41158. private _currentStepId;
  41159. private _currentInternalStep;
  41160. /**
  41161. * Sets the step Id used by deterministic lock step
  41162. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41163. * @param newStepId defines the step Id
  41164. */
  41165. setStepId(newStepId: number): void;
  41166. /**
  41167. * Gets the step Id used by deterministic lock step
  41168. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41169. * @returns the step Id
  41170. */
  41171. getStepId(): number;
  41172. /**
  41173. * Gets the internal step used by deterministic lock step
  41174. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41175. * @returns the internal step
  41176. */
  41177. getInternalStep(): number;
  41178. private _fogEnabled;
  41179. /**
  41180. * Gets or sets a boolean indicating if fog is enabled on this scene
  41181. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41182. * (Default is true)
  41183. */
  41184. set fogEnabled(value: boolean);
  41185. get fogEnabled(): boolean;
  41186. private _fogMode;
  41187. /**
  41188. * Gets or sets the fog mode to use
  41189. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41190. * | mode | value |
  41191. * | --- | --- |
  41192. * | FOGMODE_NONE | 0 |
  41193. * | FOGMODE_EXP | 1 |
  41194. * | FOGMODE_EXP2 | 2 |
  41195. * | FOGMODE_LINEAR | 3 |
  41196. */
  41197. set fogMode(value: number);
  41198. get fogMode(): number;
  41199. /**
  41200. * Gets or sets the fog color to use
  41201. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41202. * (Default is Color3(0.2, 0.2, 0.3))
  41203. */
  41204. fogColor: Color3;
  41205. /**
  41206. * Gets or sets the fog density to use
  41207. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41208. * (Default is 0.1)
  41209. */
  41210. fogDensity: number;
  41211. /**
  41212. * Gets or sets the fog start distance to use
  41213. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41214. * (Default is 0)
  41215. */
  41216. fogStart: number;
  41217. /**
  41218. * Gets or sets the fog end distance to use
  41219. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41220. * (Default is 1000)
  41221. */
  41222. fogEnd: number;
  41223. /**
  41224. * Flag indicating that the frame buffer binding is handled by another component
  41225. */
  41226. prePass: boolean;
  41227. private _shadowsEnabled;
  41228. /**
  41229. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41230. */
  41231. set shadowsEnabled(value: boolean);
  41232. get shadowsEnabled(): boolean;
  41233. private _lightsEnabled;
  41234. /**
  41235. * Gets or sets a boolean indicating if lights are enabled on this scene
  41236. */
  41237. set lightsEnabled(value: boolean);
  41238. get lightsEnabled(): boolean;
  41239. /** All of the active cameras added to this scene. */
  41240. activeCameras: Camera[];
  41241. /** @hidden */
  41242. _activeCamera: Nullable<Camera>;
  41243. /** Gets or sets the current active camera */
  41244. get activeCamera(): Nullable<Camera>;
  41245. set activeCamera(value: Nullable<Camera>);
  41246. private _defaultMaterial;
  41247. /** The default material used on meshes when no material is affected */
  41248. get defaultMaterial(): Material;
  41249. /** The default material used on meshes when no material is affected */
  41250. set defaultMaterial(value: Material);
  41251. private _texturesEnabled;
  41252. /**
  41253. * Gets or sets a boolean indicating if textures are enabled on this scene
  41254. */
  41255. set texturesEnabled(value: boolean);
  41256. get texturesEnabled(): boolean;
  41257. /**
  41258. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41259. */
  41260. physicsEnabled: boolean;
  41261. /**
  41262. * Gets or sets a boolean indicating if particles are enabled on this scene
  41263. */
  41264. particlesEnabled: boolean;
  41265. /**
  41266. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41267. */
  41268. spritesEnabled: boolean;
  41269. private _skeletonsEnabled;
  41270. /**
  41271. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41272. */
  41273. set skeletonsEnabled(value: boolean);
  41274. get skeletonsEnabled(): boolean;
  41275. /**
  41276. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41277. */
  41278. lensFlaresEnabled: boolean;
  41279. /**
  41280. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41281. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41282. */
  41283. collisionsEnabled: boolean;
  41284. private _collisionCoordinator;
  41285. /** @hidden */
  41286. get collisionCoordinator(): ICollisionCoordinator;
  41287. /**
  41288. * Defines the gravity applied to this scene (used only for collisions)
  41289. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41290. */
  41291. gravity: Vector3;
  41292. /**
  41293. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41294. */
  41295. postProcessesEnabled: boolean;
  41296. /**
  41297. * Gets the current postprocess manager
  41298. */
  41299. postProcessManager: PostProcessManager;
  41300. /**
  41301. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41302. */
  41303. renderTargetsEnabled: boolean;
  41304. /**
  41305. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41306. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41307. */
  41308. dumpNextRenderTargets: boolean;
  41309. /**
  41310. * The list of user defined render targets added to the scene
  41311. */
  41312. customRenderTargets: RenderTargetTexture[];
  41313. /**
  41314. * Defines if texture loading must be delayed
  41315. * If true, textures will only be loaded when they need to be rendered
  41316. */
  41317. useDelayedTextureLoading: boolean;
  41318. /**
  41319. * Gets the list of meshes imported to the scene through SceneLoader
  41320. */
  41321. importedMeshesFiles: String[];
  41322. /**
  41323. * Gets or sets a boolean indicating if probes are enabled on this scene
  41324. */
  41325. probesEnabled: boolean;
  41326. /**
  41327. * Gets or sets the current offline provider to use to store scene data
  41328. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41329. */
  41330. offlineProvider: IOfflineProvider;
  41331. /**
  41332. * Gets or sets the action manager associated with the scene
  41333. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41334. */
  41335. actionManager: AbstractActionManager;
  41336. private _meshesForIntersections;
  41337. /**
  41338. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41339. */
  41340. proceduralTexturesEnabled: boolean;
  41341. private _engine;
  41342. private _totalVertices;
  41343. /** @hidden */
  41344. _activeIndices: PerfCounter;
  41345. /** @hidden */
  41346. _activeParticles: PerfCounter;
  41347. /** @hidden */
  41348. _activeBones: PerfCounter;
  41349. private _animationRatio;
  41350. /** @hidden */
  41351. _animationTimeLast: number;
  41352. /** @hidden */
  41353. _animationTime: number;
  41354. /**
  41355. * Gets or sets a general scale for animation speed
  41356. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41357. */
  41358. animationTimeScale: number;
  41359. /** @hidden */
  41360. _cachedMaterial: Nullable<Material>;
  41361. /** @hidden */
  41362. _cachedEffect: Nullable<Effect>;
  41363. /** @hidden */
  41364. _cachedVisibility: Nullable<number>;
  41365. private _renderId;
  41366. private _frameId;
  41367. private _executeWhenReadyTimeoutId;
  41368. private _intermediateRendering;
  41369. private _viewUpdateFlag;
  41370. private _projectionUpdateFlag;
  41371. /** @hidden */
  41372. _toBeDisposed: Nullable<IDisposable>[];
  41373. private _activeRequests;
  41374. /** @hidden */
  41375. _pendingData: any[];
  41376. private _isDisposed;
  41377. /**
  41378. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41379. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41380. */
  41381. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41382. private _activeMeshes;
  41383. private _processedMaterials;
  41384. private _renderTargets;
  41385. /** @hidden */
  41386. _activeParticleSystems: SmartArray<IParticleSystem>;
  41387. private _activeSkeletons;
  41388. private _softwareSkinnedMeshes;
  41389. private _renderingManager;
  41390. /** @hidden */
  41391. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41392. private _transformMatrix;
  41393. private _sceneUbo;
  41394. /** @hidden */
  41395. _viewMatrix: Matrix;
  41396. private _projectionMatrix;
  41397. /** @hidden */
  41398. _forcedViewPosition: Nullable<Vector3>;
  41399. /** @hidden */
  41400. _frustumPlanes: Plane[];
  41401. /**
  41402. * Gets the list of frustum planes (built from the active camera)
  41403. */
  41404. get frustumPlanes(): Plane[];
  41405. /**
  41406. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41407. * This is useful if there are more lights that the maximum simulteanous authorized
  41408. */
  41409. requireLightSorting: boolean;
  41410. /** @hidden */
  41411. readonly useMaterialMeshMap: boolean;
  41412. /** @hidden */
  41413. readonly useClonedMeshMap: boolean;
  41414. private _externalData;
  41415. private _uid;
  41416. /**
  41417. * @hidden
  41418. * Backing store of defined scene components.
  41419. */
  41420. _components: ISceneComponent[];
  41421. /**
  41422. * @hidden
  41423. * Backing store of defined scene components.
  41424. */
  41425. _serializableComponents: ISceneSerializableComponent[];
  41426. /**
  41427. * List of components to register on the next registration step.
  41428. */
  41429. private _transientComponents;
  41430. /**
  41431. * Registers the transient components if needed.
  41432. */
  41433. private _registerTransientComponents;
  41434. /**
  41435. * @hidden
  41436. * Add a component to the scene.
  41437. * Note that the ccomponent could be registered on th next frame if this is called after
  41438. * the register component stage.
  41439. * @param component Defines the component to add to the scene
  41440. */
  41441. _addComponent(component: ISceneComponent): void;
  41442. /**
  41443. * @hidden
  41444. * Gets a component from the scene.
  41445. * @param name defines the name of the component to retrieve
  41446. * @returns the component or null if not present
  41447. */
  41448. _getComponent(name: string): Nullable<ISceneComponent>;
  41449. /**
  41450. * @hidden
  41451. * Defines the actions happening before camera updates.
  41452. */
  41453. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41454. /**
  41455. * @hidden
  41456. * Defines the actions happening before clear the canvas.
  41457. */
  41458. _beforeClearStage: Stage<SimpleStageAction>;
  41459. /**
  41460. * @hidden
  41461. * Defines the actions when collecting render targets for the frame.
  41462. */
  41463. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41464. /**
  41465. * @hidden
  41466. * Defines the actions happening for one camera in the frame.
  41467. */
  41468. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41469. /**
  41470. * @hidden
  41471. * Defines the actions happening during the per mesh ready checks.
  41472. */
  41473. _isReadyForMeshStage: Stage<MeshStageAction>;
  41474. /**
  41475. * @hidden
  41476. * Defines the actions happening before evaluate active mesh checks.
  41477. */
  41478. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41479. /**
  41480. * @hidden
  41481. * Defines the actions happening during the evaluate sub mesh checks.
  41482. */
  41483. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41484. /**
  41485. * @hidden
  41486. * Defines the actions happening during the active mesh stage.
  41487. */
  41488. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41489. /**
  41490. * @hidden
  41491. * Defines the actions happening during the per camera render target step.
  41492. */
  41493. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41494. /**
  41495. * @hidden
  41496. * Defines the actions happening just before the active camera is drawing.
  41497. */
  41498. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41499. /**
  41500. * @hidden
  41501. * Defines the actions happening just before a render target is drawing.
  41502. */
  41503. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41504. /**
  41505. * @hidden
  41506. * Defines the actions happening just before a rendering group is drawing.
  41507. */
  41508. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41509. /**
  41510. * @hidden
  41511. * Defines the actions happening just before a mesh is drawing.
  41512. */
  41513. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41514. /**
  41515. * @hidden
  41516. * Defines the actions happening just after a mesh has been drawn.
  41517. */
  41518. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41519. /**
  41520. * @hidden
  41521. * Defines the actions happening just after a rendering group has been drawn.
  41522. */
  41523. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41524. /**
  41525. * @hidden
  41526. * Defines the actions happening just after the active camera has been drawn.
  41527. */
  41528. _afterCameraDrawStage: Stage<CameraStageAction>;
  41529. /**
  41530. * @hidden
  41531. * Defines the actions happening just after a render target has been drawn.
  41532. */
  41533. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41534. /**
  41535. * @hidden
  41536. * Defines the actions happening just after rendering all cameras and computing intersections.
  41537. */
  41538. _afterRenderStage: Stage<SimpleStageAction>;
  41539. /**
  41540. * @hidden
  41541. * Defines the actions happening when a pointer move event happens.
  41542. */
  41543. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41544. /**
  41545. * @hidden
  41546. * Defines the actions happening when a pointer down event happens.
  41547. */
  41548. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41549. /**
  41550. * @hidden
  41551. * Defines the actions happening when a pointer up event happens.
  41552. */
  41553. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41554. /**
  41555. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41556. */
  41557. private geometriesByUniqueId;
  41558. /**
  41559. * Creates a new Scene
  41560. * @param engine defines the engine to use to render this scene
  41561. * @param options defines the scene options
  41562. */
  41563. constructor(engine: Engine, options?: SceneOptions);
  41564. /**
  41565. * Gets a string identifying the name of the class
  41566. * @returns "Scene" string
  41567. */
  41568. getClassName(): string;
  41569. private _defaultMeshCandidates;
  41570. /**
  41571. * @hidden
  41572. */
  41573. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41574. private _defaultSubMeshCandidates;
  41575. /**
  41576. * @hidden
  41577. */
  41578. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41579. /**
  41580. * Sets the default candidate providers for the scene.
  41581. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41582. * and getCollidingSubMeshCandidates to their default function
  41583. */
  41584. setDefaultCandidateProviders(): void;
  41585. /**
  41586. * Gets the mesh that is currently under the pointer
  41587. */
  41588. get meshUnderPointer(): Nullable<AbstractMesh>;
  41589. /**
  41590. * Gets or sets the current on-screen X position of the pointer
  41591. */
  41592. get pointerX(): number;
  41593. set pointerX(value: number);
  41594. /**
  41595. * Gets or sets the current on-screen Y position of the pointer
  41596. */
  41597. get pointerY(): number;
  41598. set pointerY(value: number);
  41599. /**
  41600. * Gets the cached material (ie. the latest rendered one)
  41601. * @returns the cached material
  41602. */
  41603. getCachedMaterial(): Nullable<Material>;
  41604. /**
  41605. * Gets the cached effect (ie. the latest rendered one)
  41606. * @returns the cached effect
  41607. */
  41608. getCachedEffect(): Nullable<Effect>;
  41609. /**
  41610. * Gets the cached visibility state (ie. the latest rendered one)
  41611. * @returns the cached visibility state
  41612. */
  41613. getCachedVisibility(): Nullable<number>;
  41614. /**
  41615. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41616. * @param material defines the current material
  41617. * @param effect defines the current effect
  41618. * @param visibility defines the current visibility state
  41619. * @returns true if one parameter is not cached
  41620. */
  41621. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41622. /**
  41623. * Gets the engine associated with the scene
  41624. * @returns an Engine
  41625. */
  41626. getEngine(): Engine;
  41627. /**
  41628. * Gets the total number of vertices rendered per frame
  41629. * @returns the total number of vertices rendered per frame
  41630. */
  41631. getTotalVertices(): number;
  41632. /**
  41633. * Gets the performance counter for total vertices
  41634. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41635. */
  41636. get totalVerticesPerfCounter(): PerfCounter;
  41637. /**
  41638. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41639. * @returns the total number of active indices rendered per frame
  41640. */
  41641. getActiveIndices(): number;
  41642. /**
  41643. * Gets the performance counter for active indices
  41644. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41645. */
  41646. get totalActiveIndicesPerfCounter(): PerfCounter;
  41647. /**
  41648. * Gets the total number of active particles rendered per frame
  41649. * @returns the total number of active particles rendered per frame
  41650. */
  41651. getActiveParticles(): number;
  41652. /**
  41653. * Gets the performance counter for active particles
  41654. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41655. */
  41656. get activeParticlesPerfCounter(): PerfCounter;
  41657. /**
  41658. * Gets the total number of active bones rendered per frame
  41659. * @returns the total number of active bones rendered per frame
  41660. */
  41661. getActiveBones(): number;
  41662. /**
  41663. * Gets the performance counter for active bones
  41664. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41665. */
  41666. get activeBonesPerfCounter(): PerfCounter;
  41667. /**
  41668. * Gets the array of active meshes
  41669. * @returns an array of AbstractMesh
  41670. */
  41671. getActiveMeshes(): SmartArray<AbstractMesh>;
  41672. /**
  41673. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41674. * @returns a number
  41675. */
  41676. getAnimationRatio(): number;
  41677. /**
  41678. * Gets an unique Id for the current render phase
  41679. * @returns a number
  41680. */
  41681. getRenderId(): number;
  41682. /**
  41683. * Gets an unique Id for the current frame
  41684. * @returns a number
  41685. */
  41686. getFrameId(): number;
  41687. /** Call this function if you want to manually increment the render Id*/
  41688. incrementRenderId(): void;
  41689. private _createUbo;
  41690. /**
  41691. * Use this method to simulate a pointer move on a mesh
  41692. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41693. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41694. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41695. * @returns the current scene
  41696. */
  41697. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41698. /**
  41699. * Use this method to simulate a pointer down on a mesh
  41700. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41701. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41702. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41703. * @returns the current scene
  41704. */
  41705. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41706. /**
  41707. * Use this method to simulate a pointer up on a mesh
  41708. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41709. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41710. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41711. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41712. * @returns the current scene
  41713. */
  41714. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41715. /**
  41716. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41717. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41718. * @returns true if the pointer was captured
  41719. */
  41720. isPointerCaptured(pointerId?: number): boolean;
  41721. /**
  41722. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41723. * @param attachUp defines if you want to attach events to pointerup
  41724. * @param attachDown defines if you want to attach events to pointerdown
  41725. * @param attachMove defines if you want to attach events to pointermove
  41726. */
  41727. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41728. /** Detaches all event handlers*/
  41729. detachControl(): void;
  41730. /**
  41731. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41732. * Delay loaded resources are not taking in account
  41733. * @return true if all required resources are ready
  41734. */
  41735. isReady(): boolean;
  41736. /** Resets all cached information relative to material (including effect and visibility) */
  41737. resetCachedMaterial(): void;
  41738. /**
  41739. * Registers a function to be called before every frame render
  41740. * @param func defines the function to register
  41741. */
  41742. registerBeforeRender(func: () => void): void;
  41743. /**
  41744. * Unregisters a function called before every frame render
  41745. * @param func defines the function to unregister
  41746. */
  41747. unregisterBeforeRender(func: () => void): void;
  41748. /**
  41749. * Registers a function to be called after every frame render
  41750. * @param func defines the function to register
  41751. */
  41752. registerAfterRender(func: () => void): void;
  41753. /**
  41754. * Unregisters a function called after every frame render
  41755. * @param func defines the function to unregister
  41756. */
  41757. unregisterAfterRender(func: () => void): void;
  41758. private _executeOnceBeforeRender;
  41759. /**
  41760. * The provided function will run before render once and will be disposed afterwards.
  41761. * A timeout delay can be provided so that the function will be executed in N ms.
  41762. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41763. * @param func The function to be executed.
  41764. * @param timeout optional delay in ms
  41765. */
  41766. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41767. /** @hidden */
  41768. _addPendingData(data: any): void;
  41769. /** @hidden */
  41770. _removePendingData(data: any): void;
  41771. /**
  41772. * Returns the number of items waiting to be loaded
  41773. * @returns the number of items waiting to be loaded
  41774. */
  41775. getWaitingItemsCount(): number;
  41776. /**
  41777. * Returns a boolean indicating if the scene is still loading data
  41778. */
  41779. get isLoading(): boolean;
  41780. /**
  41781. * Registers a function to be executed when the scene is ready
  41782. * @param {Function} func - the function to be executed
  41783. */
  41784. executeWhenReady(func: () => void): void;
  41785. /**
  41786. * Returns a promise that resolves when the scene is ready
  41787. * @returns A promise that resolves when the scene is ready
  41788. */
  41789. whenReadyAsync(): Promise<void>;
  41790. /** @hidden */
  41791. _checkIsReady(): void;
  41792. /**
  41793. * Gets all animatable attached to the scene
  41794. */
  41795. get animatables(): Animatable[];
  41796. /**
  41797. * Resets the last animation time frame.
  41798. * Useful to override when animations start running when loading a scene for the first time.
  41799. */
  41800. resetLastAnimationTimeFrame(): void;
  41801. /**
  41802. * Gets the current view matrix
  41803. * @returns a Matrix
  41804. */
  41805. getViewMatrix(): Matrix;
  41806. /**
  41807. * Gets the current projection matrix
  41808. * @returns a Matrix
  41809. */
  41810. getProjectionMatrix(): Matrix;
  41811. /**
  41812. * Gets the current transform matrix
  41813. * @returns a Matrix made of View * Projection
  41814. */
  41815. getTransformMatrix(): Matrix;
  41816. /**
  41817. * Sets the current transform matrix
  41818. * @param viewL defines the View matrix to use
  41819. * @param projectionL defines the Projection matrix to use
  41820. * @param viewR defines the right View matrix to use (if provided)
  41821. * @param projectionR defines the right Projection matrix to use (if provided)
  41822. */
  41823. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41824. /**
  41825. * Gets the uniform buffer used to store scene data
  41826. * @returns a UniformBuffer
  41827. */
  41828. getSceneUniformBuffer(): UniformBuffer;
  41829. /**
  41830. * Gets an unique (relatively to the current scene) Id
  41831. * @returns an unique number for the scene
  41832. */
  41833. getUniqueId(): number;
  41834. /**
  41835. * Add a mesh to the list of scene's meshes
  41836. * @param newMesh defines the mesh to add
  41837. * @param recursive if all child meshes should also be added to the scene
  41838. */
  41839. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41840. /**
  41841. * Remove a mesh for the list of scene's meshes
  41842. * @param toRemove defines the mesh to remove
  41843. * @param recursive if all child meshes should also be removed from the scene
  41844. * @returns the index where the mesh was in the mesh list
  41845. */
  41846. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41847. /**
  41848. * Add a transform node to the list of scene's transform nodes
  41849. * @param newTransformNode defines the transform node to add
  41850. */
  41851. addTransformNode(newTransformNode: TransformNode): void;
  41852. /**
  41853. * Remove a transform node for the list of scene's transform nodes
  41854. * @param toRemove defines the transform node to remove
  41855. * @returns the index where the transform node was in the transform node list
  41856. */
  41857. removeTransformNode(toRemove: TransformNode): number;
  41858. /**
  41859. * Remove a skeleton for the list of scene's skeletons
  41860. * @param toRemove defines the skeleton to remove
  41861. * @returns the index where the skeleton was in the skeleton list
  41862. */
  41863. removeSkeleton(toRemove: Skeleton): number;
  41864. /**
  41865. * Remove a morph target for the list of scene's morph targets
  41866. * @param toRemove defines the morph target to remove
  41867. * @returns the index where the morph target was in the morph target list
  41868. */
  41869. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41870. /**
  41871. * Remove a light for the list of scene's lights
  41872. * @param toRemove defines the light to remove
  41873. * @returns the index where the light was in the light list
  41874. */
  41875. removeLight(toRemove: Light): number;
  41876. /**
  41877. * Remove a camera for the list of scene's cameras
  41878. * @param toRemove defines the camera to remove
  41879. * @returns the index where the camera was in the camera list
  41880. */
  41881. removeCamera(toRemove: Camera): number;
  41882. /**
  41883. * Remove a particle system for the list of scene's particle systems
  41884. * @param toRemove defines the particle system to remove
  41885. * @returns the index where the particle system was in the particle system list
  41886. */
  41887. removeParticleSystem(toRemove: IParticleSystem): number;
  41888. /**
  41889. * Remove a animation for the list of scene's animations
  41890. * @param toRemove defines the animation to remove
  41891. * @returns the index where the animation was in the animation list
  41892. */
  41893. removeAnimation(toRemove: Animation): number;
  41894. /**
  41895. * Will stop the animation of the given target
  41896. * @param target - the target
  41897. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41898. * @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)
  41899. */
  41900. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41901. /**
  41902. * Removes the given animation group from this scene.
  41903. * @param toRemove The animation group to remove
  41904. * @returns The index of the removed animation group
  41905. */
  41906. removeAnimationGroup(toRemove: AnimationGroup): number;
  41907. /**
  41908. * Removes the given multi-material from this scene.
  41909. * @param toRemove The multi-material to remove
  41910. * @returns The index of the removed multi-material
  41911. */
  41912. removeMultiMaterial(toRemove: MultiMaterial): number;
  41913. /**
  41914. * Removes the given material from this scene.
  41915. * @param toRemove The material to remove
  41916. * @returns The index of the removed material
  41917. */
  41918. removeMaterial(toRemove: Material): number;
  41919. /**
  41920. * Removes the given action manager from this scene.
  41921. * @param toRemove The action manager to remove
  41922. * @returns The index of the removed action manager
  41923. */
  41924. removeActionManager(toRemove: AbstractActionManager): number;
  41925. /**
  41926. * Removes the given texture from this scene.
  41927. * @param toRemove The texture to remove
  41928. * @returns The index of the removed texture
  41929. */
  41930. removeTexture(toRemove: BaseTexture): number;
  41931. /**
  41932. * Adds the given light to this scene
  41933. * @param newLight The light to add
  41934. */
  41935. addLight(newLight: Light): void;
  41936. /**
  41937. * Sorts the list list based on light priorities
  41938. */
  41939. sortLightsByPriority(): void;
  41940. /**
  41941. * Adds the given camera to this scene
  41942. * @param newCamera The camera to add
  41943. */
  41944. addCamera(newCamera: Camera): void;
  41945. /**
  41946. * Adds the given skeleton to this scene
  41947. * @param newSkeleton The skeleton to add
  41948. */
  41949. addSkeleton(newSkeleton: Skeleton): void;
  41950. /**
  41951. * Adds the given particle system to this scene
  41952. * @param newParticleSystem The particle system to add
  41953. */
  41954. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41955. /**
  41956. * Adds the given animation to this scene
  41957. * @param newAnimation The animation to add
  41958. */
  41959. addAnimation(newAnimation: Animation): void;
  41960. /**
  41961. * Adds the given animation group to this scene.
  41962. * @param newAnimationGroup The animation group to add
  41963. */
  41964. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41965. /**
  41966. * Adds the given multi-material to this scene
  41967. * @param newMultiMaterial The multi-material to add
  41968. */
  41969. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41970. /**
  41971. * Adds the given material to this scene
  41972. * @param newMaterial The material to add
  41973. */
  41974. addMaterial(newMaterial: Material): void;
  41975. /**
  41976. * Adds the given morph target to this scene
  41977. * @param newMorphTargetManager The morph target to add
  41978. */
  41979. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41980. /**
  41981. * Adds the given geometry to this scene
  41982. * @param newGeometry The geometry to add
  41983. */
  41984. addGeometry(newGeometry: Geometry): void;
  41985. /**
  41986. * Adds the given action manager to this scene
  41987. * @param newActionManager The action manager to add
  41988. */
  41989. addActionManager(newActionManager: AbstractActionManager): void;
  41990. /**
  41991. * Adds the given texture to this scene.
  41992. * @param newTexture The texture to add
  41993. */
  41994. addTexture(newTexture: BaseTexture): void;
  41995. /**
  41996. * Switch active camera
  41997. * @param newCamera defines the new active camera
  41998. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41999. */
  42000. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  42001. /**
  42002. * sets the active camera of the scene using its ID
  42003. * @param id defines the camera's ID
  42004. * @return the new active camera or null if none found.
  42005. */
  42006. setActiveCameraByID(id: string): Nullable<Camera>;
  42007. /**
  42008. * sets the active camera of the scene using its name
  42009. * @param name defines the camera's name
  42010. * @returns the new active camera or null if none found.
  42011. */
  42012. setActiveCameraByName(name: string): Nullable<Camera>;
  42013. /**
  42014. * get an animation group using its name
  42015. * @param name defines the material's name
  42016. * @return the animation group or null if none found.
  42017. */
  42018. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42019. /**
  42020. * Get a material using its unique id
  42021. * @param uniqueId defines the material's unique id
  42022. * @return the material or null if none found.
  42023. */
  42024. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42025. /**
  42026. * get a material using its id
  42027. * @param id defines the material's ID
  42028. * @return the material or null if none found.
  42029. */
  42030. getMaterialByID(id: string): Nullable<Material>;
  42031. /**
  42032. * Gets a the last added material using a given id
  42033. * @param id defines the material's ID
  42034. * @return the last material with the given id or null if none found.
  42035. */
  42036. getLastMaterialByID(id: string): Nullable<Material>;
  42037. /**
  42038. * Gets a material using its name
  42039. * @param name defines the material's name
  42040. * @return the material or null if none found.
  42041. */
  42042. getMaterialByName(name: string): Nullable<Material>;
  42043. /**
  42044. * Get a texture using its unique id
  42045. * @param uniqueId defines the texture's unique id
  42046. * @return the texture or null if none found.
  42047. */
  42048. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42049. /**
  42050. * Gets a camera using its id
  42051. * @param id defines the id to look for
  42052. * @returns the camera or null if not found
  42053. */
  42054. getCameraByID(id: string): Nullable<Camera>;
  42055. /**
  42056. * Gets a camera using its unique id
  42057. * @param uniqueId defines the unique id to look for
  42058. * @returns the camera or null if not found
  42059. */
  42060. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42061. /**
  42062. * Gets a camera using its name
  42063. * @param name defines the camera's name
  42064. * @return the camera or null if none found.
  42065. */
  42066. getCameraByName(name: string): Nullable<Camera>;
  42067. /**
  42068. * Gets a bone using its id
  42069. * @param id defines the bone's id
  42070. * @return the bone or null if not found
  42071. */
  42072. getBoneByID(id: string): Nullable<Bone>;
  42073. /**
  42074. * Gets a bone using its id
  42075. * @param name defines the bone's name
  42076. * @return the bone or null if not found
  42077. */
  42078. getBoneByName(name: string): Nullable<Bone>;
  42079. /**
  42080. * Gets a light node using its name
  42081. * @param name defines the the light's name
  42082. * @return the light or null if none found.
  42083. */
  42084. getLightByName(name: string): Nullable<Light>;
  42085. /**
  42086. * Gets a light node using its id
  42087. * @param id defines the light's id
  42088. * @return the light or null if none found.
  42089. */
  42090. getLightByID(id: string): Nullable<Light>;
  42091. /**
  42092. * Gets a light node using its scene-generated unique ID
  42093. * @param uniqueId defines the light's unique id
  42094. * @return the light or null if none found.
  42095. */
  42096. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42097. /**
  42098. * Gets a particle system by id
  42099. * @param id defines the particle system id
  42100. * @return the corresponding system or null if none found
  42101. */
  42102. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42103. /**
  42104. * Gets a geometry using its ID
  42105. * @param id defines the geometry's id
  42106. * @return the geometry or null if none found.
  42107. */
  42108. getGeometryByID(id: string): Nullable<Geometry>;
  42109. private _getGeometryByUniqueID;
  42110. /**
  42111. * Add a new geometry to this scene
  42112. * @param geometry defines the geometry to be added to the scene.
  42113. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42114. * @return a boolean defining if the geometry was added or not
  42115. */
  42116. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42117. /**
  42118. * Removes an existing geometry
  42119. * @param geometry defines the geometry to be removed from the scene
  42120. * @return a boolean defining if the geometry was removed or not
  42121. */
  42122. removeGeometry(geometry: Geometry): boolean;
  42123. /**
  42124. * Gets the list of geometries attached to the scene
  42125. * @returns an array of Geometry
  42126. */
  42127. getGeometries(): Geometry[];
  42128. /**
  42129. * Gets the first added mesh found of a given ID
  42130. * @param id defines the id to search for
  42131. * @return the mesh found or null if not found at all
  42132. */
  42133. getMeshByID(id: string): Nullable<AbstractMesh>;
  42134. /**
  42135. * Gets a list of meshes using their id
  42136. * @param id defines the id to search for
  42137. * @returns a list of meshes
  42138. */
  42139. getMeshesByID(id: string): Array<AbstractMesh>;
  42140. /**
  42141. * Gets the first added transform node found of a given ID
  42142. * @param id defines the id to search for
  42143. * @return the found transform node or null if not found at all.
  42144. */
  42145. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42146. /**
  42147. * Gets a transform node with its auto-generated unique id
  42148. * @param uniqueId efines the unique id to search for
  42149. * @return the found transform node or null if not found at all.
  42150. */
  42151. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42152. /**
  42153. * Gets a list of transform nodes using their id
  42154. * @param id defines the id to search for
  42155. * @returns a list of transform nodes
  42156. */
  42157. getTransformNodesByID(id: string): Array<TransformNode>;
  42158. /**
  42159. * Gets a mesh with its auto-generated unique id
  42160. * @param uniqueId defines the unique id to search for
  42161. * @return the found mesh or null if not found at all.
  42162. */
  42163. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42164. /**
  42165. * Gets a the last added mesh using a given id
  42166. * @param id defines the id to search for
  42167. * @return the found mesh or null if not found at all.
  42168. */
  42169. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42170. /**
  42171. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42172. * @param id defines the id to search for
  42173. * @return the found node or null if not found at all
  42174. */
  42175. getLastEntryByID(id: string): Nullable<Node>;
  42176. /**
  42177. * Gets a node (Mesh, Camera, Light) using a given id
  42178. * @param id defines the id to search for
  42179. * @return the found node or null if not found at all
  42180. */
  42181. getNodeByID(id: string): Nullable<Node>;
  42182. /**
  42183. * Gets a node (Mesh, Camera, Light) using a given name
  42184. * @param name defines the name to search for
  42185. * @return the found node or null if not found at all.
  42186. */
  42187. getNodeByName(name: string): Nullable<Node>;
  42188. /**
  42189. * Gets a mesh using a given name
  42190. * @param name defines the name to search for
  42191. * @return the found mesh or null if not found at all.
  42192. */
  42193. getMeshByName(name: string): Nullable<AbstractMesh>;
  42194. /**
  42195. * Gets a transform node using a given name
  42196. * @param name defines the name to search for
  42197. * @return the found transform node or null if not found at all.
  42198. */
  42199. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42200. /**
  42201. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42202. * @param id defines the id to search for
  42203. * @return the found skeleton or null if not found at all.
  42204. */
  42205. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42206. /**
  42207. * Gets a skeleton using a given auto generated unique id
  42208. * @param uniqueId defines the unique id to search for
  42209. * @return the found skeleton or null if not found at all.
  42210. */
  42211. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42212. /**
  42213. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42214. * @param id defines the id to search for
  42215. * @return the found skeleton or null if not found at all.
  42216. */
  42217. getSkeletonById(id: string): Nullable<Skeleton>;
  42218. /**
  42219. * Gets a skeleton using a given name
  42220. * @param name defines the name to search for
  42221. * @return the found skeleton or null if not found at all.
  42222. */
  42223. getSkeletonByName(name: string): Nullable<Skeleton>;
  42224. /**
  42225. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42226. * @param id defines the id to search for
  42227. * @return the found morph target manager or null if not found at all.
  42228. */
  42229. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42230. /**
  42231. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42232. * @param id defines the id to search for
  42233. * @return the found morph target or null if not found at all.
  42234. */
  42235. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42236. /**
  42237. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42238. * @param name defines the name to search for
  42239. * @return the found morph target or null if not found at all.
  42240. */
  42241. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42242. /**
  42243. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42244. * @param name defines the name to search for
  42245. * @return the found post process or null if not found at all.
  42246. */
  42247. getPostProcessByName(name: string): Nullable<PostProcess>;
  42248. /**
  42249. * Gets a boolean indicating if the given mesh is active
  42250. * @param mesh defines the mesh to look for
  42251. * @returns true if the mesh is in the active list
  42252. */
  42253. isActiveMesh(mesh: AbstractMesh): boolean;
  42254. /**
  42255. * Return a unique id as a string which can serve as an identifier for the scene
  42256. */
  42257. get uid(): string;
  42258. /**
  42259. * Add an externaly attached data from its key.
  42260. * This method call will fail and return false, if such key already exists.
  42261. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42262. * @param key the unique key that identifies the data
  42263. * @param data the data object to associate to the key for this Engine instance
  42264. * @return true if no such key were already present and the data was added successfully, false otherwise
  42265. */
  42266. addExternalData<T>(key: string, data: T): boolean;
  42267. /**
  42268. * Get an externaly attached data from its key
  42269. * @param key the unique key that identifies the data
  42270. * @return the associated data, if present (can be null), or undefined if not present
  42271. */
  42272. getExternalData<T>(key: string): Nullable<T>;
  42273. /**
  42274. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42275. * @param key the unique key that identifies the data
  42276. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42277. * @return the associated data, can be null if the factory returned null.
  42278. */
  42279. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42280. /**
  42281. * Remove an externaly attached data from the Engine instance
  42282. * @param key the unique key that identifies the data
  42283. * @return true if the data was successfully removed, false if it doesn't exist
  42284. */
  42285. removeExternalData(key: string): boolean;
  42286. private _evaluateSubMesh;
  42287. /**
  42288. * Clear the processed materials smart array preventing retention point in material dispose.
  42289. */
  42290. freeProcessedMaterials(): void;
  42291. private _preventFreeActiveMeshesAndRenderingGroups;
  42292. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42293. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42294. * when disposing several meshes in a row or a hierarchy of meshes.
  42295. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42296. */
  42297. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42298. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42299. /**
  42300. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42301. */
  42302. freeActiveMeshes(): void;
  42303. /**
  42304. * Clear the info related to rendering groups preventing retention points during dispose.
  42305. */
  42306. freeRenderingGroups(): void;
  42307. /** @hidden */
  42308. _isInIntermediateRendering(): boolean;
  42309. /**
  42310. * Lambda returning the list of potentially active meshes.
  42311. */
  42312. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42313. /**
  42314. * Lambda returning the list of potentially active sub meshes.
  42315. */
  42316. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42317. /**
  42318. * Lambda returning the list of potentially intersecting sub meshes.
  42319. */
  42320. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42321. /**
  42322. * Lambda returning the list of potentially colliding sub meshes.
  42323. */
  42324. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42325. private _activeMeshesFrozen;
  42326. private _skipEvaluateActiveMeshesCompletely;
  42327. /**
  42328. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42329. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42330. * @returns the current scene
  42331. */
  42332. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42333. /**
  42334. * Use this function to restart evaluating active meshes on every frame
  42335. * @returns the current scene
  42336. */
  42337. unfreezeActiveMeshes(): Scene;
  42338. private _evaluateActiveMeshes;
  42339. private _activeMesh;
  42340. /**
  42341. * Update the transform matrix to update from the current active camera
  42342. * @param force defines a boolean used to force the update even if cache is up to date
  42343. */
  42344. updateTransformMatrix(force?: boolean): void;
  42345. private _bindFrameBuffer;
  42346. /** @hidden */
  42347. _allowPostProcessClearColor: boolean;
  42348. /** @hidden */
  42349. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42350. private _processSubCameras;
  42351. private _checkIntersections;
  42352. /** @hidden */
  42353. _advancePhysicsEngineStep(step: number): void;
  42354. /**
  42355. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42356. */
  42357. getDeterministicFrameTime: () => number;
  42358. /** @hidden */
  42359. _animate(): void;
  42360. /** Execute all animations (for a frame) */
  42361. animate(): void;
  42362. /**
  42363. * Render the scene
  42364. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42365. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42366. */
  42367. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42368. /**
  42369. * Freeze all materials
  42370. * A frozen material will not be updatable but should be faster to render
  42371. */
  42372. freezeMaterials(): void;
  42373. /**
  42374. * Unfreeze all materials
  42375. * A frozen material will not be updatable but should be faster to render
  42376. */
  42377. unfreezeMaterials(): void;
  42378. /**
  42379. * Releases all held ressources
  42380. */
  42381. dispose(): void;
  42382. /**
  42383. * Gets if the scene is already disposed
  42384. */
  42385. get isDisposed(): boolean;
  42386. /**
  42387. * Call this function to reduce memory footprint of the scene.
  42388. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42389. */
  42390. clearCachedVertexData(): void;
  42391. /**
  42392. * This function will remove the local cached buffer data from texture.
  42393. * It will save memory but will prevent the texture from being rebuilt
  42394. */
  42395. cleanCachedTextureBuffer(): void;
  42396. /**
  42397. * Get the world extend vectors with an optional filter
  42398. *
  42399. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42400. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42401. */
  42402. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42403. min: Vector3;
  42404. max: Vector3;
  42405. };
  42406. /**
  42407. * Creates a ray that can be used to pick in the scene
  42408. * @param x defines the x coordinate of the origin (on-screen)
  42409. * @param y defines the y coordinate of the origin (on-screen)
  42410. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42411. * @param camera defines the camera to use for the picking
  42412. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42413. * @returns a Ray
  42414. */
  42415. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42416. /**
  42417. * Creates a ray that can be used to pick in the scene
  42418. * @param x defines the x coordinate of the origin (on-screen)
  42419. * @param y defines the y coordinate of the origin (on-screen)
  42420. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42421. * @param result defines the ray where to store the picking ray
  42422. * @param camera defines the camera to use for the picking
  42423. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42424. * @returns the current scene
  42425. */
  42426. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42427. /**
  42428. * Creates a ray that can be used to pick in the scene
  42429. * @param x defines the x coordinate of the origin (on-screen)
  42430. * @param y defines the y coordinate of the origin (on-screen)
  42431. * @param camera defines the camera to use for the picking
  42432. * @returns a Ray
  42433. */
  42434. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42435. /**
  42436. * Creates a ray that can be used to pick in the scene
  42437. * @param x defines the x coordinate of the origin (on-screen)
  42438. * @param y defines the y coordinate of the origin (on-screen)
  42439. * @param result defines the ray where to store the picking ray
  42440. * @param camera defines the camera to use for the picking
  42441. * @returns the current scene
  42442. */
  42443. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42444. /** Launch a ray to try to pick a mesh in the scene
  42445. * @param x position on screen
  42446. * @param y position on screen
  42447. * @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
  42448. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42449. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42450. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42451. * @returns a PickingInfo
  42452. */
  42453. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42454. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42455. * @param x position on screen
  42456. * @param y position on screen
  42457. * @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
  42458. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42459. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42460. * @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)
  42461. */
  42462. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42463. /** Use the given ray to pick a mesh in the scene
  42464. * @param ray The ray to use to pick meshes
  42465. * @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
  42466. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42467. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42468. * @returns a PickingInfo
  42469. */
  42470. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42471. /**
  42472. * Launch a ray to try to pick a mesh in the scene
  42473. * @param x X position on screen
  42474. * @param y Y position on screen
  42475. * @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
  42476. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42477. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42478. * @returns an array of PickingInfo
  42479. */
  42480. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42481. /**
  42482. * Launch a ray to try to pick a mesh in the scene
  42483. * @param ray Ray to use
  42484. * @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
  42485. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42486. * @returns an array of PickingInfo
  42487. */
  42488. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42489. /**
  42490. * Force the value of meshUnderPointer
  42491. * @param mesh defines the mesh to use
  42492. * @param pointerId optional pointer id when using more than one pointer
  42493. */
  42494. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42495. /**
  42496. * Gets the mesh under the pointer
  42497. * @returns a Mesh or null if no mesh is under the pointer
  42498. */
  42499. getPointerOverMesh(): Nullable<AbstractMesh>;
  42500. /** @hidden */
  42501. _rebuildGeometries(): void;
  42502. /** @hidden */
  42503. _rebuildTextures(): void;
  42504. private _getByTags;
  42505. /**
  42506. * Get a list of meshes by tags
  42507. * @param tagsQuery defines the tags query to use
  42508. * @param forEach defines a predicate used to filter results
  42509. * @returns an array of Mesh
  42510. */
  42511. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42512. /**
  42513. * Get a list of cameras by tags
  42514. * @param tagsQuery defines the tags query to use
  42515. * @param forEach defines a predicate used to filter results
  42516. * @returns an array of Camera
  42517. */
  42518. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42519. /**
  42520. * Get a list of lights by tags
  42521. * @param tagsQuery defines the tags query to use
  42522. * @param forEach defines a predicate used to filter results
  42523. * @returns an array of Light
  42524. */
  42525. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42526. /**
  42527. * Get a list of materials by tags
  42528. * @param tagsQuery defines the tags query to use
  42529. * @param forEach defines a predicate used to filter results
  42530. * @returns an array of Material
  42531. */
  42532. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42533. /**
  42534. * Get a list of transform nodes by tags
  42535. * @param tagsQuery defines the tags query to use
  42536. * @param forEach defines a predicate used to filter results
  42537. * @returns an array of TransformNode
  42538. */
  42539. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42540. /**
  42541. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42542. * This allowed control for front to back rendering or reversly depending of the special needs.
  42543. *
  42544. * @param renderingGroupId The rendering group id corresponding to its index
  42545. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42546. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42547. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42548. */
  42549. 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;
  42550. /**
  42551. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42552. *
  42553. * @param renderingGroupId The rendering group id corresponding to its index
  42554. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42555. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42556. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42557. */
  42558. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42559. /**
  42560. * Gets the current auto clear configuration for one rendering group of the rendering
  42561. * manager.
  42562. * @param index the rendering group index to get the information for
  42563. * @returns The auto clear setup for the requested rendering group
  42564. */
  42565. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42566. private _blockMaterialDirtyMechanism;
  42567. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42568. get blockMaterialDirtyMechanism(): boolean;
  42569. set blockMaterialDirtyMechanism(value: boolean);
  42570. /**
  42571. * Will flag all materials as dirty to trigger new shader compilation
  42572. * @param flag defines the flag used to specify which material part must be marked as dirty
  42573. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42574. */
  42575. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42576. /** @hidden */
  42577. _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;
  42578. /** @hidden */
  42579. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42580. /** @hidden */
  42581. _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;
  42582. /** @hidden */
  42583. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42584. /** @hidden */
  42585. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42586. /** @hidden */
  42587. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42588. }
  42589. }
  42590. declare module "babylonjs/assetContainer" {
  42591. import { AbstractScene } from "babylonjs/abstractScene";
  42592. import { Scene } from "babylonjs/scene";
  42593. import { Mesh } from "babylonjs/Meshes/mesh";
  42594. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42595. import { Skeleton } from "babylonjs/Bones/skeleton";
  42596. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42597. import { Animatable } from "babylonjs/Animations/animatable";
  42598. import { Nullable } from "babylonjs/types";
  42599. import { Node } from "babylonjs/node";
  42600. /**
  42601. * Set of assets to keep when moving a scene into an asset container.
  42602. */
  42603. export class KeepAssets extends AbstractScene {
  42604. }
  42605. /**
  42606. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42607. */
  42608. export class InstantiatedEntries {
  42609. /**
  42610. * List of new root nodes (eg. nodes with no parent)
  42611. */
  42612. rootNodes: TransformNode[];
  42613. /**
  42614. * List of new skeletons
  42615. */
  42616. skeletons: Skeleton[];
  42617. /**
  42618. * List of new animation groups
  42619. */
  42620. animationGroups: AnimationGroup[];
  42621. }
  42622. /**
  42623. * Container with a set of assets that can be added or removed from a scene.
  42624. */
  42625. export class AssetContainer extends AbstractScene {
  42626. private _wasAddedToScene;
  42627. /**
  42628. * The scene the AssetContainer belongs to.
  42629. */
  42630. scene: Scene;
  42631. /**
  42632. * Instantiates an AssetContainer.
  42633. * @param scene The scene the AssetContainer belongs to.
  42634. */
  42635. constructor(scene: Scene);
  42636. /**
  42637. * Instantiate or clone all meshes and add the new ones to the scene.
  42638. * Skeletons and animation groups will all be cloned
  42639. * @param nameFunction defines an optional function used to get new names for clones
  42640. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42641. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42642. */
  42643. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42644. /**
  42645. * Adds all the assets from the container to the scene.
  42646. */
  42647. addAllToScene(): void;
  42648. /**
  42649. * Removes all the assets in the container from the scene
  42650. */
  42651. removeAllFromScene(): void;
  42652. /**
  42653. * Disposes all the assets in the container
  42654. */
  42655. dispose(): void;
  42656. private _moveAssets;
  42657. /**
  42658. * Removes all the assets contained in the scene and adds them to the container.
  42659. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42660. */
  42661. moveAllFromScene(keepAssets?: KeepAssets): void;
  42662. /**
  42663. * 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.
  42664. * @returns the root mesh
  42665. */
  42666. createRootMesh(): Mesh;
  42667. /**
  42668. * Merge animations (direct and animation groups) from this asset container into a scene
  42669. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42670. * @param animatables set of animatables to retarget to a node from the scene
  42671. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42672. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42673. */
  42674. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42675. }
  42676. }
  42677. declare module "babylonjs/abstractScene" {
  42678. import { Scene } from "babylonjs/scene";
  42679. import { Nullable } from "babylonjs/types";
  42680. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42681. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42682. import { Geometry } from "babylonjs/Meshes/geometry";
  42683. import { Skeleton } from "babylonjs/Bones/skeleton";
  42684. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42685. import { AssetContainer } from "babylonjs/assetContainer";
  42686. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42687. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42688. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42689. import { Material } from "babylonjs/Materials/material";
  42690. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42691. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42692. import { Camera } from "babylonjs/Cameras/camera";
  42693. import { Light } from "babylonjs/Lights/light";
  42694. import { Node } from "babylonjs/node";
  42695. import { Animation } from "babylonjs/Animations/animation";
  42696. /**
  42697. * Defines how the parser contract is defined.
  42698. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42699. */
  42700. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42701. /**
  42702. * Defines how the individual parser contract is defined.
  42703. * These parser can parse an individual asset
  42704. */
  42705. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42706. /**
  42707. * Base class of the scene acting as a container for the different elements composing a scene.
  42708. * This class is dynamically extended by the different components of the scene increasing
  42709. * flexibility and reducing coupling
  42710. */
  42711. export abstract class AbstractScene {
  42712. /**
  42713. * Stores the list of available parsers in the application.
  42714. */
  42715. private static _BabylonFileParsers;
  42716. /**
  42717. * Stores the list of available individual parsers in the application.
  42718. */
  42719. private static _IndividualBabylonFileParsers;
  42720. /**
  42721. * Adds a parser in the list of available ones
  42722. * @param name Defines the name of the parser
  42723. * @param parser Defines the parser to add
  42724. */
  42725. static AddParser(name: string, parser: BabylonFileParser): void;
  42726. /**
  42727. * Gets a general parser from the list of avaialble ones
  42728. * @param name Defines the name of the parser
  42729. * @returns the requested parser or null
  42730. */
  42731. static GetParser(name: string): Nullable<BabylonFileParser>;
  42732. /**
  42733. * Adds n individual parser in the list of available ones
  42734. * @param name Defines the name of the parser
  42735. * @param parser Defines the parser to add
  42736. */
  42737. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42738. /**
  42739. * Gets an individual parser from the list of avaialble ones
  42740. * @param name Defines the name of the parser
  42741. * @returns the requested parser or null
  42742. */
  42743. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42744. /**
  42745. * Parser json data and populate both a scene and its associated container object
  42746. * @param jsonData Defines the data to parse
  42747. * @param scene Defines the scene to parse the data for
  42748. * @param container Defines the container attached to the parsing sequence
  42749. * @param rootUrl Defines the root url of the data
  42750. */
  42751. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42752. /**
  42753. * Gets the list of root nodes (ie. nodes with no parent)
  42754. */
  42755. rootNodes: Node[];
  42756. /** All of the cameras added to this scene
  42757. * @see https://doc.babylonjs.com/babylon101/cameras
  42758. */
  42759. cameras: Camera[];
  42760. /**
  42761. * All of the lights added to this scene
  42762. * @see https://doc.babylonjs.com/babylon101/lights
  42763. */
  42764. lights: Light[];
  42765. /**
  42766. * All of the (abstract) meshes added to this scene
  42767. */
  42768. meshes: AbstractMesh[];
  42769. /**
  42770. * The list of skeletons added to the scene
  42771. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42772. */
  42773. skeletons: Skeleton[];
  42774. /**
  42775. * All of the particle systems added to this scene
  42776. * @see https://doc.babylonjs.com/babylon101/particles
  42777. */
  42778. particleSystems: IParticleSystem[];
  42779. /**
  42780. * Gets a list of Animations associated with the scene
  42781. */
  42782. animations: Animation[];
  42783. /**
  42784. * All of the animation groups added to this scene
  42785. * @see https://doc.babylonjs.com/how_to/group
  42786. */
  42787. animationGroups: AnimationGroup[];
  42788. /**
  42789. * All of the multi-materials added to this scene
  42790. * @see https://doc.babylonjs.com/how_to/multi_materials
  42791. */
  42792. multiMaterials: MultiMaterial[];
  42793. /**
  42794. * All of the materials added to this scene
  42795. * In the context of a Scene, it is not supposed to be modified manually.
  42796. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42797. * Note also that the order of the Material within the array is not significant and might change.
  42798. * @see https://doc.babylonjs.com/babylon101/materials
  42799. */
  42800. materials: Material[];
  42801. /**
  42802. * The list of morph target managers added to the scene
  42803. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42804. */
  42805. morphTargetManagers: MorphTargetManager[];
  42806. /**
  42807. * The list of geometries used in the scene.
  42808. */
  42809. geometries: Geometry[];
  42810. /**
  42811. * All of the tranform nodes added to this scene
  42812. * In the context of a Scene, it is not supposed to be modified manually.
  42813. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42814. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42815. * @see https://doc.babylonjs.com/how_to/transformnode
  42816. */
  42817. transformNodes: TransformNode[];
  42818. /**
  42819. * ActionManagers available on the scene.
  42820. */
  42821. actionManagers: AbstractActionManager[];
  42822. /**
  42823. * Textures to keep.
  42824. */
  42825. textures: BaseTexture[];
  42826. /** @hidden */
  42827. protected _environmentTexture: Nullable<BaseTexture>;
  42828. /**
  42829. * Texture used in all pbr material as the reflection texture.
  42830. * As in the majority of the scene they are the same (exception for multi room and so on),
  42831. * this is easier to reference from here than from all the materials.
  42832. */
  42833. get environmentTexture(): Nullable<BaseTexture>;
  42834. set environmentTexture(value: Nullable<BaseTexture>);
  42835. /**
  42836. * The list of postprocesses added to the scene
  42837. */
  42838. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42839. /**
  42840. * @returns all meshes, lights, cameras, transformNodes and bones
  42841. */
  42842. getNodes(): Array<Node>;
  42843. }
  42844. }
  42845. declare module "babylonjs/Audio/sound" {
  42846. import { Observable } from "babylonjs/Misc/observable";
  42847. import { Vector3 } from "babylonjs/Maths/math.vector";
  42848. import { Nullable } from "babylonjs/types";
  42849. import { Scene } from "babylonjs/scene";
  42850. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42851. /**
  42852. * Interface used to define options for Sound class
  42853. */
  42854. export interface ISoundOptions {
  42855. /**
  42856. * Does the sound autoplay once loaded.
  42857. */
  42858. autoplay?: boolean;
  42859. /**
  42860. * Does the sound loop after it finishes playing once.
  42861. */
  42862. loop?: boolean;
  42863. /**
  42864. * Sound's volume
  42865. */
  42866. volume?: number;
  42867. /**
  42868. * Is it a spatial sound?
  42869. */
  42870. spatialSound?: boolean;
  42871. /**
  42872. * Maximum distance to hear that sound
  42873. */
  42874. maxDistance?: number;
  42875. /**
  42876. * Uses user defined attenuation function
  42877. */
  42878. useCustomAttenuation?: boolean;
  42879. /**
  42880. * Define the roll off factor of spatial sounds.
  42881. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42882. */
  42883. rolloffFactor?: number;
  42884. /**
  42885. * Define the reference distance the sound should be heard perfectly.
  42886. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42887. */
  42888. refDistance?: number;
  42889. /**
  42890. * Define the distance attenuation model the sound will follow.
  42891. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42892. */
  42893. distanceModel?: string;
  42894. /**
  42895. * Defines the playback speed (1 by default)
  42896. */
  42897. playbackRate?: number;
  42898. /**
  42899. * Defines if the sound is from a streaming source
  42900. */
  42901. streaming?: boolean;
  42902. /**
  42903. * Defines an optional length (in seconds) inside the sound file
  42904. */
  42905. length?: number;
  42906. /**
  42907. * Defines an optional offset (in seconds) inside the sound file
  42908. */
  42909. offset?: number;
  42910. /**
  42911. * If true, URLs will not be required to state the audio file codec to use.
  42912. */
  42913. skipCodecCheck?: boolean;
  42914. }
  42915. /**
  42916. * Defines a sound that can be played in the application.
  42917. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42918. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42919. */
  42920. export class Sound {
  42921. /**
  42922. * The name of the sound in the scene.
  42923. */
  42924. name: string;
  42925. /**
  42926. * Does the sound autoplay once loaded.
  42927. */
  42928. autoplay: boolean;
  42929. /**
  42930. * Does the sound loop after it finishes playing once.
  42931. */
  42932. loop: boolean;
  42933. /**
  42934. * Does the sound use a custom attenuation curve to simulate the falloff
  42935. * happening when the source gets further away from the camera.
  42936. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42937. */
  42938. useCustomAttenuation: boolean;
  42939. /**
  42940. * The sound track id this sound belongs to.
  42941. */
  42942. soundTrackId: number;
  42943. /**
  42944. * Is this sound currently played.
  42945. */
  42946. isPlaying: boolean;
  42947. /**
  42948. * Is this sound currently paused.
  42949. */
  42950. isPaused: boolean;
  42951. /**
  42952. * Does this sound enables spatial sound.
  42953. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42954. */
  42955. spatialSound: boolean;
  42956. /**
  42957. * Define the reference distance the sound should be heard perfectly.
  42958. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42959. */
  42960. refDistance: number;
  42961. /**
  42962. * Define the roll off factor of spatial sounds.
  42963. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42964. */
  42965. rolloffFactor: number;
  42966. /**
  42967. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42968. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42969. */
  42970. maxDistance: number;
  42971. /**
  42972. * Define the distance attenuation model the sound will follow.
  42973. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42974. */
  42975. distanceModel: string;
  42976. /**
  42977. * @hidden
  42978. * Back Compat
  42979. **/
  42980. onended: () => any;
  42981. /**
  42982. * Gets or sets an object used to store user defined information for the sound.
  42983. */
  42984. metadata: any;
  42985. /**
  42986. * Observable event when the current playing sound finishes.
  42987. */
  42988. onEndedObservable: Observable<Sound>;
  42989. private _panningModel;
  42990. private _playbackRate;
  42991. private _streaming;
  42992. private _startTime;
  42993. private _startOffset;
  42994. private _position;
  42995. /** @hidden */
  42996. _positionInEmitterSpace: boolean;
  42997. private _localDirection;
  42998. private _volume;
  42999. private _isReadyToPlay;
  43000. private _isDirectional;
  43001. private _readyToPlayCallback;
  43002. private _audioBuffer;
  43003. private _soundSource;
  43004. private _streamingSource;
  43005. private _soundPanner;
  43006. private _soundGain;
  43007. private _inputAudioNode;
  43008. private _outputAudioNode;
  43009. private _coneInnerAngle;
  43010. private _coneOuterAngle;
  43011. private _coneOuterGain;
  43012. private _scene;
  43013. private _connectedTransformNode;
  43014. private _customAttenuationFunction;
  43015. private _registerFunc;
  43016. private _isOutputConnected;
  43017. private _htmlAudioElement;
  43018. private _urlType;
  43019. private _length?;
  43020. private _offset?;
  43021. /** @hidden */
  43022. static _SceneComponentInitialization: (scene: Scene) => void;
  43023. /**
  43024. * Create a sound and attach it to a scene
  43025. * @param name Name of your sound
  43026. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43027. * @param scene defines the scene the sound belongs to
  43028. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43029. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43030. */
  43031. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43032. /**
  43033. * Release the sound and its associated resources
  43034. */
  43035. dispose(): void;
  43036. /**
  43037. * Gets if the sounds is ready to be played or not.
  43038. * @returns true if ready, otherwise false
  43039. */
  43040. isReady(): boolean;
  43041. private _soundLoaded;
  43042. /**
  43043. * Sets the data of the sound from an audiobuffer
  43044. * @param audioBuffer The audioBuffer containing the data
  43045. */
  43046. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43047. /**
  43048. * Updates the current sounds options such as maxdistance, loop...
  43049. * @param options A JSON object containing values named as the object properties
  43050. */
  43051. updateOptions(options: ISoundOptions): void;
  43052. private _createSpatialParameters;
  43053. private _updateSpatialParameters;
  43054. /**
  43055. * Switch the panning model to HRTF:
  43056. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43057. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43058. */
  43059. switchPanningModelToHRTF(): void;
  43060. /**
  43061. * Switch the panning model to Equal Power:
  43062. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43063. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43064. */
  43065. switchPanningModelToEqualPower(): void;
  43066. private _switchPanningModel;
  43067. /**
  43068. * Connect this sound to a sound track audio node like gain...
  43069. * @param soundTrackAudioNode the sound track audio node to connect to
  43070. */
  43071. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43072. /**
  43073. * Transform this sound into a directional source
  43074. * @param coneInnerAngle Size of the inner cone in degree
  43075. * @param coneOuterAngle Size of the outer cone in degree
  43076. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43077. */
  43078. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43079. /**
  43080. * Gets or sets the inner angle for the directional cone.
  43081. */
  43082. get directionalConeInnerAngle(): number;
  43083. /**
  43084. * Gets or sets the inner angle for the directional cone.
  43085. */
  43086. set directionalConeInnerAngle(value: number);
  43087. /**
  43088. * Gets or sets the outer angle for the directional cone.
  43089. */
  43090. get directionalConeOuterAngle(): number;
  43091. /**
  43092. * Gets or sets the outer angle for the directional cone.
  43093. */
  43094. set directionalConeOuterAngle(value: number);
  43095. /**
  43096. * Sets the position of the emitter if spatial sound is enabled
  43097. * @param newPosition Defines the new posisiton
  43098. */
  43099. setPosition(newPosition: Vector3): void;
  43100. /**
  43101. * Sets the local direction of the emitter if spatial sound is enabled
  43102. * @param newLocalDirection Defines the new local direction
  43103. */
  43104. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43105. private _updateDirection;
  43106. /** @hidden */
  43107. updateDistanceFromListener(): void;
  43108. /**
  43109. * Sets a new custom attenuation function for the sound.
  43110. * @param callback Defines the function used for the attenuation
  43111. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43112. */
  43113. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43114. /**
  43115. * Play the sound
  43116. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43117. * @param offset (optional) Start the sound at a specific time in seconds
  43118. * @param length (optional) Sound duration (in seconds)
  43119. */
  43120. play(time?: number, offset?: number, length?: number): void;
  43121. private _onended;
  43122. /**
  43123. * Stop the sound
  43124. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43125. */
  43126. stop(time?: number): void;
  43127. /**
  43128. * Put the sound in pause
  43129. */
  43130. pause(): void;
  43131. /**
  43132. * Sets a dedicated volume for this sounds
  43133. * @param newVolume Define the new volume of the sound
  43134. * @param time Define time for gradual change to new volume
  43135. */
  43136. setVolume(newVolume: number, time?: number): void;
  43137. /**
  43138. * Set the sound play back rate
  43139. * @param newPlaybackRate Define the playback rate the sound should be played at
  43140. */
  43141. setPlaybackRate(newPlaybackRate: number): void;
  43142. /**
  43143. * Gets the volume of the sound.
  43144. * @returns the volume of the sound
  43145. */
  43146. getVolume(): number;
  43147. /**
  43148. * Attach the sound to a dedicated mesh
  43149. * @param transformNode The transform node to connect the sound with
  43150. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43151. */
  43152. attachToMesh(transformNode: TransformNode): void;
  43153. /**
  43154. * Detach the sound from the previously attached mesh
  43155. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43156. */
  43157. detachFromMesh(): void;
  43158. private _onRegisterAfterWorldMatrixUpdate;
  43159. /**
  43160. * Clone the current sound in the scene.
  43161. * @returns the new sound clone
  43162. */
  43163. clone(): Nullable<Sound>;
  43164. /**
  43165. * Gets the current underlying audio buffer containing the data
  43166. * @returns the audio buffer
  43167. */
  43168. getAudioBuffer(): Nullable<AudioBuffer>;
  43169. /**
  43170. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43171. * @returns the source node
  43172. */
  43173. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43174. /**
  43175. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43176. * @returns the gain node
  43177. */
  43178. getSoundGain(): Nullable<GainNode>;
  43179. /**
  43180. * Serializes the Sound in a JSON representation
  43181. * @returns the JSON representation of the sound
  43182. */
  43183. serialize(): any;
  43184. /**
  43185. * Parse a JSON representation of a sound to innstantiate in a given scene
  43186. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43187. * @param scene Define the scene the new parsed sound should be created in
  43188. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43189. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43190. * @returns the newly parsed sound
  43191. */
  43192. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43193. }
  43194. }
  43195. declare module "babylonjs/Actions/directAudioActions" {
  43196. import { Action } from "babylonjs/Actions/action";
  43197. import { Condition } from "babylonjs/Actions/condition";
  43198. import { Sound } from "babylonjs/Audio/sound";
  43199. /**
  43200. * This defines an action helpful to play a defined sound on a triggered action.
  43201. */
  43202. export class PlaySoundAction extends Action {
  43203. private _sound;
  43204. /**
  43205. * Instantiate the action
  43206. * @param triggerOptions defines the trigger options
  43207. * @param sound defines the sound to play
  43208. * @param condition defines the trigger related conditions
  43209. */
  43210. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43211. /** @hidden */
  43212. _prepare(): void;
  43213. /**
  43214. * Execute the action and play the sound.
  43215. */
  43216. execute(): void;
  43217. /**
  43218. * Serializes the actions and its related information.
  43219. * @param parent defines the object to serialize in
  43220. * @returns the serialized object
  43221. */
  43222. serialize(parent: any): any;
  43223. }
  43224. /**
  43225. * This defines an action helpful to stop a defined sound on a triggered action.
  43226. */
  43227. export class StopSoundAction extends Action {
  43228. private _sound;
  43229. /**
  43230. * Instantiate the action
  43231. * @param triggerOptions defines the trigger options
  43232. * @param sound defines the sound to stop
  43233. * @param condition defines the trigger related conditions
  43234. */
  43235. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43236. /** @hidden */
  43237. _prepare(): void;
  43238. /**
  43239. * Execute the action and stop the sound.
  43240. */
  43241. execute(): void;
  43242. /**
  43243. * Serializes the actions and its related information.
  43244. * @param parent defines the object to serialize in
  43245. * @returns the serialized object
  43246. */
  43247. serialize(parent: any): any;
  43248. }
  43249. }
  43250. declare module "babylonjs/Actions/interpolateValueAction" {
  43251. import { Action } from "babylonjs/Actions/action";
  43252. import { Condition } from "babylonjs/Actions/condition";
  43253. import { Observable } from "babylonjs/Misc/observable";
  43254. /**
  43255. * This defines an action responsible to change the value of a property
  43256. * by interpolating between its current value and the newly set one once triggered.
  43257. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43258. */
  43259. export class InterpolateValueAction extends Action {
  43260. /**
  43261. * Defines the path of the property where the value should be interpolated
  43262. */
  43263. propertyPath: string;
  43264. /**
  43265. * Defines the target value at the end of the interpolation.
  43266. */
  43267. value: any;
  43268. /**
  43269. * Defines the time it will take for the property to interpolate to the value.
  43270. */
  43271. duration: number;
  43272. /**
  43273. * Defines if the other scene animations should be stopped when the action has been triggered
  43274. */
  43275. stopOtherAnimations?: boolean;
  43276. /**
  43277. * Defines a callback raised once the interpolation animation has been done.
  43278. */
  43279. onInterpolationDone?: () => void;
  43280. /**
  43281. * Observable triggered once the interpolation animation has been done.
  43282. */
  43283. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43284. private _target;
  43285. private _effectiveTarget;
  43286. private _property;
  43287. /**
  43288. * Instantiate the action
  43289. * @param triggerOptions defines the trigger options
  43290. * @param target defines the object containing the value to interpolate
  43291. * @param propertyPath defines the path to the property in the target object
  43292. * @param value defines the target value at the end of the interpolation
  43293. * @param duration deines the time it will take for the property to interpolate to the value.
  43294. * @param condition defines the trigger related conditions
  43295. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43296. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43297. */
  43298. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43299. /** @hidden */
  43300. _prepare(): void;
  43301. /**
  43302. * Execute the action starts the value interpolation.
  43303. */
  43304. execute(): void;
  43305. /**
  43306. * Serializes the actions and its related information.
  43307. * @param parent defines the object to serialize in
  43308. * @returns the serialized object
  43309. */
  43310. serialize(parent: any): any;
  43311. }
  43312. }
  43313. declare module "babylonjs/Actions/index" {
  43314. export * from "babylonjs/Actions/abstractActionManager";
  43315. export * from "babylonjs/Actions/action";
  43316. export * from "babylonjs/Actions/actionEvent";
  43317. export * from "babylonjs/Actions/actionManager";
  43318. export * from "babylonjs/Actions/condition";
  43319. export * from "babylonjs/Actions/directActions";
  43320. export * from "babylonjs/Actions/directAudioActions";
  43321. export * from "babylonjs/Actions/interpolateValueAction";
  43322. }
  43323. declare module "babylonjs/Animations/index" {
  43324. export * from "babylonjs/Animations/animatable";
  43325. export * from "babylonjs/Animations/animation";
  43326. export * from "babylonjs/Animations/animationGroup";
  43327. export * from "babylonjs/Animations/animationPropertiesOverride";
  43328. export * from "babylonjs/Animations/easing";
  43329. export * from "babylonjs/Animations/runtimeAnimation";
  43330. export * from "babylonjs/Animations/animationEvent";
  43331. export * from "babylonjs/Animations/animationGroup";
  43332. export * from "babylonjs/Animations/animationKey";
  43333. export * from "babylonjs/Animations/animationRange";
  43334. export * from "babylonjs/Animations/animatable.interface";
  43335. }
  43336. declare module "babylonjs/Audio/soundTrack" {
  43337. import { Sound } from "babylonjs/Audio/sound";
  43338. import { Analyser } from "babylonjs/Audio/analyser";
  43339. import { Scene } from "babylonjs/scene";
  43340. /**
  43341. * Options allowed during the creation of a sound track.
  43342. */
  43343. export interface ISoundTrackOptions {
  43344. /**
  43345. * The volume the sound track should take during creation
  43346. */
  43347. volume?: number;
  43348. /**
  43349. * Define if the sound track is the main sound track of the scene
  43350. */
  43351. mainTrack?: boolean;
  43352. }
  43353. /**
  43354. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43355. * It will be also used in a future release to apply effects on a specific track.
  43356. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43357. */
  43358. export class SoundTrack {
  43359. /**
  43360. * The unique identifier of the sound track in the scene.
  43361. */
  43362. id: number;
  43363. /**
  43364. * The list of sounds included in the sound track.
  43365. */
  43366. soundCollection: Array<Sound>;
  43367. private _outputAudioNode;
  43368. private _scene;
  43369. private _connectedAnalyser;
  43370. private _options;
  43371. private _isInitialized;
  43372. /**
  43373. * Creates a new sound track.
  43374. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43375. * @param scene Define the scene the sound track belongs to
  43376. * @param options
  43377. */
  43378. constructor(scene: Scene, options?: ISoundTrackOptions);
  43379. private _initializeSoundTrackAudioGraph;
  43380. /**
  43381. * Release the sound track and its associated resources
  43382. */
  43383. dispose(): void;
  43384. /**
  43385. * Adds a sound to this sound track
  43386. * @param sound define the cound to add
  43387. * @ignoreNaming
  43388. */
  43389. AddSound(sound: Sound): void;
  43390. /**
  43391. * Removes a sound to this sound track
  43392. * @param sound define the cound to remove
  43393. * @ignoreNaming
  43394. */
  43395. RemoveSound(sound: Sound): void;
  43396. /**
  43397. * Set a global volume for the full sound track.
  43398. * @param newVolume Define the new volume of the sound track
  43399. */
  43400. setVolume(newVolume: number): void;
  43401. /**
  43402. * Switch the panning model to HRTF:
  43403. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43404. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43405. */
  43406. switchPanningModelToHRTF(): void;
  43407. /**
  43408. * Switch the panning model to Equal Power:
  43409. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43410. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43411. */
  43412. switchPanningModelToEqualPower(): void;
  43413. /**
  43414. * Connect the sound track to an audio analyser allowing some amazing
  43415. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43416. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43417. * @param analyser The analyser to connect to the engine
  43418. */
  43419. connectToAnalyser(analyser: Analyser): void;
  43420. }
  43421. }
  43422. declare module "babylonjs/Audio/audioSceneComponent" {
  43423. import { Sound } from "babylonjs/Audio/sound";
  43424. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43425. import { Nullable } from "babylonjs/types";
  43426. import { Vector3 } from "babylonjs/Maths/math.vector";
  43427. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43428. import { Scene } from "babylonjs/scene";
  43429. import { AbstractScene } from "babylonjs/abstractScene";
  43430. import "babylonjs/Audio/audioEngine";
  43431. module "babylonjs/abstractScene" {
  43432. interface AbstractScene {
  43433. /**
  43434. * The list of sounds used in the scene.
  43435. */
  43436. sounds: Nullable<Array<Sound>>;
  43437. }
  43438. }
  43439. module "babylonjs/scene" {
  43440. interface Scene {
  43441. /**
  43442. * @hidden
  43443. * Backing field
  43444. */
  43445. _mainSoundTrack: SoundTrack;
  43446. /**
  43447. * The main sound track played by the scene.
  43448. * It cotains your primary collection of sounds.
  43449. */
  43450. mainSoundTrack: SoundTrack;
  43451. /**
  43452. * The list of sound tracks added to the scene
  43453. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43454. */
  43455. soundTracks: Nullable<Array<SoundTrack>>;
  43456. /**
  43457. * Gets a sound using a given name
  43458. * @param name defines the name to search for
  43459. * @return the found sound or null if not found at all.
  43460. */
  43461. getSoundByName(name: string): Nullable<Sound>;
  43462. /**
  43463. * Gets or sets if audio support is enabled
  43464. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43465. */
  43466. audioEnabled: boolean;
  43467. /**
  43468. * Gets or sets if audio will be output to headphones
  43469. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43470. */
  43471. headphone: boolean;
  43472. /**
  43473. * Gets or sets custom audio listener position provider
  43474. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43475. */
  43476. audioListenerPositionProvider: Nullable<() => Vector3>;
  43477. /**
  43478. * Gets or sets a refresh rate when using 3D audio positioning
  43479. */
  43480. audioPositioningRefreshRate: number;
  43481. }
  43482. }
  43483. /**
  43484. * Defines the sound scene component responsible to manage any sounds
  43485. * in a given scene.
  43486. */
  43487. export class AudioSceneComponent implements ISceneSerializableComponent {
  43488. private static _CameraDirectionLH;
  43489. private static _CameraDirectionRH;
  43490. /**
  43491. * The component name helpfull to identify the component in the list of scene components.
  43492. */
  43493. readonly name: string;
  43494. /**
  43495. * The scene the component belongs to.
  43496. */
  43497. scene: Scene;
  43498. private _audioEnabled;
  43499. /**
  43500. * Gets whether audio is enabled or not.
  43501. * Please use related enable/disable method to switch state.
  43502. */
  43503. get audioEnabled(): boolean;
  43504. private _headphone;
  43505. /**
  43506. * Gets whether audio is outputing to headphone or not.
  43507. * Please use the according Switch methods to change output.
  43508. */
  43509. get headphone(): boolean;
  43510. /**
  43511. * Gets or sets a refresh rate when using 3D audio positioning
  43512. */
  43513. audioPositioningRefreshRate: number;
  43514. private _audioListenerPositionProvider;
  43515. /**
  43516. * Gets the current audio listener position provider
  43517. */
  43518. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43519. /**
  43520. * Sets a custom listener position for all sounds in the scene
  43521. * By default, this is the position of the first active camera
  43522. */
  43523. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43524. /**
  43525. * Creates a new instance of the component for the given scene
  43526. * @param scene Defines the scene to register the component in
  43527. */
  43528. constructor(scene: Scene);
  43529. /**
  43530. * Registers the component in a given scene
  43531. */
  43532. register(): void;
  43533. /**
  43534. * Rebuilds the elements related to this component in case of
  43535. * context lost for instance.
  43536. */
  43537. rebuild(): void;
  43538. /**
  43539. * Serializes the component data to the specified json object
  43540. * @param serializationObject The object to serialize to
  43541. */
  43542. serialize(serializationObject: any): void;
  43543. /**
  43544. * Adds all the elements from the container to the scene
  43545. * @param container the container holding the elements
  43546. */
  43547. addFromContainer(container: AbstractScene): void;
  43548. /**
  43549. * Removes all the elements in the container from the scene
  43550. * @param container contains the elements to remove
  43551. * @param dispose if the removed element should be disposed (default: false)
  43552. */
  43553. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43554. /**
  43555. * Disposes the component and the associated ressources.
  43556. */
  43557. dispose(): void;
  43558. /**
  43559. * Disables audio in the associated scene.
  43560. */
  43561. disableAudio(): void;
  43562. /**
  43563. * Enables audio in the associated scene.
  43564. */
  43565. enableAudio(): void;
  43566. /**
  43567. * Switch audio to headphone output.
  43568. */
  43569. switchAudioModeForHeadphones(): void;
  43570. /**
  43571. * Switch audio to normal speakers.
  43572. */
  43573. switchAudioModeForNormalSpeakers(): void;
  43574. private _cachedCameraDirection;
  43575. private _cachedCameraPosition;
  43576. private _lastCheck;
  43577. private _afterRender;
  43578. }
  43579. }
  43580. declare module "babylonjs/Audio/weightedsound" {
  43581. import { Sound } from "babylonjs/Audio/sound";
  43582. /**
  43583. * Wraps one or more Sound objects and selects one with random weight for playback.
  43584. */
  43585. export class WeightedSound {
  43586. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43587. loop: boolean;
  43588. private _coneInnerAngle;
  43589. private _coneOuterAngle;
  43590. private _volume;
  43591. /** A Sound is currently playing. */
  43592. isPlaying: boolean;
  43593. /** A Sound is currently paused. */
  43594. isPaused: boolean;
  43595. private _sounds;
  43596. private _weights;
  43597. private _currentIndex?;
  43598. /**
  43599. * Creates a new WeightedSound from the list of sounds given.
  43600. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43601. * @param sounds Array of Sounds that will be selected from.
  43602. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43603. */
  43604. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43605. /**
  43606. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43607. */
  43608. get directionalConeInnerAngle(): number;
  43609. /**
  43610. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43611. */
  43612. set directionalConeInnerAngle(value: number);
  43613. /**
  43614. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43615. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43616. */
  43617. get directionalConeOuterAngle(): number;
  43618. /**
  43619. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43620. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43621. */
  43622. set directionalConeOuterAngle(value: number);
  43623. /**
  43624. * Playback volume.
  43625. */
  43626. get volume(): number;
  43627. /**
  43628. * Playback volume.
  43629. */
  43630. set volume(value: number);
  43631. private _onended;
  43632. /**
  43633. * Suspend playback
  43634. */
  43635. pause(): void;
  43636. /**
  43637. * Stop playback
  43638. */
  43639. stop(): void;
  43640. /**
  43641. * Start playback.
  43642. * @param startOffset Position the clip head at a specific time in seconds.
  43643. */
  43644. play(startOffset?: number): void;
  43645. }
  43646. }
  43647. declare module "babylonjs/Audio/index" {
  43648. export * from "babylonjs/Audio/analyser";
  43649. export * from "babylonjs/Audio/audioEngine";
  43650. export * from "babylonjs/Audio/audioSceneComponent";
  43651. export * from "babylonjs/Audio/sound";
  43652. export * from "babylonjs/Audio/soundTrack";
  43653. export * from "babylonjs/Audio/weightedsound";
  43654. }
  43655. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43656. import { Behavior } from "babylonjs/Behaviors/behavior";
  43657. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43658. import { BackEase } from "babylonjs/Animations/easing";
  43659. /**
  43660. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43661. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43662. */
  43663. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43664. /**
  43665. * Gets the name of the behavior.
  43666. */
  43667. get name(): string;
  43668. /**
  43669. * The easing function used by animations
  43670. */
  43671. static EasingFunction: BackEase;
  43672. /**
  43673. * The easing mode used by animations
  43674. */
  43675. static EasingMode: number;
  43676. /**
  43677. * The duration of the animation, in milliseconds
  43678. */
  43679. transitionDuration: number;
  43680. /**
  43681. * Length of the distance animated by the transition when lower radius is reached
  43682. */
  43683. lowerRadiusTransitionRange: number;
  43684. /**
  43685. * Length of the distance animated by the transition when upper radius is reached
  43686. */
  43687. upperRadiusTransitionRange: number;
  43688. private _autoTransitionRange;
  43689. /**
  43690. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43691. */
  43692. get autoTransitionRange(): boolean;
  43693. /**
  43694. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43695. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43696. */
  43697. set autoTransitionRange(value: boolean);
  43698. private _attachedCamera;
  43699. private _onAfterCheckInputsObserver;
  43700. private _onMeshTargetChangedObserver;
  43701. /**
  43702. * Initializes the behavior.
  43703. */
  43704. init(): void;
  43705. /**
  43706. * Attaches the behavior to its arc rotate camera.
  43707. * @param camera Defines the camera to attach the behavior to
  43708. */
  43709. attach(camera: ArcRotateCamera): void;
  43710. /**
  43711. * Detaches the behavior from its current arc rotate camera.
  43712. */
  43713. detach(): void;
  43714. private _radiusIsAnimating;
  43715. private _radiusBounceTransition;
  43716. private _animatables;
  43717. private _cachedWheelPrecision;
  43718. /**
  43719. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43720. * @param radiusLimit The limit to check against.
  43721. * @return Bool to indicate if at limit.
  43722. */
  43723. private _isRadiusAtLimit;
  43724. /**
  43725. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43726. * @param radiusDelta The delta by which to animate to. Can be negative.
  43727. */
  43728. private _applyBoundRadiusAnimation;
  43729. /**
  43730. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43731. */
  43732. protected _clearAnimationLocks(): void;
  43733. /**
  43734. * Stops and removes all animations that have been applied to the camera
  43735. */
  43736. stopAllAnimations(): void;
  43737. }
  43738. }
  43739. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43740. import { Behavior } from "babylonjs/Behaviors/behavior";
  43741. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43742. import { ExponentialEase } from "babylonjs/Animations/easing";
  43743. import { Nullable } from "babylonjs/types";
  43744. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43745. import { Vector3 } from "babylonjs/Maths/math.vector";
  43746. /**
  43747. * 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.
  43748. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43749. */
  43750. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43751. /**
  43752. * Gets the name of the behavior.
  43753. */
  43754. get name(): string;
  43755. private _mode;
  43756. private _radiusScale;
  43757. private _positionScale;
  43758. private _defaultElevation;
  43759. private _elevationReturnTime;
  43760. private _elevationReturnWaitTime;
  43761. private _zoomStopsAnimation;
  43762. private _framingTime;
  43763. /**
  43764. * The easing function used by animations
  43765. */
  43766. static EasingFunction: ExponentialEase;
  43767. /**
  43768. * The easing mode used by animations
  43769. */
  43770. static EasingMode: number;
  43771. /**
  43772. * Sets the current mode used by the behavior
  43773. */
  43774. set mode(mode: number);
  43775. /**
  43776. * Gets current mode used by the behavior.
  43777. */
  43778. get mode(): number;
  43779. /**
  43780. * Sets the scale applied to the radius (1 by default)
  43781. */
  43782. set radiusScale(radius: number);
  43783. /**
  43784. * Gets the scale applied to the radius
  43785. */
  43786. get radiusScale(): number;
  43787. /**
  43788. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43789. */
  43790. set positionScale(scale: number);
  43791. /**
  43792. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43793. */
  43794. get positionScale(): number;
  43795. /**
  43796. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43797. * behaviour is triggered, in radians.
  43798. */
  43799. set defaultElevation(elevation: number);
  43800. /**
  43801. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43802. * behaviour is triggered, in radians.
  43803. */
  43804. get defaultElevation(): number;
  43805. /**
  43806. * Sets the time (in milliseconds) taken to return to the default beta position.
  43807. * Negative value indicates camera should not return to default.
  43808. */
  43809. set elevationReturnTime(speed: number);
  43810. /**
  43811. * Gets the time (in milliseconds) taken to return to the default beta position.
  43812. * Negative value indicates camera should not return to default.
  43813. */
  43814. get elevationReturnTime(): number;
  43815. /**
  43816. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43817. */
  43818. set elevationReturnWaitTime(time: number);
  43819. /**
  43820. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43821. */
  43822. get elevationReturnWaitTime(): number;
  43823. /**
  43824. * Sets the flag that indicates if user zooming should stop animation.
  43825. */
  43826. set zoomStopsAnimation(flag: boolean);
  43827. /**
  43828. * Gets the flag that indicates if user zooming should stop animation.
  43829. */
  43830. get zoomStopsAnimation(): boolean;
  43831. /**
  43832. * Sets the transition time when framing the mesh, in milliseconds
  43833. */
  43834. set framingTime(time: number);
  43835. /**
  43836. * Gets the transition time when framing the mesh, in milliseconds
  43837. */
  43838. get framingTime(): number;
  43839. /**
  43840. * Define if the behavior should automatically change the configured
  43841. * camera limits and sensibilities.
  43842. */
  43843. autoCorrectCameraLimitsAndSensibility: boolean;
  43844. private _onPrePointerObservableObserver;
  43845. private _onAfterCheckInputsObserver;
  43846. private _onMeshTargetChangedObserver;
  43847. private _attachedCamera;
  43848. private _isPointerDown;
  43849. private _lastInteractionTime;
  43850. /**
  43851. * Initializes the behavior.
  43852. */
  43853. init(): void;
  43854. /**
  43855. * Attaches the behavior to its arc rotate camera.
  43856. * @param camera Defines the camera to attach the behavior to
  43857. */
  43858. attach(camera: ArcRotateCamera): void;
  43859. /**
  43860. * Detaches the behavior from its current arc rotate camera.
  43861. */
  43862. detach(): void;
  43863. private _animatables;
  43864. private _betaIsAnimating;
  43865. private _betaTransition;
  43866. private _radiusTransition;
  43867. private _vectorTransition;
  43868. /**
  43869. * Targets the given mesh and updates zoom level accordingly.
  43870. * @param mesh The mesh to target.
  43871. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43872. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43873. */
  43874. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43875. /**
  43876. * Targets the given mesh with its children and updates zoom level accordingly.
  43877. * @param mesh The mesh to target.
  43878. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43879. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43880. */
  43881. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43882. /**
  43883. * Targets the given meshes with their children and updates zoom level accordingly.
  43884. * @param meshes The mesh to target.
  43885. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43886. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43887. */
  43888. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43889. /**
  43890. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43891. * @param minimumWorld Determines the smaller position of the bounding box extend
  43892. * @param maximumWorld Determines the bigger position of the bounding box extend
  43893. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43894. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43895. */
  43896. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43897. /**
  43898. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43899. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43900. * frustum width.
  43901. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43902. * to fully enclose the mesh in the viewing frustum.
  43903. */
  43904. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43905. /**
  43906. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43907. * is automatically returned to its default position (expected to be above ground plane).
  43908. */
  43909. private _maintainCameraAboveGround;
  43910. /**
  43911. * Returns the frustum slope based on the canvas ratio and camera FOV
  43912. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43913. */
  43914. private _getFrustumSlope;
  43915. /**
  43916. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43917. */
  43918. private _clearAnimationLocks;
  43919. /**
  43920. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43921. */
  43922. private _applyUserInteraction;
  43923. /**
  43924. * Stops and removes all animations that have been applied to the camera
  43925. */
  43926. stopAllAnimations(): void;
  43927. /**
  43928. * Gets a value indicating if the user is moving the camera
  43929. */
  43930. get isUserIsMoving(): boolean;
  43931. /**
  43932. * The camera can move all the way towards the mesh.
  43933. */
  43934. static IgnoreBoundsSizeMode: number;
  43935. /**
  43936. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43937. */
  43938. static FitFrustumSidesMode: number;
  43939. }
  43940. }
  43941. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43942. import { Nullable } from "babylonjs/types";
  43943. import { Camera } from "babylonjs/Cameras/camera";
  43944. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43945. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43946. /**
  43947. * Base class for Camera Pointer Inputs.
  43948. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43949. * for example usage.
  43950. */
  43951. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43952. /**
  43953. * Defines the camera the input is attached to.
  43954. */
  43955. abstract camera: Camera;
  43956. /**
  43957. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43958. */
  43959. protected _altKey: boolean;
  43960. protected _ctrlKey: boolean;
  43961. protected _metaKey: boolean;
  43962. protected _shiftKey: boolean;
  43963. /**
  43964. * Which mouse buttons were pressed at time of last mouse event.
  43965. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43966. */
  43967. protected _buttonsPressed: number;
  43968. /**
  43969. * Defines the buttons associated with the input to handle camera move.
  43970. */
  43971. buttons: number[];
  43972. /**
  43973. * Attach the input controls to a specific dom element to get the input from.
  43974. * @param element Defines the element the controls should be listened from
  43975. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43976. */
  43977. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43978. /**
  43979. * Detach the current controls from the specified dom element.
  43980. * @param element Defines the element to stop listening the inputs from
  43981. */
  43982. detachControl(element: Nullable<HTMLElement>): void;
  43983. /**
  43984. * Gets the class name of the current input.
  43985. * @returns the class name
  43986. */
  43987. getClassName(): string;
  43988. /**
  43989. * Get the friendly name associated with the input class.
  43990. * @returns the input friendly name
  43991. */
  43992. getSimpleName(): string;
  43993. /**
  43994. * Called on pointer POINTERDOUBLETAP event.
  43995. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43996. */
  43997. protected onDoubleTap(type: string): void;
  43998. /**
  43999. * Called on pointer POINTERMOVE event if only a single touch is active.
  44000. * Override this method to provide functionality.
  44001. */
  44002. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44003. /**
  44004. * Called on pointer POINTERMOVE event if multiple touches are active.
  44005. * Override this method to provide functionality.
  44006. */
  44007. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44008. /**
  44009. * Called on JS contextmenu event.
  44010. * Override this method to provide functionality.
  44011. */
  44012. protected onContextMenu(evt: PointerEvent): void;
  44013. /**
  44014. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44015. * press.
  44016. * Override this method to provide functionality.
  44017. */
  44018. protected onButtonDown(evt: PointerEvent): void;
  44019. /**
  44020. * Called each time a new POINTERUP event occurs. Ie, for each button
  44021. * release.
  44022. * Override this method to provide functionality.
  44023. */
  44024. protected onButtonUp(evt: PointerEvent): void;
  44025. /**
  44026. * Called when window becomes inactive.
  44027. * Override this method to provide functionality.
  44028. */
  44029. protected onLostFocus(): void;
  44030. private _pointerInput;
  44031. private _observer;
  44032. private _onLostFocus;
  44033. private pointA;
  44034. private pointB;
  44035. }
  44036. }
  44037. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44038. import { Nullable } from "babylonjs/types";
  44039. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44040. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44041. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44042. /**
  44043. * Manage the pointers inputs to control an arc rotate camera.
  44044. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44045. */
  44046. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44047. /**
  44048. * Defines the camera the input is attached to.
  44049. */
  44050. camera: ArcRotateCamera;
  44051. /**
  44052. * Gets the class name of the current input.
  44053. * @returns the class name
  44054. */
  44055. getClassName(): string;
  44056. /**
  44057. * Defines the buttons associated with the input to handle camera move.
  44058. */
  44059. buttons: number[];
  44060. /**
  44061. * Defines the pointer angular sensibility along the X axis or how fast is
  44062. * the camera rotating.
  44063. */
  44064. angularSensibilityX: number;
  44065. /**
  44066. * Defines the pointer angular sensibility along the Y axis or how fast is
  44067. * the camera rotating.
  44068. */
  44069. angularSensibilityY: number;
  44070. /**
  44071. * Defines the pointer pinch precision or how fast is the camera zooming.
  44072. */
  44073. pinchPrecision: number;
  44074. /**
  44075. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44076. * from 0.
  44077. * It defines the percentage of current camera.radius to use as delta when
  44078. * pinch zoom is used.
  44079. */
  44080. pinchDeltaPercentage: number;
  44081. /**
  44082. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44083. * that any object in the plane at the camera's target point will scale
  44084. * perfectly with finger motion.
  44085. * Overrides pinchDeltaPercentage and pinchPrecision.
  44086. */
  44087. useNaturalPinchZoom: boolean;
  44088. /**
  44089. * Defines the pointer panning sensibility or how fast is the camera moving.
  44090. */
  44091. panningSensibility: number;
  44092. /**
  44093. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44094. */
  44095. multiTouchPanning: boolean;
  44096. /**
  44097. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44098. * zoom (pinch) through multitouch.
  44099. */
  44100. multiTouchPanAndZoom: boolean;
  44101. /**
  44102. * Revers pinch action direction.
  44103. */
  44104. pinchInwards: boolean;
  44105. private _isPanClick;
  44106. private _twoFingerActivityCount;
  44107. private _isPinching;
  44108. /**
  44109. * Called on pointer POINTERMOVE event if only a single touch is active.
  44110. */
  44111. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44112. /**
  44113. * Called on pointer POINTERDOUBLETAP event.
  44114. */
  44115. protected onDoubleTap(type: string): void;
  44116. /**
  44117. * Called on pointer POINTERMOVE event if multiple touches are active.
  44118. */
  44119. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44120. /**
  44121. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44122. * press.
  44123. */
  44124. protected onButtonDown(evt: PointerEvent): void;
  44125. /**
  44126. * Called each time a new POINTERUP event occurs. Ie, for each button
  44127. * release.
  44128. */
  44129. protected onButtonUp(evt: PointerEvent): void;
  44130. /**
  44131. * Called when window becomes inactive.
  44132. */
  44133. protected onLostFocus(): void;
  44134. }
  44135. }
  44136. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44137. import { Nullable } from "babylonjs/types";
  44138. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44139. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44140. /**
  44141. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44142. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44143. */
  44144. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44145. /**
  44146. * Defines the camera the input is attached to.
  44147. */
  44148. camera: ArcRotateCamera;
  44149. /**
  44150. * Defines the list of key codes associated with the up action (increase alpha)
  44151. */
  44152. keysUp: number[];
  44153. /**
  44154. * Defines the list of key codes associated with the down action (decrease alpha)
  44155. */
  44156. keysDown: number[];
  44157. /**
  44158. * Defines the list of key codes associated with the left action (increase beta)
  44159. */
  44160. keysLeft: number[];
  44161. /**
  44162. * Defines the list of key codes associated with the right action (decrease beta)
  44163. */
  44164. keysRight: number[];
  44165. /**
  44166. * Defines the list of key codes associated with the reset action.
  44167. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44168. */
  44169. keysReset: number[];
  44170. /**
  44171. * Defines the panning sensibility of the inputs.
  44172. * (How fast is the camera panning)
  44173. */
  44174. panningSensibility: number;
  44175. /**
  44176. * Defines the zooming sensibility of the inputs.
  44177. * (How fast is the camera zooming)
  44178. */
  44179. zoomingSensibility: number;
  44180. /**
  44181. * Defines whether maintaining the alt key down switch the movement mode from
  44182. * orientation to zoom.
  44183. */
  44184. useAltToZoom: boolean;
  44185. /**
  44186. * Rotation speed of the camera
  44187. */
  44188. angularSpeed: number;
  44189. private _keys;
  44190. private _ctrlPressed;
  44191. private _altPressed;
  44192. private _onCanvasBlurObserver;
  44193. private _onKeyboardObserver;
  44194. private _engine;
  44195. private _scene;
  44196. /**
  44197. * Attach the input controls to a specific dom element to get the input from.
  44198. * @param element Defines the element the controls should be listened from
  44199. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44200. */
  44201. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44202. /**
  44203. * Detach the current controls from the specified dom element.
  44204. * @param element Defines the element to stop listening the inputs from
  44205. */
  44206. detachControl(element: Nullable<HTMLElement>): void;
  44207. /**
  44208. * Update the current camera state depending on the inputs that have been used this frame.
  44209. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44210. */
  44211. checkInputs(): void;
  44212. /**
  44213. * Gets the class name of the current intput.
  44214. * @returns the class name
  44215. */
  44216. getClassName(): string;
  44217. /**
  44218. * Get the friendly name associated with the input class.
  44219. * @returns the input friendly name
  44220. */
  44221. getSimpleName(): string;
  44222. }
  44223. }
  44224. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44225. import { Nullable } from "babylonjs/types";
  44226. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44227. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44228. /**
  44229. * Manage the mouse wheel inputs to control an arc rotate camera.
  44230. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44231. */
  44232. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44233. /**
  44234. * Defines the camera the input is attached to.
  44235. */
  44236. camera: ArcRotateCamera;
  44237. /**
  44238. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44239. */
  44240. wheelPrecision: number;
  44241. /**
  44242. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44243. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44244. */
  44245. wheelDeltaPercentage: number;
  44246. private _wheel;
  44247. private _observer;
  44248. private computeDeltaFromMouseWheelLegacyEvent;
  44249. /**
  44250. * Attach the input controls to a specific dom element to get the input from.
  44251. * @param element Defines the element the controls should be listened from
  44252. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44253. */
  44254. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44255. /**
  44256. * Detach the current controls from the specified dom element.
  44257. * @param element Defines the element to stop listening the inputs from
  44258. */
  44259. detachControl(element: Nullable<HTMLElement>): void;
  44260. /**
  44261. * Gets the class name of the current intput.
  44262. * @returns the class name
  44263. */
  44264. getClassName(): string;
  44265. /**
  44266. * Get the friendly name associated with the input class.
  44267. * @returns the input friendly name
  44268. */
  44269. getSimpleName(): string;
  44270. }
  44271. }
  44272. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44273. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44274. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44275. /**
  44276. * Default Inputs manager for the ArcRotateCamera.
  44277. * It groups all the default supported inputs for ease of use.
  44278. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44279. */
  44280. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44281. /**
  44282. * Instantiates a new ArcRotateCameraInputsManager.
  44283. * @param camera Defines the camera the inputs belong to
  44284. */
  44285. constructor(camera: ArcRotateCamera);
  44286. /**
  44287. * Add mouse wheel input support to the input manager.
  44288. * @returns the current input manager
  44289. */
  44290. addMouseWheel(): ArcRotateCameraInputsManager;
  44291. /**
  44292. * Add pointers input support to the input manager.
  44293. * @returns the current input manager
  44294. */
  44295. addPointers(): ArcRotateCameraInputsManager;
  44296. /**
  44297. * Add keyboard input support to the input manager.
  44298. * @returns the current input manager
  44299. */
  44300. addKeyboard(): ArcRotateCameraInputsManager;
  44301. }
  44302. }
  44303. declare module "babylonjs/Cameras/arcRotateCamera" {
  44304. import { Observable } from "babylonjs/Misc/observable";
  44305. import { Nullable } from "babylonjs/types";
  44306. import { Scene } from "babylonjs/scene";
  44307. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44308. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44309. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44310. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44311. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44312. import { Camera } from "babylonjs/Cameras/camera";
  44313. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44314. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44315. import { Collider } from "babylonjs/Collisions/collider";
  44316. /**
  44317. * This represents an orbital type of camera.
  44318. *
  44319. * 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.
  44320. * 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.
  44321. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44322. */
  44323. export class ArcRotateCamera extends TargetCamera {
  44324. /**
  44325. * Defines the rotation angle of the camera along the longitudinal axis.
  44326. */
  44327. alpha: number;
  44328. /**
  44329. * Defines the rotation angle of the camera along the latitudinal axis.
  44330. */
  44331. beta: number;
  44332. /**
  44333. * Defines the radius of the camera from it s target point.
  44334. */
  44335. radius: number;
  44336. protected _target: Vector3;
  44337. protected _targetHost: Nullable<AbstractMesh>;
  44338. /**
  44339. * Defines the target point of the camera.
  44340. * The camera looks towards it form the radius distance.
  44341. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44342. */
  44343. get target(): Vector3;
  44344. set target(value: Vector3);
  44345. /**
  44346. * Define the current local position of the camera in the scene
  44347. */
  44348. get position(): Vector3;
  44349. set position(newPosition: Vector3);
  44350. protected _upToYMatrix: Matrix;
  44351. protected _YToUpMatrix: Matrix;
  44352. /**
  44353. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44354. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44355. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44356. */
  44357. set upVector(vec: Vector3);
  44358. get upVector(): Vector3;
  44359. /**
  44360. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44361. */
  44362. setMatUp(): void;
  44363. /**
  44364. * Current inertia value on the longitudinal axis.
  44365. * The bigger this number the longer it will take for the camera to stop.
  44366. */
  44367. inertialAlphaOffset: number;
  44368. /**
  44369. * Current inertia value on the latitudinal axis.
  44370. * The bigger this number the longer it will take for the camera to stop.
  44371. */
  44372. inertialBetaOffset: number;
  44373. /**
  44374. * Current inertia value on the radius axis.
  44375. * The bigger this number the longer it will take for the camera to stop.
  44376. */
  44377. inertialRadiusOffset: number;
  44378. /**
  44379. * Minimum allowed angle on the longitudinal axis.
  44380. * This can help limiting how the Camera is able to move in the scene.
  44381. */
  44382. lowerAlphaLimit: Nullable<number>;
  44383. /**
  44384. * Maximum allowed angle on the longitudinal axis.
  44385. * This can help limiting how the Camera is able to move in the scene.
  44386. */
  44387. upperAlphaLimit: Nullable<number>;
  44388. /**
  44389. * Minimum allowed angle on the latitudinal axis.
  44390. * This can help limiting how the Camera is able to move in the scene.
  44391. */
  44392. lowerBetaLimit: number;
  44393. /**
  44394. * Maximum allowed angle on the latitudinal axis.
  44395. * This can help limiting how the Camera is able to move in the scene.
  44396. */
  44397. upperBetaLimit: number;
  44398. /**
  44399. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44400. * This can help limiting how the Camera is able to move in the scene.
  44401. */
  44402. lowerRadiusLimit: Nullable<number>;
  44403. /**
  44404. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44405. * This can help limiting how the Camera is able to move in the scene.
  44406. */
  44407. upperRadiusLimit: Nullable<number>;
  44408. /**
  44409. * Defines the current inertia value used during panning of the camera along the X axis.
  44410. */
  44411. inertialPanningX: number;
  44412. /**
  44413. * Defines the current inertia value used during panning of the camera along the Y axis.
  44414. */
  44415. inertialPanningY: number;
  44416. /**
  44417. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44418. * Basically if your fingers moves away from more than this distance you will be considered
  44419. * in pinch mode.
  44420. */
  44421. pinchToPanMaxDistance: number;
  44422. /**
  44423. * Defines the maximum distance the camera can pan.
  44424. * This could help keeping the cammera always in your scene.
  44425. */
  44426. panningDistanceLimit: Nullable<number>;
  44427. /**
  44428. * Defines the target of the camera before paning.
  44429. */
  44430. panningOriginTarget: Vector3;
  44431. /**
  44432. * Defines the value of the inertia used during panning.
  44433. * 0 would mean stop inertia and one would mean no decelleration at all.
  44434. */
  44435. panningInertia: number;
  44436. /**
  44437. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44438. */
  44439. get angularSensibilityX(): number;
  44440. set angularSensibilityX(value: number);
  44441. /**
  44442. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44443. */
  44444. get angularSensibilityY(): number;
  44445. set angularSensibilityY(value: number);
  44446. /**
  44447. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44448. */
  44449. get pinchPrecision(): number;
  44450. set pinchPrecision(value: number);
  44451. /**
  44452. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44453. * It will be used instead of pinchDeltaPrecision if different from 0.
  44454. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44455. */
  44456. get pinchDeltaPercentage(): number;
  44457. set pinchDeltaPercentage(value: number);
  44458. /**
  44459. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44460. * and pinch delta percentage.
  44461. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44462. * that any object in the plane at the camera's target point will scale
  44463. * perfectly with finger motion.
  44464. */
  44465. get useNaturalPinchZoom(): boolean;
  44466. set useNaturalPinchZoom(value: boolean);
  44467. /**
  44468. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44469. */
  44470. get panningSensibility(): number;
  44471. set panningSensibility(value: number);
  44472. /**
  44473. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44474. */
  44475. get keysUp(): number[];
  44476. set keysUp(value: number[]);
  44477. /**
  44478. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44479. */
  44480. get keysDown(): number[];
  44481. set keysDown(value: number[]);
  44482. /**
  44483. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44484. */
  44485. get keysLeft(): number[];
  44486. set keysLeft(value: number[]);
  44487. /**
  44488. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44489. */
  44490. get keysRight(): number[];
  44491. set keysRight(value: number[]);
  44492. /**
  44493. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44494. */
  44495. get wheelPrecision(): number;
  44496. set wheelPrecision(value: number);
  44497. /**
  44498. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44499. * It will be used instead of pinchDeltaPrecision if different from 0.
  44500. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44501. */
  44502. get wheelDeltaPercentage(): number;
  44503. set wheelDeltaPercentage(value: number);
  44504. /**
  44505. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44506. */
  44507. zoomOnFactor: number;
  44508. /**
  44509. * Defines a screen offset for the camera position.
  44510. */
  44511. targetScreenOffset: Vector2;
  44512. /**
  44513. * Allows the camera to be completely reversed.
  44514. * If false the camera can not arrive upside down.
  44515. */
  44516. allowUpsideDown: boolean;
  44517. /**
  44518. * Define if double tap/click is used to restore the previously saved state of the camera.
  44519. */
  44520. useInputToRestoreState: boolean;
  44521. /** @hidden */
  44522. _viewMatrix: Matrix;
  44523. /** @hidden */
  44524. _useCtrlForPanning: boolean;
  44525. /** @hidden */
  44526. _panningMouseButton: number;
  44527. /**
  44528. * Defines the input associated to the camera.
  44529. */
  44530. inputs: ArcRotateCameraInputsManager;
  44531. /** @hidden */
  44532. _reset: () => void;
  44533. /**
  44534. * Defines the allowed panning axis.
  44535. */
  44536. panningAxis: Vector3;
  44537. protected _localDirection: Vector3;
  44538. protected _transformedDirection: Vector3;
  44539. private _bouncingBehavior;
  44540. /**
  44541. * Gets the bouncing behavior of the camera if it has been enabled.
  44542. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44543. */
  44544. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44545. /**
  44546. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44547. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44548. */
  44549. get useBouncingBehavior(): boolean;
  44550. set useBouncingBehavior(value: boolean);
  44551. private _framingBehavior;
  44552. /**
  44553. * Gets the framing behavior of the camera if it has been enabled.
  44554. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44555. */
  44556. get framingBehavior(): Nullable<FramingBehavior>;
  44557. /**
  44558. * Defines if the framing behavior of the camera is enabled on the camera.
  44559. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44560. */
  44561. get useFramingBehavior(): boolean;
  44562. set useFramingBehavior(value: boolean);
  44563. private _autoRotationBehavior;
  44564. /**
  44565. * Gets the auto rotation behavior of the camera if it has been enabled.
  44566. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44567. */
  44568. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44569. /**
  44570. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44571. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44572. */
  44573. get useAutoRotationBehavior(): boolean;
  44574. set useAutoRotationBehavior(value: boolean);
  44575. /**
  44576. * Observable triggered when the mesh target has been changed on the camera.
  44577. */
  44578. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44579. /**
  44580. * Event raised when the camera is colliding with a mesh.
  44581. */
  44582. onCollide: (collidedMesh: AbstractMesh) => void;
  44583. /**
  44584. * Defines whether the camera should check collision with the objects oh the scene.
  44585. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44586. */
  44587. checkCollisions: boolean;
  44588. /**
  44589. * Defines the collision radius of the camera.
  44590. * This simulates a sphere around the camera.
  44591. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44592. */
  44593. collisionRadius: Vector3;
  44594. protected _collider: Collider;
  44595. protected _previousPosition: Vector3;
  44596. protected _collisionVelocity: Vector3;
  44597. protected _newPosition: Vector3;
  44598. protected _previousAlpha: number;
  44599. protected _previousBeta: number;
  44600. protected _previousRadius: number;
  44601. protected _collisionTriggered: boolean;
  44602. protected _targetBoundingCenter: Nullable<Vector3>;
  44603. private _computationVector;
  44604. /**
  44605. * Instantiates a new ArcRotateCamera in a given scene
  44606. * @param name Defines the name of the camera
  44607. * @param alpha Defines the camera rotation along the logitudinal axis
  44608. * @param beta Defines the camera rotation along the latitudinal axis
  44609. * @param radius Defines the camera distance from its target
  44610. * @param target Defines the camera target
  44611. * @param scene Defines the scene the camera belongs to
  44612. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44613. */
  44614. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44615. /** @hidden */
  44616. _initCache(): void;
  44617. /** @hidden */
  44618. _updateCache(ignoreParentClass?: boolean): void;
  44619. protected _getTargetPosition(): Vector3;
  44620. private _storedAlpha;
  44621. private _storedBeta;
  44622. private _storedRadius;
  44623. private _storedTarget;
  44624. private _storedTargetScreenOffset;
  44625. /**
  44626. * Stores the current state of the camera (alpha, beta, radius and target)
  44627. * @returns the camera itself
  44628. */
  44629. storeState(): Camera;
  44630. /**
  44631. * @hidden
  44632. * Restored camera state. You must call storeState() first
  44633. */
  44634. _restoreStateValues(): boolean;
  44635. /** @hidden */
  44636. _isSynchronizedViewMatrix(): boolean;
  44637. /**
  44638. * Attached controls to the current camera.
  44639. * @param element Defines the element the controls should be listened from
  44640. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44641. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44642. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44643. */
  44644. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44645. /**
  44646. * Detach the current controls from the camera.
  44647. * The camera will stop reacting to inputs.
  44648. * @param element Defines the element to stop listening the inputs from
  44649. */
  44650. detachControl(element: HTMLElement): void;
  44651. /** @hidden */
  44652. _checkInputs(): void;
  44653. protected _checkLimits(): void;
  44654. /**
  44655. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44656. */
  44657. rebuildAnglesAndRadius(): void;
  44658. /**
  44659. * Use a position to define the current camera related information like alpha, beta and radius
  44660. * @param position Defines the position to set the camera at
  44661. */
  44662. setPosition(position: Vector3): void;
  44663. /**
  44664. * Defines the target the camera should look at.
  44665. * This will automatically adapt alpha beta and radius to fit within the new target.
  44666. * @param target Defines the new target as a Vector or a mesh
  44667. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44668. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44669. */
  44670. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44671. /** @hidden */
  44672. _getViewMatrix(): Matrix;
  44673. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44674. /**
  44675. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44676. * @param meshes Defines the mesh to zoom on
  44677. * @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)
  44678. */
  44679. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44680. /**
  44681. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44682. * The target will be changed but the radius
  44683. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44684. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  44685. */
  44686. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44687. min: Vector3;
  44688. max: Vector3;
  44689. distance: number;
  44690. }, doNotUpdateMaxZ?: boolean): void;
  44691. /**
  44692. * @override
  44693. * Override Camera.createRigCamera
  44694. */
  44695. createRigCamera(name: string, cameraIndex: number): Camera;
  44696. /**
  44697. * @hidden
  44698. * @override
  44699. * Override Camera._updateRigCameras
  44700. */
  44701. _updateRigCameras(): void;
  44702. /**
  44703. * Destroy the camera and release the current resources hold by it.
  44704. */
  44705. dispose(): void;
  44706. /**
  44707. * Gets the current object class name.
  44708. * @return the class name
  44709. */
  44710. getClassName(): string;
  44711. }
  44712. }
  44713. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44714. import { Behavior } from "babylonjs/Behaviors/behavior";
  44715. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44716. /**
  44717. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44718. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44719. */
  44720. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44721. /**
  44722. * Gets the name of the behavior.
  44723. */
  44724. get name(): string;
  44725. private _zoomStopsAnimation;
  44726. private _idleRotationSpeed;
  44727. private _idleRotationWaitTime;
  44728. private _idleRotationSpinupTime;
  44729. /**
  44730. * Sets the flag that indicates if user zooming should stop animation.
  44731. */
  44732. set zoomStopsAnimation(flag: boolean);
  44733. /**
  44734. * Gets the flag that indicates if user zooming should stop animation.
  44735. */
  44736. get zoomStopsAnimation(): boolean;
  44737. /**
  44738. * Sets the default speed at which the camera rotates around the model.
  44739. */
  44740. set idleRotationSpeed(speed: number);
  44741. /**
  44742. * Gets the default speed at which the camera rotates around the model.
  44743. */
  44744. get idleRotationSpeed(): number;
  44745. /**
  44746. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44747. */
  44748. set idleRotationWaitTime(time: number);
  44749. /**
  44750. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44751. */
  44752. get idleRotationWaitTime(): number;
  44753. /**
  44754. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44755. */
  44756. set idleRotationSpinupTime(time: number);
  44757. /**
  44758. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44759. */
  44760. get idleRotationSpinupTime(): number;
  44761. /**
  44762. * Gets a value indicating if the camera is currently rotating because of this behavior
  44763. */
  44764. get rotationInProgress(): boolean;
  44765. private _onPrePointerObservableObserver;
  44766. private _onAfterCheckInputsObserver;
  44767. private _attachedCamera;
  44768. private _isPointerDown;
  44769. private _lastFrameTime;
  44770. private _lastInteractionTime;
  44771. private _cameraRotationSpeed;
  44772. /**
  44773. * Initializes the behavior.
  44774. */
  44775. init(): void;
  44776. /**
  44777. * Attaches the behavior to its arc rotate camera.
  44778. * @param camera Defines the camera to attach the behavior to
  44779. */
  44780. attach(camera: ArcRotateCamera): void;
  44781. /**
  44782. * Detaches the behavior from its current arc rotate camera.
  44783. */
  44784. detach(): void;
  44785. /**
  44786. * Returns true if user is scrolling.
  44787. * @return true if user is scrolling.
  44788. */
  44789. private _userIsZooming;
  44790. private _lastFrameRadius;
  44791. private _shouldAnimationStopForInteraction;
  44792. /**
  44793. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44794. */
  44795. private _applyUserInteraction;
  44796. private _userIsMoving;
  44797. }
  44798. }
  44799. declare module "babylonjs/Behaviors/Cameras/index" {
  44800. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44801. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44802. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44803. }
  44804. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44805. import { Mesh } from "babylonjs/Meshes/mesh";
  44806. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44807. import { Behavior } from "babylonjs/Behaviors/behavior";
  44808. /**
  44809. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44810. */
  44811. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44812. private ui;
  44813. /**
  44814. * The name of the behavior
  44815. */
  44816. name: string;
  44817. /**
  44818. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44819. */
  44820. distanceAwayFromFace: number;
  44821. /**
  44822. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44823. */
  44824. distanceAwayFromBottomOfFace: number;
  44825. private _faceVectors;
  44826. private _target;
  44827. private _scene;
  44828. private _onRenderObserver;
  44829. private _tmpMatrix;
  44830. private _tmpVector;
  44831. /**
  44832. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44833. * @param ui The transform node that should be attched to the mesh
  44834. */
  44835. constructor(ui: TransformNode);
  44836. /**
  44837. * Initializes the behavior
  44838. */
  44839. init(): void;
  44840. private _closestFace;
  44841. private _zeroVector;
  44842. private _lookAtTmpMatrix;
  44843. private _lookAtToRef;
  44844. /**
  44845. * Attaches the AttachToBoxBehavior to the passed in mesh
  44846. * @param target The mesh that the specified node will be attached to
  44847. */
  44848. attach(target: Mesh): void;
  44849. /**
  44850. * Detaches the behavior from the mesh
  44851. */
  44852. detach(): void;
  44853. }
  44854. }
  44855. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44856. import { Behavior } from "babylonjs/Behaviors/behavior";
  44857. import { Mesh } from "babylonjs/Meshes/mesh";
  44858. /**
  44859. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44860. */
  44861. export class FadeInOutBehavior implements Behavior<Mesh> {
  44862. /**
  44863. * Time in milliseconds to delay before fading in (Default: 0)
  44864. */
  44865. delay: number;
  44866. /**
  44867. * Time in milliseconds for the mesh to fade in (Default: 300)
  44868. */
  44869. fadeInTime: number;
  44870. private _millisecondsPerFrame;
  44871. private _hovered;
  44872. private _hoverValue;
  44873. private _ownerNode;
  44874. /**
  44875. * Instatiates the FadeInOutBehavior
  44876. */
  44877. constructor();
  44878. /**
  44879. * The name of the behavior
  44880. */
  44881. get name(): string;
  44882. /**
  44883. * Initializes the behavior
  44884. */
  44885. init(): void;
  44886. /**
  44887. * Attaches the fade behavior on the passed in mesh
  44888. * @param ownerNode The mesh that will be faded in/out once attached
  44889. */
  44890. attach(ownerNode: Mesh): void;
  44891. /**
  44892. * Detaches the behavior from the mesh
  44893. */
  44894. detach(): void;
  44895. /**
  44896. * Triggers the mesh to begin fading in or out
  44897. * @param value if the object should fade in or out (true to fade in)
  44898. */
  44899. fadeIn(value: boolean): void;
  44900. private _update;
  44901. private _setAllVisibility;
  44902. }
  44903. }
  44904. declare module "babylonjs/Misc/pivotTools" {
  44905. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44906. /**
  44907. * Class containing a set of static utilities functions for managing Pivots
  44908. * @hidden
  44909. */
  44910. export class PivotTools {
  44911. private static _PivotCached;
  44912. private static _OldPivotPoint;
  44913. private static _PivotTranslation;
  44914. private static _PivotTmpVector;
  44915. /** @hidden */
  44916. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44917. /** @hidden */
  44918. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44919. }
  44920. }
  44921. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44922. import { Scene } from "babylonjs/scene";
  44923. import { Vector4 } from "babylonjs/Maths/math.vector";
  44924. import { Mesh } from "babylonjs/Meshes/mesh";
  44925. import { Nullable } from "babylonjs/types";
  44926. import { Plane } from "babylonjs/Maths/math.plane";
  44927. /**
  44928. * Class containing static functions to help procedurally build meshes
  44929. */
  44930. export class PlaneBuilder {
  44931. /**
  44932. * Creates a plane mesh
  44933. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44934. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44935. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44936. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44937. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44938. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44939. * @param name defines the name of the mesh
  44940. * @param options defines the options used to create the mesh
  44941. * @param scene defines the hosting scene
  44942. * @returns the plane mesh
  44943. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44944. */
  44945. static CreatePlane(name: string, options: {
  44946. size?: number;
  44947. width?: number;
  44948. height?: number;
  44949. sideOrientation?: number;
  44950. frontUVs?: Vector4;
  44951. backUVs?: Vector4;
  44952. updatable?: boolean;
  44953. sourcePlane?: Plane;
  44954. }, scene?: Nullable<Scene>): Mesh;
  44955. }
  44956. }
  44957. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44958. import { Behavior } from "babylonjs/Behaviors/behavior";
  44959. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44960. import { Observable } from "babylonjs/Misc/observable";
  44961. import { Vector3 } from "babylonjs/Maths/math.vector";
  44962. import { Ray } from "babylonjs/Culling/ray";
  44963. import "babylonjs/Meshes/Builders/planeBuilder";
  44964. /**
  44965. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44966. */
  44967. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44968. private static _AnyMouseID;
  44969. /**
  44970. * Abstract mesh the behavior is set on
  44971. */
  44972. attachedNode: AbstractMesh;
  44973. private _dragPlane;
  44974. private _scene;
  44975. private _pointerObserver;
  44976. private _beforeRenderObserver;
  44977. private static _planeScene;
  44978. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44979. /**
  44980. * 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)
  44981. */
  44982. maxDragAngle: number;
  44983. /**
  44984. * @hidden
  44985. */
  44986. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44987. /**
  44988. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44989. */
  44990. currentDraggingPointerID: number;
  44991. /**
  44992. * The last position where the pointer hit the drag plane in world space
  44993. */
  44994. lastDragPosition: Vector3;
  44995. /**
  44996. * If the behavior is currently in a dragging state
  44997. */
  44998. dragging: boolean;
  44999. /**
  45000. * 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)
  45001. */
  45002. dragDeltaRatio: number;
  45003. /**
  45004. * If the drag plane orientation should be updated during the dragging (Default: true)
  45005. */
  45006. updateDragPlane: boolean;
  45007. private _debugMode;
  45008. private _moving;
  45009. /**
  45010. * Fires each time the attached mesh is dragged with the pointer
  45011. * * delta between last drag position and current drag position in world space
  45012. * * dragDistance along the drag axis
  45013. * * dragPlaneNormal normal of the current drag plane used during the drag
  45014. * * dragPlanePoint in world space where the drag intersects the drag plane
  45015. */
  45016. onDragObservable: Observable<{
  45017. delta: Vector3;
  45018. dragPlanePoint: Vector3;
  45019. dragPlaneNormal: Vector3;
  45020. dragDistance: number;
  45021. pointerId: number;
  45022. }>;
  45023. /**
  45024. * Fires each time a drag begins (eg. mouse down on mesh)
  45025. */
  45026. onDragStartObservable: Observable<{
  45027. dragPlanePoint: Vector3;
  45028. pointerId: number;
  45029. }>;
  45030. /**
  45031. * Fires each time a drag ends (eg. mouse release after drag)
  45032. */
  45033. onDragEndObservable: Observable<{
  45034. dragPlanePoint: Vector3;
  45035. pointerId: number;
  45036. }>;
  45037. /**
  45038. * If the attached mesh should be moved when dragged
  45039. */
  45040. moveAttached: boolean;
  45041. /**
  45042. * If the drag behavior will react to drag events (Default: true)
  45043. */
  45044. enabled: boolean;
  45045. /**
  45046. * If pointer events should start and release the drag (Default: true)
  45047. */
  45048. startAndReleaseDragOnPointerEvents: boolean;
  45049. /**
  45050. * If camera controls should be detached during the drag
  45051. */
  45052. detachCameraControls: boolean;
  45053. /**
  45054. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45055. */
  45056. useObjectOrientationForDragging: boolean;
  45057. private _options;
  45058. /**
  45059. * Gets the options used by the behavior
  45060. */
  45061. get options(): {
  45062. dragAxis?: Vector3;
  45063. dragPlaneNormal?: Vector3;
  45064. };
  45065. /**
  45066. * Sets the options used by the behavior
  45067. */
  45068. set options(options: {
  45069. dragAxis?: Vector3;
  45070. dragPlaneNormal?: Vector3;
  45071. });
  45072. /**
  45073. * Creates a pointer drag behavior that can be attached to a mesh
  45074. * @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)
  45075. */
  45076. constructor(options?: {
  45077. dragAxis?: Vector3;
  45078. dragPlaneNormal?: Vector3;
  45079. });
  45080. /**
  45081. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45082. */
  45083. validateDrag: (targetPosition: Vector3) => boolean;
  45084. /**
  45085. * The name of the behavior
  45086. */
  45087. get name(): string;
  45088. /**
  45089. * Initializes the behavior
  45090. */
  45091. init(): void;
  45092. private _tmpVector;
  45093. private _alternatePickedPoint;
  45094. private _worldDragAxis;
  45095. private _targetPosition;
  45096. private _attachedElement;
  45097. /**
  45098. * Attaches the drag behavior the passed in mesh
  45099. * @param ownerNode The mesh that will be dragged around once attached
  45100. * @param predicate Predicate to use for pick filtering
  45101. */
  45102. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45103. /**
  45104. * Force relase the drag action by code.
  45105. */
  45106. releaseDrag(): void;
  45107. private _startDragRay;
  45108. private _lastPointerRay;
  45109. /**
  45110. * Simulates the start of a pointer drag event on the behavior
  45111. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45112. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45113. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45114. */
  45115. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45116. private _startDrag;
  45117. private _dragDelta;
  45118. private _moveDrag;
  45119. private _pickWithRayOnDragPlane;
  45120. private _pointA;
  45121. private _pointC;
  45122. private _localAxis;
  45123. private _lookAt;
  45124. private _updateDragPlanePosition;
  45125. /**
  45126. * Detaches the behavior from the mesh
  45127. */
  45128. detach(): void;
  45129. }
  45130. }
  45131. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45132. import { Mesh } from "babylonjs/Meshes/mesh";
  45133. import { Behavior } from "babylonjs/Behaviors/behavior";
  45134. /**
  45135. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45136. */
  45137. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45138. private _dragBehaviorA;
  45139. private _dragBehaviorB;
  45140. private _startDistance;
  45141. private _initialScale;
  45142. private _targetScale;
  45143. private _ownerNode;
  45144. private _sceneRenderObserver;
  45145. /**
  45146. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45147. */
  45148. constructor();
  45149. /**
  45150. * The name of the behavior
  45151. */
  45152. get name(): string;
  45153. /**
  45154. * Initializes the behavior
  45155. */
  45156. init(): void;
  45157. private _getCurrentDistance;
  45158. /**
  45159. * Attaches the scale behavior the passed in mesh
  45160. * @param ownerNode The mesh that will be scaled around once attached
  45161. */
  45162. attach(ownerNode: Mesh): void;
  45163. /**
  45164. * Detaches the behavior from the mesh
  45165. */
  45166. detach(): void;
  45167. }
  45168. }
  45169. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45170. import { Behavior } from "babylonjs/Behaviors/behavior";
  45171. import { Mesh } from "babylonjs/Meshes/mesh";
  45172. import { Observable } from "babylonjs/Misc/observable";
  45173. /**
  45174. * 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
  45175. */
  45176. export class SixDofDragBehavior implements Behavior<Mesh> {
  45177. private static _virtualScene;
  45178. private _ownerNode;
  45179. private _sceneRenderObserver;
  45180. private _scene;
  45181. private _targetPosition;
  45182. private _virtualOriginMesh;
  45183. private _virtualDragMesh;
  45184. private _pointerObserver;
  45185. private _moving;
  45186. private _startingOrientation;
  45187. private _attachedElement;
  45188. /**
  45189. * 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)
  45190. */
  45191. private zDragFactor;
  45192. /**
  45193. * If the object should rotate to face the drag origin
  45194. */
  45195. rotateDraggedObject: boolean;
  45196. /**
  45197. * If the behavior is currently in a dragging state
  45198. */
  45199. dragging: boolean;
  45200. /**
  45201. * 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)
  45202. */
  45203. dragDeltaRatio: number;
  45204. /**
  45205. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45206. */
  45207. currentDraggingPointerID: number;
  45208. /**
  45209. * If camera controls should be detached during the drag
  45210. */
  45211. detachCameraControls: boolean;
  45212. /**
  45213. * Fires each time a drag starts
  45214. */
  45215. onDragStartObservable: Observable<{}>;
  45216. /**
  45217. * Fires each time a drag ends (eg. mouse release after drag)
  45218. */
  45219. onDragEndObservable: Observable<{}>;
  45220. /**
  45221. * 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
  45222. */
  45223. constructor();
  45224. /**
  45225. * The name of the behavior
  45226. */
  45227. get name(): string;
  45228. /**
  45229. * Initializes the behavior
  45230. */
  45231. init(): void;
  45232. /**
  45233. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45234. */
  45235. private get _pointerCamera();
  45236. /**
  45237. * Attaches the scale behavior the passed in mesh
  45238. * @param ownerNode The mesh that will be scaled around once attached
  45239. */
  45240. attach(ownerNode: Mesh): void;
  45241. /**
  45242. * Detaches the behavior from the mesh
  45243. */
  45244. detach(): void;
  45245. }
  45246. }
  45247. declare module "babylonjs/Behaviors/Meshes/index" {
  45248. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45249. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45250. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45251. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45252. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45253. }
  45254. declare module "babylonjs/Behaviors/index" {
  45255. export * from "babylonjs/Behaviors/behavior";
  45256. export * from "babylonjs/Behaviors/Cameras/index";
  45257. export * from "babylonjs/Behaviors/Meshes/index";
  45258. }
  45259. declare module "babylonjs/Bones/boneIKController" {
  45260. import { Bone } from "babylonjs/Bones/bone";
  45261. import { Vector3 } from "babylonjs/Maths/math.vector";
  45262. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45263. import { Nullable } from "babylonjs/types";
  45264. /**
  45265. * Class used to apply inverse kinematics to bones
  45266. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45267. */
  45268. export class BoneIKController {
  45269. private static _tmpVecs;
  45270. private static _tmpQuat;
  45271. private static _tmpMats;
  45272. /**
  45273. * Gets or sets the target mesh
  45274. */
  45275. targetMesh: AbstractMesh;
  45276. /** Gets or sets the mesh used as pole */
  45277. poleTargetMesh: AbstractMesh;
  45278. /**
  45279. * Gets or sets the bone used as pole
  45280. */
  45281. poleTargetBone: Nullable<Bone>;
  45282. /**
  45283. * Gets or sets the target position
  45284. */
  45285. targetPosition: Vector3;
  45286. /**
  45287. * Gets or sets the pole target position
  45288. */
  45289. poleTargetPosition: Vector3;
  45290. /**
  45291. * Gets or sets the pole target local offset
  45292. */
  45293. poleTargetLocalOffset: Vector3;
  45294. /**
  45295. * Gets or sets the pole angle
  45296. */
  45297. poleAngle: number;
  45298. /**
  45299. * Gets or sets the mesh associated with the controller
  45300. */
  45301. mesh: AbstractMesh;
  45302. /**
  45303. * 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)
  45304. */
  45305. slerpAmount: number;
  45306. private _bone1Quat;
  45307. private _bone1Mat;
  45308. private _bone2Ang;
  45309. private _bone1;
  45310. private _bone2;
  45311. private _bone1Length;
  45312. private _bone2Length;
  45313. private _maxAngle;
  45314. private _maxReach;
  45315. private _rightHandedSystem;
  45316. private _bendAxis;
  45317. private _slerping;
  45318. private _adjustRoll;
  45319. /**
  45320. * Gets or sets maximum allowed angle
  45321. */
  45322. get maxAngle(): number;
  45323. set maxAngle(value: number);
  45324. /**
  45325. * Creates a new BoneIKController
  45326. * @param mesh defines the mesh to control
  45327. * @param bone defines the bone to control
  45328. * @param options defines options to set up the controller
  45329. */
  45330. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45331. targetMesh?: AbstractMesh;
  45332. poleTargetMesh?: AbstractMesh;
  45333. poleTargetBone?: Bone;
  45334. poleTargetLocalOffset?: Vector3;
  45335. poleAngle?: number;
  45336. bendAxis?: Vector3;
  45337. maxAngle?: number;
  45338. slerpAmount?: number;
  45339. });
  45340. private _setMaxAngle;
  45341. /**
  45342. * Force the controller to update the bones
  45343. */
  45344. update(): void;
  45345. }
  45346. }
  45347. declare module "babylonjs/Bones/boneLookController" {
  45348. import { Vector3 } from "babylonjs/Maths/math.vector";
  45349. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45350. import { Bone } from "babylonjs/Bones/bone";
  45351. import { Space } from "babylonjs/Maths/math.axis";
  45352. /**
  45353. * Class used to make a bone look toward a point in space
  45354. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45355. */
  45356. export class BoneLookController {
  45357. private static _tmpVecs;
  45358. private static _tmpQuat;
  45359. private static _tmpMats;
  45360. /**
  45361. * The target Vector3 that the bone will look at
  45362. */
  45363. target: Vector3;
  45364. /**
  45365. * The mesh that the bone is attached to
  45366. */
  45367. mesh: AbstractMesh;
  45368. /**
  45369. * The bone that will be looking to the target
  45370. */
  45371. bone: Bone;
  45372. /**
  45373. * The up axis of the coordinate system that is used when the bone is rotated
  45374. */
  45375. upAxis: Vector3;
  45376. /**
  45377. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45378. */
  45379. upAxisSpace: Space;
  45380. /**
  45381. * Used to make an adjustment to the yaw of the bone
  45382. */
  45383. adjustYaw: number;
  45384. /**
  45385. * Used to make an adjustment to the pitch of the bone
  45386. */
  45387. adjustPitch: number;
  45388. /**
  45389. * Used to make an adjustment to the roll of the bone
  45390. */
  45391. adjustRoll: number;
  45392. /**
  45393. * 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)
  45394. */
  45395. slerpAmount: number;
  45396. private _minYaw;
  45397. private _maxYaw;
  45398. private _minPitch;
  45399. private _maxPitch;
  45400. private _minYawSin;
  45401. private _minYawCos;
  45402. private _maxYawSin;
  45403. private _maxYawCos;
  45404. private _midYawConstraint;
  45405. private _minPitchTan;
  45406. private _maxPitchTan;
  45407. private _boneQuat;
  45408. private _slerping;
  45409. private _transformYawPitch;
  45410. private _transformYawPitchInv;
  45411. private _firstFrameSkipped;
  45412. private _yawRange;
  45413. private _fowardAxis;
  45414. /**
  45415. * Gets or sets the minimum yaw angle that the bone can look to
  45416. */
  45417. get minYaw(): number;
  45418. set minYaw(value: number);
  45419. /**
  45420. * Gets or sets the maximum yaw angle that the bone can look to
  45421. */
  45422. get maxYaw(): number;
  45423. set maxYaw(value: number);
  45424. /**
  45425. * Gets or sets the minimum pitch angle that the bone can look to
  45426. */
  45427. get minPitch(): number;
  45428. set minPitch(value: number);
  45429. /**
  45430. * Gets or sets the maximum pitch angle that the bone can look to
  45431. */
  45432. get maxPitch(): number;
  45433. set maxPitch(value: number);
  45434. /**
  45435. * Create a BoneLookController
  45436. * @param mesh the mesh that the bone belongs to
  45437. * @param bone the bone that will be looking to the target
  45438. * @param target the target Vector3 to look at
  45439. * @param options optional settings:
  45440. * * maxYaw: the maximum angle the bone will yaw to
  45441. * * minYaw: the minimum angle the bone will yaw to
  45442. * * maxPitch: the maximum angle the bone will pitch to
  45443. * * minPitch: the minimum angle the bone will yaw to
  45444. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45445. * * upAxis: the up axis of the coordinate system
  45446. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45447. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45448. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45449. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45450. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45451. * * adjustRoll: used to make an adjustment to the roll of the bone
  45452. **/
  45453. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45454. maxYaw?: number;
  45455. minYaw?: number;
  45456. maxPitch?: number;
  45457. minPitch?: number;
  45458. slerpAmount?: number;
  45459. upAxis?: Vector3;
  45460. upAxisSpace?: Space;
  45461. yawAxis?: Vector3;
  45462. pitchAxis?: Vector3;
  45463. adjustYaw?: number;
  45464. adjustPitch?: number;
  45465. adjustRoll?: number;
  45466. });
  45467. /**
  45468. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45469. */
  45470. update(): void;
  45471. private _getAngleDiff;
  45472. private _getAngleBetween;
  45473. private _isAngleBetween;
  45474. }
  45475. }
  45476. declare module "babylonjs/Bones/index" {
  45477. export * from "babylonjs/Bones/bone";
  45478. export * from "babylonjs/Bones/boneIKController";
  45479. export * from "babylonjs/Bones/boneLookController";
  45480. export * from "babylonjs/Bones/skeleton";
  45481. }
  45482. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45483. import { Nullable } from "babylonjs/types";
  45484. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45485. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45486. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45487. /**
  45488. * Manage the gamepad inputs to control an arc rotate camera.
  45489. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45490. */
  45491. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45492. /**
  45493. * Defines the camera the input is attached to.
  45494. */
  45495. camera: ArcRotateCamera;
  45496. /**
  45497. * Defines the gamepad the input is gathering event from.
  45498. */
  45499. gamepad: Nullable<Gamepad>;
  45500. /**
  45501. * Defines the gamepad rotation sensiblity.
  45502. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45503. */
  45504. gamepadRotationSensibility: number;
  45505. /**
  45506. * Defines the gamepad move sensiblity.
  45507. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45508. */
  45509. gamepadMoveSensibility: number;
  45510. private _yAxisScale;
  45511. /**
  45512. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45513. */
  45514. get invertYAxis(): boolean;
  45515. set invertYAxis(value: boolean);
  45516. private _onGamepadConnectedObserver;
  45517. private _onGamepadDisconnectedObserver;
  45518. /**
  45519. * Attach the input controls to a specific dom element to get the input from.
  45520. * @param element Defines the element the controls should be listened from
  45521. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45522. */
  45523. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45524. /**
  45525. * Detach the current controls from the specified dom element.
  45526. * @param element Defines the element to stop listening the inputs from
  45527. */
  45528. detachControl(element: Nullable<HTMLElement>): void;
  45529. /**
  45530. * Update the current camera state depending on the inputs that have been used this frame.
  45531. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45532. */
  45533. checkInputs(): void;
  45534. /**
  45535. * Gets the class name of the current intput.
  45536. * @returns the class name
  45537. */
  45538. getClassName(): string;
  45539. /**
  45540. * Get the friendly name associated with the input class.
  45541. * @returns the input friendly name
  45542. */
  45543. getSimpleName(): string;
  45544. }
  45545. }
  45546. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45547. import { Nullable } from "babylonjs/types";
  45548. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45549. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45550. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45551. interface ArcRotateCameraInputsManager {
  45552. /**
  45553. * Add orientation input support to the input manager.
  45554. * @returns the current input manager
  45555. */
  45556. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45557. }
  45558. }
  45559. /**
  45560. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45561. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45562. */
  45563. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45564. /**
  45565. * Defines the camera the input is attached to.
  45566. */
  45567. camera: ArcRotateCamera;
  45568. /**
  45569. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45570. */
  45571. alphaCorrection: number;
  45572. /**
  45573. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45574. */
  45575. gammaCorrection: number;
  45576. private _alpha;
  45577. private _gamma;
  45578. private _dirty;
  45579. private _deviceOrientationHandler;
  45580. /**
  45581. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45582. */
  45583. constructor();
  45584. /**
  45585. * Attach the input controls to a specific dom element to get the input from.
  45586. * @param element Defines the element the controls should be listened from
  45587. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45588. */
  45589. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45590. /** @hidden */
  45591. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45592. /**
  45593. * Update the current camera state depending on the inputs that have been used this frame.
  45594. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45595. */
  45596. checkInputs(): void;
  45597. /**
  45598. * Detach the current controls from the specified dom element.
  45599. * @param element Defines the element to stop listening the inputs from
  45600. */
  45601. detachControl(element: Nullable<HTMLElement>): void;
  45602. /**
  45603. * Gets the class name of the current intput.
  45604. * @returns the class name
  45605. */
  45606. getClassName(): string;
  45607. /**
  45608. * Get the friendly name associated with the input class.
  45609. * @returns the input friendly name
  45610. */
  45611. getSimpleName(): string;
  45612. }
  45613. }
  45614. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45615. import { Nullable } from "babylonjs/types";
  45616. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45617. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45618. /**
  45619. * Listen to mouse events to control the camera.
  45620. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45621. */
  45622. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45623. /**
  45624. * Defines the camera the input is attached to.
  45625. */
  45626. camera: FlyCamera;
  45627. /**
  45628. * Defines if touch is enabled. (Default is true.)
  45629. */
  45630. touchEnabled: boolean;
  45631. /**
  45632. * Defines the buttons associated with the input to handle camera rotation.
  45633. */
  45634. buttons: number[];
  45635. /**
  45636. * Assign buttons for Yaw control.
  45637. */
  45638. buttonsYaw: number[];
  45639. /**
  45640. * Assign buttons for Pitch control.
  45641. */
  45642. buttonsPitch: number[];
  45643. /**
  45644. * Assign buttons for Roll control.
  45645. */
  45646. buttonsRoll: number[];
  45647. /**
  45648. * Detect if any button is being pressed while mouse is moved.
  45649. * -1 = Mouse locked.
  45650. * 0 = Left button.
  45651. * 1 = Middle Button.
  45652. * 2 = Right Button.
  45653. */
  45654. activeButton: number;
  45655. /**
  45656. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45657. * Higher values reduce its sensitivity.
  45658. */
  45659. angularSensibility: number;
  45660. private _mousemoveCallback;
  45661. private _observer;
  45662. private _rollObserver;
  45663. private previousPosition;
  45664. private noPreventDefault;
  45665. private element;
  45666. /**
  45667. * Listen to mouse events to control the camera.
  45668. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45669. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45670. */
  45671. constructor(touchEnabled?: boolean);
  45672. /**
  45673. * Attach the mouse control to the HTML DOM element.
  45674. * @param element Defines the element that listens to the input events.
  45675. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45676. */
  45677. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45678. /**
  45679. * Detach the current controls from the specified dom element.
  45680. * @param element Defines the element to stop listening the inputs from
  45681. */
  45682. detachControl(element: Nullable<HTMLElement>): void;
  45683. /**
  45684. * Gets the class name of the current input.
  45685. * @returns the class name.
  45686. */
  45687. getClassName(): string;
  45688. /**
  45689. * Get the friendly name associated with the input class.
  45690. * @returns the input's friendly name.
  45691. */
  45692. getSimpleName(): string;
  45693. private _pointerInput;
  45694. private _onMouseMove;
  45695. /**
  45696. * Rotate camera by mouse offset.
  45697. */
  45698. private rotateCamera;
  45699. }
  45700. }
  45701. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45702. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45703. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45704. /**
  45705. * Default Inputs manager for the FlyCamera.
  45706. * It groups all the default supported inputs for ease of use.
  45707. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45708. */
  45709. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45710. /**
  45711. * Instantiates a new FlyCameraInputsManager.
  45712. * @param camera Defines the camera the inputs belong to.
  45713. */
  45714. constructor(camera: FlyCamera);
  45715. /**
  45716. * Add keyboard input support to the input manager.
  45717. * @returns the new FlyCameraKeyboardMoveInput().
  45718. */
  45719. addKeyboard(): FlyCameraInputsManager;
  45720. /**
  45721. * Add mouse input support to the input manager.
  45722. * @param touchEnabled Enable touch screen support.
  45723. * @returns the new FlyCameraMouseInput().
  45724. */
  45725. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45726. }
  45727. }
  45728. declare module "babylonjs/Cameras/flyCamera" {
  45729. import { Scene } from "babylonjs/scene";
  45730. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45731. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45732. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45733. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45734. /**
  45735. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45736. * such as in a 3D Space Shooter or a Flight Simulator.
  45737. */
  45738. export class FlyCamera extends TargetCamera {
  45739. /**
  45740. * Define the collision ellipsoid of the camera.
  45741. * This is helpful for simulating a camera body, like a player's body.
  45742. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45743. */
  45744. ellipsoid: Vector3;
  45745. /**
  45746. * Define an offset for the position of the ellipsoid around the camera.
  45747. * This can be helpful if the camera is attached away from the player's body center,
  45748. * such as at its head.
  45749. */
  45750. ellipsoidOffset: Vector3;
  45751. /**
  45752. * Enable or disable collisions of the camera with the rest of the scene objects.
  45753. */
  45754. checkCollisions: boolean;
  45755. /**
  45756. * Enable or disable gravity on the camera.
  45757. */
  45758. applyGravity: boolean;
  45759. /**
  45760. * Define the current direction the camera is moving to.
  45761. */
  45762. cameraDirection: Vector3;
  45763. /**
  45764. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45765. * This overrides and empties cameraRotation.
  45766. */
  45767. rotationQuaternion: Quaternion;
  45768. /**
  45769. * Track Roll to maintain the wanted Rolling when looking around.
  45770. */
  45771. _trackRoll: number;
  45772. /**
  45773. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45774. */
  45775. rollCorrect: number;
  45776. /**
  45777. * Mimic a banked turn, Rolling the camera when Yawing.
  45778. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45779. */
  45780. bankedTurn: boolean;
  45781. /**
  45782. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45783. */
  45784. bankedTurnLimit: number;
  45785. /**
  45786. * Value of 0 disables the banked Roll.
  45787. * Value of 1 is equal to the Yaw angle in radians.
  45788. */
  45789. bankedTurnMultiplier: number;
  45790. /**
  45791. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45792. */
  45793. inputs: FlyCameraInputsManager;
  45794. /**
  45795. * Gets the input sensibility for mouse input.
  45796. * Higher values reduce sensitivity.
  45797. */
  45798. get angularSensibility(): number;
  45799. /**
  45800. * Sets the input sensibility for a mouse input.
  45801. * Higher values reduce sensitivity.
  45802. */
  45803. set angularSensibility(value: number);
  45804. /**
  45805. * Get the keys for camera movement forward.
  45806. */
  45807. get keysForward(): number[];
  45808. /**
  45809. * Set the keys for camera movement forward.
  45810. */
  45811. set keysForward(value: number[]);
  45812. /**
  45813. * Get the keys for camera movement backward.
  45814. */
  45815. get keysBackward(): number[];
  45816. set keysBackward(value: number[]);
  45817. /**
  45818. * Get the keys for camera movement up.
  45819. */
  45820. get keysUp(): number[];
  45821. /**
  45822. * Set the keys for camera movement up.
  45823. */
  45824. set keysUp(value: number[]);
  45825. /**
  45826. * Get the keys for camera movement down.
  45827. */
  45828. get keysDown(): number[];
  45829. /**
  45830. * Set the keys for camera movement down.
  45831. */
  45832. set keysDown(value: number[]);
  45833. /**
  45834. * Get the keys for camera movement left.
  45835. */
  45836. get keysLeft(): number[];
  45837. /**
  45838. * Set the keys for camera movement left.
  45839. */
  45840. set keysLeft(value: number[]);
  45841. /**
  45842. * Set the keys for camera movement right.
  45843. */
  45844. get keysRight(): number[];
  45845. /**
  45846. * Set the keys for camera movement right.
  45847. */
  45848. set keysRight(value: number[]);
  45849. /**
  45850. * Event raised when the camera collides with a mesh in the scene.
  45851. */
  45852. onCollide: (collidedMesh: AbstractMesh) => void;
  45853. private _collider;
  45854. private _needMoveForGravity;
  45855. private _oldPosition;
  45856. private _diffPosition;
  45857. private _newPosition;
  45858. /** @hidden */
  45859. _localDirection: Vector3;
  45860. /** @hidden */
  45861. _transformedDirection: Vector3;
  45862. /**
  45863. * Instantiates a FlyCamera.
  45864. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45865. * such as in a 3D Space Shooter or a Flight Simulator.
  45866. * @param name Define the name of the camera in the scene.
  45867. * @param position Define the starting position of the camera in the scene.
  45868. * @param scene Define the scene the camera belongs to.
  45869. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45870. */
  45871. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45872. /**
  45873. * Attach a control to the HTML DOM element.
  45874. * @param element Defines the element that listens to the input events.
  45875. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45876. */
  45877. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45878. /**
  45879. * Detach a control from the HTML DOM element.
  45880. * The camera will stop reacting to that input.
  45881. * @param element Defines the element that listens to the input events.
  45882. */
  45883. detachControl(element: HTMLElement): void;
  45884. private _collisionMask;
  45885. /**
  45886. * Get the mask that the camera ignores in collision events.
  45887. */
  45888. get collisionMask(): number;
  45889. /**
  45890. * Set the mask that the camera ignores in collision events.
  45891. */
  45892. set collisionMask(mask: number);
  45893. /** @hidden */
  45894. _collideWithWorld(displacement: Vector3): void;
  45895. /** @hidden */
  45896. private _onCollisionPositionChange;
  45897. /** @hidden */
  45898. _checkInputs(): void;
  45899. /** @hidden */
  45900. _decideIfNeedsToMove(): boolean;
  45901. /** @hidden */
  45902. _updatePosition(): void;
  45903. /**
  45904. * Restore the Roll to its target value at the rate specified.
  45905. * @param rate - Higher means slower restoring.
  45906. * @hidden
  45907. */
  45908. restoreRoll(rate: number): void;
  45909. /**
  45910. * Destroy the camera and release the current resources held by it.
  45911. */
  45912. dispose(): void;
  45913. /**
  45914. * Get the current object class name.
  45915. * @returns the class name.
  45916. */
  45917. getClassName(): string;
  45918. }
  45919. }
  45920. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45921. import { Nullable } from "babylonjs/types";
  45922. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45923. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45924. /**
  45925. * Listen to keyboard events to control the camera.
  45926. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45927. */
  45928. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45929. /**
  45930. * Defines the camera the input is attached to.
  45931. */
  45932. camera: FlyCamera;
  45933. /**
  45934. * The list of keyboard keys used to control the forward move of the camera.
  45935. */
  45936. keysForward: number[];
  45937. /**
  45938. * The list of keyboard keys used to control the backward move of the camera.
  45939. */
  45940. keysBackward: number[];
  45941. /**
  45942. * The list of keyboard keys used to control the forward move of the camera.
  45943. */
  45944. keysUp: number[];
  45945. /**
  45946. * The list of keyboard keys used to control the backward move of the camera.
  45947. */
  45948. keysDown: number[];
  45949. /**
  45950. * The list of keyboard keys used to control the right strafe move of the camera.
  45951. */
  45952. keysRight: number[];
  45953. /**
  45954. * The list of keyboard keys used to control the left strafe move of the camera.
  45955. */
  45956. keysLeft: number[];
  45957. private _keys;
  45958. private _onCanvasBlurObserver;
  45959. private _onKeyboardObserver;
  45960. private _engine;
  45961. private _scene;
  45962. /**
  45963. * Attach the input controls to a specific dom element to get the input from.
  45964. * @param element Defines the element the controls should be listened from
  45965. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45966. */
  45967. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45968. /**
  45969. * Detach the current controls from the specified dom element.
  45970. * @param element Defines the element to stop listening the inputs from
  45971. */
  45972. detachControl(element: Nullable<HTMLElement>): void;
  45973. /**
  45974. * Gets the class name of the current intput.
  45975. * @returns the class name
  45976. */
  45977. getClassName(): string;
  45978. /** @hidden */
  45979. _onLostFocus(e: FocusEvent): void;
  45980. /**
  45981. * Get the friendly name associated with the input class.
  45982. * @returns the input friendly name
  45983. */
  45984. getSimpleName(): string;
  45985. /**
  45986. * Update the current camera state depending on the inputs that have been used this frame.
  45987. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45988. */
  45989. checkInputs(): void;
  45990. }
  45991. }
  45992. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45993. import { Nullable } from "babylonjs/types";
  45994. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45995. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45996. /**
  45997. * Manage the mouse wheel inputs to control a follow camera.
  45998. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45999. */
  46000. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  46001. /**
  46002. * Defines the camera the input is attached to.
  46003. */
  46004. camera: FollowCamera;
  46005. /**
  46006. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  46007. */
  46008. axisControlRadius: boolean;
  46009. /**
  46010. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46011. */
  46012. axisControlHeight: boolean;
  46013. /**
  46014. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46015. */
  46016. axisControlRotation: boolean;
  46017. /**
  46018. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46019. * relation to mouseWheel events.
  46020. */
  46021. wheelPrecision: number;
  46022. /**
  46023. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46024. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46025. */
  46026. wheelDeltaPercentage: number;
  46027. private _wheel;
  46028. private _observer;
  46029. /**
  46030. * Attach the input controls to a specific dom element to get the input from.
  46031. * @param element Defines the element the controls should be listened from
  46032. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46033. */
  46034. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46035. /**
  46036. * Detach the current controls from the specified dom element.
  46037. * @param element Defines the element to stop listening the inputs from
  46038. */
  46039. detachControl(element: Nullable<HTMLElement>): void;
  46040. /**
  46041. * Gets the class name of the current intput.
  46042. * @returns the class name
  46043. */
  46044. getClassName(): string;
  46045. /**
  46046. * Get the friendly name associated with the input class.
  46047. * @returns the input friendly name
  46048. */
  46049. getSimpleName(): string;
  46050. }
  46051. }
  46052. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46053. import { Nullable } from "babylonjs/types";
  46054. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46055. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46056. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46057. /**
  46058. * Manage the pointers inputs to control an follow camera.
  46059. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46060. */
  46061. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46062. /**
  46063. * Defines the camera the input is attached to.
  46064. */
  46065. camera: FollowCamera;
  46066. /**
  46067. * Gets the class name of the current input.
  46068. * @returns the class name
  46069. */
  46070. getClassName(): string;
  46071. /**
  46072. * Defines the pointer angular sensibility along the X axis or how fast is
  46073. * the camera rotating.
  46074. * A negative number will reverse the axis direction.
  46075. */
  46076. angularSensibilityX: number;
  46077. /**
  46078. * Defines the pointer angular sensibility along the Y axis or how fast is
  46079. * the camera rotating.
  46080. * A negative number will reverse the axis direction.
  46081. */
  46082. angularSensibilityY: number;
  46083. /**
  46084. * Defines the pointer pinch precision or how fast is the camera zooming.
  46085. * A negative number will reverse the axis direction.
  46086. */
  46087. pinchPrecision: number;
  46088. /**
  46089. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46090. * from 0.
  46091. * It defines the percentage of current camera.radius to use as delta when
  46092. * pinch zoom is used.
  46093. */
  46094. pinchDeltaPercentage: number;
  46095. /**
  46096. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46097. */
  46098. axisXControlRadius: boolean;
  46099. /**
  46100. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46101. */
  46102. axisXControlHeight: boolean;
  46103. /**
  46104. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46105. */
  46106. axisXControlRotation: boolean;
  46107. /**
  46108. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46109. */
  46110. axisYControlRadius: boolean;
  46111. /**
  46112. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46113. */
  46114. axisYControlHeight: boolean;
  46115. /**
  46116. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46117. */
  46118. axisYControlRotation: boolean;
  46119. /**
  46120. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46121. */
  46122. axisPinchControlRadius: boolean;
  46123. /**
  46124. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46125. */
  46126. axisPinchControlHeight: boolean;
  46127. /**
  46128. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46129. */
  46130. axisPinchControlRotation: boolean;
  46131. /**
  46132. * Log error messages if basic misconfiguration has occurred.
  46133. */
  46134. warningEnable: boolean;
  46135. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46136. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46137. private _warningCounter;
  46138. private _warning;
  46139. }
  46140. }
  46141. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46142. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46143. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46144. /**
  46145. * Default Inputs manager for the FollowCamera.
  46146. * It groups all the default supported inputs for ease of use.
  46147. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46148. */
  46149. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46150. /**
  46151. * Instantiates a new FollowCameraInputsManager.
  46152. * @param camera Defines the camera the inputs belong to
  46153. */
  46154. constructor(camera: FollowCamera);
  46155. /**
  46156. * Add keyboard input support to the input manager.
  46157. * @returns the current input manager
  46158. */
  46159. addKeyboard(): FollowCameraInputsManager;
  46160. /**
  46161. * Add mouse wheel input support to the input manager.
  46162. * @returns the current input manager
  46163. */
  46164. addMouseWheel(): FollowCameraInputsManager;
  46165. /**
  46166. * Add pointers input support to the input manager.
  46167. * @returns the current input manager
  46168. */
  46169. addPointers(): FollowCameraInputsManager;
  46170. /**
  46171. * Add orientation input support to the input manager.
  46172. * @returns the current input manager
  46173. */
  46174. addVRDeviceOrientation(): FollowCameraInputsManager;
  46175. }
  46176. }
  46177. declare module "babylonjs/Cameras/followCamera" {
  46178. import { Nullable } from "babylonjs/types";
  46179. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46180. import { Scene } from "babylonjs/scene";
  46181. import { Vector3 } from "babylonjs/Maths/math.vector";
  46182. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46183. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46184. /**
  46185. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46186. * an arc rotate version arcFollowCamera are available.
  46187. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46188. */
  46189. export class FollowCamera extends TargetCamera {
  46190. /**
  46191. * Distance the follow camera should follow an object at
  46192. */
  46193. radius: number;
  46194. /**
  46195. * Minimum allowed distance of the camera to the axis of rotation
  46196. * (The camera can not get closer).
  46197. * This can help limiting how the Camera is able to move in the scene.
  46198. */
  46199. lowerRadiusLimit: Nullable<number>;
  46200. /**
  46201. * Maximum allowed distance of the camera to the axis of rotation
  46202. * (The camera can not get further).
  46203. * This can help limiting how the Camera is able to move in the scene.
  46204. */
  46205. upperRadiusLimit: Nullable<number>;
  46206. /**
  46207. * Define a rotation offset between the camera and the object it follows
  46208. */
  46209. rotationOffset: number;
  46210. /**
  46211. * Minimum allowed angle to camera position relative to target object.
  46212. * This can help limiting how the Camera is able to move in the scene.
  46213. */
  46214. lowerRotationOffsetLimit: Nullable<number>;
  46215. /**
  46216. * Maximum allowed angle to camera position relative to target object.
  46217. * This can help limiting how the Camera is able to move in the scene.
  46218. */
  46219. upperRotationOffsetLimit: Nullable<number>;
  46220. /**
  46221. * Define a height offset between the camera and the object it follows.
  46222. * It can help following an object from the top (like a car chaing a plane)
  46223. */
  46224. heightOffset: number;
  46225. /**
  46226. * Minimum allowed height of camera position relative to target object.
  46227. * This can help limiting how the Camera is able to move in the scene.
  46228. */
  46229. lowerHeightOffsetLimit: Nullable<number>;
  46230. /**
  46231. * Maximum allowed height of camera position relative to target object.
  46232. * This can help limiting how the Camera is able to move in the scene.
  46233. */
  46234. upperHeightOffsetLimit: Nullable<number>;
  46235. /**
  46236. * Define how fast the camera can accelerate to follow it s target.
  46237. */
  46238. cameraAcceleration: number;
  46239. /**
  46240. * Define the speed limit of the camera following an object.
  46241. */
  46242. maxCameraSpeed: number;
  46243. /**
  46244. * Define the target of the camera.
  46245. */
  46246. lockedTarget: Nullable<AbstractMesh>;
  46247. /**
  46248. * Defines the input associated with the camera.
  46249. */
  46250. inputs: FollowCameraInputsManager;
  46251. /**
  46252. * Instantiates the follow camera.
  46253. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46254. * @param name Define the name of the camera in the scene
  46255. * @param position Define the position of the camera
  46256. * @param scene Define the scene the camera belong to
  46257. * @param lockedTarget Define the target of the camera
  46258. */
  46259. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46260. private _follow;
  46261. /**
  46262. * Attached controls to the current camera.
  46263. * @param element Defines the element the controls should be listened from
  46264. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46265. */
  46266. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46267. /**
  46268. * Detach the current controls from the camera.
  46269. * The camera will stop reacting to inputs.
  46270. * @param element Defines the element to stop listening the inputs from
  46271. */
  46272. detachControl(element: HTMLElement): void;
  46273. /** @hidden */
  46274. _checkInputs(): void;
  46275. private _checkLimits;
  46276. /**
  46277. * Gets the camera class name.
  46278. * @returns the class name
  46279. */
  46280. getClassName(): string;
  46281. }
  46282. /**
  46283. * Arc Rotate version of the follow camera.
  46284. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46285. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46286. */
  46287. export class ArcFollowCamera extends TargetCamera {
  46288. /** The longitudinal angle of the camera */
  46289. alpha: number;
  46290. /** The latitudinal angle of the camera */
  46291. beta: number;
  46292. /** The radius of the camera from its target */
  46293. radius: number;
  46294. private _cartesianCoordinates;
  46295. /** Define the camera target (the mesh it should follow) */
  46296. private _meshTarget;
  46297. /**
  46298. * Instantiates a new ArcFollowCamera
  46299. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46300. * @param name Define the name of the camera
  46301. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46302. * @param beta Define the rotation angle of the camera around the elevation axis
  46303. * @param radius Define the radius of the camera from its target point
  46304. * @param target Define the target of the camera
  46305. * @param scene Define the scene the camera belongs to
  46306. */
  46307. constructor(name: string,
  46308. /** The longitudinal angle of the camera */
  46309. alpha: number,
  46310. /** The latitudinal angle of the camera */
  46311. beta: number,
  46312. /** The radius of the camera from its target */
  46313. radius: number,
  46314. /** Define the camera target (the mesh it should follow) */
  46315. target: Nullable<AbstractMesh>, scene: Scene);
  46316. private _follow;
  46317. /** @hidden */
  46318. _checkInputs(): void;
  46319. /**
  46320. * Returns the class name of the object.
  46321. * It is mostly used internally for serialization purposes.
  46322. */
  46323. getClassName(): string;
  46324. }
  46325. }
  46326. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46327. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46328. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46329. import { Nullable } from "babylonjs/types";
  46330. /**
  46331. * Manage the keyboard inputs to control the movement of a follow camera.
  46332. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46333. */
  46334. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46335. /**
  46336. * Defines the camera the input is attached to.
  46337. */
  46338. camera: FollowCamera;
  46339. /**
  46340. * Defines the list of key codes associated with the up action (increase heightOffset)
  46341. */
  46342. keysHeightOffsetIncr: number[];
  46343. /**
  46344. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46345. */
  46346. keysHeightOffsetDecr: number[];
  46347. /**
  46348. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46349. */
  46350. keysHeightOffsetModifierAlt: boolean;
  46351. /**
  46352. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46353. */
  46354. keysHeightOffsetModifierCtrl: boolean;
  46355. /**
  46356. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46357. */
  46358. keysHeightOffsetModifierShift: boolean;
  46359. /**
  46360. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46361. */
  46362. keysRotationOffsetIncr: number[];
  46363. /**
  46364. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46365. */
  46366. keysRotationOffsetDecr: number[];
  46367. /**
  46368. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46369. */
  46370. keysRotationOffsetModifierAlt: boolean;
  46371. /**
  46372. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46373. */
  46374. keysRotationOffsetModifierCtrl: boolean;
  46375. /**
  46376. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46377. */
  46378. keysRotationOffsetModifierShift: boolean;
  46379. /**
  46380. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46381. */
  46382. keysRadiusIncr: number[];
  46383. /**
  46384. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46385. */
  46386. keysRadiusDecr: number[];
  46387. /**
  46388. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46389. */
  46390. keysRadiusModifierAlt: boolean;
  46391. /**
  46392. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46393. */
  46394. keysRadiusModifierCtrl: boolean;
  46395. /**
  46396. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46397. */
  46398. keysRadiusModifierShift: boolean;
  46399. /**
  46400. * Defines the rate of change of heightOffset.
  46401. */
  46402. heightSensibility: number;
  46403. /**
  46404. * Defines the rate of change of rotationOffset.
  46405. */
  46406. rotationSensibility: number;
  46407. /**
  46408. * Defines the rate of change of radius.
  46409. */
  46410. radiusSensibility: number;
  46411. private _keys;
  46412. private _ctrlPressed;
  46413. private _altPressed;
  46414. private _shiftPressed;
  46415. private _onCanvasBlurObserver;
  46416. private _onKeyboardObserver;
  46417. private _engine;
  46418. private _scene;
  46419. /**
  46420. * Attach the input controls to a specific dom element to get the input from.
  46421. * @param element Defines the element the controls should be listened from
  46422. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46423. */
  46424. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46425. /**
  46426. * Detach the current controls from the specified dom element.
  46427. * @param element Defines the element to stop listening the inputs from
  46428. */
  46429. detachControl(element: Nullable<HTMLElement>): void;
  46430. /**
  46431. * Update the current camera state depending on the inputs that have been used this frame.
  46432. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46433. */
  46434. checkInputs(): void;
  46435. /**
  46436. * Gets the class name of the current input.
  46437. * @returns the class name
  46438. */
  46439. getClassName(): string;
  46440. /**
  46441. * Get the friendly name associated with the input class.
  46442. * @returns the input friendly name
  46443. */
  46444. getSimpleName(): string;
  46445. /**
  46446. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46447. * allow modification of the heightOffset value.
  46448. */
  46449. private _modifierHeightOffset;
  46450. /**
  46451. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46452. * allow modification of the rotationOffset value.
  46453. */
  46454. private _modifierRotationOffset;
  46455. /**
  46456. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46457. * allow modification of the radius value.
  46458. */
  46459. private _modifierRadius;
  46460. }
  46461. }
  46462. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46463. import { Nullable } from "babylonjs/types";
  46464. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46465. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46466. import { Observable } from "babylonjs/Misc/observable";
  46467. module "babylonjs/Cameras/freeCameraInputsManager" {
  46468. interface FreeCameraInputsManager {
  46469. /**
  46470. * @hidden
  46471. */
  46472. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46473. /**
  46474. * Add orientation input support to the input manager.
  46475. * @returns the current input manager
  46476. */
  46477. addDeviceOrientation(): FreeCameraInputsManager;
  46478. }
  46479. }
  46480. /**
  46481. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46482. * Screen rotation is taken into account.
  46483. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46484. */
  46485. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46486. private _camera;
  46487. private _screenOrientationAngle;
  46488. private _constantTranform;
  46489. private _screenQuaternion;
  46490. private _alpha;
  46491. private _beta;
  46492. private _gamma;
  46493. /**
  46494. * Can be used to detect if a device orientation sensor is available on a device
  46495. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46496. * @returns a promise that will resolve on orientation change
  46497. */
  46498. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46499. /**
  46500. * @hidden
  46501. */
  46502. _onDeviceOrientationChangedObservable: Observable<void>;
  46503. /**
  46504. * Instantiates a new input
  46505. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46506. */
  46507. constructor();
  46508. /**
  46509. * Define the camera controlled by the input.
  46510. */
  46511. get camera(): FreeCamera;
  46512. set camera(camera: FreeCamera);
  46513. /**
  46514. * Attach the input controls to a specific dom element to get the input from.
  46515. * @param element Defines the element the controls should be listened from
  46516. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46517. */
  46518. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46519. private _orientationChanged;
  46520. private _deviceOrientation;
  46521. /**
  46522. * Detach the current controls from the specified dom element.
  46523. * @param element Defines the element to stop listening the inputs from
  46524. */
  46525. detachControl(element: Nullable<HTMLElement>): void;
  46526. /**
  46527. * Update the current camera state depending on the inputs that have been used this frame.
  46528. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46529. */
  46530. checkInputs(): void;
  46531. /**
  46532. * Gets the class name of the current intput.
  46533. * @returns the class name
  46534. */
  46535. getClassName(): string;
  46536. /**
  46537. * Get the friendly name associated with the input class.
  46538. * @returns the input friendly name
  46539. */
  46540. getSimpleName(): string;
  46541. }
  46542. }
  46543. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46544. import { Nullable } from "babylonjs/types";
  46545. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46546. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46547. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46548. /**
  46549. * Manage the gamepad inputs to control a free camera.
  46550. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46551. */
  46552. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46553. /**
  46554. * Define the camera the input is attached to.
  46555. */
  46556. camera: FreeCamera;
  46557. /**
  46558. * Define the Gamepad controlling the input
  46559. */
  46560. gamepad: Nullable<Gamepad>;
  46561. /**
  46562. * Defines the gamepad rotation sensiblity.
  46563. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46564. */
  46565. gamepadAngularSensibility: number;
  46566. /**
  46567. * Defines the gamepad move sensiblity.
  46568. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46569. */
  46570. gamepadMoveSensibility: number;
  46571. private _yAxisScale;
  46572. /**
  46573. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46574. */
  46575. get invertYAxis(): boolean;
  46576. set invertYAxis(value: boolean);
  46577. private _onGamepadConnectedObserver;
  46578. private _onGamepadDisconnectedObserver;
  46579. private _cameraTransform;
  46580. private _deltaTransform;
  46581. private _vector3;
  46582. private _vector2;
  46583. /**
  46584. * Attach the input controls to a specific dom element to get the input from.
  46585. * @param element Defines the element the controls should be listened from
  46586. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46587. */
  46588. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46589. /**
  46590. * Detach the current controls from the specified dom element.
  46591. * @param element Defines the element to stop listening the inputs from
  46592. */
  46593. detachControl(element: Nullable<HTMLElement>): void;
  46594. /**
  46595. * Update the current camera state depending on the inputs that have been used this frame.
  46596. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46597. */
  46598. checkInputs(): 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/Misc/virtualJoystick" {
  46612. import { Nullable } from "babylonjs/types";
  46613. import { Vector3 } from "babylonjs/Maths/math.vector";
  46614. /**
  46615. * Defines the potential axis of a Joystick
  46616. */
  46617. export enum JoystickAxis {
  46618. /** X axis */
  46619. X = 0,
  46620. /** Y axis */
  46621. Y = 1,
  46622. /** Z axis */
  46623. Z = 2
  46624. }
  46625. /**
  46626. * Represents the different customization options available
  46627. * for VirtualJoystick
  46628. */
  46629. interface VirtualJoystickCustomizations {
  46630. /**
  46631. * Size of the joystick's puck
  46632. */
  46633. puckSize: number;
  46634. /**
  46635. * Size of the joystick's container
  46636. */
  46637. containerSize: number;
  46638. /**
  46639. * Color of the joystick && puck
  46640. */
  46641. color: string;
  46642. /**
  46643. * Image URL for the joystick's puck
  46644. */
  46645. puckImage?: string;
  46646. /**
  46647. * Image URL for the joystick's container
  46648. */
  46649. containerImage?: string;
  46650. /**
  46651. * Defines the unmoving position of the joystick container
  46652. */
  46653. position?: {
  46654. x: number;
  46655. y: number;
  46656. };
  46657. /**
  46658. * Defines whether or not the joystick container is always visible
  46659. */
  46660. alwaysVisible: boolean;
  46661. /**
  46662. * Defines whether or not to limit the movement of the puck to the joystick's container
  46663. */
  46664. limitToContainer: boolean;
  46665. }
  46666. /**
  46667. * Class used to define virtual joystick (used in touch mode)
  46668. */
  46669. export class VirtualJoystick {
  46670. /**
  46671. * Gets or sets a boolean indicating that left and right values must be inverted
  46672. */
  46673. reverseLeftRight: boolean;
  46674. /**
  46675. * Gets or sets a boolean indicating that up and down values must be inverted
  46676. */
  46677. reverseUpDown: boolean;
  46678. /**
  46679. * Gets the offset value for the position (ie. the change of the position value)
  46680. */
  46681. deltaPosition: Vector3;
  46682. /**
  46683. * Gets a boolean indicating if the virtual joystick was pressed
  46684. */
  46685. pressed: boolean;
  46686. /**
  46687. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46688. */
  46689. static Canvas: Nullable<HTMLCanvasElement>;
  46690. /**
  46691. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46692. */
  46693. limitToContainer: boolean;
  46694. private static _globalJoystickIndex;
  46695. private static _alwaysVisibleSticks;
  46696. private static vjCanvasContext;
  46697. private static vjCanvasWidth;
  46698. private static vjCanvasHeight;
  46699. private static halfWidth;
  46700. private static _GetDefaultOptions;
  46701. private _action;
  46702. private _axisTargetedByLeftAndRight;
  46703. private _axisTargetedByUpAndDown;
  46704. private _joystickSensibility;
  46705. private _inversedSensibility;
  46706. private _joystickPointerID;
  46707. private _joystickColor;
  46708. private _joystickPointerPos;
  46709. private _joystickPreviousPointerPos;
  46710. private _joystickPointerStartPos;
  46711. private _deltaJoystickVector;
  46712. private _leftJoystick;
  46713. private _touches;
  46714. private _joystickPosition;
  46715. private _alwaysVisible;
  46716. private _puckImage;
  46717. private _containerImage;
  46718. private _joystickPuckSize;
  46719. private _joystickContainerSize;
  46720. private _clearPuckSize;
  46721. private _clearContainerSize;
  46722. private _clearPuckSizeOffset;
  46723. private _clearContainerSizeOffset;
  46724. private _onPointerDownHandlerRef;
  46725. private _onPointerMoveHandlerRef;
  46726. private _onPointerUpHandlerRef;
  46727. private _onResize;
  46728. /**
  46729. * Creates a new virtual joystick
  46730. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46731. * @param customizations Defines the options we want to customize the VirtualJoystick
  46732. */
  46733. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46734. /**
  46735. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46736. * @param newJoystickSensibility defines the new sensibility
  46737. */
  46738. setJoystickSensibility(newJoystickSensibility: number): void;
  46739. private _onPointerDown;
  46740. private _onPointerMove;
  46741. private _onPointerUp;
  46742. /**
  46743. * Change the color of the virtual joystick
  46744. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46745. */
  46746. setJoystickColor(newColor: string): void;
  46747. /**
  46748. * Size of the joystick's container
  46749. */
  46750. set containerSize(newSize: number);
  46751. get containerSize(): number;
  46752. /**
  46753. * Size of the joystick's puck
  46754. */
  46755. set puckSize(newSize: number);
  46756. get puckSize(): number;
  46757. /**
  46758. * Clears the set position of the joystick
  46759. */
  46760. clearPosition(): void;
  46761. /**
  46762. * Defines whether or not the joystick container is always visible
  46763. */
  46764. set alwaysVisible(value: boolean);
  46765. get alwaysVisible(): boolean;
  46766. /**
  46767. * Sets the constant position of the Joystick container
  46768. * @param x X axis coordinate
  46769. * @param y Y axis coordinate
  46770. */
  46771. setPosition(x: number, y: number): void;
  46772. /**
  46773. * Defines a callback to call when the joystick is touched
  46774. * @param action defines the callback
  46775. */
  46776. setActionOnTouch(action: () => any): void;
  46777. /**
  46778. * Defines which axis you'd like to control for left & right
  46779. * @param axis defines the axis to use
  46780. */
  46781. setAxisForLeftRight(axis: JoystickAxis): void;
  46782. /**
  46783. * Defines which axis you'd like to control for up & down
  46784. * @param axis defines the axis to use
  46785. */
  46786. setAxisForUpDown(axis: JoystickAxis): void;
  46787. /**
  46788. * Clears the canvas from the previous puck / container draw
  46789. */
  46790. private _clearPreviousDraw;
  46791. /**
  46792. * Loads `urlPath` to be used for the container's image
  46793. * @param urlPath defines the urlPath of an image to use
  46794. */
  46795. setContainerImage(urlPath: string): void;
  46796. /**
  46797. * Loads `urlPath` to be used for the puck's image
  46798. * @param urlPath defines the urlPath of an image to use
  46799. */
  46800. setPuckImage(urlPath: string): void;
  46801. /**
  46802. * Draws the Virtual Joystick's container
  46803. */
  46804. private _drawContainer;
  46805. /**
  46806. * Draws the Virtual Joystick's puck
  46807. */
  46808. private _drawPuck;
  46809. private _drawVirtualJoystick;
  46810. /**
  46811. * Release internal HTML canvas
  46812. */
  46813. releaseCanvas(): void;
  46814. }
  46815. }
  46816. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46817. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46818. import { Nullable } from "babylonjs/types";
  46819. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46820. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46821. module "babylonjs/Cameras/freeCameraInputsManager" {
  46822. interface FreeCameraInputsManager {
  46823. /**
  46824. * Add virtual joystick input support to the input manager.
  46825. * @returns the current input manager
  46826. */
  46827. addVirtualJoystick(): FreeCameraInputsManager;
  46828. }
  46829. }
  46830. /**
  46831. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46832. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46833. */
  46834. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46835. /**
  46836. * Defines the camera the input is attached to.
  46837. */
  46838. camera: FreeCamera;
  46839. private _leftjoystick;
  46840. private _rightjoystick;
  46841. /**
  46842. * Gets the left stick of the virtual joystick.
  46843. * @returns The virtual Joystick
  46844. */
  46845. getLeftJoystick(): VirtualJoystick;
  46846. /**
  46847. * Gets the right stick of the virtual joystick.
  46848. * @returns The virtual Joystick
  46849. */
  46850. getRightJoystick(): VirtualJoystick;
  46851. /**
  46852. * Update the current camera state depending on the inputs that have been used this frame.
  46853. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46854. */
  46855. checkInputs(): void;
  46856. /**
  46857. * Attach the input controls to a specific dom element to get the input from.
  46858. * @param element Defines the element the controls should be listened from
  46859. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46860. */
  46861. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46862. /**
  46863. * Detach the current controls from the specified dom element.
  46864. * @param element Defines the element to stop listening the inputs from
  46865. */
  46866. detachControl(element: Nullable<HTMLElement>): void;
  46867. /**
  46868. * Gets the class name of the current intput.
  46869. * @returns the class name
  46870. */
  46871. getClassName(): string;
  46872. /**
  46873. * Get the friendly name associated with the input class.
  46874. * @returns the input friendly name
  46875. */
  46876. getSimpleName(): string;
  46877. }
  46878. }
  46879. declare module "babylonjs/Cameras/Inputs/index" {
  46880. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46881. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46882. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46883. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46884. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46885. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46886. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46887. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46888. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46889. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46890. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46891. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46892. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46893. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46894. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46895. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46896. }
  46897. declare module "babylonjs/Cameras/touchCamera" {
  46898. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46899. import { Scene } from "babylonjs/scene";
  46900. import { Vector3 } from "babylonjs/Maths/math.vector";
  46901. /**
  46902. * This represents a FPS type of camera controlled by touch.
  46903. * This is like a universal camera minus the Gamepad controls.
  46904. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46905. */
  46906. export class TouchCamera extends FreeCamera {
  46907. /**
  46908. * Defines the touch sensibility for rotation.
  46909. * The higher the faster.
  46910. */
  46911. get touchAngularSensibility(): number;
  46912. set touchAngularSensibility(value: number);
  46913. /**
  46914. * Defines the touch sensibility for move.
  46915. * The higher the faster.
  46916. */
  46917. get touchMoveSensibility(): number;
  46918. set touchMoveSensibility(value: number);
  46919. /**
  46920. * Instantiates a new touch camera.
  46921. * This represents a FPS type of camera controlled by touch.
  46922. * This is like a universal camera minus the Gamepad controls.
  46923. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46924. * @param name Define the name of the camera in the scene
  46925. * @param position Define the start position of the camera in the scene
  46926. * @param scene Define the scene the camera belongs to
  46927. */
  46928. constructor(name: string, position: Vector3, scene: Scene);
  46929. /**
  46930. * Gets the current object class name.
  46931. * @return the class name
  46932. */
  46933. getClassName(): string;
  46934. /** @hidden */
  46935. _setupInputs(): void;
  46936. }
  46937. }
  46938. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46939. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46940. import { Scene } from "babylonjs/scene";
  46941. import { Vector3 } from "babylonjs/Maths/math.vector";
  46942. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46943. import { Axis } from "babylonjs/Maths/math.axis";
  46944. /**
  46945. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46946. * being tilted forward or back and left or right.
  46947. */
  46948. export class DeviceOrientationCamera extends FreeCamera {
  46949. private _initialQuaternion;
  46950. private _quaternionCache;
  46951. private _tmpDragQuaternion;
  46952. private _disablePointerInputWhenUsingDeviceOrientation;
  46953. /**
  46954. * Creates a new device orientation camera
  46955. * @param name The name of the camera
  46956. * @param position The start position camera
  46957. * @param scene The scene the camera belongs to
  46958. */
  46959. constructor(name: string, position: Vector3, scene: Scene);
  46960. /**
  46961. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46962. */
  46963. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46964. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46965. private _dragFactor;
  46966. /**
  46967. * Enabled turning on the y axis when the orientation sensor is active
  46968. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46969. */
  46970. enableHorizontalDragging(dragFactor?: number): void;
  46971. /**
  46972. * Gets the current instance class name ("DeviceOrientationCamera").
  46973. * This helps avoiding instanceof at run time.
  46974. * @returns the class name
  46975. */
  46976. getClassName(): string;
  46977. /**
  46978. * @hidden
  46979. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46980. */
  46981. _checkInputs(): void;
  46982. /**
  46983. * Reset the camera to its default orientation on the specified axis only.
  46984. * @param axis The axis to reset
  46985. */
  46986. resetToCurrentRotation(axis?: Axis): void;
  46987. }
  46988. }
  46989. declare module "babylonjs/Gamepads/xboxGamepad" {
  46990. import { Observable } from "babylonjs/Misc/observable";
  46991. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46992. /**
  46993. * Defines supported buttons for XBox360 compatible gamepads
  46994. */
  46995. export enum Xbox360Button {
  46996. /** A */
  46997. A = 0,
  46998. /** B */
  46999. B = 1,
  47000. /** X */
  47001. X = 2,
  47002. /** Y */
  47003. Y = 3,
  47004. /** Left button */
  47005. LB = 4,
  47006. /** Right button */
  47007. RB = 5,
  47008. /** Back */
  47009. Back = 8,
  47010. /** Start */
  47011. Start = 9,
  47012. /** Left stick */
  47013. LeftStick = 10,
  47014. /** Right stick */
  47015. RightStick = 11
  47016. }
  47017. /** Defines values for XBox360 DPad */
  47018. export enum Xbox360Dpad {
  47019. /** Up */
  47020. Up = 12,
  47021. /** Down */
  47022. Down = 13,
  47023. /** Left */
  47024. Left = 14,
  47025. /** Right */
  47026. Right = 15
  47027. }
  47028. /**
  47029. * Defines a XBox360 gamepad
  47030. */
  47031. export class Xbox360Pad extends Gamepad {
  47032. private _leftTrigger;
  47033. private _rightTrigger;
  47034. private _onlefttriggerchanged;
  47035. private _onrighttriggerchanged;
  47036. private _onbuttondown;
  47037. private _onbuttonup;
  47038. private _ondpaddown;
  47039. private _ondpadup;
  47040. /** Observable raised when a button is pressed */
  47041. onButtonDownObservable: Observable<Xbox360Button>;
  47042. /** Observable raised when a button is released */
  47043. onButtonUpObservable: Observable<Xbox360Button>;
  47044. /** Observable raised when a pad is pressed */
  47045. onPadDownObservable: Observable<Xbox360Dpad>;
  47046. /** Observable raised when a pad is released */
  47047. onPadUpObservable: Observable<Xbox360Dpad>;
  47048. private _buttonA;
  47049. private _buttonB;
  47050. private _buttonX;
  47051. private _buttonY;
  47052. private _buttonBack;
  47053. private _buttonStart;
  47054. private _buttonLB;
  47055. private _buttonRB;
  47056. private _buttonLeftStick;
  47057. private _buttonRightStick;
  47058. private _dPadUp;
  47059. private _dPadDown;
  47060. private _dPadLeft;
  47061. private _dPadRight;
  47062. private _isXboxOnePad;
  47063. /**
  47064. * Creates a new XBox360 gamepad object
  47065. * @param id defines the id of this gamepad
  47066. * @param index defines its index
  47067. * @param gamepad defines the internal HTML gamepad object
  47068. * @param xboxOne defines if it is a XBox One gamepad
  47069. */
  47070. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47071. /**
  47072. * Defines the callback to call when left trigger is pressed
  47073. * @param callback defines the callback to use
  47074. */
  47075. onlefttriggerchanged(callback: (value: number) => void): void;
  47076. /**
  47077. * Defines the callback to call when right trigger is pressed
  47078. * @param callback defines the callback to use
  47079. */
  47080. onrighttriggerchanged(callback: (value: number) => void): void;
  47081. /**
  47082. * Gets the left trigger value
  47083. */
  47084. get leftTrigger(): number;
  47085. /**
  47086. * Sets the left trigger value
  47087. */
  47088. set leftTrigger(newValue: number);
  47089. /**
  47090. * Gets the right trigger value
  47091. */
  47092. get rightTrigger(): number;
  47093. /**
  47094. * Sets the right trigger value
  47095. */
  47096. set rightTrigger(newValue: number);
  47097. /**
  47098. * Defines the callback to call when a button is pressed
  47099. * @param callback defines the callback to use
  47100. */
  47101. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47102. /**
  47103. * Defines the callback to call when a button is released
  47104. * @param callback defines the callback to use
  47105. */
  47106. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47107. /**
  47108. * Defines the callback to call when a pad is pressed
  47109. * @param callback defines the callback to use
  47110. */
  47111. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47112. /**
  47113. * Defines the callback to call when a pad is released
  47114. * @param callback defines the callback to use
  47115. */
  47116. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47117. private _setButtonValue;
  47118. private _setDPadValue;
  47119. /**
  47120. * Gets the value of the `A` button
  47121. */
  47122. get buttonA(): number;
  47123. /**
  47124. * Sets the value of the `A` button
  47125. */
  47126. set buttonA(value: number);
  47127. /**
  47128. * Gets the value of the `B` button
  47129. */
  47130. get buttonB(): number;
  47131. /**
  47132. * Sets the value of the `B` button
  47133. */
  47134. set buttonB(value: number);
  47135. /**
  47136. * Gets the value of the `X` button
  47137. */
  47138. get buttonX(): number;
  47139. /**
  47140. * Sets the value of the `X` button
  47141. */
  47142. set buttonX(value: number);
  47143. /**
  47144. * Gets the value of the `Y` button
  47145. */
  47146. get buttonY(): number;
  47147. /**
  47148. * Sets the value of the `Y` button
  47149. */
  47150. set buttonY(value: number);
  47151. /**
  47152. * Gets the value of the `Start` button
  47153. */
  47154. get buttonStart(): number;
  47155. /**
  47156. * Sets the value of the `Start` button
  47157. */
  47158. set buttonStart(value: number);
  47159. /**
  47160. * Gets the value of the `Back` button
  47161. */
  47162. get buttonBack(): number;
  47163. /**
  47164. * Sets the value of the `Back` button
  47165. */
  47166. set buttonBack(value: number);
  47167. /**
  47168. * Gets the value of the `Left` button
  47169. */
  47170. get buttonLB(): number;
  47171. /**
  47172. * Sets the value of the `Left` button
  47173. */
  47174. set buttonLB(value: number);
  47175. /**
  47176. * Gets the value of the `Right` button
  47177. */
  47178. get buttonRB(): number;
  47179. /**
  47180. * Sets the value of the `Right` button
  47181. */
  47182. set buttonRB(value: number);
  47183. /**
  47184. * Gets the value of the Left joystick
  47185. */
  47186. get buttonLeftStick(): number;
  47187. /**
  47188. * Sets the value of the Left joystick
  47189. */
  47190. set buttonLeftStick(value: number);
  47191. /**
  47192. * Gets the value of the Right joystick
  47193. */
  47194. get buttonRightStick(): number;
  47195. /**
  47196. * Sets the value of the Right joystick
  47197. */
  47198. set buttonRightStick(value: number);
  47199. /**
  47200. * Gets the value of D-pad up
  47201. */
  47202. get dPadUp(): number;
  47203. /**
  47204. * Sets the value of D-pad up
  47205. */
  47206. set dPadUp(value: number);
  47207. /**
  47208. * Gets the value of D-pad down
  47209. */
  47210. get dPadDown(): number;
  47211. /**
  47212. * Sets the value of D-pad down
  47213. */
  47214. set dPadDown(value: number);
  47215. /**
  47216. * Gets the value of D-pad left
  47217. */
  47218. get dPadLeft(): number;
  47219. /**
  47220. * Sets the value of D-pad left
  47221. */
  47222. set dPadLeft(value: number);
  47223. /**
  47224. * Gets the value of D-pad right
  47225. */
  47226. get dPadRight(): number;
  47227. /**
  47228. * Sets the value of D-pad right
  47229. */
  47230. set dPadRight(value: number);
  47231. /**
  47232. * Force the gamepad to synchronize with device values
  47233. */
  47234. update(): void;
  47235. /**
  47236. * Disposes the gamepad
  47237. */
  47238. dispose(): void;
  47239. }
  47240. }
  47241. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47242. import { Observable } from "babylonjs/Misc/observable";
  47243. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47244. /**
  47245. * Defines supported buttons for DualShock compatible gamepads
  47246. */
  47247. export enum DualShockButton {
  47248. /** Cross */
  47249. Cross = 0,
  47250. /** Circle */
  47251. Circle = 1,
  47252. /** Square */
  47253. Square = 2,
  47254. /** Triangle */
  47255. Triangle = 3,
  47256. /** L1 */
  47257. L1 = 4,
  47258. /** R1 */
  47259. R1 = 5,
  47260. /** Share */
  47261. Share = 8,
  47262. /** Options */
  47263. Options = 9,
  47264. /** Left stick */
  47265. LeftStick = 10,
  47266. /** Right stick */
  47267. RightStick = 11
  47268. }
  47269. /** Defines values for DualShock DPad */
  47270. export enum DualShockDpad {
  47271. /** Up */
  47272. Up = 12,
  47273. /** Down */
  47274. Down = 13,
  47275. /** Left */
  47276. Left = 14,
  47277. /** Right */
  47278. Right = 15
  47279. }
  47280. /**
  47281. * Defines a DualShock gamepad
  47282. */
  47283. export class DualShockPad extends Gamepad {
  47284. private _leftTrigger;
  47285. private _rightTrigger;
  47286. private _onlefttriggerchanged;
  47287. private _onrighttriggerchanged;
  47288. private _onbuttondown;
  47289. private _onbuttonup;
  47290. private _ondpaddown;
  47291. private _ondpadup;
  47292. /** Observable raised when a button is pressed */
  47293. onButtonDownObservable: Observable<DualShockButton>;
  47294. /** Observable raised when a button is released */
  47295. onButtonUpObservable: Observable<DualShockButton>;
  47296. /** Observable raised when a pad is pressed */
  47297. onPadDownObservable: Observable<DualShockDpad>;
  47298. /** Observable raised when a pad is released */
  47299. onPadUpObservable: Observable<DualShockDpad>;
  47300. private _buttonCross;
  47301. private _buttonCircle;
  47302. private _buttonSquare;
  47303. private _buttonTriangle;
  47304. private _buttonShare;
  47305. private _buttonOptions;
  47306. private _buttonL1;
  47307. private _buttonR1;
  47308. private _buttonLeftStick;
  47309. private _buttonRightStick;
  47310. private _dPadUp;
  47311. private _dPadDown;
  47312. private _dPadLeft;
  47313. private _dPadRight;
  47314. /**
  47315. * Creates a new DualShock gamepad object
  47316. * @param id defines the id of this gamepad
  47317. * @param index defines its index
  47318. * @param gamepad defines the internal HTML gamepad object
  47319. */
  47320. constructor(id: string, index: number, gamepad: any);
  47321. /**
  47322. * Defines the callback to call when left trigger is pressed
  47323. * @param callback defines the callback to use
  47324. */
  47325. onlefttriggerchanged(callback: (value: number) => void): void;
  47326. /**
  47327. * Defines the callback to call when right trigger is pressed
  47328. * @param callback defines the callback to use
  47329. */
  47330. onrighttriggerchanged(callback: (value: number) => void): void;
  47331. /**
  47332. * Gets the left trigger value
  47333. */
  47334. get leftTrigger(): number;
  47335. /**
  47336. * Sets the left trigger value
  47337. */
  47338. set leftTrigger(newValue: number);
  47339. /**
  47340. * Gets the right trigger value
  47341. */
  47342. get rightTrigger(): number;
  47343. /**
  47344. * Sets the right trigger value
  47345. */
  47346. set rightTrigger(newValue: number);
  47347. /**
  47348. * Defines the callback to call when a button is pressed
  47349. * @param callback defines the callback to use
  47350. */
  47351. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47352. /**
  47353. * Defines the callback to call when a button is released
  47354. * @param callback defines the callback to use
  47355. */
  47356. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47357. /**
  47358. * Defines the callback to call when a pad is pressed
  47359. * @param callback defines the callback to use
  47360. */
  47361. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47362. /**
  47363. * Defines the callback to call when a pad is released
  47364. * @param callback defines the callback to use
  47365. */
  47366. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47367. private _setButtonValue;
  47368. private _setDPadValue;
  47369. /**
  47370. * Gets the value of the `Cross` button
  47371. */
  47372. get buttonCross(): number;
  47373. /**
  47374. * Sets the value of the `Cross` button
  47375. */
  47376. set buttonCross(value: number);
  47377. /**
  47378. * Gets the value of the `Circle` button
  47379. */
  47380. get buttonCircle(): number;
  47381. /**
  47382. * Sets the value of the `Circle` button
  47383. */
  47384. set buttonCircle(value: number);
  47385. /**
  47386. * Gets the value of the `Square` button
  47387. */
  47388. get buttonSquare(): number;
  47389. /**
  47390. * Sets the value of the `Square` button
  47391. */
  47392. set buttonSquare(value: number);
  47393. /**
  47394. * Gets the value of the `Triangle` button
  47395. */
  47396. get buttonTriangle(): number;
  47397. /**
  47398. * Sets the value of the `Triangle` button
  47399. */
  47400. set buttonTriangle(value: number);
  47401. /**
  47402. * Gets the value of the `Options` button
  47403. */
  47404. get buttonOptions(): number;
  47405. /**
  47406. * Sets the value of the `Options` button
  47407. */
  47408. set buttonOptions(value: number);
  47409. /**
  47410. * Gets the value of the `Share` button
  47411. */
  47412. get buttonShare(): number;
  47413. /**
  47414. * Sets the value of the `Share` button
  47415. */
  47416. set buttonShare(value: number);
  47417. /**
  47418. * Gets the value of the `L1` button
  47419. */
  47420. get buttonL1(): number;
  47421. /**
  47422. * Sets the value of the `L1` button
  47423. */
  47424. set buttonL1(value: number);
  47425. /**
  47426. * Gets the value of the `R1` button
  47427. */
  47428. get buttonR1(): number;
  47429. /**
  47430. * Sets the value of the `R1` button
  47431. */
  47432. set buttonR1(value: number);
  47433. /**
  47434. * Gets the value of the Left joystick
  47435. */
  47436. get buttonLeftStick(): number;
  47437. /**
  47438. * Sets the value of the Left joystick
  47439. */
  47440. set buttonLeftStick(value: number);
  47441. /**
  47442. * Gets the value of the Right joystick
  47443. */
  47444. get buttonRightStick(): number;
  47445. /**
  47446. * Sets the value of the Right joystick
  47447. */
  47448. set buttonRightStick(value: number);
  47449. /**
  47450. * Gets the value of D-pad up
  47451. */
  47452. get dPadUp(): number;
  47453. /**
  47454. * Sets the value of D-pad up
  47455. */
  47456. set dPadUp(value: number);
  47457. /**
  47458. * Gets the value of D-pad down
  47459. */
  47460. get dPadDown(): number;
  47461. /**
  47462. * Sets the value of D-pad down
  47463. */
  47464. set dPadDown(value: number);
  47465. /**
  47466. * Gets the value of D-pad left
  47467. */
  47468. get dPadLeft(): number;
  47469. /**
  47470. * Sets the value of D-pad left
  47471. */
  47472. set dPadLeft(value: number);
  47473. /**
  47474. * Gets the value of D-pad right
  47475. */
  47476. get dPadRight(): number;
  47477. /**
  47478. * Sets the value of D-pad right
  47479. */
  47480. set dPadRight(value: number);
  47481. /**
  47482. * Force the gamepad to synchronize with device values
  47483. */
  47484. update(): void;
  47485. /**
  47486. * Disposes the gamepad
  47487. */
  47488. dispose(): void;
  47489. }
  47490. }
  47491. declare module "babylonjs/Gamepads/gamepadManager" {
  47492. import { Observable } from "babylonjs/Misc/observable";
  47493. import { Nullable } from "babylonjs/types";
  47494. import { Scene } from "babylonjs/scene";
  47495. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47496. /**
  47497. * Manager for handling gamepads
  47498. */
  47499. export class GamepadManager {
  47500. private _scene?;
  47501. private _babylonGamepads;
  47502. private _oneGamepadConnected;
  47503. /** @hidden */
  47504. _isMonitoring: boolean;
  47505. private _gamepadEventSupported;
  47506. private _gamepadSupport?;
  47507. /**
  47508. * observable to be triggered when the gamepad controller has been connected
  47509. */
  47510. onGamepadConnectedObservable: Observable<Gamepad>;
  47511. /**
  47512. * observable to be triggered when the gamepad controller has been disconnected
  47513. */
  47514. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47515. private _onGamepadConnectedEvent;
  47516. private _onGamepadDisconnectedEvent;
  47517. /**
  47518. * Initializes the gamepad manager
  47519. * @param _scene BabylonJS scene
  47520. */
  47521. constructor(_scene?: Scene | undefined);
  47522. /**
  47523. * The gamepads in the game pad manager
  47524. */
  47525. get gamepads(): Gamepad[];
  47526. /**
  47527. * Get the gamepad controllers based on type
  47528. * @param type The type of gamepad controller
  47529. * @returns Nullable gamepad
  47530. */
  47531. getGamepadByType(type?: number): Nullable<Gamepad>;
  47532. /**
  47533. * Disposes the gamepad manager
  47534. */
  47535. dispose(): void;
  47536. private _addNewGamepad;
  47537. private _startMonitoringGamepads;
  47538. private _stopMonitoringGamepads;
  47539. /** @hidden */
  47540. _checkGamepadsStatus(): void;
  47541. private _updateGamepadObjects;
  47542. }
  47543. }
  47544. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47545. import { Nullable } from "babylonjs/types";
  47546. import { Scene } from "babylonjs/scene";
  47547. import { ISceneComponent } from "babylonjs/sceneComponent";
  47548. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47549. module "babylonjs/scene" {
  47550. interface Scene {
  47551. /** @hidden */
  47552. _gamepadManager: Nullable<GamepadManager>;
  47553. /**
  47554. * Gets the gamepad manager associated with the scene
  47555. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47556. */
  47557. gamepadManager: GamepadManager;
  47558. }
  47559. }
  47560. module "babylonjs/Cameras/freeCameraInputsManager" {
  47561. /**
  47562. * Interface representing a free camera inputs manager
  47563. */
  47564. interface FreeCameraInputsManager {
  47565. /**
  47566. * Adds gamepad input support to the FreeCameraInputsManager.
  47567. * @returns the FreeCameraInputsManager
  47568. */
  47569. addGamepad(): FreeCameraInputsManager;
  47570. }
  47571. }
  47572. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47573. /**
  47574. * Interface representing an arc rotate camera inputs manager
  47575. */
  47576. interface ArcRotateCameraInputsManager {
  47577. /**
  47578. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47579. * @returns the camera inputs manager
  47580. */
  47581. addGamepad(): ArcRotateCameraInputsManager;
  47582. }
  47583. }
  47584. /**
  47585. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47586. */
  47587. export class GamepadSystemSceneComponent implements ISceneComponent {
  47588. /**
  47589. * The component name helpfull to identify the component in the list of scene components.
  47590. */
  47591. readonly name: string;
  47592. /**
  47593. * The scene the component belongs to.
  47594. */
  47595. scene: Scene;
  47596. /**
  47597. * Creates a new instance of the component for the given scene
  47598. * @param scene Defines the scene to register the component in
  47599. */
  47600. constructor(scene: Scene);
  47601. /**
  47602. * Registers the component in a given scene
  47603. */
  47604. register(): void;
  47605. /**
  47606. * Rebuilds the elements related to this component in case of
  47607. * context lost for instance.
  47608. */
  47609. rebuild(): void;
  47610. /**
  47611. * Disposes the component and the associated ressources
  47612. */
  47613. dispose(): void;
  47614. private _beforeCameraUpdate;
  47615. }
  47616. }
  47617. declare module "babylonjs/Cameras/universalCamera" {
  47618. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47619. import { Scene } from "babylonjs/scene";
  47620. import { Vector3 } from "babylonjs/Maths/math.vector";
  47621. import "babylonjs/Gamepads/gamepadSceneComponent";
  47622. /**
  47623. * 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,
  47624. * which still works and will still be found in many Playgrounds.
  47625. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47626. */
  47627. export class UniversalCamera extends TouchCamera {
  47628. /**
  47629. * Defines the gamepad rotation sensiblity.
  47630. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47631. */
  47632. get gamepadAngularSensibility(): number;
  47633. set gamepadAngularSensibility(value: number);
  47634. /**
  47635. * Defines the gamepad move sensiblity.
  47636. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47637. */
  47638. get gamepadMoveSensibility(): number;
  47639. set gamepadMoveSensibility(value: number);
  47640. /**
  47641. * 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,
  47642. * which still works and will still be found in many Playgrounds.
  47643. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47644. * @param name Define the name of the camera in the scene
  47645. * @param position Define the start position of the camera in the scene
  47646. * @param scene Define the scene the camera belongs to
  47647. */
  47648. constructor(name: string, position: Vector3, scene: Scene);
  47649. /**
  47650. * Gets the current object class name.
  47651. * @return the class name
  47652. */
  47653. getClassName(): string;
  47654. }
  47655. }
  47656. declare module "babylonjs/Cameras/gamepadCamera" {
  47657. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47658. import { Scene } from "babylonjs/scene";
  47659. import { Vector3 } from "babylonjs/Maths/math.vector";
  47660. /**
  47661. * This represents a FPS type of camera. This is only here for back compat purpose.
  47662. * Please use the UniversalCamera instead as both are identical.
  47663. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47664. */
  47665. export class GamepadCamera extends UniversalCamera {
  47666. /**
  47667. * Instantiates a new Gamepad Camera
  47668. * This represents a FPS type of camera. This is only here for back compat purpose.
  47669. * Please use the UniversalCamera instead as both are identical.
  47670. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47671. * @param name Define the name of the camera in the scene
  47672. * @param position Define the start position of the camera in the scene
  47673. * @param scene Define the scene the camera belongs to
  47674. */
  47675. constructor(name: string, position: Vector3, scene: Scene);
  47676. /**
  47677. * Gets the current object class name.
  47678. * @return the class name
  47679. */
  47680. getClassName(): string;
  47681. }
  47682. }
  47683. declare module "babylonjs/Shaders/pass.fragment" {
  47684. /** @hidden */
  47685. export var passPixelShader: {
  47686. name: string;
  47687. shader: string;
  47688. };
  47689. }
  47690. declare module "babylonjs/Shaders/passCube.fragment" {
  47691. /** @hidden */
  47692. export var passCubePixelShader: {
  47693. name: string;
  47694. shader: string;
  47695. };
  47696. }
  47697. declare module "babylonjs/PostProcesses/passPostProcess" {
  47698. import { Nullable } from "babylonjs/types";
  47699. import { Camera } from "babylonjs/Cameras/camera";
  47700. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47701. import { Engine } from "babylonjs/Engines/engine";
  47702. import "babylonjs/Shaders/pass.fragment";
  47703. import "babylonjs/Shaders/passCube.fragment";
  47704. import { Scene } from "babylonjs/scene";
  47705. /**
  47706. * PassPostProcess which produces an output the same as it's input
  47707. */
  47708. export class PassPostProcess extends PostProcess {
  47709. /**
  47710. * Gets a string identifying the name of the class
  47711. * @returns "PassPostProcess" string
  47712. */
  47713. getClassName(): string;
  47714. /**
  47715. * Creates the PassPostProcess
  47716. * @param name The name of the effect.
  47717. * @param options The required width/height ratio to downsize to before computing the render pass.
  47718. * @param camera The camera to apply the render pass to.
  47719. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47720. * @param engine The engine which the post process will be applied. (default: current engine)
  47721. * @param reusable If the post process can be reused on the same frame. (default: false)
  47722. * @param textureType The type of texture to be used when performing the post processing.
  47723. * @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)
  47724. */
  47725. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47726. /** @hidden */
  47727. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47728. }
  47729. /**
  47730. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47731. */
  47732. export class PassCubePostProcess extends PostProcess {
  47733. private _face;
  47734. /**
  47735. * Gets or sets the cube face to display.
  47736. * * 0 is +X
  47737. * * 1 is -X
  47738. * * 2 is +Y
  47739. * * 3 is -Y
  47740. * * 4 is +Z
  47741. * * 5 is -Z
  47742. */
  47743. get face(): number;
  47744. set face(value: number);
  47745. /**
  47746. * Gets a string identifying the name of the class
  47747. * @returns "PassCubePostProcess" string
  47748. */
  47749. getClassName(): string;
  47750. /**
  47751. * Creates the PassCubePostProcess
  47752. * @param name The name of the effect.
  47753. * @param options The required width/height ratio to downsize to before computing the render pass.
  47754. * @param camera The camera to apply the render pass to.
  47755. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47756. * @param engine The engine which the post process will be applied. (default: current engine)
  47757. * @param reusable If the post process can be reused on the same frame. (default: false)
  47758. * @param textureType The type of texture to be used when performing the post processing.
  47759. * @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)
  47760. */
  47761. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47762. /** @hidden */
  47763. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47764. }
  47765. }
  47766. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47767. /** @hidden */
  47768. export var anaglyphPixelShader: {
  47769. name: string;
  47770. shader: string;
  47771. };
  47772. }
  47773. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47774. import { Engine } from "babylonjs/Engines/engine";
  47775. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47776. import { Camera } from "babylonjs/Cameras/camera";
  47777. import "babylonjs/Shaders/anaglyph.fragment";
  47778. /**
  47779. * Postprocess used to generate anaglyphic rendering
  47780. */
  47781. export class AnaglyphPostProcess extends PostProcess {
  47782. private _passedProcess;
  47783. /**
  47784. * Gets a string identifying the name of the class
  47785. * @returns "AnaglyphPostProcess" string
  47786. */
  47787. getClassName(): string;
  47788. /**
  47789. * Creates a new AnaglyphPostProcess
  47790. * @param name defines postprocess name
  47791. * @param options defines creation options or target ratio scale
  47792. * @param rigCameras defines cameras using this postprocess
  47793. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47794. * @param engine defines hosting engine
  47795. * @param reusable defines if the postprocess will be reused multiple times per frame
  47796. */
  47797. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47798. }
  47799. }
  47800. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47801. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47802. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47803. import { Scene } from "babylonjs/scene";
  47804. import { Vector3 } from "babylonjs/Maths/math.vector";
  47805. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47806. /**
  47807. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47808. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47809. */
  47810. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47811. /**
  47812. * Creates a new AnaglyphArcRotateCamera
  47813. * @param name defines camera name
  47814. * @param alpha defines alpha angle (in radians)
  47815. * @param beta defines beta angle (in radians)
  47816. * @param radius defines radius
  47817. * @param target defines camera target
  47818. * @param interaxialDistance defines distance between each color axis
  47819. * @param scene defines the hosting scene
  47820. */
  47821. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47822. /**
  47823. * Gets camera class name
  47824. * @returns AnaglyphArcRotateCamera
  47825. */
  47826. getClassName(): string;
  47827. }
  47828. }
  47829. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47830. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47831. import { Scene } from "babylonjs/scene";
  47832. import { Vector3 } from "babylonjs/Maths/math.vector";
  47833. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47834. /**
  47835. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47836. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47837. */
  47838. export class AnaglyphFreeCamera extends FreeCamera {
  47839. /**
  47840. * Creates a new AnaglyphFreeCamera
  47841. * @param name defines camera name
  47842. * @param position defines initial position
  47843. * @param interaxialDistance defines distance between each color axis
  47844. * @param scene defines the hosting scene
  47845. */
  47846. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47847. /**
  47848. * Gets camera class name
  47849. * @returns AnaglyphFreeCamera
  47850. */
  47851. getClassName(): string;
  47852. }
  47853. }
  47854. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47855. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47856. import { Scene } from "babylonjs/scene";
  47857. import { Vector3 } from "babylonjs/Maths/math.vector";
  47858. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47859. /**
  47860. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47861. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47862. */
  47863. export class AnaglyphGamepadCamera extends GamepadCamera {
  47864. /**
  47865. * Creates a new AnaglyphGamepadCamera
  47866. * @param name defines camera name
  47867. * @param position defines initial position
  47868. * @param interaxialDistance defines distance between each color axis
  47869. * @param scene defines the hosting scene
  47870. */
  47871. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47872. /**
  47873. * Gets camera class name
  47874. * @returns AnaglyphGamepadCamera
  47875. */
  47876. getClassName(): string;
  47877. }
  47878. }
  47879. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47880. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47881. import { Scene } from "babylonjs/scene";
  47882. import { Vector3 } from "babylonjs/Maths/math.vector";
  47883. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47884. /**
  47885. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47886. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47887. */
  47888. export class AnaglyphUniversalCamera extends UniversalCamera {
  47889. /**
  47890. * Creates a new AnaglyphUniversalCamera
  47891. * @param name defines camera name
  47892. * @param position defines initial position
  47893. * @param interaxialDistance defines distance between each color axis
  47894. * @param scene defines the hosting scene
  47895. */
  47896. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47897. /**
  47898. * Gets camera class name
  47899. * @returns AnaglyphUniversalCamera
  47900. */
  47901. getClassName(): string;
  47902. }
  47903. }
  47904. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47905. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47906. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47907. import { Scene } from "babylonjs/scene";
  47908. import { Vector3 } from "babylonjs/Maths/math.vector";
  47909. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47910. /**
  47911. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47912. * @see https://doc.babylonjs.com/features/cameras
  47913. */
  47914. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47915. /**
  47916. * Creates a new StereoscopicArcRotateCamera
  47917. * @param name defines camera name
  47918. * @param alpha defines alpha angle (in radians)
  47919. * @param beta defines beta angle (in radians)
  47920. * @param radius defines radius
  47921. * @param target defines camera target
  47922. * @param interaxialDistance defines distance between each color axis
  47923. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47924. * @param scene defines the hosting scene
  47925. */
  47926. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47927. /**
  47928. * Gets camera class name
  47929. * @returns StereoscopicArcRotateCamera
  47930. */
  47931. getClassName(): string;
  47932. }
  47933. }
  47934. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47935. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47936. import { Scene } from "babylonjs/scene";
  47937. import { Vector3 } from "babylonjs/Maths/math.vector";
  47938. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47939. /**
  47940. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47941. * @see https://doc.babylonjs.com/features/cameras
  47942. */
  47943. export class StereoscopicFreeCamera extends FreeCamera {
  47944. /**
  47945. * Creates a new StereoscopicFreeCamera
  47946. * @param name defines camera name
  47947. * @param position defines initial position
  47948. * @param interaxialDistance defines distance between each color axis
  47949. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47950. * @param scene defines the hosting scene
  47951. */
  47952. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47953. /**
  47954. * Gets camera class name
  47955. * @returns StereoscopicFreeCamera
  47956. */
  47957. getClassName(): string;
  47958. }
  47959. }
  47960. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47961. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47962. import { Scene } from "babylonjs/scene";
  47963. import { Vector3 } from "babylonjs/Maths/math.vector";
  47964. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47965. /**
  47966. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47967. * @see https://doc.babylonjs.com/features/cameras
  47968. */
  47969. export class StereoscopicGamepadCamera extends GamepadCamera {
  47970. /**
  47971. * Creates a new StereoscopicGamepadCamera
  47972. * @param name defines camera name
  47973. * @param position defines initial position
  47974. * @param interaxialDistance defines distance between each color axis
  47975. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47976. * @param scene defines the hosting scene
  47977. */
  47978. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47979. /**
  47980. * Gets camera class name
  47981. * @returns StereoscopicGamepadCamera
  47982. */
  47983. getClassName(): string;
  47984. }
  47985. }
  47986. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47987. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47988. import { Scene } from "babylonjs/scene";
  47989. import { Vector3 } from "babylonjs/Maths/math.vector";
  47990. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47991. /**
  47992. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47993. * @see https://doc.babylonjs.com/features/cameras
  47994. */
  47995. export class StereoscopicUniversalCamera extends UniversalCamera {
  47996. /**
  47997. * Creates a new StereoscopicUniversalCamera
  47998. * @param name defines camera name
  47999. * @param position defines initial position
  48000. * @param interaxialDistance defines distance between each color axis
  48001. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48002. * @param scene defines the hosting scene
  48003. */
  48004. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48005. /**
  48006. * Gets camera class name
  48007. * @returns StereoscopicUniversalCamera
  48008. */
  48009. getClassName(): string;
  48010. }
  48011. }
  48012. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48013. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48014. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48015. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48016. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48017. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48018. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48019. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48020. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48021. }
  48022. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48023. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48024. import { Scene } from "babylonjs/scene";
  48025. import { Vector3 } from "babylonjs/Maths/math.vector";
  48026. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48027. /**
  48028. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48029. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48030. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48031. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48032. */
  48033. export class VirtualJoysticksCamera extends FreeCamera {
  48034. /**
  48035. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48036. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48037. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48038. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48039. * @param name Define the name of the camera in the scene
  48040. * @param position Define the start position of the camera in the scene
  48041. * @param scene Define the scene the camera belongs to
  48042. */
  48043. constructor(name: string, position: Vector3, scene: Scene);
  48044. /**
  48045. * Gets the current object class name.
  48046. * @return the class name
  48047. */
  48048. getClassName(): string;
  48049. }
  48050. }
  48051. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48052. import { Matrix } from "babylonjs/Maths/math.vector";
  48053. /**
  48054. * This represents all the required metrics to create a VR camera.
  48055. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48056. */
  48057. export class VRCameraMetrics {
  48058. /**
  48059. * Define the horizontal resolution off the screen.
  48060. */
  48061. hResolution: number;
  48062. /**
  48063. * Define the vertical resolution off the screen.
  48064. */
  48065. vResolution: number;
  48066. /**
  48067. * Define the horizontal screen size.
  48068. */
  48069. hScreenSize: number;
  48070. /**
  48071. * Define the vertical screen size.
  48072. */
  48073. vScreenSize: number;
  48074. /**
  48075. * Define the vertical screen center position.
  48076. */
  48077. vScreenCenter: number;
  48078. /**
  48079. * Define the distance of the eyes to the screen.
  48080. */
  48081. eyeToScreenDistance: number;
  48082. /**
  48083. * Define the distance between both lenses
  48084. */
  48085. lensSeparationDistance: number;
  48086. /**
  48087. * Define the distance between both viewer's eyes.
  48088. */
  48089. interpupillaryDistance: number;
  48090. /**
  48091. * Define the distortion factor of the VR postprocess.
  48092. * Please, touch with care.
  48093. */
  48094. distortionK: number[];
  48095. /**
  48096. * Define the chromatic aberration correction factors for the VR post process.
  48097. */
  48098. chromaAbCorrection: number[];
  48099. /**
  48100. * Define the scale factor of the post process.
  48101. * The smaller the better but the slower.
  48102. */
  48103. postProcessScaleFactor: number;
  48104. /**
  48105. * Define an offset for the lens center.
  48106. */
  48107. lensCenterOffset: number;
  48108. /**
  48109. * Define if the current vr camera should compensate the distortion of the lense or not.
  48110. */
  48111. compensateDistortion: boolean;
  48112. /**
  48113. * Defines if multiview should be enabled when rendering (Default: false)
  48114. */
  48115. multiviewEnabled: boolean;
  48116. /**
  48117. * Gets the rendering aspect ratio based on the provided resolutions.
  48118. */
  48119. get aspectRatio(): number;
  48120. /**
  48121. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48122. */
  48123. get aspectRatioFov(): number;
  48124. /**
  48125. * @hidden
  48126. */
  48127. get leftHMatrix(): Matrix;
  48128. /**
  48129. * @hidden
  48130. */
  48131. get rightHMatrix(): Matrix;
  48132. /**
  48133. * @hidden
  48134. */
  48135. get leftPreViewMatrix(): Matrix;
  48136. /**
  48137. * @hidden
  48138. */
  48139. get rightPreViewMatrix(): Matrix;
  48140. /**
  48141. * Get the default VRMetrics based on the most generic setup.
  48142. * @returns the default vr metrics
  48143. */
  48144. static GetDefault(): VRCameraMetrics;
  48145. }
  48146. }
  48147. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48148. /** @hidden */
  48149. export var vrDistortionCorrectionPixelShader: {
  48150. name: string;
  48151. shader: string;
  48152. };
  48153. }
  48154. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48155. import { Camera } from "babylonjs/Cameras/camera";
  48156. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48157. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48158. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48159. /**
  48160. * VRDistortionCorrectionPostProcess used for mobile VR
  48161. */
  48162. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48163. private _isRightEye;
  48164. private _distortionFactors;
  48165. private _postProcessScaleFactor;
  48166. private _lensCenterOffset;
  48167. private _scaleIn;
  48168. private _scaleFactor;
  48169. private _lensCenter;
  48170. /**
  48171. * Gets a string identifying the name of the class
  48172. * @returns "VRDistortionCorrectionPostProcess" string
  48173. */
  48174. getClassName(): string;
  48175. /**
  48176. * Initializes the VRDistortionCorrectionPostProcess
  48177. * @param name The name of the effect.
  48178. * @param camera The camera to apply the render pass to.
  48179. * @param isRightEye If this is for the right eye distortion
  48180. * @param vrMetrics All the required metrics for the VR camera
  48181. */
  48182. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48183. }
  48184. }
  48185. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48186. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48187. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48188. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48189. import { Scene } from "babylonjs/scene";
  48190. import { Vector3 } from "babylonjs/Maths/math.vector";
  48191. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48192. import "babylonjs/Cameras/RigModes/vrRigMode";
  48193. /**
  48194. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48195. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48196. */
  48197. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48198. /**
  48199. * Creates a new VRDeviceOrientationArcRotateCamera
  48200. * @param name defines camera name
  48201. * @param alpha defines the camera rotation along the logitudinal axis
  48202. * @param beta defines the camera rotation along the latitudinal axis
  48203. * @param radius defines the camera distance from its target
  48204. * @param target defines the camera target
  48205. * @param scene defines the scene the camera belongs to
  48206. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48207. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48208. */
  48209. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48210. /**
  48211. * Gets camera class name
  48212. * @returns VRDeviceOrientationArcRotateCamera
  48213. */
  48214. getClassName(): string;
  48215. }
  48216. }
  48217. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48218. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48219. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48220. import { Scene } from "babylonjs/scene";
  48221. import { Vector3 } from "babylonjs/Maths/math.vector";
  48222. import "babylonjs/Cameras/RigModes/vrRigMode";
  48223. /**
  48224. * Camera used to simulate VR rendering (based on FreeCamera)
  48225. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48226. */
  48227. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48228. /**
  48229. * Creates a new VRDeviceOrientationFreeCamera
  48230. * @param name defines camera name
  48231. * @param position defines the start position of the camera
  48232. * @param scene defines the scene the camera belongs to
  48233. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48234. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48235. */
  48236. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48237. /**
  48238. * Gets camera class name
  48239. * @returns VRDeviceOrientationFreeCamera
  48240. */
  48241. getClassName(): string;
  48242. }
  48243. }
  48244. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48245. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48246. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48247. import { Scene } from "babylonjs/scene";
  48248. import { Vector3 } from "babylonjs/Maths/math.vector";
  48249. import "babylonjs/Gamepads/gamepadSceneComponent";
  48250. /**
  48251. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48252. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48253. */
  48254. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48255. /**
  48256. * Creates a new VRDeviceOrientationGamepadCamera
  48257. * @param name defines camera name
  48258. * @param position defines the start position of the camera
  48259. * @param scene defines the scene the camera belongs to
  48260. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48261. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48262. */
  48263. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48264. /**
  48265. * Gets camera class name
  48266. * @returns VRDeviceOrientationGamepadCamera
  48267. */
  48268. getClassName(): string;
  48269. }
  48270. }
  48271. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48272. import { Scene } from "babylonjs/scene";
  48273. import { Texture } from "babylonjs/Materials/Textures/texture";
  48274. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48275. /**
  48276. * A class extending Texture allowing drawing on a texture
  48277. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48278. */
  48279. export class DynamicTexture extends Texture {
  48280. private _generateMipMaps;
  48281. private _canvas;
  48282. private _context;
  48283. /**
  48284. * Creates a DynamicTexture
  48285. * @param name defines the name of the texture
  48286. * @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
  48287. * @param scene defines the scene where you want the texture
  48288. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48289. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48290. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48291. */
  48292. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48293. /**
  48294. * Get the current class name of the texture useful for serialization or dynamic coding.
  48295. * @returns "DynamicTexture"
  48296. */
  48297. getClassName(): string;
  48298. /**
  48299. * Gets the current state of canRescale
  48300. */
  48301. get canRescale(): boolean;
  48302. private _recreate;
  48303. /**
  48304. * Scales the texture
  48305. * @param ratio the scale factor to apply to both width and height
  48306. */
  48307. scale(ratio: number): void;
  48308. /**
  48309. * Resizes the texture
  48310. * @param width the new width
  48311. * @param height the new height
  48312. */
  48313. scaleTo(width: number, height: number): void;
  48314. /**
  48315. * Gets the context of the canvas used by the texture
  48316. * @returns the canvas context of the dynamic texture
  48317. */
  48318. getContext(): CanvasRenderingContext2D;
  48319. /**
  48320. * Clears the texture
  48321. */
  48322. clear(): void;
  48323. /**
  48324. * Updates the texture
  48325. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48326. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48327. */
  48328. update(invertY?: boolean, premulAlpha?: boolean): void;
  48329. /**
  48330. * Draws text onto the texture
  48331. * @param text defines the text to be drawn
  48332. * @param x defines the placement of the text from the left
  48333. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48334. * @param font defines the font to be used with font-style, font-size, font-name
  48335. * @param color defines the color used for the text
  48336. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48337. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48338. * @param update defines whether texture is immediately update (default is true)
  48339. */
  48340. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48341. /**
  48342. * Clones the texture
  48343. * @returns the clone of the texture.
  48344. */
  48345. clone(): DynamicTexture;
  48346. /**
  48347. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48348. * @returns a serialized dynamic texture object
  48349. */
  48350. serialize(): any;
  48351. private _IsCanvasElement;
  48352. /** @hidden */
  48353. _rebuild(): void;
  48354. }
  48355. }
  48356. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48357. import { Scene } from "babylonjs/scene";
  48358. import { Color3 } from "babylonjs/Maths/math.color";
  48359. import { Mesh } from "babylonjs/Meshes/mesh";
  48360. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48361. import { Nullable } from "babylonjs/types";
  48362. /**
  48363. * Class containing static functions to help procedurally build meshes
  48364. */
  48365. export class GroundBuilder {
  48366. /**
  48367. * Creates a ground mesh
  48368. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48369. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48370. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48371. * @param name defines the name of the mesh
  48372. * @param options defines the options used to create the mesh
  48373. * @param scene defines the hosting scene
  48374. * @returns the ground mesh
  48375. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48376. */
  48377. static CreateGround(name: string, options: {
  48378. width?: number;
  48379. height?: number;
  48380. subdivisions?: number;
  48381. subdivisionsX?: number;
  48382. subdivisionsY?: number;
  48383. updatable?: boolean;
  48384. }, scene: any): Mesh;
  48385. /**
  48386. * Creates a tiled ground mesh
  48387. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48388. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48389. * * 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
  48390. * * 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
  48391. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48392. * @param name defines the name of the mesh
  48393. * @param options defines the options used to create the mesh
  48394. * @param scene defines the hosting scene
  48395. * @returns the tiled ground mesh
  48396. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48397. */
  48398. static CreateTiledGround(name: string, options: {
  48399. xmin: number;
  48400. zmin: number;
  48401. xmax: number;
  48402. zmax: number;
  48403. subdivisions?: {
  48404. w: number;
  48405. h: number;
  48406. };
  48407. precision?: {
  48408. w: number;
  48409. h: number;
  48410. };
  48411. updatable?: boolean;
  48412. }, scene?: Nullable<Scene>): Mesh;
  48413. /**
  48414. * Creates a ground mesh from a height map
  48415. * * The parameter `url` sets the URL of the height map image resource.
  48416. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48417. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48418. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48419. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48420. * * 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.
  48421. * * 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).
  48422. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48423. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48424. * @param name defines the name of the mesh
  48425. * @param url defines the url to the height map
  48426. * @param options defines the options used to create the mesh
  48427. * @param scene defines the hosting scene
  48428. * @returns the ground mesh
  48429. * @see https://doc.babylonjs.com/babylon101/height_map
  48430. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48431. */
  48432. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48433. width?: number;
  48434. height?: number;
  48435. subdivisions?: number;
  48436. minHeight?: number;
  48437. maxHeight?: number;
  48438. colorFilter?: Color3;
  48439. alphaFilter?: number;
  48440. updatable?: boolean;
  48441. onReady?: (mesh: GroundMesh) => void;
  48442. }, scene?: Nullable<Scene>): GroundMesh;
  48443. }
  48444. }
  48445. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48446. import { Vector4 } from "babylonjs/Maths/math.vector";
  48447. import { Mesh } from "babylonjs/Meshes/mesh";
  48448. /**
  48449. * Class containing static functions to help procedurally build meshes
  48450. */
  48451. export class TorusBuilder {
  48452. /**
  48453. * Creates a torus mesh
  48454. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48455. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48456. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48457. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48458. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48459. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48460. * @param name defines the name of the mesh
  48461. * @param options defines the options used to create the mesh
  48462. * @param scene defines the hosting scene
  48463. * @returns the torus mesh
  48464. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48465. */
  48466. static CreateTorus(name: string, options: {
  48467. diameter?: number;
  48468. thickness?: number;
  48469. tessellation?: number;
  48470. updatable?: boolean;
  48471. sideOrientation?: number;
  48472. frontUVs?: Vector4;
  48473. backUVs?: Vector4;
  48474. }, scene: any): Mesh;
  48475. }
  48476. }
  48477. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48478. import { Vector4 } from "babylonjs/Maths/math.vector";
  48479. import { Color4 } from "babylonjs/Maths/math.color";
  48480. import { Mesh } from "babylonjs/Meshes/mesh";
  48481. /**
  48482. * Class containing static functions to help procedurally build meshes
  48483. */
  48484. export class CylinderBuilder {
  48485. /**
  48486. * Creates a cylinder or a cone mesh
  48487. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48488. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48489. * * 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.
  48490. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48491. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48492. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48493. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48494. * * 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).
  48495. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48496. * * 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).
  48497. * * 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
  48498. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48499. * * 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
  48500. * * 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.
  48501. * * If `enclose` is false, a ring surface is one element.
  48502. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48503. * * 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
  48504. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48505. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48506. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48507. * @param name defines the name of the mesh
  48508. * @param options defines the options used to create the mesh
  48509. * @param scene defines the hosting scene
  48510. * @returns the cylinder mesh
  48511. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48512. */
  48513. static CreateCylinder(name: string, options: {
  48514. height?: number;
  48515. diameterTop?: number;
  48516. diameterBottom?: number;
  48517. diameter?: number;
  48518. tessellation?: number;
  48519. subdivisions?: number;
  48520. arc?: number;
  48521. faceColors?: Color4[];
  48522. faceUV?: Vector4[];
  48523. updatable?: boolean;
  48524. hasRings?: boolean;
  48525. enclose?: boolean;
  48526. cap?: number;
  48527. sideOrientation?: number;
  48528. frontUVs?: Vector4;
  48529. backUVs?: Vector4;
  48530. }, scene: any): Mesh;
  48531. }
  48532. }
  48533. declare module "babylonjs/XR/webXRTypes" {
  48534. import { Nullable } from "babylonjs/types";
  48535. import { IDisposable } from "babylonjs/scene";
  48536. /**
  48537. * States of the webXR experience
  48538. */
  48539. export enum WebXRState {
  48540. /**
  48541. * Transitioning to being in XR mode
  48542. */
  48543. ENTERING_XR = 0,
  48544. /**
  48545. * Transitioning to non XR mode
  48546. */
  48547. EXITING_XR = 1,
  48548. /**
  48549. * In XR mode and presenting
  48550. */
  48551. IN_XR = 2,
  48552. /**
  48553. * Not entered XR mode
  48554. */
  48555. NOT_IN_XR = 3
  48556. }
  48557. /**
  48558. * Abstraction of the XR render target
  48559. */
  48560. export interface WebXRRenderTarget extends IDisposable {
  48561. /**
  48562. * xrpresent context of the canvas which can be used to display/mirror xr content
  48563. */
  48564. canvasContext: WebGLRenderingContext;
  48565. /**
  48566. * xr layer for the canvas
  48567. */
  48568. xrLayer: Nullable<XRWebGLLayer>;
  48569. /**
  48570. * Initializes the xr layer for the session
  48571. * @param xrSession xr session
  48572. * @returns a promise that will resolve once the XR Layer has been created
  48573. */
  48574. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48575. }
  48576. }
  48577. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48578. import { Nullable } from "babylonjs/types";
  48579. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48580. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48581. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48582. import { Observable } from "babylonjs/Misc/observable";
  48583. /**
  48584. * COnfiguration object for WebXR output canvas
  48585. */
  48586. export class WebXRManagedOutputCanvasOptions {
  48587. /**
  48588. * An optional canvas in case you wish to create it yourself and provide it here.
  48589. * If not provided, a new canvas will be created
  48590. */
  48591. canvasElement?: HTMLCanvasElement;
  48592. /**
  48593. * Options for this XR Layer output
  48594. */
  48595. canvasOptions?: XRWebGLLayerOptions;
  48596. /**
  48597. * CSS styling for a newly created canvas (if not provided)
  48598. */
  48599. newCanvasCssStyle?: string;
  48600. /**
  48601. * Get the default values of the configuration object
  48602. * @param engine defines the engine to use (can be null)
  48603. * @returns default values of this configuration object
  48604. */
  48605. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48606. }
  48607. /**
  48608. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48609. */
  48610. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48611. private _options;
  48612. private _canvas;
  48613. private _engine;
  48614. private _originalCanvasSize;
  48615. /**
  48616. * Rendering context of the canvas which can be used to display/mirror xr content
  48617. */
  48618. canvasContext: WebGLRenderingContext;
  48619. /**
  48620. * xr layer for the canvas
  48621. */
  48622. xrLayer: Nullable<XRWebGLLayer>;
  48623. /**
  48624. * Obseervers registered here will be triggered when the xr layer was initialized
  48625. */
  48626. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48627. /**
  48628. * Initializes the canvas to be added/removed upon entering/exiting xr
  48629. * @param _xrSessionManager The XR Session manager
  48630. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48631. */
  48632. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48633. /**
  48634. * Disposes of the object
  48635. */
  48636. dispose(): void;
  48637. /**
  48638. * Initializes the xr layer for the session
  48639. * @param xrSession xr session
  48640. * @returns a promise that will resolve once the XR Layer has been created
  48641. */
  48642. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48643. private _addCanvas;
  48644. private _removeCanvas;
  48645. private _setCanvasSize;
  48646. private _setManagedOutputCanvas;
  48647. }
  48648. }
  48649. declare module "babylonjs/XR/webXRSessionManager" {
  48650. import { Observable } from "babylonjs/Misc/observable";
  48651. import { Nullable } from "babylonjs/types";
  48652. import { IDisposable, Scene } from "babylonjs/scene";
  48653. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48654. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48655. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48656. /**
  48657. * Manages an XRSession to work with Babylon's engine
  48658. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48659. */
  48660. export class WebXRSessionManager implements IDisposable {
  48661. /** The scene which the session should be created for */
  48662. scene: Scene;
  48663. private _referenceSpace;
  48664. private _rttProvider;
  48665. private _sessionEnded;
  48666. private _xrNavigator;
  48667. private baseLayer;
  48668. /**
  48669. * The base reference space from which the session started. good if you want to reset your
  48670. * reference space
  48671. */
  48672. baseReferenceSpace: XRReferenceSpace;
  48673. /**
  48674. * Current XR frame
  48675. */
  48676. currentFrame: Nullable<XRFrame>;
  48677. /** WebXR timestamp updated every frame */
  48678. currentTimestamp: number;
  48679. /**
  48680. * Used just in case of a failure to initialize an immersive session.
  48681. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48682. */
  48683. defaultHeightCompensation: number;
  48684. /**
  48685. * Fires every time a new xrFrame arrives which can be used to update the camera
  48686. */
  48687. onXRFrameObservable: Observable<XRFrame>;
  48688. /**
  48689. * Fires when the reference space changed
  48690. */
  48691. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48692. /**
  48693. * Fires when the xr session is ended either by the device or manually done
  48694. */
  48695. onXRSessionEnded: Observable<any>;
  48696. /**
  48697. * Fires when the xr session is ended either by the device or manually done
  48698. */
  48699. onXRSessionInit: Observable<XRSession>;
  48700. /**
  48701. * Underlying xr session
  48702. */
  48703. session: XRSession;
  48704. /**
  48705. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48706. * or get the offset the player is currently at.
  48707. */
  48708. viewerReferenceSpace: XRReferenceSpace;
  48709. /**
  48710. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48711. * @param scene The scene which the session should be created for
  48712. */
  48713. constructor(
  48714. /** The scene which the session should be created for */
  48715. scene: Scene);
  48716. /**
  48717. * The current reference space used in this session. This reference space can constantly change!
  48718. * It is mainly used to offset the camera's position.
  48719. */
  48720. get referenceSpace(): XRReferenceSpace;
  48721. /**
  48722. * Set a new reference space and triggers the observable
  48723. */
  48724. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48725. /**
  48726. * Disposes of the session manager
  48727. */
  48728. dispose(): void;
  48729. /**
  48730. * Stops the xrSession and restores the render loop
  48731. * @returns Promise which resolves after it exits XR
  48732. */
  48733. exitXRAsync(): Promise<void>;
  48734. /**
  48735. * Gets the correct render target texture to be rendered this frame for this eye
  48736. * @param eye the eye for which to get the render target
  48737. * @returns the render target for the specified eye
  48738. */
  48739. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48740. /**
  48741. * Creates a WebXRRenderTarget object for the XR session
  48742. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48743. * @param options optional options to provide when creating a new render target
  48744. * @returns a WebXR render target to which the session can render
  48745. */
  48746. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48747. /**
  48748. * Initializes the manager
  48749. * After initialization enterXR can be called to start an XR session
  48750. * @returns Promise which resolves after it is initialized
  48751. */
  48752. initializeAsync(): Promise<void>;
  48753. /**
  48754. * Initializes an xr session
  48755. * @param xrSessionMode mode to initialize
  48756. * @param xrSessionInit defines optional and required values to pass to the session builder
  48757. * @returns a promise which will resolve once the session has been initialized
  48758. */
  48759. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48760. /**
  48761. * Checks if a session would be supported for the creation options specified
  48762. * @param sessionMode session mode to check if supported eg. immersive-vr
  48763. * @returns A Promise that resolves to true if supported and false if not
  48764. */
  48765. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48766. /**
  48767. * Resets the reference space to the one started the session
  48768. */
  48769. resetReferenceSpace(): void;
  48770. /**
  48771. * Starts rendering to the xr layer
  48772. */
  48773. runXRRenderLoop(): void;
  48774. /**
  48775. * Sets the reference space on the xr session
  48776. * @param referenceSpaceType space to set
  48777. * @returns a promise that will resolve once the reference space has been set
  48778. */
  48779. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48780. /**
  48781. * Updates the render state of the session
  48782. * @param state state to set
  48783. * @returns a promise that resolves once the render state has been updated
  48784. */
  48785. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48786. /**
  48787. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48788. * @param sessionMode defines the session to test
  48789. * @returns a promise with boolean as final value
  48790. */
  48791. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48792. private _createRenderTargetTexture;
  48793. }
  48794. }
  48795. declare module "babylonjs/XR/webXRCamera" {
  48796. import { Vector3 } from "babylonjs/Maths/math.vector";
  48797. import { Scene } from "babylonjs/scene";
  48798. import { Camera } from "babylonjs/Cameras/camera";
  48799. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48800. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48801. import { Observable } from "babylonjs/Misc/observable";
  48802. /**
  48803. * WebXR Camera which holds the views for the xrSession
  48804. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48805. */
  48806. export class WebXRCamera extends FreeCamera {
  48807. private _xrSessionManager;
  48808. private _firstFrame;
  48809. private _referenceQuaternion;
  48810. private _referencedPosition;
  48811. private _xrInvPositionCache;
  48812. private _xrInvQuaternionCache;
  48813. /**
  48814. * Observable raised before camera teleportation
  48815. */
  48816. onBeforeCameraTeleport: Observable<Vector3>;
  48817. /**
  48818. * Observable raised after camera teleportation
  48819. */
  48820. onAfterCameraTeleport: Observable<Vector3>;
  48821. /**
  48822. * Should position compensation execute on first frame.
  48823. * This is used when copying the position from a native (non XR) camera
  48824. */
  48825. compensateOnFirstFrame: boolean;
  48826. /**
  48827. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48828. * @param name the name of the camera
  48829. * @param scene the scene to add the camera to
  48830. * @param _xrSessionManager a constructed xr session manager
  48831. */
  48832. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48833. /**
  48834. * Return the user's height, unrelated to the current ground.
  48835. * This will be the y position of this camera, when ground level is 0.
  48836. */
  48837. get realWorldHeight(): number;
  48838. /** @hidden */
  48839. _updateForDualEyeDebugging(): void;
  48840. /**
  48841. * Sets this camera's transformation based on a non-vr camera
  48842. * @param otherCamera the non-vr camera to copy the transformation from
  48843. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48844. */
  48845. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48846. /**
  48847. * Gets the current instance class name ("WebXRCamera").
  48848. * @returns the class name
  48849. */
  48850. getClassName(): string;
  48851. private _rotate180;
  48852. private _updateFromXRSession;
  48853. private _updateNumberOfRigCameras;
  48854. private _updateReferenceSpace;
  48855. private _updateReferenceSpaceOffset;
  48856. }
  48857. }
  48858. declare module "babylonjs/XR/webXRFeaturesManager" {
  48859. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48860. import { IDisposable } from "babylonjs/scene";
  48861. /**
  48862. * Defining the interface required for a (webxr) feature
  48863. */
  48864. export interface IWebXRFeature extends IDisposable {
  48865. /**
  48866. * Is this feature attached
  48867. */
  48868. attached: boolean;
  48869. /**
  48870. * Should auto-attach be disabled?
  48871. */
  48872. disableAutoAttach: boolean;
  48873. /**
  48874. * Attach the feature to the session
  48875. * Will usually be called by the features manager
  48876. *
  48877. * @param force should attachment be forced (even when already attached)
  48878. * @returns true if successful.
  48879. */
  48880. attach(force?: boolean): boolean;
  48881. /**
  48882. * Detach the feature from the session
  48883. * Will usually be called by the features manager
  48884. *
  48885. * @returns true if successful.
  48886. */
  48887. detach(): boolean;
  48888. /**
  48889. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48890. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48891. *
  48892. * @returns whether or not the feature is compatible in this environment
  48893. */
  48894. isCompatible(): boolean;
  48895. /**
  48896. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48897. */
  48898. xrNativeFeatureName?: string;
  48899. /**
  48900. * A list of (Babylon WebXR) features this feature depends on
  48901. */
  48902. dependsOn?: string[];
  48903. }
  48904. /**
  48905. * A list of the currently available features without referencing them
  48906. */
  48907. export class WebXRFeatureName {
  48908. /**
  48909. * The name of the anchor system feature
  48910. */
  48911. static readonly ANCHOR_SYSTEM: string;
  48912. /**
  48913. * The name of the background remover feature
  48914. */
  48915. static readonly BACKGROUND_REMOVER: string;
  48916. /**
  48917. * The name of the hit test feature
  48918. */
  48919. static readonly HIT_TEST: string;
  48920. /**
  48921. * physics impostors for xr controllers feature
  48922. */
  48923. static readonly PHYSICS_CONTROLLERS: string;
  48924. /**
  48925. * The name of the plane detection feature
  48926. */
  48927. static readonly PLANE_DETECTION: string;
  48928. /**
  48929. * The name of the pointer selection feature
  48930. */
  48931. static readonly POINTER_SELECTION: string;
  48932. /**
  48933. * The name of the teleportation feature
  48934. */
  48935. static readonly TELEPORTATION: string;
  48936. /**
  48937. * The name of the feature points feature.
  48938. */
  48939. static readonly FEATURE_POINTS: string;
  48940. /**
  48941. * The name of the hand tracking feature.
  48942. */
  48943. static readonly HAND_TRACKING: string;
  48944. }
  48945. /**
  48946. * Defining the constructor of a feature. Used to register the modules.
  48947. */
  48948. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48949. /**
  48950. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48951. * It is mainly used in AR sessions.
  48952. *
  48953. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48954. */
  48955. export class WebXRFeaturesManager implements IDisposable {
  48956. private _xrSessionManager;
  48957. private static readonly _AvailableFeatures;
  48958. private _features;
  48959. /**
  48960. * constructs a new features manages.
  48961. *
  48962. * @param _xrSessionManager an instance of WebXRSessionManager
  48963. */
  48964. constructor(_xrSessionManager: WebXRSessionManager);
  48965. /**
  48966. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48967. * Mainly used internally.
  48968. *
  48969. * @param featureName the name of the feature to register
  48970. * @param constructorFunction the function used to construct the module
  48971. * @param version the (babylon) version of the module
  48972. * @param stable is that a stable version of this module
  48973. */
  48974. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48975. /**
  48976. * Returns a constructor of a specific feature.
  48977. *
  48978. * @param featureName the name of the feature to construct
  48979. * @param version the version of the feature to load
  48980. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48981. * @param options optional options provided to the module.
  48982. * @returns a function that, when called, will return a new instance of this feature
  48983. */
  48984. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48985. /**
  48986. * Can be used to return the list of features currently registered
  48987. *
  48988. * @returns an Array of available features
  48989. */
  48990. static GetAvailableFeatures(): string[];
  48991. /**
  48992. * Gets the versions available for a specific feature
  48993. * @param featureName the name of the feature
  48994. * @returns an array with the available versions
  48995. */
  48996. static GetAvailableVersions(featureName: string): string[];
  48997. /**
  48998. * Return the latest unstable version of this feature
  48999. * @param featureName the name of the feature to search
  49000. * @returns the version number. if not found will return -1
  49001. */
  49002. static GetLatestVersionOfFeature(featureName: string): number;
  49003. /**
  49004. * Return the latest stable version of this feature
  49005. * @param featureName the name of the feature to search
  49006. * @returns the version number. if not found will return -1
  49007. */
  49008. static GetStableVersionOfFeature(featureName: string): number;
  49009. /**
  49010. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49011. * Can be used during a session to start a feature
  49012. * @param featureName the name of feature to attach
  49013. */
  49014. attachFeature(featureName: string): void;
  49015. /**
  49016. * Can be used inside a session or when the session ends to detach a specific feature
  49017. * @param featureName the name of the feature to detach
  49018. */
  49019. detachFeature(featureName: string): void;
  49020. /**
  49021. * Used to disable an already-enabled feature
  49022. * The feature will be disposed and will be recreated once enabled.
  49023. * @param featureName the feature to disable
  49024. * @returns true if disable was successful
  49025. */
  49026. disableFeature(featureName: string | {
  49027. Name: string;
  49028. }): boolean;
  49029. /**
  49030. * dispose this features manager
  49031. */
  49032. dispose(): void;
  49033. /**
  49034. * 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.
  49035. * 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.
  49036. *
  49037. * @param featureName the name of the feature to load or the class of the feature
  49038. * @param version optional version to load. if not provided the latest version will be enabled
  49039. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49040. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49041. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49042. * @returns a new constructed feature or throws an error if feature not found.
  49043. */
  49044. enableFeature(featureName: string | {
  49045. Name: string;
  49046. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49047. /**
  49048. * get the implementation of an enabled feature.
  49049. * @param featureName the name of the feature to load
  49050. * @returns the feature class, if found
  49051. */
  49052. getEnabledFeature(featureName: string): IWebXRFeature;
  49053. /**
  49054. * Get the list of enabled features
  49055. * @returns an array of enabled features
  49056. */
  49057. getEnabledFeatures(): string[];
  49058. /**
  49059. * This function will exten the session creation configuration object with enabled features.
  49060. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49061. * according to the defined "required" variable, provided during enableFeature call
  49062. * @param xrSessionInit the xr Session init object to extend
  49063. *
  49064. * @returns an extended XRSessionInit object
  49065. */
  49066. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49067. }
  49068. }
  49069. declare module "babylonjs/XR/webXRExperienceHelper" {
  49070. import { Observable } from "babylonjs/Misc/observable";
  49071. import { IDisposable, Scene } from "babylonjs/scene";
  49072. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49073. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49074. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49075. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49076. /**
  49077. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49078. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49079. */
  49080. export class WebXRExperienceHelper implements IDisposable {
  49081. private scene;
  49082. private _nonVRCamera;
  49083. private _originalSceneAutoClear;
  49084. private _supported;
  49085. /**
  49086. * Camera used to render xr content
  49087. */
  49088. camera: WebXRCamera;
  49089. /** A features manager for this xr session */
  49090. featuresManager: WebXRFeaturesManager;
  49091. /**
  49092. * Observers registered here will be triggered after the camera's initial transformation is set
  49093. * This can be used to set a different ground level or an extra rotation.
  49094. *
  49095. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49096. * to the position set after this observable is done executing.
  49097. */
  49098. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49099. /**
  49100. * Fires when the state of the experience helper has changed
  49101. */
  49102. onStateChangedObservable: Observable<WebXRState>;
  49103. /** Session manager used to keep track of xr session */
  49104. sessionManager: WebXRSessionManager;
  49105. /**
  49106. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49107. */
  49108. state: WebXRState;
  49109. /**
  49110. * Creates a WebXRExperienceHelper
  49111. * @param scene The scene the helper should be created in
  49112. */
  49113. private constructor();
  49114. /**
  49115. * Creates the experience helper
  49116. * @param scene the scene to attach the experience helper to
  49117. * @returns a promise for the experience helper
  49118. */
  49119. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49120. /**
  49121. * Disposes of the experience helper
  49122. */
  49123. dispose(): void;
  49124. /**
  49125. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49126. * @param sessionMode options for the XR session
  49127. * @param referenceSpaceType frame of reference of the XR session
  49128. * @param renderTarget the output canvas that will be used to enter XR mode
  49129. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49130. * @returns promise that resolves after xr mode has entered
  49131. */
  49132. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49133. /**
  49134. * Exits XR mode and returns the scene to its original state
  49135. * @returns promise that resolves after xr mode has exited
  49136. */
  49137. exitXRAsync(): Promise<void>;
  49138. private _nonXRToXRCamera;
  49139. private _setState;
  49140. }
  49141. }
  49142. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49143. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49144. import { Observable } from "babylonjs/Misc/observable";
  49145. import { IDisposable } from "babylonjs/scene";
  49146. /**
  49147. * X-Y values for axes in WebXR
  49148. */
  49149. export interface IWebXRMotionControllerAxesValue {
  49150. /**
  49151. * The value of the x axis
  49152. */
  49153. x: number;
  49154. /**
  49155. * The value of the y-axis
  49156. */
  49157. y: number;
  49158. }
  49159. /**
  49160. * changed / previous values for the values of this component
  49161. */
  49162. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49163. /**
  49164. * current (this frame) value
  49165. */
  49166. current: T;
  49167. /**
  49168. * previous (last change) value
  49169. */
  49170. previous: T;
  49171. }
  49172. /**
  49173. * Represents changes in the component between current frame and last values recorded
  49174. */
  49175. export interface IWebXRMotionControllerComponentChanges {
  49176. /**
  49177. * will be populated with previous and current values if axes changed
  49178. */
  49179. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49180. /**
  49181. * will be populated with previous and current values if pressed changed
  49182. */
  49183. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49184. /**
  49185. * will be populated with previous and current values if touched changed
  49186. */
  49187. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49188. /**
  49189. * will be populated with previous and current values if value changed
  49190. */
  49191. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49192. }
  49193. /**
  49194. * This class represents a single component (for example button or thumbstick) of a motion controller
  49195. */
  49196. export class WebXRControllerComponent implements IDisposable {
  49197. /**
  49198. * the id of this component
  49199. */
  49200. id: string;
  49201. /**
  49202. * the type of the component
  49203. */
  49204. type: MotionControllerComponentType;
  49205. private _buttonIndex;
  49206. private _axesIndices;
  49207. private _axes;
  49208. private _changes;
  49209. private _currentValue;
  49210. private _hasChanges;
  49211. private _pressed;
  49212. private _touched;
  49213. /**
  49214. * button component type
  49215. */
  49216. static BUTTON_TYPE: MotionControllerComponentType;
  49217. /**
  49218. * squeeze component type
  49219. */
  49220. static SQUEEZE_TYPE: MotionControllerComponentType;
  49221. /**
  49222. * Thumbstick component type
  49223. */
  49224. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49225. /**
  49226. * Touchpad component type
  49227. */
  49228. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49229. /**
  49230. * trigger component type
  49231. */
  49232. static TRIGGER_TYPE: MotionControllerComponentType;
  49233. /**
  49234. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49235. * the axes data changes
  49236. */
  49237. onAxisValueChangedObservable: Observable<{
  49238. x: number;
  49239. y: number;
  49240. }>;
  49241. /**
  49242. * Observers registered here will be triggered when the state of a button changes
  49243. * State change is either pressed / touched / value
  49244. */
  49245. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49246. /**
  49247. * Creates a new component for a motion controller.
  49248. * It is created by the motion controller itself
  49249. *
  49250. * @param id the id of this component
  49251. * @param type the type of the component
  49252. * @param _buttonIndex index in the buttons array of the gamepad
  49253. * @param _axesIndices indices of the values in the axes array of the gamepad
  49254. */
  49255. constructor(
  49256. /**
  49257. * the id of this component
  49258. */
  49259. id: string,
  49260. /**
  49261. * the type of the component
  49262. */
  49263. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49264. /**
  49265. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49266. */
  49267. get axes(): IWebXRMotionControllerAxesValue;
  49268. /**
  49269. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49270. */
  49271. get changes(): IWebXRMotionControllerComponentChanges;
  49272. /**
  49273. * Return whether or not the component changed the last frame
  49274. */
  49275. get hasChanges(): boolean;
  49276. /**
  49277. * is the button currently pressed
  49278. */
  49279. get pressed(): boolean;
  49280. /**
  49281. * is the button currently touched
  49282. */
  49283. get touched(): boolean;
  49284. /**
  49285. * Get the current value of this component
  49286. */
  49287. get value(): number;
  49288. /**
  49289. * Dispose this component
  49290. */
  49291. dispose(): void;
  49292. /**
  49293. * Are there axes correlating to this component
  49294. * @return true is axes data is available
  49295. */
  49296. isAxes(): boolean;
  49297. /**
  49298. * Is this component a button (hence - pressable)
  49299. * @returns true if can be pressed
  49300. */
  49301. isButton(): boolean;
  49302. /**
  49303. * update this component using the gamepad object it is in. Called on every frame
  49304. * @param nativeController the native gamepad controller object
  49305. */
  49306. update(nativeController: IMinimalMotionControllerObject): void;
  49307. }
  49308. }
  49309. declare module "babylonjs/Loading/sceneLoader" {
  49310. import { Observable } from "babylonjs/Misc/observable";
  49311. import { Nullable } from "babylonjs/types";
  49312. import { Scene } from "babylonjs/scene";
  49313. import { Engine } from "babylonjs/Engines/engine";
  49314. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49315. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49316. import { AssetContainer } from "babylonjs/assetContainer";
  49317. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49318. import { Skeleton } from "babylonjs/Bones/skeleton";
  49319. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49320. import { WebRequest } from "babylonjs/Misc/webRequest";
  49321. /**
  49322. * Interface used to represent data loading progression
  49323. */
  49324. export interface ISceneLoaderProgressEvent {
  49325. /**
  49326. * Defines if data length to load can be evaluated
  49327. */
  49328. readonly lengthComputable: boolean;
  49329. /**
  49330. * Defines the loaded data length
  49331. */
  49332. readonly loaded: number;
  49333. /**
  49334. * Defines the data length to load
  49335. */
  49336. readonly total: number;
  49337. }
  49338. /**
  49339. * Interface used by SceneLoader plugins to define supported file extensions
  49340. */
  49341. export interface ISceneLoaderPluginExtensions {
  49342. /**
  49343. * Defines the list of supported extensions
  49344. */
  49345. [extension: string]: {
  49346. isBinary: boolean;
  49347. };
  49348. }
  49349. /**
  49350. * Interface used by SceneLoader plugin factory
  49351. */
  49352. export interface ISceneLoaderPluginFactory {
  49353. /**
  49354. * Defines the name of the factory
  49355. */
  49356. name: string;
  49357. /**
  49358. * Function called to create a new plugin
  49359. * @return the new plugin
  49360. */
  49361. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49362. /**
  49363. * The callback that returns true if the data can be directly loaded.
  49364. * @param data string containing the file data
  49365. * @returns if the data can be loaded directly
  49366. */
  49367. canDirectLoad?(data: string): boolean;
  49368. }
  49369. /**
  49370. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49371. */
  49372. export interface ISceneLoaderPluginBase {
  49373. /**
  49374. * The friendly name of this plugin.
  49375. */
  49376. name: string;
  49377. /**
  49378. * The file extensions supported by this plugin.
  49379. */
  49380. extensions: string | ISceneLoaderPluginExtensions;
  49381. /**
  49382. * The callback called when loading from a url.
  49383. * @param scene scene loading this url
  49384. * @param url url to load
  49385. * @param onSuccess callback called when the file successfully loads
  49386. * @param onProgress callback called while file is loading (if the server supports this mode)
  49387. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49388. * @param onError callback called when the file fails to load
  49389. * @returns a file request object
  49390. */
  49391. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49392. /**
  49393. * The callback called when loading from a file object.
  49394. * @param scene scene loading this file
  49395. * @param file defines the file to load
  49396. * @param onSuccess defines the callback to call when data is loaded
  49397. * @param onProgress defines the callback to call during loading process
  49398. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49399. * @param onError defines the callback to call when an error occurs
  49400. * @returns a file request object
  49401. */
  49402. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49403. /**
  49404. * The callback that returns true if the data can be directly loaded.
  49405. * @param data string containing the file data
  49406. * @returns if the data can be loaded directly
  49407. */
  49408. canDirectLoad?(data: string): boolean;
  49409. /**
  49410. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49411. * @param scene scene loading this data
  49412. * @param data string containing the data
  49413. * @returns data to pass to the plugin
  49414. */
  49415. directLoad?(scene: Scene, data: string): any;
  49416. /**
  49417. * The callback that allows custom handling of the root url based on the response url.
  49418. * @param rootUrl the original root url
  49419. * @param responseURL the response url if available
  49420. * @returns the new root url
  49421. */
  49422. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49423. }
  49424. /**
  49425. * Interface used to define a SceneLoader plugin
  49426. */
  49427. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49428. /**
  49429. * Import meshes into a scene.
  49430. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49431. * @param scene The scene to import into
  49432. * @param data The data to import
  49433. * @param rootUrl The root url for scene and resources
  49434. * @param meshes The meshes array to import into
  49435. * @param particleSystems The particle systems array to import into
  49436. * @param skeletons The skeletons array to import into
  49437. * @param onError The callback when import fails
  49438. * @returns True if successful or false otherwise
  49439. */
  49440. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49441. /**
  49442. * Load into a scene.
  49443. * @param scene The scene to load into
  49444. * @param data The data to import
  49445. * @param rootUrl The root url for scene and resources
  49446. * @param onError The callback when import fails
  49447. * @returns True if successful or false otherwise
  49448. */
  49449. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49450. /**
  49451. * Load into an asset container.
  49452. * @param scene The scene to load into
  49453. * @param data The data to import
  49454. * @param rootUrl The root url for scene and resources
  49455. * @param onError The callback when import fails
  49456. * @returns The loaded asset container
  49457. */
  49458. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49459. }
  49460. /**
  49461. * Interface used to define an async SceneLoader plugin
  49462. */
  49463. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49464. /**
  49465. * Import meshes into a scene.
  49466. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49467. * @param scene The scene to import into
  49468. * @param data The data to import
  49469. * @param rootUrl The root url for scene and resources
  49470. * @param onProgress The callback when the load progresses
  49471. * @param fileName Defines the name of the file to load
  49472. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49473. */
  49474. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49475. meshes: AbstractMesh[];
  49476. particleSystems: IParticleSystem[];
  49477. skeletons: Skeleton[];
  49478. animationGroups: AnimationGroup[];
  49479. }>;
  49480. /**
  49481. * Load into a scene.
  49482. * @param scene The scene to load into
  49483. * @param data The data to import
  49484. * @param rootUrl The root url for scene and resources
  49485. * @param onProgress The callback when the load progresses
  49486. * @param fileName Defines the name of the file to load
  49487. * @returns Nothing
  49488. */
  49489. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49490. /**
  49491. * Load into an asset container.
  49492. * @param scene The scene to load into
  49493. * @param data The data to import
  49494. * @param rootUrl The root url for scene and resources
  49495. * @param onProgress The callback when the load progresses
  49496. * @param fileName Defines the name of the file to load
  49497. * @returns The loaded asset container
  49498. */
  49499. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49500. }
  49501. /**
  49502. * Mode that determines how to handle old animation groups before loading new ones.
  49503. */
  49504. export enum SceneLoaderAnimationGroupLoadingMode {
  49505. /**
  49506. * Reset all old animations to initial state then dispose them.
  49507. */
  49508. Clean = 0,
  49509. /**
  49510. * Stop all old animations.
  49511. */
  49512. Stop = 1,
  49513. /**
  49514. * Restart old animations from first frame.
  49515. */
  49516. Sync = 2,
  49517. /**
  49518. * Old animations remains untouched.
  49519. */
  49520. NoSync = 3
  49521. }
  49522. /**
  49523. * Defines a plugin registered by the SceneLoader
  49524. */
  49525. interface IRegisteredPlugin {
  49526. /**
  49527. * Defines the plugin to use
  49528. */
  49529. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49530. /**
  49531. * Defines if the plugin supports binary data
  49532. */
  49533. isBinary: boolean;
  49534. }
  49535. /**
  49536. * Class used to load scene from various file formats using registered plugins
  49537. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49538. */
  49539. export class SceneLoader {
  49540. /**
  49541. * No logging while loading
  49542. */
  49543. static readonly NO_LOGGING: number;
  49544. /**
  49545. * Minimal logging while loading
  49546. */
  49547. static readonly MINIMAL_LOGGING: number;
  49548. /**
  49549. * Summary logging while loading
  49550. */
  49551. static readonly SUMMARY_LOGGING: number;
  49552. /**
  49553. * Detailled logging while loading
  49554. */
  49555. static readonly DETAILED_LOGGING: number;
  49556. /**
  49557. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49558. */
  49559. static get ForceFullSceneLoadingForIncremental(): boolean;
  49560. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49561. /**
  49562. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49563. */
  49564. static get ShowLoadingScreen(): boolean;
  49565. static set ShowLoadingScreen(value: boolean);
  49566. /**
  49567. * Defines the current logging level (while loading the scene)
  49568. * @ignorenaming
  49569. */
  49570. static get loggingLevel(): number;
  49571. static set loggingLevel(value: number);
  49572. /**
  49573. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49574. */
  49575. static get CleanBoneMatrixWeights(): boolean;
  49576. static set CleanBoneMatrixWeights(value: boolean);
  49577. /**
  49578. * Event raised when a plugin is used to load a scene
  49579. */
  49580. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49581. private static _registeredPlugins;
  49582. private static _showingLoadingScreen;
  49583. /**
  49584. * Gets the default plugin (used to load Babylon files)
  49585. * @returns the .babylon plugin
  49586. */
  49587. static GetDefaultPlugin(): IRegisteredPlugin;
  49588. private static _GetPluginForExtension;
  49589. private static _GetPluginForDirectLoad;
  49590. private static _GetPluginForFilename;
  49591. private static _GetDirectLoad;
  49592. private static _LoadData;
  49593. private static _GetFileInfo;
  49594. /**
  49595. * Gets a plugin that can load the given extension
  49596. * @param extension defines the extension to load
  49597. * @returns a plugin or null if none works
  49598. */
  49599. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49600. /**
  49601. * Gets a boolean indicating that the given extension can be loaded
  49602. * @param extension defines the extension to load
  49603. * @returns true if the extension is supported
  49604. */
  49605. static IsPluginForExtensionAvailable(extension: string): boolean;
  49606. /**
  49607. * Adds a new plugin to the list of registered plugins
  49608. * @param plugin defines the plugin to add
  49609. */
  49610. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49611. /**
  49612. * Import meshes into a scene
  49613. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49614. * @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)
  49615. * @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)
  49616. * @param scene the instance of BABYLON.Scene to append to
  49617. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49618. * @param onProgress a callback with a progress event for each file being loaded
  49619. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49620. * @param pluginExtension the extension used to determine the plugin
  49621. * @returns The loaded plugin
  49622. */
  49623. 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>;
  49624. /**
  49625. * Import meshes into a scene
  49626. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49627. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  49628. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  49629. * @param scene the instance of BABYLON.Scene to append to
  49630. * @param onProgress a callback with a progress event for each file being loaded
  49631. * @param pluginExtension the extension used to determine the plugin
  49632. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49633. */
  49634. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49635. meshes: AbstractMesh[];
  49636. particleSystems: IParticleSystem[];
  49637. skeletons: Skeleton[];
  49638. animationGroups: AnimationGroup[];
  49639. }>;
  49640. /**
  49641. * Load a scene
  49642. * @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)
  49643. * @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)
  49644. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49645. * @param onSuccess a callback with the scene when import succeeds
  49646. * @param onProgress a callback with a progress event for each file being loaded
  49647. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49648. * @param pluginExtension the extension used to determine the plugin
  49649. * @returns The loaded plugin
  49650. */
  49651. 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>;
  49652. /**
  49653. * Load a scene
  49654. * @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)
  49655. * @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)
  49656. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49657. * @param onProgress a callback with a progress event for each file being loaded
  49658. * @param pluginExtension the extension used to determine the plugin
  49659. * @returns The loaded scene
  49660. */
  49661. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49662. /**
  49663. * Append a scene
  49664. * @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)
  49665. * @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)
  49666. * @param scene is the instance of BABYLON.Scene to append to
  49667. * @param onSuccess a callback with the scene when import succeeds
  49668. * @param onProgress a callback with a progress event for each file being loaded
  49669. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49670. * @param pluginExtension the extension used to determine the plugin
  49671. * @returns The loaded plugin
  49672. */
  49673. 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>;
  49674. /**
  49675. * Append a scene
  49676. * @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)
  49677. * @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)
  49678. * @param scene is the instance of BABYLON.Scene to append to
  49679. * @param onProgress a callback with a progress event for each file being loaded
  49680. * @param pluginExtension the extension used to determine the plugin
  49681. * @returns The given scene
  49682. */
  49683. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49684. /**
  49685. * Load a scene into an asset container
  49686. * @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)
  49687. * @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)
  49688. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49689. * @param onSuccess a callback with the scene when import succeeds
  49690. * @param onProgress a callback with a progress event for each file being loaded
  49691. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49692. * @param pluginExtension the extension used to determine the plugin
  49693. * @returns The loaded plugin
  49694. */
  49695. 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>;
  49696. /**
  49697. * Load a scene into an asset container
  49698. * @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)
  49699. * @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)
  49700. * @param scene is the instance of Scene to append to
  49701. * @param onProgress a callback with a progress event for each file being loaded
  49702. * @param pluginExtension the extension used to determine the plugin
  49703. * @returns The loaded asset container
  49704. */
  49705. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49706. /**
  49707. * Import animations from a file into a scene
  49708. * @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)
  49709. * @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)
  49710. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49711. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49712. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49713. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49714. * @param onSuccess a callback with the scene when import succeeds
  49715. * @param onProgress a callback with a progress event for each file being loaded
  49716. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49717. * @param pluginExtension the extension used to determine the plugin
  49718. */
  49719. 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;
  49720. /**
  49721. * Import animations from a file into a scene
  49722. * @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)
  49723. * @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)
  49724. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49725. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49726. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49727. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49728. * @param onSuccess a callback with the scene when import succeeds
  49729. * @param onProgress a callback with a progress event for each file being loaded
  49730. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49731. * @param pluginExtension the extension used to determine the plugin
  49732. * @returns the updated scene with imported animations
  49733. */
  49734. 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>;
  49735. }
  49736. }
  49737. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49738. import { IDisposable, Scene } from "babylonjs/scene";
  49739. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49740. import { Observable } from "babylonjs/Misc/observable";
  49741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49742. import { Nullable } from "babylonjs/types";
  49743. /**
  49744. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49745. */
  49746. export type MotionControllerHandedness = "none" | "left" | "right";
  49747. /**
  49748. * The type of components available in motion controllers.
  49749. * This is not the name of the component.
  49750. */
  49751. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49752. /**
  49753. * The state of a controller component
  49754. */
  49755. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49756. /**
  49757. * The schema of motion controller layout.
  49758. * No object will be initialized using this interface
  49759. * This is used just to define the profile.
  49760. */
  49761. export interface IMotionControllerLayout {
  49762. /**
  49763. * Path to load the assets. Usually relative to the base path
  49764. */
  49765. assetPath: string;
  49766. /**
  49767. * Available components (unsorted)
  49768. */
  49769. components: {
  49770. /**
  49771. * A map of component Ids
  49772. */
  49773. [componentId: string]: {
  49774. /**
  49775. * The type of input the component outputs
  49776. */
  49777. type: MotionControllerComponentType;
  49778. /**
  49779. * The indices of this component in the gamepad object
  49780. */
  49781. gamepadIndices: {
  49782. /**
  49783. * Index of button
  49784. */
  49785. button?: number;
  49786. /**
  49787. * If available, index of x-axis
  49788. */
  49789. xAxis?: number;
  49790. /**
  49791. * If available, index of y-axis
  49792. */
  49793. yAxis?: number;
  49794. };
  49795. /**
  49796. * The mesh's root node name
  49797. */
  49798. rootNodeName: string;
  49799. /**
  49800. * Animation definitions for this model
  49801. */
  49802. visualResponses: {
  49803. [stateKey: string]: {
  49804. /**
  49805. * What property will be animated
  49806. */
  49807. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49808. /**
  49809. * What states influence this visual response
  49810. */
  49811. states: MotionControllerComponentStateType[];
  49812. /**
  49813. * Type of animation - movement or visibility
  49814. */
  49815. valueNodeProperty: "transform" | "visibility";
  49816. /**
  49817. * Base node name to move. Its position will be calculated according to the min and max nodes
  49818. */
  49819. valueNodeName?: string;
  49820. /**
  49821. * Minimum movement node
  49822. */
  49823. minNodeName?: string;
  49824. /**
  49825. * Max movement node
  49826. */
  49827. maxNodeName?: string;
  49828. };
  49829. };
  49830. /**
  49831. * If touch enabled, what is the name of node to display user feedback
  49832. */
  49833. touchPointNodeName?: string;
  49834. };
  49835. };
  49836. /**
  49837. * Is it xr standard mapping or not
  49838. */
  49839. gamepadMapping: "" | "xr-standard";
  49840. /**
  49841. * Base root node of this entire model
  49842. */
  49843. rootNodeName: string;
  49844. /**
  49845. * Defines the main button component id
  49846. */
  49847. selectComponentId: string;
  49848. }
  49849. /**
  49850. * A definition for the layout map in the input profile
  49851. */
  49852. export interface IMotionControllerLayoutMap {
  49853. /**
  49854. * Layouts with handedness type as a key
  49855. */
  49856. [handedness: string]: IMotionControllerLayout;
  49857. }
  49858. /**
  49859. * The XR Input profile schema
  49860. * Profiles can be found here:
  49861. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49862. */
  49863. export interface IMotionControllerProfile {
  49864. /**
  49865. * fallback profiles for this profileId
  49866. */
  49867. fallbackProfileIds: string[];
  49868. /**
  49869. * The layout map, with handedness as key
  49870. */
  49871. layouts: IMotionControllerLayoutMap;
  49872. /**
  49873. * The id of this profile
  49874. * correlates to the profile(s) in the xrInput.profiles array
  49875. */
  49876. profileId: string;
  49877. }
  49878. /**
  49879. * A helper-interface for the 3 meshes needed for controller button animation
  49880. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49881. */
  49882. export interface IMotionControllerButtonMeshMap {
  49883. /**
  49884. * the mesh that defines the pressed value mesh position.
  49885. * This is used to find the max-position of this button
  49886. */
  49887. pressedMesh: AbstractMesh;
  49888. /**
  49889. * the mesh that defines the unpressed value mesh position.
  49890. * This is used to find the min (or initial) position of this button
  49891. */
  49892. unpressedMesh: AbstractMesh;
  49893. /**
  49894. * The mesh that will be changed when value changes
  49895. */
  49896. valueMesh: AbstractMesh;
  49897. }
  49898. /**
  49899. * A helper-interface for the 3 meshes needed for controller axis animation.
  49900. * This will be expanded when touchpad animations are fully supported
  49901. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49902. */
  49903. export interface IMotionControllerMeshMap {
  49904. /**
  49905. * the mesh that defines the maximum value mesh position.
  49906. */
  49907. maxMesh?: AbstractMesh;
  49908. /**
  49909. * the mesh that defines the minimum value mesh position.
  49910. */
  49911. minMesh?: AbstractMesh;
  49912. /**
  49913. * The mesh that will be changed when axis value changes
  49914. */
  49915. valueMesh?: AbstractMesh;
  49916. }
  49917. /**
  49918. * The elements needed for change-detection of the gamepad objects in motion controllers
  49919. */
  49920. export interface IMinimalMotionControllerObject {
  49921. /**
  49922. * Available axes of this controller
  49923. */
  49924. axes: number[];
  49925. /**
  49926. * An array of available buttons
  49927. */
  49928. buttons: Array<{
  49929. /**
  49930. * Value of the button/trigger
  49931. */
  49932. value: number;
  49933. /**
  49934. * If the button/trigger is currently touched
  49935. */
  49936. touched: boolean;
  49937. /**
  49938. * If the button/trigger is currently pressed
  49939. */
  49940. pressed: boolean;
  49941. }>;
  49942. /**
  49943. * EXPERIMENTAL haptic support.
  49944. */
  49945. hapticActuators?: Array<{
  49946. pulse: (value: number, duration: number) => Promise<boolean>;
  49947. }>;
  49948. }
  49949. /**
  49950. * An Abstract Motion controller
  49951. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49952. * Each component has an observable to check for changes in value and state
  49953. */
  49954. export abstract class WebXRAbstractMotionController implements IDisposable {
  49955. protected scene: Scene;
  49956. protected layout: IMotionControllerLayout;
  49957. /**
  49958. * The gamepad object correlating to this controller
  49959. */
  49960. gamepadObject: IMinimalMotionControllerObject;
  49961. /**
  49962. * handedness (left/right/none) of this controller
  49963. */
  49964. handedness: MotionControllerHandedness;
  49965. private _initComponent;
  49966. private _modelReady;
  49967. /**
  49968. * A map of components (WebXRControllerComponent) in this motion controller
  49969. * Components have a ComponentType and can also have both button and axis definitions
  49970. */
  49971. readonly components: {
  49972. [id: string]: WebXRControllerComponent;
  49973. };
  49974. /**
  49975. * Disable the model's animation. Can be set at any time.
  49976. */
  49977. disableAnimation: boolean;
  49978. /**
  49979. * Observers registered here will be triggered when the model of this controller is done loading
  49980. */
  49981. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49982. /**
  49983. * The profile id of this motion controller
  49984. */
  49985. abstract profileId: string;
  49986. /**
  49987. * The root mesh of the model. It is null if the model was not yet initialized
  49988. */
  49989. rootMesh: Nullable<AbstractMesh>;
  49990. /**
  49991. * constructs a new abstract motion controller
  49992. * @param scene the scene to which the model of the controller will be added
  49993. * @param layout The profile layout to load
  49994. * @param gamepadObject The gamepad object correlating to this controller
  49995. * @param handedness handedness (left/right/none) of this controller
  49996. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49997. */
  49998. constructor(scene: Scene, layout: IMotionControllerLayout,
  49999. /**
  50000. * The gamepad object correlating to this controller
  50001. */
  50002. gamepadObject: IMinimalMotionControllerObject,
  50003. /**
  50004. * handedness (left/right/none) of this controller
  50005. */
  50006. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  50007. /**
  50008. * Dispose this controller, the model mesh and all its components
  50009. */
  50010. dispose(): void;
  50011. /**
  50012. * Returns all components of specific type
  50013. * @param type the type to search for
  50014. * @return an array of components with this type
  50015. */
  50016. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50017. /**
  50018. * get a component based an its component id as defined in layout.components
  50019. * @param id the id of the component
  50020. * @returns the component correlates to the id or undefined if not found
  50021. */
  50022. getComponent(id: string): WebXRControllerComponent;
  50023. /**
  50024. * Get the list of components available in this motion controller
  50025. * @returns an array of strings correlating to available components
  50026. */
  50027. getComponentIds(): string[];
  50028. /**
  50029. * Get the first component of specific type
  50030. * @param type type of component to find
  50031. * @return a controller component or null if not found
  50032. */
  50033. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50034. /**
  50035. * Get the main (Select) component of this controller as defined in the layout
  50036. * @returns the main component of this controller
  50037. */
  50038. getMainComponent(): WebXRControllerComponent;
  50039. /**
  50040. * Loads the model correlating to this controller
  50041. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50042. * @returns A promise fulfilled with the result of the model loading
  50043. */
  50044. loadModel(): Promise<boolean>;
  50045. /**
  50046. * Update this model using the current XRFrame
  50047. * @param xrFrame the current xr frame to use and update the model
  50048. */
  50049. updateFromXRFrame(xrFrame: XRFrame): void;
  50050. /**
  50051. * Backwards compatibility due to a deeply-integrated typo
  50052. */
  50053. get handness(): XREye;
  50054. /**
  50055. * Pulse (vibrate) this controller
  50056. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50057. * Consecutive calls to this function will cancel the last pulse call
  50058. *
  50059. * @param value the strength of the pulse in 0.0...1.0 range
  50060. * @param duration Duration of the pulse in milliseconds
  50061. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50062. * @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
  50063. */
  50064. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50065. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50066. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50067. /**
  50068. * Moves the axis on the controller mesh based on its current state
  50069. * @param axis the index of the axis
  50070. * @param axisValue the value of the axis which determines the meshes new position
  50071. * @hidden
  50072. */
  50073. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50074. /**
  50075. * Update the model itself with the current frame data
  50076. * @param xrFrame the frame to use for updating the model mesh
  50077. */
  50078. protected updateModel(xrFrame: XRFrame): void;
  50079. /**
  50080. * Get the filename and path for this controller's model
  50081. * @returns a map of filename and path
  50082. */
  50083. protected abstract _getFilenameAndPath(): {
  50084. filename: string;
  50085. path: string;
  50086. };
  50087. /**
  50088. * This function is called before the mesh is loaded. It checks for loading constraints.
  50089. * For example, this function can check if the GLB loader is available
  50090. * If this function returns false, the generic controller will be loaded instead
  50091. * @returns Is the client ready to load the mesh
  50092. */
  50093. protected abstract _getModelLoadingConstraints(): boolean;
  50094. /**
  50095. * This function will be called after the model was successfully loaded and can be used
  50096. * for mesh transformations before it is available for the user
  50097. * @param meshes the loaded meshes
  50098. */
  50099. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50100. /**
  50101. * Set the root mesh for this controller. Important for the WebXR controller class
  50102. * @param meshes the loaded meshes
  50103. */
  50104. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50105. /**
  50106. * A function executed each frame that updates the mesh (if needed)
  50107. * @param xrFrame the current xrFrame
  50108. */
  50109. protected abstract _updateModel(xrFrame: XRFrame): void;
  50110. private _getGenericFilenameAndPath;
  50111. private _getGenericParentMesh;
  50112. }
  50113. }
  50114. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50115. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50116. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50117. import { Scene } from "babylonjs/scene";
  50118. /**
  50119. * A generic trigger-only motion controller for WebXR
  50120. */
  50121. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50122. /**
  50123. * Static version of the profile id of this controller
  50124. */
  50125. static ProfileId: string;
  50126. profileId: string;
  50127. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50128. protected _getFilenameAndPath(): {
  50129. filename: string;
  50130. path: string;
  50131. };
  50132. protected _getModelLoadingConstraints(): boolean;
  50133. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50134. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50135. protected _updateModel(): void;
  50136. }
  50137. }
  50138. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50139. import { Vector4 } from "babylonjs/Maths/math.vector";
  50140. import { Mesh } from "babylonjs/Meshes/mesh";
  50141. import { Scene } from "babylonjs/scene";
  50142. import { Nullable } from "babylonjs/types";
  50143. /**
  50144. * Class containing static functions to help procedurally build meshes
  50145. */
  50146. export class SphereBuilder {
  50147. /**
  50148. * Creates a sphere mesh
  50149. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50150. * * 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`)
  50151. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50152. * * 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
  50153. * * 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)
  50154. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50155. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50156. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50157. * @param name defines the name of the mesh
  50158. * @param options defines the options used to create the mesh
  50159. * @param scene defines the hosting scene
  50160. * @returns the sphere mesh
  50161. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50162. */
  50163. static CreateSphere(name: string, options: {
  50164. segments?: number;
  50165. diameter?: number;
  50166. diameterX?: number;
  50167. diameterY?: number;
  50168. diameterZ?: number;
  50169. arc?: number;
  50170. slice?: number;
  50171. sideOrientation?: number;
  50172. frontUVs?: Vector4;
  50173. backUVs?: Vector4;
  50174. updatable?: boolean;
  50175. }, scene?: Nullable<Scene>): Mesh;
  50176. }
  50177. }
  50178. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50179. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50180. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50181. import { Scene } from "babylonjs/scene";
  50182. /**
  50183. * A profiled motion controller has its profile loaded from an online repository.
  50184. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50185. */
  50186. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50187. private _repositoryUrl;
  50188. private _buttonMeshMapping;
  50189. private _touchDots;
  50190. /**
  50191. * The profile ID of this controller. Will be populated when the controller initializes.
  50192. */
  50193. profileId: string;
  50194. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50195. dispose(): void;
  50196. protected _getFilenameAndPath(): {
  50197. filename: string;
  50198. path: string;
  50199. };
  50200. protected _getModelLoadingConstraints(): boolean;
  50201. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50202. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50203. protected _updateModel(_xrFrame: XRFrame): void;
  50204. }
  50205. }
  50206. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50207. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50208. import { Scene } from "babylonjs/scene";
  50209. /**
  50210. * A construction function type to create a new controller based on an xrInput object
  50211. */
  50212. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50213. /**
  50214. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50215. *
  50216. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50217. * it should be replaced with auto-loaded controllers.
  50218. *
  50219. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50220. */
  50221. export class WebXRMotionControllerManager {
  50222. private static _AvailableControllers;
  50223. private static _Fallbacks;
  50224. private static _ProfileLoadingPromises;
  50225. private static _ProfilesList;
  50226. /**
  50227. * The base URL of the online controller repository. Can be changed at any time.
  50228. */
  50229. static BaseRepositoryUrl: string;
  50230. /**
  50231. * Which repository gets priority - local or online
  50232. */
  50233. static PrioritizeOnlineRepository: boolean;
  50234. /**
  50235. * Use the online repository, or use only locally-defined controllers
  50236. */
  50237. static UseOnlineRepository: boolean;
  50238. /**
  50239. * Clear the cache used for profile loading and reload when requested again
  50240. */
  50241. static ClearProfilesCache(): void;
  50242. /**
  50243. * Register the default fallbacks.
  50244. * This function is called automatically when this file is imported.
  50245. */
  50246. static DefaultFallbacks(): void;
  50247. /**
  50248. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50249. * @param profileId the profile to which a fallback needs to be found
  50250. * @return an array with corresponding fallback profiles
  50251. */
  50252. static FindFallbackWithProfileId(profileId: string): string[];
  50253. /**
  50254. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50255. * The order of search:
  50256. *
  50257. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50258. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50259. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50260. * 4) return the generic trigger controller if none were found
  50261. *
  50262. * @param xrInput the xrInput to which a new controller is initialized
  50263. * @param scene the scene to which the model will be added
  50264. * @param forceProfile force a certain profile for this controller
  50265. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50266. */
  50267. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50268. /**
  50269. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50270. *
  50271. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50272. *
  50273. * @param type the profile type to register
  50274. * @param constructFunction the function to be called when loading this profile
  50275. */
  50276. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50277. /**
  50278. * Register a fallback to a specific profile.
  50279. * @param profileId the profileId that will receive the fallbacks
  50280. * @param fallbacks A list of fallback profiles
  50281. */
  50282. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50283. /**
  50284. * Will update the list of profiles available in the repository
  50285. * @return a promise that resolves to a map of profiles available online
  50286. */
  50287. static UpdateProfilesList(): Promise<{
  50288. [profile: string]: string;
  50289. }>;
  50290. private static _LoadProfileFromRepository;
  50291. private static _LoadProfilesFromAvailableControllers;
  50292. }
  50293. }
  50294. declare module "babylonjs/XR/webXRInputSource" {
  50295. import { Observable } from "babylonjs/Misc/observable";
  50296. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50297. import { Ray } from "babylonjs/Culling/ray";
  50298. import { Scene } from "babylonjs/scene";
  50299. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50300. /**
  50301. * Configuration options for the WebXR controller creation
  50302. */
  50303. export interface IWebXRControllerOptions {
  50304. /**
  50305. * Should the controller mesh be animated when a user interacts with it
  50306. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50307. */
  50308. disableMotionControllerAnimation?: boolean;
  50309. /**
  50310. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50311. */
  50312. doNotLoadControllerMesh?: boolean;
  50313. /**
  50314. * Force a specific controller type for this controller.
  50315. * This can be used when creating your own profile or when testing different controllers
  50316. */
  50317. forceControllerProfile?: string;
  50318. /**
  50319. * Defines a rendering group ID for meshes that will be loaded.
  50320. * This is for the default controllers only.
  50321. */
  50322. renderingGroupId?: number;
  50323. }
  50324. /**
  50325. * Represents an XR controller
  50326. */
  50327. export class WebXRInputSource {
  50328. private _scene;
  50329. /** The underlying input source for the controller */
  50330. inputSource: XRInputSource;
  50331. private _options;
  50332. private _tmpVector;
  50333. private _uniqueId;
  50334. private _disposed;
  50335. /**
  50336. * 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
  50337. */
  50338. grip?: AbstractMesh;
  50339. /**
  50340. * If available, this is the gamepad object related to this controller.
  50341. * Using this object it is possible to get click events and trackpad changes of the
  50342. * webxr controller that is currently being used.
  50343. */
  50344. motionController?: WebXRAbstractMotionController;
  50345. /**
  50346. * Event that fires when the controller is removed/disposed.
  50347. * The object provided as event data is this controller, after associated assets were disposed.
  50348. * uniqueId is still available.
  50349. */
  50350. onDisposeObservable: Observable<WebXRInputSource>;
  50351. /**
  50352. * Will be triggered when the mesh associated with the motion controller is done loading.
  50353. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50354. * A shortened version of controller -> motion controller -> on mesh loaded.
  50355. */
  50356. onMeshLoadedObservable: Observable<AbstractMesh>;
  50357. /**
  50358. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50359. */
  50360. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50361. /**
  50362. * Pointer which can be used to select objects or attach a visible laser to
  50363. */
  50364. pointer: AbstractMesh;
  50365. /**
  50366. * Creates the input source object
  50367. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50368. * @param _scene the scene which the controller should be associated to
  50369. * @param inputSource the underlying input source for the controller
  50370. * @param _options options for this controller creation
  50371. */
  50372. constructor(_scene: Scene,
  50373. /** The underlying input source for the controller */
  50374. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50375. /**
  50376. * Get this controllers unique id
  50377. */
  50378. get uniqueId(): string;
  50379. /**
  50380. * Disposes of the object
  50381. */
  50382. dispose(): void;
  50383. /**
  50384. * Gets a world space ray coming from the pointer or grip
  50385. * @param result the resulting ray
  50386. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50387. */
  50388. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50389. /**
  50390. * Updates the controller pose based on the given XRFrame
  50391. * @param xrFrame xr frame to update the pose with
  50392. * @param referenceSpace reference space to use
  50393. */
  50394. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50395. }
  50396. }
  50397. declare module "babylonjs/XR/webXRInput" {
  50398. import { Observable } from "babylonjs/Misc/observable";
  50399. import { IDisposable } from "babylonjs/scene";
  50400. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50401. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50402. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50403. /**
  50404. * The schema for initialization options of the XR Input class
  50405. */
  50406. export interface IWebXRInputOptions {
  50407. /**
  50408. * If set to true no model will be automatically loaded
  50409. */
  50410. doNotLoadControllerMeshes?: boolean;
  50411. /**
  50412. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50413. * If not found, the xr input profile data will be used.
  50414. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50415. */
  50416. forceInputProfile?: string;
  50417. /**
  50418. * Do not send a request to the controller repository to load the profile.
  50419. *
  50420. * Instead, use the controllers available in babylon itself.
  50421. */
  50422. disableOnlineControllerRepository?: boolean;
  50423. /**
  50424. * A custom URL for the controllers repository
  50425. */
  50426. customControllersRepositoryURL?: string;
  50427. /**
  50428. * Should the controller model's components not move according to the user input
  50429. */
  50430. disableControllerAnimation?: boolean;
  50431. /**
  50432. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50433. */
  50434. controllerOptions?: IWebXRControllerOptions;
  50435. }
  50436. /**
  50437. * XR input used to track XR inputs such as controllers/rays
  50438. */
  50439. export class WebXRInput implements IDisposable {
  50440. /**
  50441. * the xr session manager for this session
  50442. */
  50443. xrSessionManager: WebXRSessionManager;
  50444. /**
  50445. * the WebXR camera for this session. Mainly used for teleportation
  50446. */
  50447. xrCamera: WebXRCamera;
  50448. private readonly options;
  50449. /**
  50450. * XR controllers being tracked
  50451. */
  50452. controllers: Array<WebXRInputSource>;
  50453. private _frameObserver;
  50454. private _sessionEndedObserver;
  50455. private _sessionInitObserver;
  50456. /**
  50457. * Event when a controller has been connected/added
  50458. */
  50459. onControllerAddedObservable: Observable<WebXRInputSource>;
  50460. /**
  50461. * Event when a controller has been removed/disconnected
  50462. */
  50463. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50464. /**
  50465. * Initializes the WebXRInput
  50466. * @param xrSessionManager the xr session manager for this session
  50467. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50468. * @param options = initialization options for this xr input
  50469. */
  50470. constructor(
  50471. /**
  50472. * the xr session manager for this session
  50473. */
  50474. xrSessionManager: WebXRSessionManager,
  50475. /**
  50476. * the WebXR camera for this session. Mainly used for teleportation
  50477. */
  50478. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50479. private _onInputSourcesChange;
  50480. private _addAndRemoveControllers;
  50481. /**
  50482. * Disposes of the object
  50483. */
  50484. dispose(): void;
  50485. }
  50486. }
  50487. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50488. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50489. import { Observable, EventState } from "babylonjs/Misc/observable";
  50490. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50491. /**
  50492. * This is the base class for all WebXR features.
  50493. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50494. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50495. */
  50496. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50497. protected _xrSessionManager: WebXRSessionManager;
  50498. private _attached;
  50499. private _removeOnDetach;
  50500. /**
  50501. * Should auto-attach be disabled?
  50502. */
  50503. disableAutoAttach: boolean;
  50504. /**
  50505. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50506. */
  50507. xrNativeFeatureName: string;
  50508. /**
  50509. * Construct a new (abstract) WebXR feature
  50510. * @param _xrSessionManager the xr session manager for this feature
  50511. */
  50512. constructor(_xrSessionManager: WebXRSessionManager);
  50513. /**
  50514. * Is this feature attached
  50515. */
  50516. get attached(): boolean;
  50517. /**
  50518. * attach this feature
  50519. *
  50520. * @param force should attachment be forced (even when already attached)
  50521. * @returns true if successful, false is failed or already attached
  50522. */
  50523. attach(force?: boolean): boolean;
  50524. /**
  50525. * detach this feature.
  50526. *
  50527. * @returns true if successful, false if failed or already detached
  50528. */
  50529. detach(): boolean;
  50530. /**
  50531. * Dispose this feature and all of the resources attached
  50532. */
  50533. dispose(): void;
  50534. /**
  50535. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50536. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50537. *
  50538. * @returns whether or not the feature is compatible in this environment
  50539. */
  50540. isCompatible(): boolean;
  50541. /**
  50542. * This is used to register callbacks that will automatically be removed when detach is called.
  50543. * @param observable the observable to which the observer will be attached
  50544. * @param callback the callback to register
  50545. */
  50546. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50547. /**
  50548. * Code in this function will be executed on each xrFrame received from the browser.
  50549. * This function will not execute after the feature is detached.
  50550. * @param _xrFrame the current frame
  50551. */
  50552. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50553. }
  50554. }
  50555. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50556. import { IDisposable, Scene } from "babylonjs/scene";
  50557. import { Nullable } from "babylonjs/types";
  50558. import { Observable } from "babylonjs/Misc/observable";
  50559. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50560. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50561. import { Camera } from "babylonjs/Cameras/camera";
  50562. /**
  50563. * Renders a layer on top of an existing scene
  50564. */
  50565. export class UtilityLayerRenderer implements IDisposable {
  50566. /** the original scene that will be rendered on top of */
  50567. originalScene: Scene;
  50568. private _pointerCaptures;
  50569. private _lastPointerEvents;
  50570. private static _DefaultUtilityLayer;
  50571. private static _DefaultKeepDepthUtilityLayer;
  50572. private _sharedGizmoLight;
  50573. private _renderCamera;
  50574. /**
  50575. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50576. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50577. * @returns the camera that is used when rendering the utility layer
  50578. */
  50579. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50580. /**
  50581. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50582. * @param cam the camera that should be used when rendering the utility layer
  50583. */
  50584. setRenderCamera(cam: Nullable<Camera>): void;
  50585. /**
  50586. * @hidden
  50587. * Light which used by gizmos to get light shading
  50588. */
  50589. _getSharedGizmoLight(): HemisphericLight;
  50590. /**
  50591. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50592. */
  50593. pickUtilitySceneFirst: boolean;
  50594. /**
  50595. * 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)
  50596. */
  50597. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50598. /**
  50599. * 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)
  50600. */
  50601. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50602. /**
  50603. * The scene that is rendered on top of the original scene
  50604. */
  50605. utilityLayerScene: Scene;
  50606. /**
  50607. * If the utility layer should automatically be rendered on top of existing scene
  50608. */
  50609. shouldRender: boolean;
  50610. /**
  50611. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50612. */
  50613. onlyCheckPointerDownEvents: boolean;
  50614. /**
  50615. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50616. */
  50617. processAllEvents: boolean;
  50618. /**
  50619. * Observable raised when the pointer move from the utility layer scene to the main scene
  50620. */
  50621. onPointerOutObservable: Observable<number>;
  50622. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50623. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50624. private _afterRenderObserver;
  50625. private _sceneDisposeObserver;
  50626. private _originalPointerObserver;
  50627. /**
  50628. * Instantiates a UtilityLayerRenderer
  50629. * @param originalScene the original scene that will be rendered on top of
  50630. * @param handleEvents boolean indicating if the utility layer should handle events
  50631. */
  50632. constructor(
  50633. /** the original scene that will be rendered on top of */
  50634. originalScene: Scene, handleEvents?: boolean);
  50635. private _notifyObservers;
  50636. /**
  50637. * Renders the utility layers scene on top of the original scene
  50638. */
  50639. render(): void;
  50640. /**
  50641. * Disposes of the renderer
  50642. */
  50643. dispose(): void;
  50644. private _updateCamera;
  50645. }
  50646. }
  50647. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50648. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50649. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50650. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50651. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50652. import { Scene } from "babylonjs/scene";
  50653. import { Nullable } from "babylonjs/types";
  50654. import { Color3 } from "babylonjs/Maths/math.color";
  50655. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50656. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50657. /**
  50658. * Options interface for the pointer selection module
  50659. */
  50660. export interface IWebXRControllerPointerSelectionOptions {
  50661. /**
  50662. * if provided, this scene will be used to render meshes.
  50663. */
  50664. customUtilityLayerScene?: Scene;
  50665. /**
  50666. * 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)
  50667. * If not disabled, the last picked point will be used to execute a pointer up event
  50668. * If disabled, pointer up event will be triggered right after the pointer down event.
  50669. * Used in screen and gaze target ray mode only
  50670. */
  50671. disablePointerUpOnTouchOut: boolean;
  50672. /**
  50673. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50674. */
  50675. forceGazeMode: boolean;
  50676. /**
  50677. * 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
  50678. * to start a new countdown to the pointer down event.
  50679. * Defaults to 1.
  50680. */
  50681. gazeModePointerMovedFactor?: number;
  50682. /**
  50683. * Different button type to use instead of the main component
  50684. */
  50685. overrideButtonId?: string;
  50686. /**
  50687. * use this rendering group id for the meshes (optional)
  50688. */
  50689. renderingGroupId?: number;
  50690. /**
  50691. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50692. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50693. * 3000 means 3 seconds between pointing at something and selecting it
  50694. */
  50695. timeToSelect?: number;
  50696. /**
  50697. * Should meshes created here be added to a utility layer or the main scene
  50698. */
  50699. useUtilityLayer?: boolean;
  50700. /**
  50701. * Optional WebXR camera to be used for gaze selection
  50702. */
  50703. gazeCamera?: WebXRCamera;
  50704. /**
  50705. * the xr input to use with this pointer selection
  50706. */
  50707. xrInput: WebXRInput;
  50708. }
  50709. /**
  50710. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50711. */
  50712. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50713. private readonly _options;
  50714. private static _idCounter;
  50715. private _attachController;
  50716. private _controllers;
  50717. private _scene;
  50718. private _tmpVectorForPickCompare;
  50719. /**
  50720. * The module's name
  50721. */
  50722. static readonly Name: string;
  50723. /**
  50724. * The (Babylon) version of this module.
  50725. * This is an integer representing the implementation version.
  50726. * This number does not correspond to the WebXR specs version
  50727. */
  50728. static readonly Version: number;
  50729. /**
  50730. * Disable lighting on the laser pointer (so it will always be visible)
  50731. */
  50732. disablePointerLighting: boolean;
  50733. /**
  50734. * Disable lighting on the selection mesh (so it will always be visible)
  50735. */
  50736. disableSelectionMeshLighting: boolean;
  50737. /**
  50738. * Should the laser pointer be displayed
  50739. */
  50740. displayLaserPointer: boolean;
  50741. /**
  50742. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50743. */
  50744. displaySelectionMesh: boolean;
  50745. /**
  50746. * This color will be set to the laser pointer when selection is triggered
  50747. */
  50748. laserPointerPickedColor: Color3;
  50749. /**
  50750. * Default color of the laser pointer
  50751. */
  50752. laserPointerDefaultColor: Color3;
  50753. /**
  50754. * default color of the selection ring
  50755. */
  50756. selectionMeshDefaultColor: Color3;
  50757. /**
  50758. * This color will be applied to the selection ring when selection is triggered
  50759. */
  50760. selectionMeshPickedColor: Color3;
  50761. /**
  50762. * Optional filter to be used for ray selection. This predicate shares behavior with
  50763. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50764. */
  50765. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50766. /**
  50767. * constructs a new background remover module
  50768. * @param _xrSessionManager the session manager for this module
  50769. * @param _options read-only options to be used in this module
  50770. */
  50771. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50772. /**
  50773. * attach this feature
  50774. * Will usually be called by the features manager
  50775. *
  50776. * @returns true if successful.
  50777. */
  50778. attach(): boolean;
  50779. /**
  50780. * detach this feature.
  50781. * Will usually be called by the features manager
  50782. *
  50783. * @returns true if successful.
  50784. */
  50785. detach(): boolean;
  50786. /**
  50787. * Will get the mesh under a specific pointer.
  50788. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50789. * @param controllerId the controllerId to check
  50790. * @returns The mesh under pointer or null if no mesh is under the pointer
  50791. */
  50792. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50793. /**
  50794. * Get the xr controller that correlates to the pointer id in the pointer event
  50795. *
  50796. * @param id the pointer id to search for
  50797. * @returns the controller that correlates to this id or null if not found
  50798. */
  50799. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50800. protected _onXRFrame(_xrFrame: XRFrame): void;
  50801. private _attachGazeMode;
  50802. private _attachScreenRayMode;
  50803. private _attachTrackedPointerRayMode;
  50804. private _convertNormalToDirectionOfRay;
  50805. private _detachController;
  50806. private _generateNewMeshPair;
  50807. private _pickingMoved;
  50808. private _updatePointerDistance;
  50809. /** @hidden */
  50810. get lasterPointerDefaultColor(): Color3;
  50811. }
  50812. }
  50813. declare module "babylonjs/XR/webXREnterExitUI" {
  50814. import { Nullable } from "babylonjs/types";
  50815. import { Observable } from "babylonjs/Misc/observable";
  50816. import { IDisposable, Scene } from "babylonjs/scene";
  50817. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50818. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50819. /**
  50820. * Button which can be used to enter a different mode of XR
  50821. */
  50822. export class WebXREnterExitUIButton {
  50823. /** button element */
  50824. element: HTMLElement;
  50825. /** XR initialization options for the button */
  50826. sessionMode: XRSessionMode;
  50827. /** Reference space type */
  50828. referenceSpaceType: XRReferenceSpaceType;
  50829. /**
  50830. * Creates a WebXREnterExitUIButton
  50831. * @param element button element
  50832. * @param sessionMode XR initialization session mode
  50833. * @param referenceSpaceType the type of reference space to be used
  50834. */
  50835. constructor(
  50836. /** button element */
  50837. element: HTMLElement,
  50838. /** XR initialization options for the button */
  50839. sessionMode: XRSessionMode,
  50840. /** Reference space type */
  50841. referenceSpaceType: XRReferenceSpaceType);
  50842. /**
  50843. * Extendable function which can be used to update the button's visuals when the state changes
  50844. * @param activeButton the current active button in the UI
  50845. */
  50846. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50847. }
  50848. /**
  50849. * Options to create the webXR UI
  50850. */
  50851. export class WebXREnterExitUIOptions {
  50852. /**
  50853. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50854. */
  50855. customButtons?: Array<WebXREnterExitUIButton>;
  50856. /**
  50857. * A reference space type to use when creating the default button.
  50858. * Default is local-floor
  50859. */
  50860. referenceSpaceType?: XRReferenceSpaceType;
  50861. /**
  50862. * Context to enter xr with
  50863. */
  50864. renderTarget?: Nullable<WebXRRenderTarget>;
  50865. /**
  50866. * A session mode to use when creating the default button.
  50867. * Default is immersive-vr
  50868. */
  50869. sessionMode?: XRSessionMode;
  50870. /**
  50871. * A list of optional features to init the session with
  50872. */
  50873. optionalFeatures?: string[];
  50874. /**
  50875. * A list of optional features to init the session with
  50876. */
  50877. requiredFeatures?: string[];
  50878. }
  50879. /**
  50880. * UI to allow the user to enter/exit XR mode
  50881. */
  50882. export class WebXREnterExitUI implements IDisposable {
  50883. private scene;
  50884. /** version of the options passed to this UI */
  50885. options: WebXREnterExitUIOptions;
  50886. private _activeButton;
  50887. private _buttons;
  50888. /**
  50889. * The HTML Div Element to which buttons are added.
  50890. */
  50891. readonly overlay: HTMLDivElement;
  50892. /**
  50893. * Fired every time the active button is changed.
  50894. *
  50895. * When xr is entered via a button that launches xr that button will be the callback parameter
  50896. *
  50897. * When exiting xr the callback parameter will be null)
  50898. */
  50899. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50900. /**
  50901. *
  50902. * @param scene babylon scene object to use
  50903. * @param options (read-only) version of the options passed to this UI
  50904. */
  50905. private constructor();
  50906. /**
  50907. * Creates UI to allow the user to enter/exit XR mode
  50908. * @param scene the scene to add the ui to
  50909. * @param helper the xr experience helper to enter/exit xr with
  50910. * @param options options to configure the UI
  50911. * @returns the created ui
  50912. */
  50913. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50914. /**
  50915. * Disposes of the XR UI component
  50916. */
  50917. dispose(): void;
  50918. private _updateButtons;
  50919. }
  50920. }
  50921. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50922. import { Vector3 } from "babylonjs/Maths/math.vector";
  50923. import { Color4 } from "babylonjs/Maths/math.color";
  50924. import { Nullable } from "babylonjs/types";
  50925. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50926. import { Scene } from "babylonjs/scene";
  50927. /**
  50928. * Class containing static functions to help procedurally build meshes
  50929. */
  50930. export class LinesBuilder {
  50931. /**
  50932. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50933. * * 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
  50934. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50935. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50936. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50937. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50938. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50939. * * 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
  50940. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50941. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50942. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50943. * @param name defines the name of the new line system
  50944. * @param options defines the options used to create the line system
  50945. * @param scene defines the hosting scene
  50946. * @returns a new line system mesh
  50947. */
  50948. static CreateLineSystem(name: string, options: {
  50949. lines: Vector3[][];
  50950. updatable?: boolean;
  50951. instance?: Nullable<LinesMesh>;
  50952. colors?: Nullable<Color4[][]>;
  50953. useVertexAlpha?: boolean;
  50954. }, scene: Nullable<Scene>): LinesMesh;
  50955. /**
  50956. * Creates a line mesh
  50957. * 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
  50958. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50959. * * The parameter `points` is an array successive Vector3
  50960. * * 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
  50961. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50962. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50963. * * When updating an instance, remember that only point positions can change, not the number of points
  50964. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50965. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50966. * @param name defines the name of the new line system
  50967. * @param options defines the options used to create the line system
  50968. * @param scene defines the hosting scene
  50969. * @returns a new line mesh
  50970. */
  50971. static CreateLines(name: string, options: {
  50972. points: Vector3[];
  50973. updatable?: boolean;
  50974. instance?: Nullable<LinesMesh>;
  50975. colors?: Color4[];
  50976. useVertexAlpha?: boolean;
  50977. }, scene?: Nullable<Scene>): LinesMesh;
  50978. /**
  50979. * Creates a dashed line mesh
  50980. * * 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
  50981. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50982. * * The parameter `points` is an array successive Vector3
  50983. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50984. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50985. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50986. * * 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
  50987. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50988. * * When updating an instance, remember that only point positions can change, not the number of points
  50989. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50990. * @param name defines the name of the mesh
  50991. * @param options defines the options used to create the mesh
  50992. * @param scene defines the hosting scene
  50993. * @returns the dashed line mesh
  50994. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50995. */
  50996. static CreateDashedLines(name: string, options: {
  50997. points: Vector3[];
  50998. dashSize?: number;
  50999. gapSize?: number;
  51000. dashNb?: number;
  51001. updatable?: boolean;
  51002. instance?: LinesMesh;
  51003. useVertexAlpha?: boolean;
  51004. }, scene?: Nullable<Scene>): LinesMesh;
  51005. }
  51006. }
  51007. declare module "babylonjs/Misc/timer" {
  51008. import { Observable, Observer } from "babylonjs/Misc/observable";
  51009. import { Nullable } from "babylonjs/types";
  51010. import { IDisposable } from "babylonjs/scene";
  51011. /**
  51012. * Construction options for a timer
  51013. */
  51014. export interface ITimerOptions<T> {
  51015. /**
  51016. * Time-to-end
  51017. */
  51018. timeout: number;
  51019. /**
  51020. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51021. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51022. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51023. */
  51024. contextObservable: Observable<T>;
  51025. /**
  51026. * Optional parameters when adding an observer to the observable
  51027. */
  51028. observableParameters?: {
  51029. mask?: number;
  51030. insertFirst?: boolean;
  51031. scope?: any;
  51032. };
  51033. /**
  51034. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51035. */
  51036. breakCondition?: (data?: ITimerData<T>) => boolean;
  51037. /**
  51038. * Will be triggered when the time condition has met
  51039. */
  51040. onEnded?: (data: ITimerData<any>) => void;
  51041. /**
  51042. * Will be triggered when the break condition has met (prematurely ended)
  51043. */
  51044. onAborted?: (data: ITimerData<any>) => void;
  51045. /**
  51046. * Optional function to execute on each tick (or count)
  51047. */
  51048. onTick?: (data: ITimerData<any>) => void;
  51049. }
  51050. /**
  51051. * An interface defining the data sent by the timer
  51052. */
  51053. export interface ITimerData<T> {
  51054. /**
  51055. * When did it start
  51056. */
  51057. startTime: number;
  51058. /**
  51059. * Time now
  51060. */
  51061. currentTime: number;
  51062. /**
  51063. * Time passed since started
  51064. */
  51065. deltaTime: number;
  51066. /**
  51067. * How much is completed, in [0.0...1.0].
  51068. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51069. */
  51070. completeRate: number;
  51071. /**
  51072. * What the registered observable sent in the last count
  51073. */
  51074. payload: T;
  51075. }
  51076. /**
  51077. * The current state of the timer
  51078. */
  51079. export enum TimerState {
  51080. /**
  51081. * Timer initialized, not yet started
  51082. */
  51083. INIT = 0,
  51084. /**
  51085. * Timer started and counting
  51086. */
  51087. STARTED = 1,
  51088. /**
  51089. * Timer ended (whether aborted or time reached)
  51090. */
  51091. ENDED = 2
  51092. }
  51093. /**
  51094. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51095. *
  51096. * @param options options with which to initialize this timer
  51097. */
  51098. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51099. /**
  51100. * An advanced implementation of a timer class
  51101. */
  51102. export class AdvancedTimer<T = any> implements IDisposable {
  51103. /**
  51104. * Will notify each time the timer calculates the remaining time
  51105. */
  51106. onEachCountObservable: Observable<ITimerData<T>>;
  51107. /**
  51108. * Will trigger when the timer was aborted due to the break condition
  51109. */
  51110. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51111. /**
  51112. * Will trigger when the timer ended successfully
  51113. */
  51114. onTimerEndedObservable: Observable<ITimerData<T>>;
  51115. /**
  51116. * Will trigger when the timer state has changed
  51117. */
  51118. onStateChangedObservable: Observable<TimerState>;
  51119. private _observer;
  51120. private _contextObservable;
  51121. private _observableParameters;
  51122. private _startTime;
  51123. private _timer;
  51124. private _state;
  51125. private _breakCondition;
  51126. private _timeToEnd;
  51127. private _breakOnNextTick;
  51128. /**
  51129. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51130. * @param options construction options for this advanced timer
  51131. */
  51132. constructor(options: ITimerOptions<T>);
  51133. /**
  51134. * set a breaking condition for this timer. Default is to never break during count
  51135. * @param predicate the new break condition. Returns true to break, false otherwise
  51136. */
  51137. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51138. /**
  51139. * Reset ALL associated observables in this advanced timer
  51140. */
  51141. clearObservables(): void;
  51142. /**
  51143. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51144. *
  51145. * @param timeToEnd how much time to measure until timer ended
  51146. */
  51147. start(timeToEnd?: number): void;
  51148. /**
  51149. * Will force a stop on the next tick.
  51150. */
  51151. stop(): void;
  51152. /**
  51153. * Dispose this timer, clearing all resources
  51154. */
  51155. dispose(): void;
  51156. private _setState;
  51157. private _tick;
  51158. private _stop;
  51159. }
  51160. }
  51161. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51162. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51163. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51164. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51165. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51166. import { Vector3 } from "babylonjs/Maths/math.vector";
  51167. import { Material } from "babylonjs/Materials/material";
  51168. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51169. import { Scene } from "babylonjs/scene";
  51170. /**
  51171. * The options container for the teleportation module
  51172. */
  51173. export interface IWebXRTeleportationOptions {
  51174. /**
  51175. * if provided, this scene will be used to render meshes.
  51176. */
  51177. customUtilityLayerScene?: Scene;
  51178. /**
  51179. * Values to configure the default target mesh
  51180. */
  51181. defaultTargetMeshOptions?: {
  51182. /**
  51183. * Fill color of the teleportation area
  51184. */
  51185. teleportationFillColor?: string;
  51186. /**
  51187. * Border color for the teleportation area
  51188. */
  51189. teleportationBorderColor?: string;
  51190. /**
  51191. * Disable the mesh's animation sequence
  51192. */
  51193. disableAnimation?: boolean;
  51194. /**
  51195. * Disable lighting on the material or the ring and arrow
  51196. */
  51197. disableLighting?: boolean;
  51198. /**
  51199. * Override the default material of the torus and arrow
  51200. */
  51201. torusArrowMaterial?: Material;
  51202. };
  51203. /**
  51204. * A list of meshes to use as floor meshes.
  51205. * Meshes can be added and removed after initializing the feature using the
  51206. * addFloorMesh and removeFloorMesh functions
  51207. * If empty, rotation will still work
  51208. */
  51209. floorMeshes?: AbstractMesh[];
  51210. /**
  51211. * use this rendering group id for the meshes (optional)
  51212. */
  51213. renderingGroupId?: number;
  51214. /**
  51215. * Should teleportation move only to snap points
  51216. */
  51217. snapPointsOnly?: boolean;
  51218. /**
  51219. * An array of points to which the teleportation will snap to.
  51220. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51221. */
  51222. snapPositions?: Vector3[];
  51223. /**
  51224. * How close should the teleportation ray be in order to snap to position.
  51225. * Default to 0.8 units (meters)
  51226. */
  51227. snapToPositionRadius?: number;
  51228. /**
  51229. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51230. * If you want to support rotation, make sure your mesh has a direction indicator.
  51231. *
  51232. * When left untouched, the default mesh will be initialized.
  51233. */
  51234. teleportationTargetMesh?: AbstractMesh;
  51235. /**
  51236. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51237. */
  51238. timeToTeleport?: number;
  51239. /**
  51240. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51241. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51242. */
  51243. useMainComponentOnly?: boolean;
  51244. /**
  51245. * Should meshes created here be added to a utility layer or the main scene
  51246. */
  51247. useUtilityLayer?: boolean;
  51248. /**
  51249. * Babylon XR Input class for controller
  51250. */
  51251. xrInput: WebXRInput;
  51252. }
  51253. /**
  51254. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51255. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51256. * the input of the attached controllers.
  51257. */
  51258. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51259. private _options;
  51260. private _controllers;
  51261. private _currentTeleportationControllerId;
  51262. private _floorMeshes;
  51263. private _quadraticBezierCurve;
  51264. private _selectionFeature;
  51265. private _snapToPositions;
  51266. private _snappedToPoint;
  51267. private _teleportationRingMaterial?;
  51268. private _tmpRay;
  51269. private _tmpVector;
  51270. /**
  51271. * The module's name
  51272. */
  51273. static readonly Name: string;
  51274. /**
  51275. * The (Babylon) version of this module.
  51276. * This is an integer representing the implementation version.
  51277. * This number does not correspond to the webxr specs version
  51278. */
  51279. static readonly Version: number;
  51280. /**
  51281. * Is movement backwards enabled
  51282. */
  51283. backwardsMovementEnabled: boolean;
  51284. /**
  51285. * Distance to travel when moving backwards
  51286. */
  51287. backwardsTeleportationDistance: number;
  51288. /**
  51289. * The distance from the user to the inspection point in the direction of the controller
  51290. * A higher number will allow the user to move further
  51291. * defaults to 5 (meters, in xr units)
  51292. */
  51293. parabolicCheckRadius: number;
  51294. /**
  51295. * Should the module support parabolic ray on top of direct ray
  51296. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51297. * Very helpful when moving between floors / different heights
  51298. */
  51299. parabolicRayEnabled: boolean;
  51300. /**
  51301. * How much rotation should be applied when rotating right and left
  51302. */
  51303. rotationAngle: number;
  51304. /**
  51305. * Is rotation enabled when moving forward?
  51306. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51307. */
  51308. rotationEnabled: boolean;
  51309. /**
  51310. * constructs a new anchor system
  51311. * @param _xrSessionManager an instance of WebXRSessionManager
  51312. * @param _options configuration object for this feature
  51313. */
  51314. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51315. /**
  51316. * Get the snapPointsOnly flag
  51317. */
  51318. get snapPointsOnly(): boolean;
  51319. /**
  51320. * Sets the snapPointsOnly flag
  51321. * @param snapToPoints should teleportation be exclusively to snap points
  51322. */
  51323. set snapPointsOnly(snapToPoints: boolean);
  51324. /**
  51325. * Add a new mesh to the floor meshes array
  51326. * @param mesh the mesh to use as floor mesh
  51327. */
  51328. addFloorMesh(mesh: AbstractMesh): void;
  51329. /**
  51330. * Add a new snap-to point to fix teleportation to this position
  51331. * @param newSnapPoint The new Snap-To point
  51332. */
  51333. addSnapPoint(newSnapPoint: Vector3): void;
  51334. attach(): boolean;
  51335. detach(): boolean;
  51336. dispose(): void;
  51337. /**
  51338. * Remove a mesh from the floor meshes array
  51339. * @param mesh the mesh to remove
  51340. */
  51341. removeFloorMesh(mesh: AbstractMesh): void;
  51342. /**
  51343. * Remove a mesh from the floor meshes array using its name
  51344. * @param name the mesh name to remove
  51345. */
  51346. removeFloorMeshByName(name: string): void;
  51347. /**
  51348. * 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
  51349. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51350. * @returns was the point found and removed or not
  51351. */
  51352. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51353. /**
  51354. * This function sets a selection feature that will be disabled when
  51355. * the forward ray is shown and will be reattached when hidden.
  51356. * This is used to remove the selection rays when moving.
  51357. * @param selectionFeature the feature to disable when forward movement is enabled
  51358. */
  51359. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51360. protected _onXRFrame(_xrFrame: XRFrame): void;
  51361. private _attachController;
  51362. private _createDefaultTargetMesh;
  51363. private _detachController;
  51364. private _findClosestSnapPointWithRadius;
  51365. private _setTargetMeshPosition;
  51366. private _setTargetMeshVisibility;
  51367. private _showParabolicPath;
  51368. private _teleportForward;
  51369. }
  51370. }
  51371. declare module "babylonjs/XR/webXRDefaultExperience" {
  51372. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51373. import { Scene } from "babylonjs/scene";
  51374. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51375. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51376. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51377. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51378. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51379. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51380. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51381. /**
  51382. * Options for the default xr helper
  51383. */
  51384. export class WebXRDefaultExperienceOptions {
  51385. /**
  51386. * Enable or disable default UI to enter XR
  51387. */
  51388. disableDefaultUI?: boolean;
  51389. /**
  51390. * Should teleportation not initialize. defaults to false.
  51391. */
  51392. disableTeleportation?: boolean;
  51393. /**
  51394. * Floor meshes that will be used for teleport
  51395. */
  51396. floorMeshes?: Array<AbstractMesh>;
  51397. /**
  51398. * If set to true, the first frame will not be used to reset position
  51399. * The first frame is mainly used when copying transformation from the old camera
  51400. * Mainly used in AR
  51401. */
  51402. ignoreNativeCameraTransformation?: boolean;
  51403. /**
  51404. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51405. */
  51406. inputOptions?: IWebXRInputOptions;
  51407. /**
  51408. * optional configuration for the output canvas
  51409. */
  51410. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51411. /**
  51412. * optional UI options. This can be used among other to change session mode and reference space type
  51413. */
  51414. uiOptions?: WebXREnterExitUIOptions;
  51415. /**
  51416. * When loading teleportation and pointer select, use stable versions instead of latest.
  51417. */
  51418. useStablePlugins?: boolean;
  51419. /**
  51420. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51421. */
  51422. renderingGroupId?: number;
  51423. /**
  51424. * A list of optional features to init the session with
  51425. * If set to true, all features we support will be added
  51426. */
  51427. optionalFeatures?: boolean | string[];
  51428. }
  51429. /**
  51430. * Default experience which provides a similar setup to the previous webVRExperience
  51431. */
  51432. export class WebXRDefaultExperience {
  51433. /**
  51434. * Base experience
  51435. */
  51436. baseExperience: WebXRExperienceHelper;
  51437. /**
  51438. * Enables ui for entering/exiting xr
  51439. */
  51440. enterExitUI: WebXREnterExitUI;
  51441. /**
  51442. * Input experience extension
  51443. */
  51444. input: WebXRInput;
  51445. /**
  51446. * Enables laser pointer and selection
  51447. */
  51448. pointerSelection: WebXRControllerPointerSelection;
  51449. /**
  51450. * Default target xr should render to
  51451. */
  51452. renderTarget: WebXRRenderTarget;
  51453. /**
  51454. * Enables teleportation
  51455. */
  51456. teleportation: WebXRMotionControllerTeleportation;
  51457. private constructor();
  51458. /**
  51459. * Creates the default xr experience
  51460. * @param scene scene
  51461. * @param options options for basic configuration
  51462. * @returns resulting WebXRDefaultExperience
  51463. */
  51464. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51465. /**
  51466. * DIsposes of the experience helper
  51467. */
  51468. dispose(): void;
  51469. }
  51470. }
  51471. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51472. import { Observable } from "babylonjs/Misc/observable";
  51473. import { Nullable } from "babylonjs/types";
  51474. import { Camera } from "babylonjs/Cameras/camera";
  51475. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51476. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51477. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51478. import { Scene } from "babylonjs/scene";
  51479. import { Vector3 } from "babylonjs/Maths/math.vector";
  51480. import { Color3 } from "babylonjs/Maths/math.color";
  51481. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51482. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51483. import { Mesh } from "babylonjs/Meshes/mesh";
  51484. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51485. import { EasingFunction } from "babylonjs/Animations/easing";
  51486. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51487. import "babylonjs/Meshes/Builders/groundBuilder";
  51488. import "babylonjs/Meshes/Builders/torusBuilder";
  51489. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51490. import "babylonjs/Gamepads/gamepadSceneComponent";
  51491. import "babylonjs/Animations/animatable";
  51492. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51493. /**
  51494. * Options to modify the vr teleportation behavior.
  51495. */
  51496. export interface VRTeleportationOptions {
  51497. /**
  51498. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51499. */
  51500. floorMeshName?: string;
  51501. /**
  51502. * A list of meshes to be used as the teleportation floor. (default: empty)
  51503. */
  51504. floorMeshes?: Mesh[];
  51505. /**
  51506. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51507. */
  51508. teleportationMode?: number;
  51509. /**
  51510. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51511. */
  51512. teleportationTime?: number;
  51513. /**
  51514. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51515. */
  51516. teleportationSpeed?: number;
  51517. /**
  51518. * The easing function used in the animation or null for Linear. (default CircleEase)
  51519. */
  51520. easingFunction?: EasingFunction;
  51521. }
  51522. /**
  51523. * Options to modify the vr experience helper's behavior.
  51524. */
  51525. export interface VRExperienceHelperOptions extends WebVROptions {
  51526. /**
  51527. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51528. */
  51529. createDeviceOrientationCamera?: boolean;
  51530. /**
  51531. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51532. */
  51533. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51534. /**
  51535. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51536. */
  51537. laserToggle?: boolean;
  51538. /**
  51539. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51540. */
  51541. floorMeshes?: Mesh[];
  51542. /**
  51543. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51544. */
  51545. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51546. /**
  51547. * Defines if WebXR should be used instead of WebVR (if available)
  51548. */
  51549. useXR?: boolean;
  51550. }
  51551. /**
  51552. * Event containing information after VR has been entered
  51553. */
  51554. export class OnAfterEnteringVRObservableEvent {
  51555. /**
  51556. * If entering vr was successful
  51557. */
  51558. success: boolean;
  51559. }
  51560. /**
  51561. * Helps to quickly add VR support to an existing scene.
  51562. * See https://doc.babylonjs.com/how_to/webvr_helper
  51563. */
  51564. export class VRExperienceHelper {
  51565. /** Options to modify the vr experience helper's behavior. */
  51566. webVROptions: VRExperienceHelperOptions;
  51567. private _scene;
  51568. private _position;
  51569. private _btnVR;
  51570. private _btnVRDisplayed;
  51571. private _webVRsupported;
  51572. private _webVRready;
  51573. private _webVRrequesting;
  51574. private _webVRpresenting;
  51575. private _hasEnteredVR;
  51576. private _fullscreenVRpresenting;
  51577. private _inputElement;
  51578. private _webVRCamera;
  51579. private _vrDeviceOrientationCamera;
  51580. private _deviceOrientationCamera;
  51581. private _existingCamera;
  51582. private _onKeyDown;
  51583. private _onVrDisplayPresentChange;
  51584. private _onVRDisplayChanged;
  51585. private _onVRRequestPresentStart;
  51586. private _onVRRequestPresentComplete;
  51587. /**
  51588. * 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)
  51589. */
  51590. enableGazeEvenWhenNoPointerLock: boolean;
  51591. /**
  51592. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51593. */
  51594. exitVROnDoubleTap: boolean;
  51595. /**
  51596. * Observable raised right before entering VR.
  51597. */
  51598. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51599. /**
  51600. * Observable raised when entering VR has completed.
  51601. */
  51602. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51603. /**
  51604. * Observable raised when exiting VR.
  51605. */
  51606. onExitingVRObservable: Observable<VRExperienceHelper>;
  51607. /**
  51608. * Observable raised when controller mesh is loaded.
  51609. */
  51610. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51611. /** Return this.onEnteringVRObservable
  51612. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51613. */
  51614. get onEnteringVR(): Observable<VRExperienceHelper>;
  51615. /** Return this.onExitingVRObservable
  51616. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51617. */
  51618. get onExitingVR(): Observable<VRExperienceHelper>;
  51619. /** Return this.onControllerMeshLoadedObservable
  51620. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51621. */
  51622. get onControllerMeshLoaded(): Observable<WebVRController>;
  51623. private _rayLength;
  51624. private _useCustomVRButton;
  51625. private _teleportationRequested;
  51626. private _teleportActive;
  51627. private _floorMeshName;
  51628. private _floorMeshesCollection;
  51629. private _teleportationMode;
  51630. private _teleportationTime;
  51631. private _teleportationSpeed;
  51632. private _teleportationEasing;
  51633. private _rotationAllowed;
  51634. private _teleportBackwardsVector;
  51635. private _teleportationTarget;
  51636. private _isDefaultTeleportationTarget;
  51637. private _postProcessMove;
  51638. private _teleportationFillColor;
  51639. private _teleportationBorderColor;
  51640. private _rotationAngle;
  51641. private _haloCenter;
  51642. private _cameraGazer;
  51643. private _padSensibilityUp;
  51644. private _padSensibilityDown;
  51645. private _leftController;
  51646. private _rightController;
  51647. private _gazeColor;
  51648. private _laserColor;
  51649. private _pickedLaserColor;
  51650. private _pickedGazeColor;
  51651. /**
  51652. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51653. */
  51654. onNewMeshSelected: Observable<AbstractMesh>;
  51655. /**
  51656. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51657. * This observable will provide the mesh and the controller used to select the mesh
  51658. */
  51659. onMeshSelectedWithController: Observable<{
  51660. mesh: AbstractMesh;
  51661. controller: WebVRController;
  51662. }>;
  51663. /**
  51664. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51665. */
  51666. onNewMeshPicked: Observable<PickingInfo>;
  51667. private _circleEase;
  51668. /**
  51669. * Observable raised before camera teleportation
  51670. */
  51671. onBeforeCameraTeleport: Observable<Vector3>;
  51672. /**
  51673. * Observable raised after camera teleportation
  51674. */
  51675. onAfterCameraTeleport: Observable<Vector3>;
  51676. /**
  51677. * Observable raised when current selected mesh gets unselected
  51678. */
  51679. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51680. private _raySelectionPredicate;
  51681. /**
  51682. * To be optionaly changed by user to define custom ray selection
  51683. */
  51684. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51685. /**
  51686. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51687. */
  51688. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51689. /**
  51690. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51691. */
  51692. teleportationEnabled: boolean;
  51693. private _defaultHeight;
  51694. private _teleportationInitialized;
  51695. private _interactionsEnabled;
  51696. private _interactionsRequested;
  51697. private _displayGaze;
  51698. private _displayLaserPointer;
  51699. /**
  51700. * The mesh used to display where the user is going to teleport.
  51701. */
  51702. get teleportationTarget(): Mesh;
  51703. /**
  51704. * Sets the mesh to be used to display where the user is going to teleport.
  51705. */
  51706. set teleportationTarget(value: Mesh);
  51707. /**
  51708. * 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
  51709. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51710. * See https://doc.babylonjs.com/resources/baking_transformations
  51711. */
  51712. get gazeTrackerMesh(): Mesh;
  51713. set gazeTrackerMesh(value: Mesh);
  51714. /**
  51715. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51716. */
  51717. updateGazeTrackerScale: boolean;
  51718. /**
  51719. * If the gaze trackers color should be updated when selecting meshes
  51720. */
  51721. updateGazeTrackerColor: boolean;
  51722. /**
  51723. * If the controller laser color should be updated when selecting meshes
  51724. */
  51725. updateControllerLaserColor: boolean;
  51726. /**
  51727. * The gaze tracking mesh corresponding to the left controller
  51728. */
  51729. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51730. /**
  51731. * The gaze tracking mesh corresponding to the right controller
  51732. */
  51733. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51734. /**
  51735. * If the ray of the gaze should be displayed.
  51736. */
  51737. get displayGaze(): boolean;
  51738. /**
  51739. * Sets if the ray of the gaze should be displayed.
  51740. */
  51741. set displayGaze(value: boolean);
  51742. /**
  51743. * If the ray of the LaserPointer should be displayed.
  51744. */
  51745. get displayLaserPointer(): boolean;
  51746. /**
  51747. * Sets if the ray of the LaserPointer should be displayed.
  51748. */
  51749. set displayLaserPointer(value: boolean);
  51750. /**
  51751. * The deviceOrientationCamera used as the camera when not in VR.
  51752. */
  51753. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51754. /**
  51755. * Based on the current WebVR support, returns the current VR camera used.
  51756. */
  51757. get currentVRCamera(): Nullable<Camera>;
  51758. /**
  51759. * The webVRCamera which is used when in VR.
  51760. */
  51761. get webVRCamera(): WebVRFreeCamera;
  51762. /**
  51763. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51764. */
  51765. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51766. /**
  51767. * The html button that is used to trigger entering into VR.
  51768. */
  51769. get vrButton(): Nullable<HTMLButtonElement>;
  51770. private get _teleportationRequestInitiated();
  51771. /**
  51772. * Defines whether or not Pointer lock should be requested when switching to
  51773. * full screen.
  51774. */
  51775. requestPointerLockOnFullScreen: boolean;
  51776. /**
  51777. * If asking to force XR, this will be populated with the default xr experience
  51778. */
  51779. xr: WebXRDefaultExperience;
  51780. /**
  51781. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51782. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51783. */
  51784. xrTestDone: boolean;
  51785. /**
  51786. * Instantiates a VRExperienceHelper.
  51787. * Helps to quickly add VR support to an existing scene.
  51788. * @param scene The scene the VRExperienceHelper belongs to.
  51789. * @param webVROptions Options to modify the vr experience helper's behavior.
  51790. */
  51791. constructor(scene: Scene,
  51792. /** Options to modify the vr experience helper's behavior. */
  51793. webVROptions?: VRExperienceHelperOptions);
  51794. private completeVRInit;
  51795. private _onDefaultMeshLoaded;
  51796. private _onResize;
  51797. private _onFullscreenChange;
  51798. /**
  51799. * Gets a value indicating if we are currently in VR mode.
  51800. */
  51801. get isInVRMode(): boolean;
  51802. private onVrDisplayPresentChange;
  51803. private onVRDisplayChanged;
  51804. private moveButtonToBottomRight;
  51805. private displayVRButton;
  51806. private updateButtonVisibility;
  51807. private _cachedAngularSensibility;
  51808. /**
  51809. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51810. * Otherwise, will use the fullscreen API.
  51811. */
  51812. enterVR(): void;
  51813. /**
  51814. * Attempt to exit VR, or fullscreen.
  51815. */
  51816. exitVR(): void;
  51817. /**
  51818. * The position of the vr experience helper.
  51819. */
  51820. get position(): Vector3;
  51821. /**
  51822. * Sets the position of the vr experience helper.
  51823. */
  51824. set position(value: Vector3);
  51825. /**
  51826. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51827. */
  51828. enableInteractions(): void;
  51829. private get _noControllerIsActive();
  51830. private beforeRender;
  51831. private _isTeleportationFloor;
  51832. /**
  51833. * Adds a floor mesh to be used for teleportation.
  51834. * @param floorMesh the mesh to be used for teleportation.
  51835. */
  51836. addFloorMesh(floorMesh: Mesh): void;
  51837. /**
  51838. * Removes a floor mesh from being used for teleportation.
  51839. * @param floorMesh the mesh to be removed.
  51840. */
  51841. removeFloorMesh(floorMesh: Mesh): void;
  51842. /**
  51843. * Enables interactions and teleportation using the VR controllers and gaze.
  51844. * @param vrTeleportationOptions options to modify teleportation behavior.
  51845. */
  51846. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51847. private _onNewGamepadConnected;
  51848. private _tryEnableInteractionOnController;
  51849. private _onNewGamepadDisconnected;
  51850. private _enableInteractionOnController;
  51851. private _checkTeleportWithRay;
  51852. private _checkRotate;
  51853. private _checkTeleportBackwards;
  51854. private _enableTeleportationOnController;
  51855. private _createTeleportationCircles;
  51856. private _displayTeleportationTarget;
  51857. private _hideTeleportationTarget;
  51858. private _rotateCamera;
  51859. private _moveTeleportationSelectorTo;
  51860. private _workingVector;
  51861. private _workingQuaternion;
  51862. private _workingMatrix;
  51863. /**
  51864. * Time Constant Teleportation Mode
  51865. */
  51866. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51867. /**
  51868. * Speed Constant Teleportation Mode
  51869. */
  51870. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51871. /**
  51872. * Teleports the users feet to the desired location
  51873. * @param location The location where the user's feet should be placed
  51874. */
  51875. teleportCamera(location: Vector3): void;
  51876. private _convertNormalToDirectionOfRay;
  51877. private _castRayAndSelectObject;
  51878. private _notifySelectedMeshUnselected;
  51879. /**
  51880. * Permanently set new colors for the laser pointer
  51881. * @param color the new laser color
  51882. * @param pickedColor the new laser color when picked mesh detected
  51883. */
  51884. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51885. /**
  51886. * Set lighting enabled / disabled on the laser pointer of both controllers
  51887. * @param enabled should the lighting be enabled on the laser pointer
  51888. */
  51889. setLaserLightingState(enabled?: boolean): void;
  51890. /**
  51891. * Permanently set new colors for the gaze pointer
  51892. * @param color the new gaze color
  51893. * @param pickedColor the new gaze color when picked mesh detected
  51894. */
  51895. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51896. /**
  51897. * Sets the color of the laser ray from the vr controllers.
  51898. * @param color new color for the ray.
  51899. */
  51900. changeLaserColor(color: Color3): void;
  51901. /**
  51902. * Sets the color of the ray from the vr headsets gaze.
  51903. * @param color new color for the ray.
  51904. */
  51905. changeGazeColor(color: Color3): void;
  51906. /**
  51907. * Exits VR and disposes of the vr experience helper
  51908. */
  51909. dispose(): void;
  51910. /**
  51911. * Gets the name of the VRExperienceHelper class
  51912. * @returns "VRExperienceHelper"
  51913. */
  51914. getClassName(): string;
  51915. }
  51916. }
  51917. declare module "babylonjs/Cameras/VR/index" {
  51918. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51919. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51920. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51921. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51922. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51923. export * from "babylonjs/Cameras/VR/webVRCamera";
  51924. }
  51925. declare module "babylonjs/Cameras/RigModes/index" {
  51926. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51927. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51928. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51929. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51930. }
  51931. declare module "babylonjs/Cameras/index" {
  51932. export * from "babylonjs/Cameras/Inputs/index";
  51933. export * from "babylonjs/Cameras/cameraInputsManager";
  51934. export * from "babylonjs/Cameras/camera";
  51935. export * from "babylonjs/Cameras/targetCamera";
  51936. export * from "babylonjs/Cameras/freeCamera";
  51937. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51938. export * from "babylonjs/Cameras/touchCamera";
  51939. export * from "babylonjs/Cameras/arcRotateCamera";
  51940. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51941. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51942. export * from "babylonjs/Cameras/flyCamera";
  51943. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51944. export * from "babylonjs/Cameras/followCamera";
  51945. export * from "babylonjs/Cameras/followCameraInputsManager";
  51946. export * from "babylonjs/Cameras/gamepadCamera";
  51947. export * from "babylonjs/Cameras/Stereoscopic/index";
  51948. export * from "babylonjs/Cameras/universalCamera";
  51949. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51950. export * from "babylonjs/Cameras/VR/index";
  51951. export * from "babylonjs/Cameras/RigModes/index";
  51952. }
  51953. declare module "babylonjs/Collisions/index" {
  51954. export * from "babylonjs/Collisions/collider";
  51955. export * from "babylonjs/Collisions/collisionCoordinator";
  51956. export * from "babylonjs/Collisions/pickingInfo";
  51957. export * from "babylonjs/Collisions/intersectionInfo";
  51958. export * from "babylonjs/Collisions/meshCollisionData";
  51959. }
  51960. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51961. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51962. import { Vector3 } from "babylonjs/Maths/math.vector";
  51963. import { Ray } from "babylonjs/Culling/ray";
  51964. import { Plane } from "babylonjs/Maths/math.plane";
  51965. /**
  51966. * Contains an array of blocks representing the octree
  51967. */
  51968. export interface IOctreeContainer<T> {
  51969. /**
  51970. * Blocks within the octree
  51971. */
  51972. blocks: Array<OctreeBlock<T>>;
  51973. }
  51974. /**
  51975. * Class used to store a cell in an octree
  51976. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51977. */
  51978. export class OctreeBlock<T> {
  51979. /**
  51980. * Gets the content of the current block
  51981. */
  51982. entries: T[];
  51983. /**
  51984. * Gets the list of block children
  51985. */
  51986. blocks: Array<OctreeBlock<T>>;
  51987. private _depth;
  51988. private _maxDepth;
  51989. private _capacity;
  51990. private _minPoint;
  51991. private _maxPoint;
  51992. private _boundingVectors;
  51993. private _creationFunc;
  51994. /**
  51995. * Creates a new block
  51996. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51997. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51998. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51999. * @param depth defines the current depth of this block in the octree
  52000. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  52001. * @param creationFunc defines a callback to call when an element is added to the block
  52002. */
  52003. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  52004. /**
  52005. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52006. */
  52007. get capacity(): number;
  52008. /**
  52009. * Gets the minimum vector (in world space) of the block's bounding box
  52010. */
  52011. get minPoint(): Vector3;
  52012. /**
  52013. * Gets the maximum vector (in world space) of the block's bounding box
  52014. */
  52015. get maxPoint(): Vector3;
  52016. /**
  52017. * Add a new element to this block
  52018. * @param entry defines the element to add
  52019. */
  52020. addEntry(entry: T): void;
  52021. /**
  52022. * Remove an element from this block
  52023. * @param entry defines the element to remove
  52024. */
  52025. removeEntry(entry: T): void;
  52026. /**
  52027. * Add an array of elements to this block
  52028. * @param entries defines the array of elements to add
  52029. */
  52030. addEntries(entries: T[]): void;
  52031. /**
  52032. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52033. * @param frustumPlanes defines the frustum planes to test
  52034. * @param selection defines the array to store current content if selection is positive
  52035. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52036. */
  52037. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52038. /**
  52039. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52040. * @param sphereCenter defines the bounding sphere center
  52041. * @param sphereRadius defines the bounding sphere radius
  52042. * @param selection defines the array to store current content if selection is positive
  52043. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52044. */
  52045. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52046. /**
  52047. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52048. * @param ray defines the ray to test with
  52049. * @param selection defines the array to store current content if selection is positive
  52050. */
  52051. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52052. /**
  52053. * Subdivide the content into child blocks (this block will then be empty)
  52054. */
  52055. createInnerBlocks(): void;
  52056. /**
  52057. * @hidden
  52058. */
  52059. 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;
  52060. }
  52061. }
  52062. declare module "babylonjs/Culling/Octrees/octree" {
  52063. import { SmartArray } from "babylonjs/Misc/smartArray";
  52064. import { Vector3 } from "babylonjs/Maths/math.vector";
  52065. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52066. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52067. import { Ray } from "babylonjs/Culling/ray";
  52068. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52069. import { Plane } from "babylonjs/Maths/math.plane";
  52070. /**
  52071. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52072. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52073. */
  52074. export class Octree<T> {
  52075. /** 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.) */
  52076. maxDepth: number;
  52077. /**
  52078. * Blocks within the octree containing objects
  52079. */
  52080. blocks: Array<OctreeBlock<T>>;
  52081. /**
  52082. * Content stored in the octree
  52083. */
  52084. dynamicContent: T[];
  52085. private _maxBlockCapacity;
  52086. private _selectionContent;
  52087. private _creationFunc;
  52088. /**
  52089. * Creates a octree
  52090. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52091. * @param creationFunc function to be used to instatiate the octree
  52092. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52093. * @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.)
  52094. */
  52095. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52096. /** 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.) */
  52097. maxDepth?: number);
  52098. /**
  52099. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52100. * @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);
  52101. * @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);
  52102. * @param entries meshes to be added to the octree blocks
  52103. */
  52104. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52105. /**
  52106. * Adds a mesh to the octree
  52107. * @param entry Mesh to add to the octree
  52108. */
  52109. addMesh(entry: T): void;
  52110. /**
  52111. * Remove an element from the octree
  52112. * @param entry defines the element to remove
  52113. */
  52114. removeMesh(entry: T): void;
  52115. /**
  52116. * Selects an array of meshes within the frustum
  52117. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52118. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52119. * @returns array of meshes within the frustum
  52120. */
  52121. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52122. /**
  52123. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52124. * @param sphereCenter defines the bounding sphere center
  52125. * @param sphereRadius defines the bounding sphere radius
  52126. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52127. * @returns an array of objects that intersect the sphere
  52128. */
  52129. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52130. /**
  52131. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52132. * @param ray defines the ray to test with
  52133. * @returns array of intersected objects
  52134. */
  52135. intersectsRay(ray: Ray): SmartArray<T>;
  52136. /**
  52137. * Adds a mesh into the octree block if it intersects the block
  52138. */
  52139. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52140. /**
  52141. * Adds a submesh into the octree block if it intersects the block
  52142. */
  52143. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52144. }
  52145. }
  52146. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52147. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52148. import { Scene } from "babylonjs/scene";
  52149. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52150. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52151. import { Ray } from "babylonjs/Culling/ray";
  52152. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52153. import { Collider } from "babylonjs/Collisions/collider";
  52154. module "babylonjs/scene" {
  52155. interface Scene {
  52156. /**
  52157. * @hidden
  52158. * Backing Filed
  52159. */
  52160. _selectionOctree: Octree<AbstractMesh>;
  52161. /**
  52162. * Gets the octree used to boost mesh selection (picking)
  52163. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52164. */
  52165. selectionOctree: Octree<AbstractMesh>;
  52166. /**
  52167. * Creates or updates the octree used to boost selection (picking)
  52168. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52169. * @param maxCapacity defines the maximum capacity per leaf
  52170. * @param maxDepth defines the maximum depth of the octree
  52171. * @returns an octree of AbstractMesh
  52172. */
  52173. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52174. }
  52175. }
  52176. module "babylonjs/Meshes/abstractMesh" {
  52177. interface AbstractMesh {
  52178. /**
  52179. * @hidden
  52180. * Backing Field
  52181. */
  52182. _submeshesOctree: Octree<SubMesh>;
  52183. /**
  52184. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52185. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52186. * @param maxCapacity defines the maximum size of each block (64 by default)
  52187. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52188. * @returns the new octree
  52189. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52190. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52191. */
  52192. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52193. }
  52194. }
  52195. /**
  52196. * Defines the octree scene component responsible to manage any octrees
  52197. * in a given scene.
  52198. */
  52199. export class OctreeSceneComponent {
  52200. /**
  52201. * The component name help to identify the component in the list of scene components.
  52202. */
  52203. readonly name: string;
  52204. /**
  52205. * The scene the component belongs to.
  52206. */
  52207. scene: Scene;
  52208. /**
  52209. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52210. */
  52211. readonly checksIsEnabled: boolean;
  52212. /**
  52213. * Creates a new instance of the component for the given scene
  52214. * @param scene Defines the scene to register the component in
  52215. */
  52216. constructor(scene: Scene);
  52217. /**
  52218. * Registers the component in a given scene
  52219. */
  52220. register(): void;
  52221. /**
  52222. * Return the list of active meshes
  52223. * @returns the list of active meshes
  52224. */
  52225. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52226. /**
  52227. * Return the list of active sub meshes
  52228. * @param mesh The mesh to get the candidates sub meshes from
  52229. * @returns the list of active sub meshes
  52230. */
  52231. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52232. private _tempRay;
  52233. /**
  52234. * Return the list of sub meshes intersecting with a given local ray
  52235. * @param mesh defines the mesh to find the submesh for
  52236. * @param localRay defines the ray in local space
  52237. * @returns the list of intersecting sub meshes
  52238. */
  52239. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52240. /**
  52241. * Return the list of sub meshes colliding with a collider
  52242. * @param mesh defines the mesh to find the submesh for
  52243. * @param collider defines the collider to evaluate the collision against
  52244. * @returns the list of colliding sub meshes
  52245. */
  52246. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52247. /**
  52248. * Rebuilds the elements related to this component in case of
  52249. * context lost for instance.
  52250. */
  52251. rebuild(): void;
  52252. /**
  52253. * Disposes the component and the associated ressources.
  52254. */
  52255. dispose(): void;
  52256. }
  52257. }
  52258. declare module "babylonjs/Culling/Octrees/index" {
  52259. export * from "babylonjs/Culling/Octrees/octree";
  52260. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52261. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52262. }
  52263. declare module "babylonjs/Culling/index" {
  52264. export * from "babylonjs/Culling/boundingBox";
  52265. export * from "babylonjs/Culling/boundingInfo";
  52266. export * from "babylonjs/Culling/boundingSphere";
  52267. export * from "babylonjs/Culling/Octrees/index";
  52268. export * from "babylonjs/Culling/ray";
  52269. }
  52270. declare module "babylonjs/Gizmos/gizmo" {
  52271. import { Nullable } from "babylonjs/types";
  52272. import { IDisposable } from "babylonjs/scene";
  52273. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52274. import { Mesh } from "babylonjs/Meshes/mesh";
  52275. import { Node } from "babylonjs/node";
  52276. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52277. /**
  52278. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52279. */
  52280. export class Gizmo implements IDisposable {
  52281. /** The utility layer the gizmo will be added to */
  52282. gizmoLayer: UtilityLayerRenderer;
  52283. /**
  52284. * The root mesh of the gizmo
  52285. */
  52286. _rootMesh: Mesh;
  52287. private _attachedMesh;
  52288. private _attachedNode;
  52289. /**
  52290. * Ratio for the scale of the gizmo (Default: 1)
  52291. */
  52292. protected _scaleRatio: number;
  52293. /**
  52294. * Ratio for the scale of the gizmo (Default: 1)
  52295. */
  52296. set scaleRatio(value: number);
  52297. get scaleRatio(): number;
  52298. /**
  52299. * If a custom mesh has been set (Default: false)
  52300. */
  52301. protected _customMeshSet: boolean;
  52302. /**
  52303. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52304. * * When set, interactions will be enabled
  52305. */
  52306. get attachedMesh(): Nullable<AbstractMesh>;
  52307. set attachedMesh(value: Nullable<AbstractMesh>);
  52308. /**
  52309. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52310. * * When set, interactions will be enabled
  52311. */
  52312. get attachedNode(): Nullable<Node>;
  52313. set attachedNode(value: Nullable<Node>);
  52314. /**
  52315. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52316. * @param mesh The mesh to replace the default mesh of the gizmo
  52317. */
  52318. setCustomMesh(mesh: Mesh): void;
  52319. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52320. /**
  52321. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52322. */
  52323. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52324. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52325. /**
  52326. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52327. */
  52328. updateGizmoPositionToMatchAttachedMesh: boolean;
  52329. /**
  52330. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52331. */
  52332. updateScale: boolean;
  52333. protected _interactionsEnabled: boolean;
  52334. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52335. private _beforeRenderObserver;
  52336. private _tempQuaternion;
  52337. private _tempVector;
  52338. private _tempVector2;
  52339. private _tempMatrix1;
  52340. private _tempMatrix2;
  52341. private _rightHandtoLeftHandMatrix;
  52342. /**
  52343. * Creates a gizmo
  52344. * @param gizmoLayer The utility layer the gizmo will be added to
  52345. */
  52346. constructor(
  52347. /** The utility layer the gizmo will be added to */
  52348. gizmoLayer?: UtilityLayerRenderer);
  52349. /**
  52350. * Updates the gizmo to match the attached mesh's position/rotation
  52351. */
  52352. protected _update(): void;
  52353. /**
  52354. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52355. * @param value Node, TransformNode or mesh
  52356. */
  52357. protected _matrixChanged(): void;
  52358. /**
  52359. * Disposes of the gizmo
  52360. */
  52361. dispose(): void;
  52362. }
  52363. }
  52364. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52365. import { Observable } from "babylonjs/Misc/observable";
  52366. import { Nullable } from "babylonjs/types";
  52367. import { Vector3 } from "babylonjs/Maths/math.vector";
  52368. import { Color3 } from "babylonjs/Maths/math.color";
  52369. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52370. import { Node } from "babylonjs/node";
  52371. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52372. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52373. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52374. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52375. import { Scene } from "babylonjs/scene";
  52376. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52377. /**
  52378. * Single plane drag gizmo
  52379. */
  52380. export class PlaneDragGizmo extends Gizmo {
  52381. /**
  52382. * Drag behavior responsible for the gizmos dragging interactions
  52383. */
  52384. dragBehavior: PointerDragBehavior;
  52385. private _pointerObserver;
  52386. /**
  52387. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52388. */
  52389. snapDistance: number;
  52390. /**
  52391. * Event that fires each time the gizmo snaps to a new location.
  52392. * * snapDistance is the the change in distance
  52393. */
  52394. onSnapObservable: Observable<{
  52395. snapDistance: number;
  52396. }>;
  52397. private _plane;
  52398. private _coloredMaterial;
  52399. private _hoverMaterial;
  52400. private _isEnabled;
  52401. private _parent;
  52402. /** @hidden */
  52403. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52404. /** @hidden */
  52405. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52406. /**
  52407. * Creates a PlaneDragGizmo
  52408. * @param gizmoLayer The utility layer the gizmo will be added to
  52409. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52410. * @param color The color of the gizmo
  52411. */
  52412. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52413. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52414. /**
  52415. * If the gizmo is enabled
  52416. */
  52417. set isEnabled(value: boolean);
  52418. get isEnabled(): boolean;
  52419. /**
  52420. * Disposes of the gizmo
  52421. */
  52422. dispose(): void;
  52423. }
  52424. }
  52425. declare module "babylonjs/Gizmos/positionGizmo" {
  52426. import { Observable } from "babylonjs/Misc/observable";
  52427. import { Nullable } from "babylonjs/types";
  52428. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52429. import { Node } from "babylonjs/node";
  52430. import { Mesh } from "babylonjs/Meshes/mesh";
  52431. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52432. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52433. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52434. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52435. /**
  52436. * Gizmo that enables dragging a mesh along 3 axis
  52437. */
  52438. export class PositionGizmo extends Gizmo {
  52439. /**
  52440. * Internal gizmo used for interactions on the x axis
  52441. */
  52442. xGizmo: AxisDragGizmo;
  52443. /**
  52444. * Internal gizmo used for interactions on the y axis
  52445. */
  52446. yGizmo: AxisDragGizmo;
  52447. /**
  52448. * Internal gizmo used for interactions on the z axis
  52449. */
  52450. zGizmo: AxisDragGizmo;
  52451. /**
  52452. * Internal gizmo used for interactions on the yz plane
  52453. */
  52454. xPlaneGizmo: PlaneDragGizmo;
  52455. /**
  52456. * Internal gizmo used for interactions on the xz plane
  52457. */
  52458. yPlaneGizmo: PlaneDragGizmo;
  52459. /**
  52460. * Internal gizmo used for interactions on the xy plane
  52461. */
  52462. zPlaneGizmo: PlaneDragGizmo;
  52463. /**
  52464. * private variables
  52465. */
  52466. private _meshAttached;
  52467. private _nodeAttached;
  52468. private _snapDistance;
  52469. /** Fires an event when any of it's sub gizmos are dragged */
  52470. onDragStartObservable: Observable<unknown>;
  52471. /** Fires an event when any of it's sub gizmos are released from dragging */
  52472. onDragEndObservable: Observable<unknown>;
  52473. /**
  52474. * If set to true, planar drag is enabled
  52475. */
  52476. private _planarGizmoEnabled;
  52477. get attachedMesh(): Nullable<AbstractMesh>;
  52478. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52479. get attachedNode(): Nullable<Node>;
  52480. set attachedNode(node: Nullable<Node>);
  52481. /**
  52482. * Creates a PositionGizmo
  52483. * @param gizmoLayer The utility layer the gizmo will be added to
  52484. @param thickness display gizmo axis thickness
  52485. */
  52486. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52487. /**
  52488. * If the planar drag gizmo is enabled
  52489. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52490. */
  52491. set planarGizmoEnabled(value: boolean);
  52492. get planarGizmoEnabled(): boolean;
  52493. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52494. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52495. /**
  52496. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52497. */
  52498. set snapDistance(value: number);
  52499. get snapDistance(): number;
  52500. /**
  52501. * Ratio for the scale of the gizmo (Default: 1)
  52502. */
  52503. set scaleRatio(value: number);
  52504. get scaleRatio(): number;
  52505. /**
  52506. * Disposes of the gizmo
  52507. */
  52508. dispose(): void;
  52509. /**
  52510. * CustomMeshes are not supported by this gizmo
  52511. * @param mesh The mesh to replace the default mesh of the gizmo
  52512. */
  52513. setCustomMesh(mesh: Mesh): void;
  52514. }
  52515. }
  52516. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52517. import { Observable } from "babylonjs/Misc/observable";
  52518. import { Nullable } from "babylonjs/types";
  52519. import { Vector3 } from "babylonjs/Maths/math.vector";
  52520. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52521. import { Node } from "babylonjs/node";
  52522. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52523. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52524. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52525. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52526. import { Scene } from "babylonjs/scene";
  52527. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52528. import { Color3 } from "babylonjs/Maths/math.color";
  52529. /**
  52530. * Single axis drag gizmo
  52531. */
  52532. export class AxisDragGizmo extends Gizmo {
  52533. /**
  52534. * Drag behavior responsible for the gizmos dragging interactions
  52535. */
  52536. dragBehavior: PointerDragBehavior;
  52537. private _pointerObserver;
  52538. /**
  52539. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52540. */
  52541. snapDistance: number;
  52542. /**
  52543. * Event that fires each time the gizmo snaps to a new location.
  52544. * * snapDistance is the the change in distance
  52545. */
  52546. onSnapObservable: Observable<{
  52547. snapDistance: number;
  52548. }>;
  52549. private _isEnabled;
  52550. private _parent;
  52551. private _arrow;
  52552. private _coloredMaterial;
  52553. private _hoverMaterial;
  52554. /** @hidden */
  52555. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52556. /** @hidden */
  52557. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52558. /**
  52559. * Creates an AxisDragGizmo
  52560. * @param gizmoLayer The utility layer the gizmo will be added to
  52561. * @param dragAxis The axis which the gizmo will be able to drag on
  52562. * @param color The color of the gizmo
  52563. * @param thickness display gizmo axis thickness
  52564. */
  52565. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52566. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52567. /**
  52568. * If the gizmo is enabled
  52569. */
  52570. set isEnabled(value: boolean);
  52571. get isEnabled(): boolean;
  52572. /**
  52573. * Disposes of the gizmo
  52574. */
  52575. dispose(): void;
  52576. }
  52577. }
  52578. declare module "babylonjs/Debug/axesViewer" {
  52579. import { Vector3 } from "babylonjs/Maths/math.vector";
  52580. import { Nullable } from "babylonjs/types";
  52581. import { Scene } from "babylonjs/scene";
  52582. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52583. /**
  52584. * The Axes viewer will show 3 axes in a specific point in space
  52585. */
  52586. export class AxesViewer {
  52587. private _xAxis;
  52588. private _yAxis;
  52589. private _zAxis;
  52590. private _scaleLinesFactor;
  52591. private _instanced;
  52592. /**
  52593. * Gets the hosting scene
  52594. */
  52595. scene: Nullable<Scene>;
  52596. /**
  52597. * Gets or sets a number used to scale line length
  52598. */
  52599. scaleLines: number;
  52600. /** Gets the node hierarchy used to render x-axis */
  52601. get xAxis(): TransformNode;
  52602. /** Gets the node hierarchy used to render y-axis */
  52603. get yAxis(): TransformNode;
  52604. /** Gets the node hierarchy used to render z-axis */
  52605. get zAxis(): TransformNode;
  52606. /**
  52607. * Creates a new AxesViewer
  52608. * @param scene defines the hosting scene
  52609. * @param scaleLines defines a number used to scale line length (1 by default)
  52610. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52611. * @param xAxis defines the node hierarchy used to render the x-axis
  52612. * @param yAxis defines the node hierarchy used to render the y-axis
  52613. * @param zAxis defines the node hierarchy used to render the z-axis
  52614. */
  52615. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52616. /**
  52617. * Force the viewer to update
  52618. * @param position defines the position of the viewer
  52619. * @param xaxis defines the x axis of the viewer
  52620. * @param yaxis defines the y axis of the viewer
  52621. * @param zaxis defines the z axis of the viewer
  52622. */
  52623. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52624. /**
  52625. * Creates an instance of this axes viewer.
  52626. * @returns a new axes viewer with instanced meshes
  52627. */
  52628. createInstance(): AxesViewer;
  52629. /** Releases resources */
  52630. dispose(): void;
  52631. private static _SetRenderingGroupId;
  52632. }
  52633. }
  52634. declare module "babylonjs/Debug/boneAxesViewer" {
  52635. import { Nullable } from "babylonjs/types";
  52636. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52637. import { Vector3 } from "babylonjs/Maths/math.vector";
  52638. import { Mesh } from "babylonjs/Meshes/mesh";
  52639. import { Bone } from "babylonjs/Bones/bone";
  52640. import { Scene } from "babylonjs/scene";
  52641. /**
  52642. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52643. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52644. */
  52645. export class BoneAxesViewer extends AxesViewer {
  52646. /**
  52647. * Gets or sets the target mesh where to display the axes viewer
  52648. */
  52649. mesh: Nullable<Mesh>;
  52650. /**
  52651. * Gets or sets the target bone where to display the axes viewer
  52652. */
  52653. bone: Nullable<Bone>;
  52654. /** Gets current position */
  52655. pos: Vector3;
  52656. /** Gets direction of X axis */
  52657. xaxis: Vector3;
  52658. /** Gets direction of Y axis */
  52659. yaxis: Vector3;
  52660. /** Gets direction of Z axis */
  52661. zaxis: Vector3;
  52662. /**
  52663. * Creates a new BoneAxesViewer
  52664. * @param scene defines the hosting scene
  52665. * @param bone defines the target bone
  52666. * @param mesh defines the target mesh
  52667. * @param scaleLines defines a scaling factor for line length (1 by default)
  52668. */
  52669. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52670. /**
  52671. * Force the viewer to update
  52672. */
  52673. update(): void;
  52674. /** Releases resources */
  52675. dispose(): void;
  52676. }
  52677. }
  52678. declare module "babylonjs/Debug/debugLayer" {
  52679. import { Scene } from "babylonjs/scene";
  52680. /**
  52681. * Interface used to define scene explorer extensibility option
  52682. */
  52683. export interface IExplorerExtensibilityOption {
  52684. /**
  52685. * Define the option label
  52686. */
  52687. label: string;
  52688. /**
  52689. * Defines the action to execute on click
  52690. */
  52691. action: (entity: any) => void;
  52692. }
  52693. /**
  52694. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52695. */
  52696. export interface IExplorerExtensibilityGroup {
  52697. /**
  52698. * Defines a predicate to test if a given type mut be extended
  52699. */
  52700. predicate: (entity: any) => boolean;
  52701. /**
  52702. * Gets the list of options added to a type
  52703. */
  52704. entries: IExplorerExtensibilityOption[];
  52705. }
  52706. /**
  52707. * Interface used to define the options to use to create the Inspector
  52708. */
  52709. export interface IInspectorOptions {
  52710. /**
  52711. * Display in overlay mode (default: false)
  52712. */
  52713. overlay?: boolean;
  52714. /**
  52715. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52716. */
  52717. globalRoot?: HTMLElement;
  52718. /**
  52719. * Display the Scene explorer
  52720. */
  52721. showExplorer?: boolean;
  52722. /**
  52723. * Display the property inspector
  52724. */
  52725. showInspector?: boolean;
  52726. /**
  52727. * Display in embed mode (both panes on the right)
  52728. */
  52729. embedMode?: boolean;
  52730. /**
  52731. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52732. */
  52733. handleResize?: boolean;
  52734. /**
  52735. * Allow the panes to popup (default: true)
  52736. */
  52737. enablePopup?: boolean;
  52738. /**
  52739. * Allow the panes to be closed by users (default: true)
  52740. */
  52741. enableClose?: boolean;
  52742. /**
  52743. * Optional list of extensibility entries
  52744. */
  52745. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52746. /**
  52747. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52748. */
  52749. inspectorURL?: string;
  52750. /**
  52751. * Optional initial tab (default to DebugLayerTab.Properties)
  52752. */
  52753. initialTab?: DebugLayerTab;
  52754. }
  52755. module "babylonjs/scene" {
  52756. interface Scene {
  52757. /**
  52758. * @hidden
  52759. * Backing field
  52760. */
  52761. _debugLayer: DebugLayer;
  52762. /**
  52763. * Gets the debug layer (aka Inspector) associated with the scene
  52764. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52765. */
  52766. debugLayer: DebugLayer;
  52767. }
  52768. }
  52769. /**
  52770. * Enum of inspector action tab
  52771. */
  52772. export enum DebugLayerTab {
  52773. /**
  52774. * Properties tag (default)
  52775. */
  52776. Properties = 0,
  52777. /**
  52778. * Debug tab
  52779. */
  52780. Debug = 1,
  52781. /**
  52782. * Statistics tab
  52783. */
  52784. Statistics = 2,
  52785. /**
  52786. * Tools tab
  52787. */
  52788. Tools = 3,
  52789. /**
  52790. * Settings tab
  52791. */
  52792. Settings = 4
  52793. }
  52794. /**
  52795. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52796. * what is happening in your scene
  52797. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52798. */
  52799. export class DebugLayer {
  52800. /**
  52801. * Define the url to get the inspector script from.
  52802. * By default it uses the babylonjs CDN.
  52803. * @ignoreNaming
  52804. */
  52805. static InspectorURL: string;
  52806. private _scene;
  52807. private BJSINSPECTOR;
  52808. private _onPropertyChangedObservable?;
  52809. /**
  52810. * Observable triggered when a property is changed through the inspector.
  52811. */
  52812. get onPropertyChangedObservable(): any;
  52813. /**
  52814. * Instantiates a new debug layer.
  52815. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52816. * what is happening in your scene
  52817. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52818. * @param scene Defines the scene to inspect
  52819. */
  52820. constructor(scene: Scene);
  52821. /** Creates the inspector window. */
  52822. private _createInspector;
  52823. /**
  52824. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52825. * @param entity defines the entity to select
  52826. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52827. */
  52828. select(entity: any, lineContainerTitles?: string | string[]): void;
  52829. /** Get the inspector from bundle or global */
  52830. private _getGlobalInspector;
  52831. /**
  52832. * Get if the inspector is visible or not.
  52833. * @returns true if visible otherwise, false
  52834. */
  52835. isVisible(): boolean;
  52836. /**
  52837. * Hide the inspector and close its window.
  52838. */
  52839. hide(): void;
  52840. /**
  52841. * Update the scene in the inspector
  52842. */
  52843. setAsActiveScene(): void;
  52844. /**
  52845. * Launch the debugLayer.
  52846. * @param config Define the configuration of the inspector
  52847. * @return a promise fulfilled when the debug layer is visible
  52848. */
  52849. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52850. }
  52851. }
  52852. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52853. import { Nullable } from "babylonjs/types";
  52854. import { Scene } from "babylonjs/scene";
  52855. import { Vector4 } from "babylonjs/Maths/math.vector";
  52856. import { Color4 } from "babylonjs/Maths/math.color";
  52857. import { Mesh } from "babylonjs/Meshes/mesh";
  52858. /**
  52859. * Class containing static functions to help procedurally build meshes
  52860. */
  52861. export class BoxBuilder {
  52862. /**
  52863. * Creates a box mesh
  52864. * * The parameter `size` sets the size (float) of each box side (default 1)
  52865. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52866. * * 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)
  52867. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52868. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52869. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52870. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52871. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52872. * @param name defines the name of the mesh
  52873. * @param options defines the options used to create the mesh
  52874. * @param scene defines the hosting scene
  52875. * @returns the box mesh
  52876. */
  52877. static CreateBox(name: string, options: {
  52878. size?: number;
  52879. width?: number;
  52880. height?: number;
  52881. depth?: number;
  52882. faceUV?: Vector4[];
  52883. faceColors?: Color4[];
  52884. sideOrientation?: number;
  52885. frontUVs?: Vector4;
  52886. backUVs?: Vector4;
  52887. wrap?: boolean;
  52888. topBaseAt?: number;
  52889. bottomBaseAt?: number;
  52890. updatable?: boolean;
  52891. }, scene?: Nullable<Scene>): Mesh;
  52892. }
  52893. }
  52894. declare module "babylonjs/Debug/physicsViewer" {
  52895. import { Nullable } from "babylonjs/types";
  52896. import { Scene } from "babylonjs/scene";
  52897. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52898. import { Mesh } from "babylonjs/Meshes/mesh";
  52899. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52900. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52901. /**
  52902. * Used to show the physics impostor around the specific mesh
  52903. */
  52904. export class PhysicsViewer {
  52905. /** @hidden */
  52906. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52907. /** @hidden */
  52908. protected _meshes: Array<Nullable<AbstractMesh>>;
  52909. /** @hidden */
  52910. protected _scene: Nullable<Scene>;
  52911. /** @hidden */
  52912. protected _numMeshes: number;
  52913. /** @hidden */
  52914. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52915. private _renderFunction;
  52916. private _utilityLayer;
  52917. private _debugBoxMesh;
  52918. private _debugSphereMesh;
  52919. private _debugCylinderMesh;
  52920. private _debugMaterial;
  52921. private _debugMeshMeshes;
  52922. /**
  52923. * Creates a new PhysicsViewer
  52924. * @param scene defines the hosting scene
  52925. */
  52926. constructor(scene: Scene);
  52927. /** @hidden */
  52928. protected _updateDebugMeshes(): void;
  52929. /**
  52930. * Renders a specified physic impostor
  52931. * @param impostor defines the impostor to render
  52932. * @param targetMesh defines the mesh represented by the impostor
  52933. * @returns the new debug mesh used to render the impostor
  52934. */
  52935. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52936. /**
  52937. * Hides a specified physic impostor
  52938. * @param impostor defines the impostor to hide
  52939. */
  52940. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52941. private _getDebugMaterial;
  52942. private _getDebugBoxMesh;
  52943. private _getDebugSphereMesh;
  52944. private _getDebugCylinderMesh;
  52945. private _getDebugMeshMesh;
  52946. private _getDebugMesh;
  52947. /** Releases all resources */
  52948. dispose(): void;
  52949. }
  52950. }
  52951. declare module "babylonjs/Debug/rayHelper" {
  52952. import { Nullable } from "babylonjs/types";
  52953. import { Ray } from "babylonjs/Culling/ray";
  52954. import { Vector3 } from "babylonjs/Maths/math.vector";
  52955. import { Color3 } from "babylonjs/Maths/math.color";
  52956. import { Scene } from "babylonjs/scene";
  52957. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52958. import "babylonjs/Meshes/Builders/linesBuilder";
  52959. /**
  52960. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52961. * in order to better appreciate the issue one might have.
  52962. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52963. */
  52964. export class RayHelper {
  52965. /**
  52966. * Defines the ray we are currently tryin to visualize.
  52967. */
  52968. ray: Nullable<Ray>;
  52969. private _renderPoints;
  52970. private _renderLine;
  52971. private _renderFunction;
  52972. private _scene;
  52973. private _onAfterRenderObserver;
  52974. private _onAfterStepObserver;
  52975. private _attachedToMesh;
  52976. private _meshSpaceDirection;
  52977. private _meshSpaceOrigin;
  52978. /**
  52979. * Helper function to create a colored helper in a scene in one line.
  52980. * @param ray Defines the ray we are currently tryin to visualize
  52981. * @param scene Defines the scene the ray is used in
  52982. * @param color Defines the color we want to see the ray in
  52983. * @returns The newly created ray helper.
  52984. */
  52985. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52986. /**
  52987. * Instantiate a new ray helper.
  52988. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52989. * in order to better appreciate the issue one might have.
  52990. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52991. * @param ray Defines the ray we are currently tryin to visualize
  52992. */
  52993. constructor(ray: Ray);
  52994. /**
  52995. * Shows the ray we are willing to debug.
  52996. * @param scene Defines the scene the ray needs to be rendered in
  52997. * @param color Defines the color the ray needs to be rendered in
  52998. */
  52999. show(scene: Scene, color?: Color3): void;
  53000. /**
  53001. * Hides the ray we are debugging.
  53002. */
  53003. hide(): void;
  53004. private _render;
  53005. /**
  53006. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  53007. * @param mesh Defines the mesh we want the helper attached to
  53008. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  53009. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  53010. * @param length Defines the length of the ray
  53011. */
  53012. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  53013. /**
  53014. * Detach the ray helper from the mesh it has previously been attached to.
  53015. */
  53016. detachFromMesh(): void;
  53017. private _updateToMesh;
  53018. /**
  53019. * Dispose the helper and release its associated resources.
  53020. */
  53021. dispose(): void;
  53022. }
  53023. }
  53024. declare module "babylonjs/Debug/ISkeletonViewer" {
  53025. /**
  53026. * Defines the options associated with the creation of a SkeletonViewer.
  53027. */
  53028. export interface ISkeletonViewerOptions {
  53029. /** Should the system pause animations before building the Viewer? */
  53030. pauseAnimations: boolean;
  53031. /** Should the system return the skeleton to rest before building? */
  53032. returnToRest: boolean;
  53033. /** public Display Mode of the Viewer */
  53034. displayMode: number;
  53035. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53036. displayOptions: ISkeletonViewerDisplayOptions;
  53037. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53038. computeBonesUsingShaders: boolean;
  53039. }
  53040. /**
  53041. * Defines how to display the various bone meshes for the viewer.
  53042. */
  53043. export interface ISkeletonViewerDisplayOptions {
  53044. /** How far down to start tapering the bone spurs */
  53045. midStep?: number;
  53046. /** How big is the midStep? */
  53047. midStepFactor?: number;
  53048. /** Base for the Sphere Size */
  53049. sphereBaseSize?: number;
  53050. /** The ratio of the sphere to the longest bone in units */
  53051. sphereScaleUnit?: number;
  53052. /** Ratio for the Sphere Size */
  53053. sphereFactor?: number;
  53054. }
  53055. }
  53056. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53057. import { Nullable } from "babylonjs/types";
  53058. import { Scene } from "babylonjs/scene";
  53059. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53060. import { Color4 } from "babylonjs/Maths/math.color";
  53061. import { Mesh } from "babylonjs/Meshes/mesh";
  53062. /**
  53063. * Class containing static functions to help procedurally build meshes
  53064. */
  53065. export class RibbonBuilder {
  53066. /**
  53067. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53068. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53069. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53070. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53071. * * 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
  53072. * * 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
  53073. * * 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
  53074. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53075. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53076. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53077. * * 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
  53078. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53079. * * 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
  53080. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53081. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53082. * @param name defines the name of the mesh
  53083. * @param options defines the options used to create the mesh
  53084. * @param scene defines the hosting scene
  53085. * @returns the ribbon mesh
  53086. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53087. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53088. */
  53089. static CreateRibbon(name: string, options: {
  53090. pathArray: Vector3[][];
  53091. closeArray?: boolean;
  53092. closePath?: boolean;
  53093. offset?: number;
  53094. updatable?: boolean;
  53095. sideOrientation?: number;
  53096. frontUVs?: Vector4;
  53097. backUVs?: Vector4;
  53098. instance?: Mesh;
  53099. invertUV?: boolean;
  53100. uvs?: Vector2[];
  53101. colors?: Color4[];
  53102. }, scene?: Nullable<Scene>): Mesh;
  53103. }
  53104. }
  53105. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53106. import { Nullable } from "babylonjs/types";
  53107. import { Scene } from "babylonjs/scene";
  53108. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53109. import { Mesh } from "babylonjs/Meshes/mesh";
  53110. /**
  53111. * Class containing static functions to help procedurally build meshes
  53112. */
  53113. export class ShapeBuilder {
  53114. /**
  53115. * 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.
  53116. * * 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.
  53117. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53118. * * 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.
  53119. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53120. * * 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
  53121. * * 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
  53122. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53123. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53124. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53125. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53126. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53127. * @param name defines the name of the mesh
  53128. * @param options defines the options used to create the mesh
  53129. * @param scene defines the hosting scene
  53130. * @returns the extruded shape mesh
  53131. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53132. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53133. */
  53134. static ExtrudeShape(name: string, options: {
  53135. shape: Vector3[];
  53136. path: Vector3[];
  53137. scale?: number;
  53138. rotation?: number;
  53139. cap?: number;
  53140. updatable?: boolean;
  53141. sideOrientation?: number;
  53142. frontUVs?: Vector4;
  53143. backUVs?: Vector4;
  53144. instance?: Mesh;
  53145. invertUV?: boolean;
  53146. }, scene?: Nullable<Scene>): Mesh;
  53147. /**
  53148. * Creates an custom extruded shape mesh.
  53149. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53150. * * 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.
  53151. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53152. * * 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
  53153. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53154. * * 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
  53155. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53156. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53157. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53158. * * 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
  53159. * * 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
  53160. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53161. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53162. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53163. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53164. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53165. * @param name defines the name of the mesh
  53166. * @param options defines the options used to create the mesh
  53167. * @param scene defines the hosting scene
  53168. * @returns the custom extruded shape mesh
  53169. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53170. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53171. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53172. */
  53173. static ExtrudeShapeCustom(name: string, options: {
  53174. shape: Vector3[];
  53175. path: Vector3[];
  53176. scaleFunction?: any;
  53177. rotationFunction?: any;
  53178. ribbonCloseArray?: boolean;
  53179. ribbonClosePath?: boolean;
  53180. cap?: number;
  53181. updatable?: boolean;
  53182. sideOrientation?: number;
  53183. frontUVs?: Vector4;
  53184. backUVs?: Vector4;
  53185. instance?: Mesh;
  53186. invertUV?: boolean;
  53187. }, scene?: Nullable<Scene>): Mesh;
  53188. private static _ExtrudeShapeGeneric;
  53189. }
  53190. }
  53191. declare module "babylonjs/Debug/skeletonViewer" {
  53192. import { Color3 } from "babylonjs/Maths/math.color";
  53193. import { Scene } from "babylonjs/scene";
  53194. import { Nullable } from "babylonjs/types";
  53195. import { Skeleton } from "babylonjs/Bones/skeleton";
  53196. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53197. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53198. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53199. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53200. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53201. /**
  53202. * Class used to render a debug view of a given skeleton
  53203. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53204. */
  53205. export class SkeletonViewer {
  53206. /** defines the skeleton to render */
  53207. skeleton: Skeleton;
  53208. /** defines the mesh attached to the skeleton */
  53209. mesh: AbstractMesh;
  53210. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53211. autoUpdateBonesMatrices: boolean;
  53212. /** defines the rendering group id to use with the viewer */
  53213. renderingGroupId: number;
  53214. /** is the options for the viewer */
  53215. options: Partial<ISkeletonViewerOptions>;
  53216. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53217. static readonly DISPLAY_LINES: number;
  53218. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53219. static readonly DISPLAY_SPHERES: number;
  53220. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53221. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53222. /** If SkeletonViewer scene scope. */
  53223. private _scene;
  53224. /** Gets or sets the color used to render the skeleton */
  53225. color: Color3;
  53226. /** Array of the points of the skeleton fo the line view. */
  53227. private _debugLines;
  53228. /** The SkeletonViewers Mesh. */
  53229. private _debugMesh;
  53230. /** If SkeletonViewer is enabled. */
  53231. private _isEnabled;
  53232. /** If SkeletonViewer is ready. */
  53233. private _ready;
  53234. /** SkeletonViewer render observable. */
  53235. private _obs;
  53236. /** The Utility Layer to render the gizmos in. */
  53237. private _utilityLayer;
  53238. private _boneIndices;
  53239. /** Gets the Scene. */
  53240. get scene(): Scene;
  53241. /** Gets the utilityLayer. */
  53242. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53243. /** Checks Ready Status. */
  53244. get isReady(): Boolean;
  53245. /** Sets Ready Status. */
  53246. set ready(value: boolean);
  53247. /** Gets the debugMesh */
  53248. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53249. /** Sets the debugMesh */
  53250. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53251. /** Gets the material */
  53252. get material(): StandardMaterial;
  53253. /** Sets the material */
  53254. set material(value: StandardMaterial);
  53255. /** Gets the material */
  53256. get displayMode(): number;
  53257. /** Sets the material */
  53258. set displayMode(value: number);
  53259. /**
  53260. * Creates a new SkeletonViewer
  53261. * @param skeleton defines the skeleton to render
  53262. * @param mesh defines the mesh attached to the skeleton
  53263. * @param scene defines the hosting scene
  53264. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53265. * @param renderingGroupId defines the rendering group id to use with the viewer
  53266. * @param options All of the extra constructor options for the SkeletonViewer
  53267. */
  53268. constructor(
  53269. /** defines the skeleton to render */
  53270. skeleton: Skeleton,
  53271. /** defines the mesh attached to the skeleton */
  53272. mesh: AbstractMesh,
  53273. /** The Scene scope*/
  53274. scene: Scene,
  53275. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53276. autoUpdateBonesMatrices?: boolean,
  53277. /** defines the rendering group id to use with the viewer */
  53278. renderingGroupId?: number,
  53279. /** is the options for the viewer */
  53280. options?: Partial<ISkeletonViewerOptions>);
  53281. /** The Dynamic bindings for the update functions */
  53282. private _bindObs;
  53283. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53284. update(): void;
  53285. /** Gets or sets a boolean indicating if the viewer is enabled */
  53286. set isEnabled(value: boolean);
  53287. get isEnabled(): boolean;
  53288. private _getBonePosition;
  53289. private _getLinesForBonesWithLength;
  53290. private _getLinesForBonesNoLength;
  53291. /** function to revert the mesh and scene back to the initial state. */
  53292. private _revert;
  53293. /** function to build and bind sphere joint points and spur bone representations. */
  53294. private _buildSpheresAndSpurs;
  53295. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53296. private _displayLinesUpdate;
  53297. /** Changes the displayMode of the skeleton viewer
  53298. * @param mode The displayMode numerical value
  53299. */
  53300. changeDisplayMode(mode: number): void;
  53301. /** Changes the displayMode of the skeleton viewer
  53302. * @param option String of the option name
  53303. * @param value The numerical option value
  53304. */
  53305. changeDisplayOptions(option: string, value: number): void;
  53306. /** Release associated resources */
  53307. dispose(): void;
  53308. }
  53309. }
  53310. declare module "babylonjs/Debug/index" {
  53311. export * from "babylonjs/Debug/axesViewer";
  53312. export * from "babylonjs/Debug/boneAxesViewer";
  53313. export * from "babylonjs/Debug/debugLayer";
  53314. export * from "babylonjs/Debug/physicsViewer";
  53315. export * from "babylonjs/Debug/rayHelper";
  53316. export * from "babylonjs/Debug/skeletonViewer";
  53317. export * from "babylonjs/Debug/ISkeletonViewer";
  53318. }
  53319. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53320. /**
  53321. * Enum for Device Types
  53322. */
  53323. export enum DeviceType {
  53324. /** Generic */
  53325. Generic = 0,
  53326. /** Keyboard */
  53327. Keyboard = 1,
  53328. /** Mouse */
  53329. Mouse = 2,
  53330. /** Touch Pointers */
  53331. Touch = 3,
  53332. /** PS4 Dual Shock */
  53333. DualShock = 4,
  53334. /** Xbox */
  53335. Xbox = 5,
  53336. /** Switch Controller */
  53337. Switch = 6
  53338. }
  53339. /**
  53340. * Enum for All Pointers (Touch/Mouse)
  53341. */
  53342. export enum PointerInput {
  53343. /** Horizontal Axis */
  53344. Horizontal = 0,
  53345. /** Vertical Axis */
  53346. Vertical = 1,
  53347. /** Left Click or Touch */
  53348. LeftClick = 2,
  53349. /** Middle Click */
  53350. MiddleClick = 3,
  53351. /** Right Click */
  53352. RightClick = 4,
  53353. /** Browser Back */
  53354. BrowserBack = 5,
  53355. /** Browser Forward */
  53356. BrowserForward = 6
  53357. }
  53358. /**
  53359. * Enum for Dual Shock Gamepad
  53360. */
  53361. export enum DualShockInput {
  53362. /** Cross */
  53363. Cross = 0,
  53364. /** Circle */
  53365. Circle = 1,
  53366. /** Square */
  53367. Square = 2,
  53368. /** Triangle */
  53369. Triangle = 3,
  53370. /** L1 */
  53371. L1 = 4,
  53372. /** R1 */
  53373. R1 = 5,
  53374. /** L2 */
  53375. L2 = 6,
  53376. /** R2 */
  53377. R2 = 7,
  53378. /** Share */
  53379. Share = 8,
  53380. /** Options */
  53381. Options = 9,
  53382. /** L3 */
  53383. L3 = 10,
  53384. /** R3 */
  53385. R3 = 11,
  53386. /** DPadUp */
  53387. DPadUp = 12,
  53388. /** DPadDown */
  53389. DPadDown = 13,
  53390. /** DPadLeft */
  53391. DPadLeft = 14,
  53392. /** DRight */
  53393. DPadRight = 15,
  53394. /** Home */
  53395. Home = 16,
  53396. /** TouchPad */
  53397. TouchPad = 17,
  53398. /** LStickXAxis */
  53399. LStickXAxis = 18,
  53400. /** LStickYAxis */
  53401. LStickYAxis = 19,
  53402. /** RStickXAxis */
  53403. RStickXAxis = 20,
  53404. /** RStickYAxis */
  53405. RStickYAxis = 21
  53406. }
  53407. /**
  53408. * Enum for Xbox Gamepad
  53409. */
  53410. export enum XboxInput {
  53411. /** A */
  53412. A = 0,
  53413. /** B */
  53414. B = 1,
  53415. /** X */
  53416. X = 2,
  53417. /** Y */
  53418. Y = 3,
  53419. /** LB */
  53420. LB = 4,
  53421. /** RB */
  53422. RB = 5,
  53423. /** LT */
  53424. LT = 6,
  53425. /** RT */
  53426. RT = 7,
  53427. /** Back */
  53428. Back = 8,
  53429. /** Start */
  53430. Start = 9,
  53431. /** LS */
  53432. LS = 10,
  53433. /** RS */
  53434. RS = 11,
  53435. /** DPadUp */
  53436. DPadUp = 12,
  53437. /** DPadDown */
  53438. DPadDown = 13,
  53439. /** DPadLeft */
  53440. DPadLeft = 14,
  53441. /** DRight */
  53442. DPadRight = 15,
  53443. /** Home */
  53444. Home = 16,
  53445. /** LStickXAxis */
  53446. LStickXAxis = 17,
  53447. /** LStickYAxis */
  53448. LStickYAxis = 18,
  53449. /** RStickXAxis */
  53450. RStickXAxis = 19,
  53451. /** RStickYAxis */
  53452. RStickYAxis = 20
  53453. }
  53454. /**
  53455. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53456. */
  53457. export enum SwitchInput {
  53458. /** B */
  53459. B = 0,
  53460. /** A */
  53461. A = 1,
  53462. /** Y */
  53463. Y = 2,
  53464. /** X */
  53465. X = 3,
  53466. /** L */
  53467. L = 4,
  53468. /** R */
  53469. R = 5,
  53470. /** ZL */
  53471. ZL = 6,
  53472. /** ZR */
  53473. ZR = 7,
  53474. /** Minus */
  53475. Minus = 8,
  53476. /** Plus */
  53477. Plus = 9,
  53478. /** LS */
  53479. LS = 10,
  53480. /** RS */
  53481. RS = 11,
  53482. /** DPadUp */
  53483. DPadUp = 12,
  53484. /** DPadDown */
  53485. DPadDown = 13,
  53486. /** DPadLeft */
  53487. DPadLeft = 14,
  53488. /** DRight */
  53489. DPadRight = 15,
  53490. /** Home */
  53491. Home = 16,
  53492. /** Capture */
  53493. Capture = 17,
  53494. /** LStickXAxis */
  53495. LStickXAxis = 18,
  53496. /** LStickYAxis */
  53497. LStickYAxis = 19,
  53498. /** RStickXAxis */
  53499. RStickXAxis = 20,
  53500. /** RStickYAxis */
  53501. RStickYAxis = 21
  53502. }
  53503. }
  53504. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53505. import { Engine } from "babylonjs/Engines/engine";
  53506. import { IDisposable } from "babylonjs/scene";
  53507. import { Nullable } from "babylonjs/types";
  53508. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53509. /**
  53510. * This class will take all inputs from Keyboard, Pointer, and
  53511. * any Gamepads and provide a polling system that all devices
  53512. * will use. This class assumes that there will only be one
  53513. * pointer device and one keyboard.
  53514. */
  53515. export class DeviceInputSystem implements IDisposable {
  53516. /**
  53517. * Callback to be triggered when a device is connected
  53518. */
  53519. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53520. /**
  53521. * Callback to be triggered when a device is disconnected
  53522. */
  53523. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53524. /**
  53525. * Callback to be triggered when event driven input is updated
  53526. */
  53527. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53528. private _inputs;
  53529. private _gamepads;
  53530. private _keyboardActive;
  53531. private _pointerActive;
  53532. private _elementToAttachTo;
  53533. private _keyboardDownEvent;
  53534. private _keyboardUpEvent;
  53535. private _pointerMoveEvent;
  53536. private _pointerDownEvent;
  53537. private _pointerUpEvent;
  53538. private _gamepadConnectedEvent;
  53539. private _gamepadDisconnectedEvent;
  53540. private static _MAX_KEYCODES;
  53541. private static _MAX_POINTER_INPUTS;
  53542. private constructor();
  53543. /**
  53544. * Creates a new DeviceInputSystem instance
  53545. * @param engine Engine to pull input element from
  53546. * @returns The new instance
  53547. */
  53548. static Create(engine: Engine): DeviceInputSystem;
  53549. /**
  53550. * Checks for current device input value, given an id and input index
  53551. * @param deviceName Id of connected device
  53552. * @param inputIndex Index of device input
  53553. * @returns Current value of input
  53554. */
  53555. /**
  53556. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53557. * @param deviceType Enum specifiying device type
  53558. * @param deviceSlot "Slot" or index that device is referenced in
  53559. * @param inputIndex Id of input to be checked
  53560. * @returns Current value of input
  53561. */
  53562. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53563. /**
  53564. * Dispose of all the eventlisteners
  53565. */
  53566. dispose(): void;
  53567. /**
  53568. * Add device and inputs to device array
  53569. * @param deviceType Enum specifiying device type
  53570. * @param deviceSlot "Slot" or index that device is referenced in
  53571. * @param numberOfInputs Number of input entries to create for given device
  53572. */
  53573. private _registerDevice;
  53574. /**
  53575. * Given a specific device name, remove that device from the device map
  53576. * @param deviceType Enum specifiying device type
  53577. * @param deviceSlot "Slot" or index that device is referenced in
  53578. */
  53579. private _unregisterDevice;
  53580. /**
  53581. * Handle all actions that come from keyboard interaction
  53582. */
  53583. private _handleKeyActions;
  53584. /**
  53585. * Handle all actions that come from pointer interaction
  53586. */
  53587. private _handlePointerActions;
  53588. /**
  53589. * Handle all actions that come from gamepad interaction
  53590. */
  53591. private _handleGamepadActions;
  53592. /**
  53593. * Update all non-event based devices with each frame
  53594. * @param deviceType Enum specifiying device type
  53595. * @param deviceSlot "Slot" or index that device is referenced in
  53596. * @param inputIndex Id of input to be checked
  53597. */
  53598. private _updateDevice;
  53599. /**
  53600. * Gets DeviceType from the device name
  53601. * @param deviceName Name of Device from DeviceInputSystem
  53602. * @returns DeviceType enum value
  53603. */
  53604. private _getGamepadDeviceType;
  53605. }
  53606. }
  53607. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53608. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53609. /**
  53610. * Type to handle enforcement of inputs
  53611. */
  53612. 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;
  53613. }
  53614. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53615. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53616. import { Engine } from "babylonjs/Engines/engine";
  53617. import { IDisposable } from "babylonjs/scene";
  53618. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53619. import { Nullable } from "babylonjs/types";
  53620. import { Observable } from "babylonjs/Misc/observable";
  53621. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53622. /**
  53623. * Class that handles all input for a specific device
  53624. */
  53625. export class DeviceSource<T extends DeviceType> {
  53626. /** Type of device */
  53627. readonly deviceType: DeviceType;
  53628. /** "Slot" or index that device is referenced in */
  53629. readonly deviceSlot: number;
  53630. /**
  53631. * Observable to handle device input changes per device
  53632. */
  53633. readonly onInputChangedObservable: Observable<{
  53634. inputIndex: DeviceInput<T>;
  53635. previousState: Nullable<number>;
  53636. currentState: Nullable<number>;
  53637. }>;
  53638. private readonly _deviceInputSystem;
  53639. /**
  53640. * Default Constructor
  53641. * @param deviceInputSystem Reference to DeviceInputSystem
  53642. * @param deviceType Type of device
  53643. * @param deviceSlot "Slot" or index that device is referenced in
  53644. */
  53645. constructor(deviceInputSystem: DeviceInputSystem,
  53646. /** Type of device */
  53647. deviceType: DeviceType,
  53648. /** "Slot" or index that device is referenced in */
  53649. deviceSlot?: number);
  53650. /**
  53651. * Get input for specific input
  53652. * @param inputIndex index of specific input on device
  53653. * @returns Input value from DeviceInputSystem
  53654. */
  53655. getInput(inputIndex: DeviceInput<T>): number;
  53656. }
  53657. /**
  53658. * Class to keep track of devices
  53659. */
  53660. export class DeviceSourceManager implements IDisposable {
  53661. /**
  53662. * Observable to be triggered when before a device is connected
  53663. */
  53664. readonly onBeforeDeviceConnectedObservable: Observable<{
  53665. deviceType: DeviceType;
  53666. deviceSlot: number;
  53667. }>;
  53668. /**
  53669. * Observable to be triggered when before a device is disconnected
  53670. */
  53671. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53672. deviceType: DeviceType;
  53673. deviceSlot: number;
  53674. }>;
  53675. /**
  53676. * Observable to be triggered when after a device is connected
  53677. */
  53678. readonly onAfterDeviceConnectedObservable: Observable<{
  53679. deviceType: DeviceType;
  53680. deviceSlot: number;
  53681. }>;
  53682. /**
  53683. * Observable to be triggered when after a device is disconnected
  53684. */
  53685. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53686. deviceType: DeviceType;
  53687. deviceSlot: number;
  53688. }>;
  53689. private readonly _devices;
  53690. private readonly _firstDevice;
  53691. private readonly _deviceInputSystem;
  53692. /**
  53693. * Default Constructor
  53694. * @param engine engine to pull input element from
  53695. */
  53696. constructor(engine: Engine);
  53697. /**
  53698. * Gets a DeviceSource, given a type and slot
  53699. * @param deviceType Enum specifying device type
  53700. * @param deviceSlot "Slot" or index that device is referenced in
  53701. * @returns DeviceSource object
  53702. */
  53703. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53704. /**
  53705. * Gets an array of DeviceSource objects for a given device type
  53706. * @param deviceType Enum specifying device type
  53707. * @returns Array of DeviceSource objects
  53708. */
  53709. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53710. /**
  53711. * Dispose of DeviceInputSystem and other parts
  53712. */
  53713. dispose(): void;
  53714. /**
  53715. * Function to add device name to device list
  53716. * @param deviceType Enum specifying device type
  53717. * @param deviceSlot "Slot" or index that device is referenced in
  53718. */
  53719. private _addDevice;
  53720. /**
  53721. * Function to remove device name to device list
  53722. * @param deviceType Enum specifying device type
  53723. * @param deviceSlot "Slot" or index that device is referenced in
  53724. */
  53725. private _removeDevice;
  53726. /**
  53727. * Updates array storing first connected device of each type
  53728. * @param type Type of Device
  53729. */
  53730. private _updateFirstDevices;
  53731. }
  53732. }
  53733. declare module "babylonjs/DeviceInput/index" {
  53734. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53735. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53736. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53737. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53738. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53739. }
  53740. declare module "babylonjs/Engines/nullEngine" {
  53741. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53742. import { Engine } from "babylonjs/Engines/engine";
  53743. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53744. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53745. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53746. import { Effect } from "babylonjs/Materials/effect";
  53747. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53748. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53749. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53750. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53751. /**
  53752. * Options to create the null engine
  53753. */
  53754. export class NullEngineOptions {
  53755. /**
  53756. * Render width (Default: 512)
  53757. */
  53758. renderWidth: number;
  53759. /**
  53760. * Render height (Default: 256)
  53761. */
  53762. renderHeight: number;
  53763. /**
  53764. * Texture size (Default: 512)
  53765. */
  53766. textureSize: number;
  53767. /**
  53768. * If delta time between frames should be constant
  53769. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53770. */
  53771. deterministicLockstep: boolean;
  53772. /**
  53773. * Maximum about of steps between frames (Default: 4)
  53774. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53775. */
  53776. lockstepMaxSteps: number;
  53777. /**
  53778. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53779. */
  53780. useHighPrecisionMatrix?: boolean;
  53781. }
  53782. /**
  53783. * The null engine class provides support for headless version of babylon.js.
  53784. * This can be used in server side scenario or for testing purposes
  53785. */
  53786. export class NullEngine extends Engine {
  53787. private _options;
  53788. /**
  53789. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53790. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53791. * @returns true if engine is in deterministic lock step mode
  53792. */
  53793. isDeterministicLockStep(): boolean;
  53794. /**
  53795. * Gets the max steps when engine is running in deterministic lock step
  53796. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53797. * @returns the max steps
  53798. */
  53799. getLockstepMaxSteps(): number;
  53800. /**
  53801. * Gets the current hardware scaling level.
  53802. * By default the hardware scaling level is computed from the window device ratio.
  53803. * 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.
  53804. * @returns a number indicating the current hardware scaling level
  53805. */
  53806. getHardwareScalingLevel(): number;
  53807. constructor(options?: NullEngineOptions);
  53808. /**
  53809. * Creates a vertex buffer
  53810. * @param vertices the data for the vertex buffer
  53811. * @returns the new WebGL static buffer
  53812. */
  53813. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53814. /**
  53815. * Creates a new index buffer
  53816. * @param indices defines the content of the index buffer
  53817. * @param updatable defines if the index buffer must be updatable
  53818. * @returns a new webGL buffer
  53819. */
  53820. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53821. /**
  53822. * Clear the current render buffer or the current render target (if any is set up)
  53823. * @param color defines the color to use
  53824. * @param backBuffer defines if the back buffer must be cleared
  53825. * @param depth defines if the depth buffer must be cleared
  53826. * @param stencil defines if the stencil buffer must be cleared
  53827. */
  53828. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53829. /**
  53830. * Gets the current render width
  53831. * @param useScreen defines if screen size must be used (or the current render target if any)
  53832. * @returns a number defining the current render width
  53833. */
  53834. getRenderWidth(useScreen?: boolean): number;
  53835. /**
  53836. * Gets the current render height
  53837. * @param useScreen defines if screen size must be used (or the current render target if any)
  53838. * @returns a number defining the current render height
  53839. */
  53840. getRenderHeight(useScreen?: boolean): number;
  53841. /**
  53842. * Set the WebGL's viewport
  53843. * @param viewport defines the viewport element to be used
  53844. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53845. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53846. */
  53847. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53848. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53849. /**
  53850. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53851. * @param pipelineContext defines the pipeline context to use
  53852. * @param uniformsNames defines the list of uniform names
  53853. * @returns an array of webGL uniform locations
  53854. */
  53855. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53856. /**
  53857. * Gets the lsit of active attributes for a given webGL program
  53858. * @param pipelineContext defines the pipeline context to use
  53859. * @param attributesNames defines the list of attribute names to get
  53860. * @returns an array of indices indicating the offset of each attribute
  53861. */
  53862. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53863. /**
  53864. * Binds an effect to the webGL context
  53865. * @param effect defines the effect to bind
  53866. */
  53867. bindSamplers(effect: Effect): void;
  53868. /**
  53869. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53870. * @param effect defines the effect to activate
  53871. */
  53872. enableEffect(effect: Effect): void;
  53873. /**
  53874. * Set various states to the webGL context
  53875. * @param culling defines backface culling state
  53876. * @param zOffset defines the value to apply to zOffset (0 by default)
  53877. * @param force defines if states must be applied even if cache is up to date
  53878. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53879. */
  53880. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53881. /**
  53882. * Set the value of an uniform to an array of int32
  53883. * @param uniform defines the webGL uniform location where to store the value
  53884. * @param array defines the array of int32 to store
  53885. */
  53886. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53887. /**
  53888. * Set the value of an uniform to an array of int32 (stored as vec2)
  53889. * @param uniform defines the webGL uniform location where to store the value
  53890. * @param array defines the array of int32 to store
  53891. */
  53892. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53893. /**
  53894. * Set the value of an uniform to an array of int32 (stored as vec3)
  53895. * @param uniform defines the webGL uniform location where to store the value
  53896. * @param array defines the array of int32 to store
  53897. */
  53898. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53899. /**
  53900. * Set the value of an uniform to an array of int32 (stored as vec4)
  53901. * @param uniform defines the webGL uniform location where to store the value
  53902. * @param array defines the array of int32 to store
  53903. */
  53904. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53905. /**
  53906. * Set the value of an uniform to an array of float32
  53907. * @param uniform defines the webGL uniform location where to store the value
  53908. * @param array defines the array of float32 to store
  53909. */
  53910. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53911. /**
  53912. * Set the value of an uniform to an array of float32 (stored as vec2)
  53913. * @param uniform defines the webGL uniform location where to store the value
  53914. * @param array defines the array of float32 to store
  53915. */
  53916. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53917. /**
  53918. * Set the value of an uniform to an array of float32 (stored as vec3)
  53919. * @param uniform defines the webGL uniform location where to store the value
  53920. * @param array defines the array of float32 to store
  53921. */
  53922. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53923. /**
  53924. * Set the value of an uniform to an array of float32 (stored as vec4)
  53925. * @param uniform defines the webGL uniform location where to store the value
  53926. * @param array defines the array of float32 to store
  53927. */
  53928. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53929. /**
  53930. * Set the value of an uniform to an array of number
  53931. * @param uniform defines the webGL uniform location where to store the value
  53932. * @param array defines the array of number to store
  53933. */
  53934. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53935. /**
  53936. * Set the value of an uniform to an array of number (stored as vec2)
  53937. * @param uniform defines the webGL uniform location where to store the value
  53938. * @param array defines the array of number to store
  53939. */
  53940. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53941. /**
  53942. * Set the value of an uniform to an array of number (stored as vec3)
  53943. * @param uniform defines the webGL uniform location where to store the value
  53944. * @param array defines the array of number to store
  53945. */
  53946. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53947. /**
  53948. * Set the value of an uniform to an array of number (stored as vec4)
  53949. * @param uniform defines the webGL uniform location where to store the value
  53950. * @param array defines the array of number to store
  53951. */
  53952. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53953. /**
  53954. * Set the value of an uniform to an array of float32 (stored as matrices)
  53955. * @param uniform defines the webGL uniform location where to store the value
  53956. * @param matrices defines the array of float32 to store
  53957. */
  53958. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53959. /**
  53960. * Set the value of an uniform to a matrix (3x3)
  53961. * @param uniform defines the webGL uniform location where to store the value
  53962. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53963. */
  53964. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53965. /**
  53966. * Set the value of an uniform to a matrix (2x2)
  53967. * @param uniform defines the webGL uniform location where to store the value
  53968. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53969. */
  53970. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53971. /**
  53972. * Set the value of an uniform to a number (float)
  53973. * @param uniform defines the webGL uniform location where to store the value
  53974. * @param value defines the float number to store
  53975. */
  53976. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53977. /**
  53978. * Set the value of an uniform to a vec2
  53979. * @param uniform defines the webGL uniform location where to store the value
  53980. * @param x defines the 1st component of the value
  53981. * @param y defines the 2nd component of the value
  53982. */
  53983. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53984. /**
  53985. * Set the value of an uniform to a vec3
  53986. * @param uniform defines the webGL uniform location where to store the value
  53987. * @param x defines the 1st component of the value
  53988. * @param y defines the 2nd component of the value
  53989. * @param z defines the 3rd component of the value
  53990. */
  53991. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53992. /**
  53993. * Set the value of an uniform to a boolean
  53994. * @param uniform defines the webGL uniform location where to store the value
  53995. * @param bool defines the boolean to store
  53996. */
  53997. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53998. /**
  53999. * Set the value of an uniform to a vec4
  54000. * @param uniform defines the webGL uniform location where to store the value
  54001. * @param x defines the 1st component of the value
  54002. * @param y defines the 2nd component of the value
  54003. * @param z defines the 3rd component of the value
  54004. * @param w defines the 4th component of the value
  54005. */
  54006. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54007. /**
  54008. * Sets the current alpha mode
  54009. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  54010. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54011. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54012. */
  54013. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54014. /**
  54015. * Bind webGl buffers directly to the webGL context
  54016. * @param vertexBuffers defines the vertex buffer to bind
  54017. * @param indexBuffer defines the index buffer to bind
  54018. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54019. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54020. * @param effect defines the effect associated with the vertex buffer
  54021. */
  54022. bindBuffers(vertexBuffers: {
  54023. [key: string]: VertexBuffer;
  54024. }, indexBuffer: DataBuffer, effect: Effect): void;
  54025. /**
  54026. * Force the entire cache to be cleared
  54027. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54028. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54029. */
  54030. wipeCaches(bruteForce?: boolean): void;
  54031. /**
  54032. * Send a draw order
  54033. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54034. * @param indexStart defines the starting index
  54035. * @param indexCount defines the number of index to draw
  54036. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54037. */
  54038. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54039. /**
  54040. * Draw a list of indexed primitives
  54041. * @param fillMode defines the primitive to use
  54042. * @param indexStart defines the starting index
  54043. * @param indexCount defines the number of index to draw
  54044. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54045. */
  54046. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54047. /**
  54048. * Draw a list of unindexed primitives
  54049. * @param fillMode defines the primitive to use
  54050. * @param verticesStart defines the index of first vertex to draw
  54051. * @param verticesCount defines the count of vertices to draw
  54052. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54053. */
  54054. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54055. /** @hidden */
  54056. _createTexture(): WebGLTexture;
  54057. /** @hidden */
  54058. _releaseTexture(texture: InternalTexture): void;
  54059. /**
  54060. * Usually called from Texture.ts.
  54061. * Passed information to create a WebGLTexture
  54062. * @param urlArg defines a value which contains one of the following:
  54063. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54064. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54065. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54066. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54067. * @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)
  54068. * @param scene needed for loading to the correct scene
  54069. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54070. * @param onLoad optional callback to be called upon successful completion
  54071. * @param onError optional callback to be called upon failure
  54072. * @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
  54073. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54074. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54075. * @param forcedExtension defines the extension to use to pick the right loader
  54076. * @param mimeType defines an optional mime type
  54077. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54078. */
  54079. 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;
  54080. /**
  54081. * Creates a new render target texture
  54082. * @param size defines the size of the texture
  54083. * @param options defines the options used to create the texture
  54084. * @returns a new render target texture stored in an InternalTexture
  54085. */
  54086. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54087. /**
  54088. * Update the sampling mode of a given texture
  54089. * @param samplingMode defines the required sampling mode
  54090. * @param texture defines the texture to update
  54091. */
  54092. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54093. /**
  54094. * Binds the frame buffer to the specified texture.
  54095. * @param texture The texture to render to or null for the default canvas
  54096. * @param faceIndex The face of the texture to render to in case of cube texture
  54097. * @param requiredWidth The width of the target to render to
  54098. * @param requiredHeight The height of the target to render to
  54099. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54100. * @param lodLevel defines le lod level to bind to the frame buffer
  54101. */
  54102. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54103. /**
  54104. * Unbind the current render target texture from the webGL context
  54105. * @param texture defines the render target texture to unbind
  54106. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54107. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54108. */
  54109. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54110. /**
  54111. * Creates a dynamic vertex buffer
  54112. * @param vertices the data for the dynamic vertex buffer
  54113. * @returns the new WebGL dynamic buffer
  54114. */
  54115. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54116. /**
  54117. * Update the content of a dynamic texture
  54118. * @param texture defines the texture to update
  54119. * @param canvas defines the canvas containing the source
  54120. * @param invertY defines if data must be stored with Y axis inverted
  54121. * @param premulAlpha defines if alpha is stored as premultiplied
  54122. * @param format defines the format of the data
  54123. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54124. */
  54125. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54126. /**
  54127. * Gets a boolean indicating if all created effects are ready
  54128. * @returns true if all effects are ready
  54129. */
  54130. areAllEffectsReady(): boolean;
  54131. /**
  54132. * @hidden
  54133. * Get the current error code of the webGL context
  54134. * @returns the error code
  54135. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54136. */
  54137. getError(): number;
  54138. /** @hidden */
  54139. _getUnpackAlignement(): number;
  54140. /** @hidden */
  54141. _unpackFlipY(value: boolean): void;
  54142. /**
  54143. * Update a dynamic index buffer
  54144. * @param indexBuffer defines the target index buffer
  54145. * @param indices defines the data to update
  54146. * @param offset defines the offset in the target index buffer where update should start
  54147. */
  54148. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54149. /**
  54150. * Updates a dynamic vertex buffer.
  54151. * @param vertexBuffer the vertex buffer to update
  54152. * @param vertices the data used to update the vertex buffer
  54153. * @param byteOffset the byte offset of the data (optional)
  54154. * @param byteLength the byte length of the data (optional)
  54155. */
  54156. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54157. /** @hidden */
  54158. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54159. /** @hidden */
  54160. _bindTexture(channel: number, texture: InternalTexture): void;
  54161. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54162. /**
  54163. * 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
  54164. */
  54165. releaseEffects(): void;
  54166. displayLoadingUI(): void;
  54167. hideLoadingUI(): void;
  54168. /** @hidden */
  54169. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54170. /** @hidden */
  54171. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54172. /** @hidden */
  54173. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54174. /** @hidden */
  54175. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54176. }
  54177. }
  54178. declare module "babylonjs/Instrumentation/timeToken" {
  54179. import { Nullable } from "babylonjs/types";
  54180. /**
  54181. * @hidden
  54182. **/
  54183. export class _TimeToken {
  54184. _startTimeQuery: Nullable<WebGLQuery>;
  54185. _endTimeQuery: Nullable<WebGLQuery>;
  54186. _timeElapsedQuery: Nullable<WebGLQuery>;
  54187. _timeElapsedQueryEnded: boolean;
  54188. }
  54189. }
  54190. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54191. import { Nullable, int } from "babylonjs/types";
  54192. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54193. /** @hidden */
  54194. export class _OcclusionDataStorage {
  54195. /** @hidden */
  54196. occlusionInternalRetryCounter: number;
  54197. /** @hidden */
  54198. isOcclusionQueryInProgress: boolean;
  54199. /** @hidden */
  54200. isOccluded: boolean;
  54201. /** @hidden */
  54202. occlusionRetryCount: number;
  54203. /** @hidden */
  54204. occlusionType: number;
  54205. /** @hidden */
  54206. occlusionQueryAlgorithmType: number;
  54207. }
  54208. module "babylonjs/Engines/engine" {
  54209. interface Engine {
  54210. /**
  54211. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54212. * @return the new query
  54213. */
  54214. createQuery(): WebGLQuery;
  54215. /**
  54216. * Delete and release a webGL query
  54217. * @param query defines the query to delete
  54218. * @return the current engine
  54219. */
  54220. deleteQuery(query: WebGLQuery): Engine;
  54221. /**
  54222. * Check if a given query has resolved and got its value
  54223. * @param query defines the query to check
  54224. * @returns true if the query got its value
  54225. */
  54226. isQueryResultAvailable(query: WebGLQuery): boolean;
  54227. /**
  54228. * Gets the value of a given query
  54229. * @param query defines the query to check
  54230. * @returns the value of the query
  54231. */
  54232. getQueryResult(query: WebGLQuery): number;
  54233. /**
  54234. * Initiates an occlusion query
  54235. * @param algorithmType defines the algorithm to use
  54236. * @param query defines the query to use
  54237. * @returns the current engine
  54238. * @see https://doc.babylonjs.com/features/occlusionquery
  54239. */
  54240. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54241. /**
  54242. * Ends an occlusion query
  54243. * @see https://doc.babylonjs.com/features/occlusionquery
  54244. * @param algorithmType defines the algorithm to use
  54245. * @returns the current engine
  54246. */
  54247. endOcclusionQuery(algorithmType: number): Engine;
  54248. /**
  54249. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54250. * Please note that only one query can be issued at a time
  54251. * @returns a time token used to track the time span
  54252. */
  54253. startTimeQuery(): Nullable<_TimeToken>;
  54254. /**
  54255. * Ends a time query
  54256. * @param token defines the token used to measure the time span
  54257. * @returns the time spent (in ns)
  54258. */
  54259. endTimeQuery(token: _TimeToken): int;
  54260. /** @hidden */
  54261. _currentNonTimestampToken: Nullable<_TimeToken>;
  54262. /** @hidden */
  54263. _createTimeQuery(): WebGLQuery;
  54264. /** @hidden */
  54265. _deleteTimeQuery(query: WebGLQuery): void;
  54266. /** @hidden */
  54267. _getGlAlgorithmType(algorithmType: number): number;
  54268. /** @hidden */
  54269. _getTimeQueryResult(query: WebGLQuery): any;
  54270. /** @hidden */
  54271. _getTimeQueryAvailability(query: WebGLQuery): any;
  54272. }
  54273. }
  54274. module "babylonjs/Meshes/abstractMesh" {
  54275. interface AbstractMesh {
  54276. /**
  54277. * Backing filed
  54278. * @hidden
  54279. */
  54280. __occlusionDataStorage: _OcclusionDataStorage;
  54281. /**
  54282. * Access property
  54283. * @hidden
  54284. */
  54285. _occlusionDataStorage: _OcclusionDataStorage;
  54286. /**
  54287. * 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.
  54288. * The default value is -1 which means don't break the query and wait till the result
  54289. * @see https://doc.babylonjs.com/features/occlusionquery
  54290. */
  54291. occlusionRetryCount: number;
  54292. /**
  54293. * 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:
  54294. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54295. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54296. * * 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.
  54297. * @see https://doc.babylonjs.com/features/occlusionquery
  54298. */
  54299. occlusionType: number;
  54300. /**
  54301. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54302. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54303. * * 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.
  54304. * @see https://doc.babylonjs.com/features/occlusionquery
  54305. */
  54306. occlusionQueryAlgorithmType: number;
  54307. /**
  54308. * 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
  54309. * @see https://doc.babylonjs.com/features/occlusionquery
  54310. */
  54311. isOccluded: boolean;
  54312. /**
  54313. * Flag to check the progress status of the query
  54314. * @see https://doc.babylonjs.com/features/occlusionquery
  54315. */
  54316. isOcclusionQueryInProgress: boolean;
  54317. }
  54318. }
  54319. }
  54320. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54321. import { Nullable } from "babylonjs/types";
  54322. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54323. /** @hidden */
  54324. export var _forceTransformFeedbackToBundle: boolean;
  54325. module "babylonjs/Engines/engine" {
  54326. interface Engine {
  54327. /**
  54328. * Creates a webGL transform feedback object
  54329. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54330. * @returns the webGL transform feedback object
  54331. */
  54332. createTransformFeedback(): WebGLTransformFeedback;
  54333. /**
  54334. * Delete a webGL transform feedback object
  54335. * @param value defines the webGL transform feedback object to delete
  54336. */
  54337. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54338. /**
  54339. * Bind a webGL transform feedback object to the webgl context
  54340. * @param value defines the webGL transform feedback object to bind
  54341. */
  54342. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54343. /**
  54344. * Begins a transform feedback operation
  54345. * @param usePoints defines if points or triangles must be used
  54346. */
  54347. beginTransformFeedback(usePoints: boolean): void;
  54348. /**
  54349. * Ends a transform feedback operation
  54350. */
  54351. endTransformFeedback(): void;
  54352. /**
  54353. * Specify the varyings to use with transform feedback
  54354. * @param program defines the associated webGL program
  54355. * @param value defines the list of strings representing the varying names
  54356. */
  54357. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54358. /**
  54359. * Bind a webGL buffer for a transform feedback operation
  54360. * @param value defines the webGL buffer to bind
  54361. */
  54362. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54363. }
  54364. }
  54365. }
  54366. declare module "babylonjs/Engines/Extensions/engine.views" {
  54367. import { Camera } from "babylonjs/Cameras/camera";
  54368. import { Nullable } from "babylonjs/types";
  54369. /**
  54370. * Class used to define an additional view for the engine
  54371. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54372. */
  54373. export class EngineView {
  54374. /** Defines the canvas where to render the view */
  54375. target: HTMLCanvasElement;
  54376. /** Defines an optional camera used to render the view (will use active camera else) */
  54377. camera?: Camera;
  54378. }
  54379. module "babylonjs/Engines/engine" {
  54380. interface Engine {
  54381. /**
  54382. * Gets or sets the HTML element to use for attaching events
  54383. */
  54384. inputElement: Nullable<HTMLElement>;
  54385. /**
  54386. * Gets the current engine view
  54387. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54388. */
  54389. activeView: Nullable<EngineView>;
  54390. /** Gets or sets the list of views */
  54391. views: EngineView[];
  54392. /**
  54393. * Register a new child canvas
  54394. * @param canvas defines the canvas to register
  54395. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54396. * @returns the associated view
  54397. */
  54398. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54399. /**
  54400. * Remove a registered child canvas
  54401. * @param canvas defines the canvas to remove
  54402. * @returns the current engine
  54403. */
  54404. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54405. }
  54406. }
  54407. }
  54408. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54409. import { Nullable } from "babylonjs/types";
  54410. module "babylonjs/Engines/engine" {
  54411. interface Engine {
  54412. /** @hidden */
  54413. _excludedCompressedTextures: string[];
  54414. /** @hidden */
  54415. _textureFormatInUse: string;
  54416. /**
  54417. * Gets the list of texture formats supported
  54418. */
  54419. readonly texturesSupported: Array<string>;
  54420. /**
  54421. * Gets the texture format in use
  54422. */
  54423. readonly textureFormatInUse: Nullable<string>;
  54424. /**
  54425. * Set the compressed texture extensions or file names to skip.
  54426. *
  54427. * @param skippedFiles defines the list of those texture files you want to skip
  54428. * Example: [".dds", ".env", "myfile.png"]
  54429. */
  54430. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54431. /**
  54432. * Set the compressed texture format to use, based on the formats you have, and the formats
  54433. * supported by the hardware / browser.
  54434. *
  54435. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54436. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54437. * to API arguments needed to compressed textures. This puts the burden on the container
  54438. * generator to house the arcane code for determining these for current & future formats.
  54439. *
  54440. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54441. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54442. *
  54443. * Note: The result of this call is not taken into account when a texture is base64.
  54444. *
  54445. * @param formatsAvailable defines the list of those format families you have created
  54446. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54447. *
  54448. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54449. * @returns The extension selected.
  54450. */
  54451. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54452. }
  54453. }
  54454. }
  54455. declare module "babylonjs/Engines/Extensions/index" {
  54456. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54457. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54458. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54459. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54460. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54461. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54462. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54463. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54464. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54465. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54466. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54467. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54468. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54469. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54470. export * from "babylonjs/Engines/Extensions/engine.views";
  54471. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54472. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54473. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54474. }
  54475. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54476. import { Nullable } from "babylonjs/types";
  54477. /**
  54478. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54479. */
  54480. export interface CubeMapInfo {
  54481. /**
  54482. * The pixel array for the front face.
  54483. * This is stored in format, left to right, up to down format.
  54484. */
  54485. front: Nullable<ArrayBufferView>;
  54486. /**
  54487. * The pixel array for the back face.
  54488. * This is stored in format, left to right, up to down format.
  54489. */
  54490. back: Nullable<ArrayBufferView>;
  54491. /**
  54492. * The pixel array for the left face.
  54493. * This is stored in format, left to right, up to down format.
  54494. */
  54495. left: Nullable<ArrayBufferView>;
  54496. /**
  54497. * The pixel array for the right face.
  54498. * This is stored in format, left to right, up to down format.
  54499. */
  54500. right: Nullable<ArrayBufferView>;
  54501. /**
  54502. * The pixel array for the up face.
  54503. * This is stored in format, left to right, up to down format.
  54504. */
  54505. up: Nullable<ArrayBufferView>;
  54506. /**
  54507. * The pixel array for the down face.
  54508. * This is stored in format, left to right, up to down format.
  54509. */
  54510. down: Nullable<ArrayBufferView>;
  54511. /**
  54512. * The size of the cubemap stored.
  54513. *
  54514. * Each faces will be size * size pixels.
  54515. */
  54516. size: number;
  54517. /**
  54518. * The format of the texture.
  54519. *
  54520. * RGBA, RGB.
  54521. */
  54522. format: number;
  54523. /**
  54524. * The type of the texture data.
  54525. *
  54526. * UNSIGNED_INT, FLOAT.
  54527. */
  54528. type: number;
  54529. /**
  54530. * Specifies whether the texture is in gamma space.
  54531. */
  54532. gammaSpace: boolean;
  54533. }
  54534. /**
  54535. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54536. */
  54537. export class PanoramaToCubeMapTools {
  54538. private static FACE_LEFT;
  54539. private static FACE_RIGHT;
  54540. private static FACE_FRONT;
  54541. private static FACE_BACK;
  54542. private static FACE_DOWN;
  54543. private static FACE_UP;
  54544. /**
  54545. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54546. *
  54547. * @param float32Array The source data.
  54548. * @param inputWidth The width of the input panorama.
  54549. * @param inputHeight The height of the input panorama.
  54550. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54551. * @return The cubemap data
  54552. */
  54553. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54554. private static CreateCubemapTexture;
  54555. private static CalcProjectionSpherical;
  54556. }
  54557. }
  54558. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54559. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54560. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54561. import { Nullable } from "babylonjs/types";
  54562. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54563. /**
  54564. * Helper class dealing with the extraction of spherical polynomial dataArray
  54565. * from a cube map.
  54566. */
  54567. export class CubeMapToSphericalPolynomialTools {
  54568. private static FileFaces;
  54569. /**
  54570. * Converts a texture to the according Spherical Polynomial data.
  54571. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54572. *
  54573. * @param texture The texture to extract the information from.
  54574. * @return The Spherical Polynomial data.
  54575. */
  54576. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54577. /**
  54578. * Converts a cubemap to the according Spherical Polynomial data.
  54579. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54580. *
  54581. * @param cubeInfo The Cube map to extract the information from.
  54582. * @return The Spherical Polynomial data.
  54583. */
  54584. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54585. }
  54586. }
  54587. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54588. import { Nullable } from "babylonjs/types";
  54589. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54590. module "babylonjs/Materials/Textures/baseTexture" {
  54591. interface BaseTexture {
  54592. /**
  54593. * Get the polynomial representation of the texture data.
  54594. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54595. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54596. */
  54597. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54598. }
  54599. }
  54600. }
  54601. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54602. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54603. /** @hidden */
  54604. export var rgbdEncodePixelShader: {
  54605. name: string;
  54606. shader: string;
  54607. };
  54608. }
  54609. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54610. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54611. /** @hidden */
  54612. export var rgbdDecodePixelShader: {
  54613. name: string;
  54614. shader: string;
  54615. };
  54616. }
  54617. declare module "babylonjs/Misc/environmentTextureTools" {
  54618. import { Nullable } from "babylonjs/types";
  54619. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54620. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54621. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54622. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54623. import "babylonjs/Engines/Extensions/engine.readTexture";
  54624. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54625. import "babylonjs/Shaders/rgbdEncode.fragment";
  54626. import "babylonjs/Shaders/rgbdDecode.fragment";
  54627. /**
  54628. * Raw texture data and descriptor sufficient for WebGL texture upload
  54629. */
  54630. export interface EnvironmentTextureInfo {
  54631. /**
  54632. * Version of the environment map
  54633. */
  54634. version: number;
  54635. /**
  54636. * Width of image
  54637. */
  54638. width: number;
  54639. /**
  54640. * Irradiance information stored in the file.
  54641. */
  54642. irradiance: any;
  54643. /**
  54644. * Specular information stored in the file.
  54645. */
  54646. specular: any;
  54647. }
  54648. /**
  54649. * Defines One Image in the file. It requires only the position in the file
  54650. * as well as the length.
  54651. */
  54652. interface BufferImageData {
  54653. /**
  54654. * Length of the image data.
  54655. */
  54656. length: number;
  54657. /**
  54658. * Position of the data from the null terminator delimiting the end of the JSON.
  54659. */
  54660. position: number;
  54661. }
  54662. /**
  54663. * Defines the specular data enclosed in the file.
  54664. * This corresponds to the version 1 of the data.
  54665. */
  54666. export interface EnvironmentTextureSpecularInfoV1 {
  54667. /**
  54668. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54669. */
  54670. specularDataPosition?: number;
  54671. /**
  54672. * This contains all the images data needed to reconstruct the cubemap.
  54673. */
  54674. mipmaps: Array<BufferImageData>;
  54675. /**
  54676. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54677. */
  54678. lodGenerationScale: number;
  54679. }
  54680. /**
  54681. * Sets of helpers addressing the serialization and deserialization of environment texture
  54682. * stored in a BabylonJS env file.
  54683. * Those files are usually stored as .env files.
  54684. */
  54685. export class EnvironmentTextureTools {
  54686. /**
  54687. * Magic number identifying the env file.
  54688. */
  54689. private static _MagicBytes;
  54690. /**
  54691. * Gets the environment info from an env file.
  54692. * @param data The array buffer containing the .env bytes.
  54693. * @returns the environment file info (the json header) if successfully parsed.
  54694. */
  54695. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54696. /**
  54697. * Creates an environment texture from a loaded cube texture.
  54698. * @param texture defines the cube texture to convert in env file
  54699. * @return a promise containing the environment data if succesfull.
  54700. */
  54701. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54702. /**
  54703. * Creates a JSON representation of the spherical data.
  54704. * @param texture defines the texture containing the polynomials
  54705. * @return the JSON representation of the spherical info
  54706. */
  54707. private static _CreateEnvTextureIrradiance;
  54708. /**
  54709. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54710. * @param data the image data
  54711. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54712. * @return the views described by info providing access to the underlying buffer
  54713. */
  54714. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54715. /**
  54716. * Uploads the texture info contained in the env file to the GPU.
  54717. * @param texture defines the internal texture to upload to
  54718. * @param data defines the data to load
  54719. * @param info defines the texture info retrieved through the GetEnvInfo method
  54720. * @returns a promise
  54721. */
  54722. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54723. private static _OnImageReadyAsync;
  54724. /**
  54725. * Uploads the levels of image data to the GPU.
  54726. * @param texture defines the internal texture to upload to
  54727. * @param imageData defines the array buffer views of image data [mipmap][face]
  54728. * @returns a promise
  54729. */
  54730. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54731. /**
  54732. * Uploads spherical polynomials information to the texture.
  54733. * @param texture defines the texture we are trying to upload the information to
  54734. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54735. */
  54736. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54737. /** @hidden */
  54738. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54739. }
  54740. }
  54741. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54742. /**
  54743. * Class used to inline functions in shader code
  54744. */
  54745. export class ShaderCodeInliner {
  54746. private static readonly _RegexpFindFunctionNameAndType;
  54747. private _sourceCode;
  54748. private _functionDescr;
  54749. private _numMaxIterations;
  54750. /** Gets or sets the token used to mark the functions to inline */
  54751. inlineToken: string;
  54752. /** Gets or sets the debug mode */
  54753. debug: boolean;
  54754. /** Gets the code after the inlining process */
  54755. get code(): string;
  54756. /**
  54757. * Initializes the inliner
  54758. * @param sourceCode shader code source to inline
  54759. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54760. */
  54761. constructor(sourceCode: string, numMaxIterations?: number);
  54762. /**
  54763. * Start the processing of the shader code
  54764. */
  54765. processCode(): void;
  54766. private _collectFunctions;
  54767. private _processInlining;
  54768. private _extractBetweenMarkers;
  54769. private _skipWhitespaces;
  54770. private _removeComments;
  54771. private _replaceFunctionCallsByCode;
  54772. private _findBackward;
  54773. private _escapeRegExp;
  54774. private _replaceNames;
  54775. }
  54776. }
  54777. declare module "babylonjs/Engines/nativeEngine" {
  54778. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54779. import { Engine } from "babylonjs/Engines/engine";
  54780. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54781. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54782. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54783. import { Effect } from "babylonjs/Materials/effect";
  54784. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54785. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54786. import { IColor4Like } from "babylonjs/Maths/math.like";
  54787. import { Scene } from "babylonjs/scene";
  54788. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54789. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54790. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54791. /**
  54792. * Container for accessors for natively-stored mesh data buffers.
  54793. */
  54794. class NativeDataBuffer extends DataBuffer {
  54795. /**
  54796. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54797. */
  54798. nativeIndexBuffer?: any;
  54799. /**
  54800. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54801. */
  54802. nativeVertexBuffer?: any;
  54803. }
  54804. /** @hidden */
  54805. class NativeTexture extends InternalTexture {
  54806. getInternalTexture(): InternalTexture;
  54807. getViewCount(): number;
  54808. }
  54809. /** @hidden */
  54810. export class NativeEngine extends Engine {
  54811. private readonly _native;
  54812. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54813. private readonly INVALID_HANDLE;
  54814. private _boundBuffersVertexArray;
  54815. getHardwareScalingLevel(): number;
  54816. constructor();
  54817. dispose(): void;
  54818. /**
  54819. * Can be used to override the current requestAnimationFrame requester.
  54820. * @hidden
  54821. */
  54822. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54823. /**
  54824. * Override default engine behavior.
  54825. * @param color
  54826. * @param backBuffer
  54827. * @param depth
  54828. * @param stencil
  54829. */
  54830. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54831. /**
  54832. * Gets host document
  54833. * @returns the host document object
  54834. */
  54835. getHostDocument(): Nullable<Document>;
  54836. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54837. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54838. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54839. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54840. [key: string]: VertexBuffer;
  54841. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54842. bindBuffers(vertexBuffers: {
  54843. [key: string]: VertexBuffer;
  54844. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54845. recordVertexArrayObject(vertexBuffers: {
  54846. [key: string]: VertexBuffer;
  54847. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54848. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54849. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54850. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54851. /**
  54852. * Draw a list of indexed primitives
  54853. * @param fillMode defines the primitive to use
  54854. * @param indexStart defines the starting index
  54855. * @param indexCount defines the number of index to draw
  54856. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54857. */
  54858. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54859. /**
  54860. * Draw a list of unindexed primitives
  54861. * @param fillMode defines the primitive to use
  54862. * @param verticesStart defines the index of first vertex to draw
  54863. * @param verticesCount defines the count of vertices to draw
  54864. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54865. */
  54866. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54867. createPipelineContext(): IPipelineContext;
  54868. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54869. /** @hidden */
  54870. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54871. /** @hidden */
  54872. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54873. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54874. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54875. protected _setProgram(program: WebGLProgram): void;
  54876. _releaseEffect(effect: Effect): void;
  54877. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54878. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54879. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54880. bindSamplers(effect: Effect): void;
  54881. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54882. getRenderWidth(useScreen?: boolean): number;
  54883. getRenderHeight(useScreen?: boolean): number;
  54884. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54885. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54886. /**
  54887. * Set the z offset to apply to current rendering
  54888. * @param value defines the offset to apply
  54889. */
  54890. setZOffset(value: number): void;
  54891. /**
  54892. * Gets the current value of the zOffset
  54893. * @returns the current zOffset state
  54894. */
  54895. getZOffset(): number;
  54896. /**
  54897. * Enable or disable depth buffering
  54898. * @param enable defines the state to set
  54899. */
  54900. setDepthBuffer(enable: boolean): void;
  54901. /**
  54902. * Gets a boolean indicating if depth writing is enabled
  54903. * @returns the current depth writing state
  54904. */
  54905. getDepthWrite(): boolean;
  54906. /**
  54907. * Enable or disable depth writing
  54908. * @param enable defines the state to set
  54909. */
  54910. setDepthWrite(enable: boolean): void;
  54911. /**
  54912. * Enable or disable color writing
  54913. * @param enable defines the state to set
  54914. */
  54915. setColorWrite(enable: boolean): void;
  54916. /**
  54917. * Gets a boolean indicating if color writing is enabled
  54918. * @returns the current color writing state
  54919. */
  54920. getColorWrite(): boolean;
  54921. /**
  54922. * Sets alpha constants used by some alpha blending modes
  54923. * @param r defines the red component
  54924. * @param g defines the green component
  54925. * @param b defines the blue component
  54926. * @param a defines the alpha component
  54927. */
  54928. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54929. /**
  54930. * Sets the current alpha mode
  54931. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54932. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54933. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54934. */
  54935. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54936. /**
  54937. * Gets the current alpha mode
  54938. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54939. * @returns the current alpha mode
  54940. */
  54941. getAlphaMode(): number;
  54942. setInt(uniform: WebGLUniformLocation, int: number): void;
  54943. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54944. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54945. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54946. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54947. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54948. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54949. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54950. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54951. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54952. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54953. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54954. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54955. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54956. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54957. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54958. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54959. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54960. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54961. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54962. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54963. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54964. wipeCaches(bruteForce?: boolean): void;
  54965. _createTexture(): WebGLTexture;
  54966. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54967. /**
  54968. * Usually called from Texture.ts.
  54969. * Passed information to create a WebGLTexture
  54970. * @param url defines a value which contains one of the following:
  54971. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54972. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54973. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54974. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54975. * @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)
  54976. * @param scene needed for loading to the correct scene
  54977. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54978. * @param onLoad optional callback to be called upon successful completion
  54979. * @param onError optional callback to be called upon failure
  54980. * @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
  54981. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54982. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54983. * @param forcedExtension defines the extension to use to pick the right loader
  54984. * @param mimeType defines an optional mime type
  54985. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54986. */
  54987. 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;
  54988. /**
  54989. * Creates a cube texture
  54990. * @param rootUrl defines the url where the files to load is located
  54991. * @param scene defines the current scene
  54992. * @param files defines the list of files to load (1 per face)
  54993. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54994. * @param onLoad defines an optional callback raised when the texture is loaded
  54995. * @param onError defines an optional callback raised if there is an issue to load the texture
  54996. * @param format defines the format of the data
  54997. * @param forcedExtension defines the extension to use to pick the right loader
  54998. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54999. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55000. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55001. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  55002. * @returns the cube texture as an InternalTexture
  55003. */
  55004. 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;
  55005. private _getSamplingFilter;
  55006. private static _GetNativeTextureFormat;
  55007. createRenderTargetTexture(size: number | {
  55008. width: number;
  55009. height: number;
  55010. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  55011. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  55012. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  55013. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55014. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55015. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55016. /**
  55017. * Updates a dynamic vertex buffer.
  55018. * @param vertexBuffer the vertex buffer to update
  55019. * @param data the data used to update the vertex buffer
  55020. * @param byteOffset the byte offset of the data (optional)
  55021. * @param byteLength the byte length of the data (optional)
  55022. */
  55023. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55024. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55025. private _updateAnisotropicLevel;
  55026. private _getAddressMode;
  55027. /** @hidden */
  55028. _bindTexture(channel: number, texture: InternalTexture): void;
  55029. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55030. releaseEffects(): void;
  55031. /** @hidden */
  55032. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55033. /** @hidden */
  55034. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55035. /** @hidden */
  55036. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55037. /** @hidden */
  55038. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55039. }
  55040. }
  55041. declare module "babylonjs/Engines/index" {
  55042. export * from "babylonjs/Engines/constants";
  55043. export * from "babylonjs/Engines/engineCapabilities";
  55044. export * from "babylonjs/Engines/instancingAttributeInfo";
  55045. export * from "babylonjs/Engines/thinEngine";
  55046. export * from "babylonjs/Engines/engine";
  55047. export * from "babylonjs/Engines/engineStore";
  55048. export * from "babylonjs/Engines/nullEngine";
  55049. export * from "babylonjs/Engines/Extensions/index";
  55050. export * from "babylonjs/Engines/IPipelineContext";
  55051. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55052. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55053. export * from "babylonjs/Engines/nativeEngine";
  55054. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55055. export * from "babylonjs/Engines/performanceConfigurator";
  55056. }
  55057. declare module "babylonjs/Events/clipboardEvents" {
  55058. /**
  55059. * Gather the list of clipboard event types as constants.
  55060. */
  55061. export class ClipboardEventTypes {
  55062. /**
  55063. * The clipboard event is fired when a copy command is active (pressed).
  55064. */
  55065. static readonly COPY: number;
  55066. /**
  55067. * The clipboard event is fired when a cut command is active (pressed).
  55068. */
  55069. static readonly CUT: number;
  55070. /**
  55071. * The clipboard event is fired when a paste command is active (pressed).
  55072. */
  55073. static readonly PASTE: number;
  55074. }
  55075. /**
  55076. * This class is used to store clipboard related info for the onClipboardObservable event.
  55077. */
  55078. export class ClipboardInfo {
  55079. /**
  55080. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55081. */
  55082. type: number;
  55083. /**
  55084. * Defines the related dom event
  55085. */
  55086. event: ClipboardEvent;
  55087. /**
  55088. *Creates an instance of ClipboardInfo.
  55089. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55090. * @param event Defines the related dom event
  55091. */
  55092. constructor(
  55093. /**
  55094. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55095. */
  55096. type: number,
  55097. /**
  55098. * Defines the related dom event
  55099. */
  55100. event: ClipboardEvent);
  55101. /**
  55102. * Get the clipboard event's type from the keycode.
  55103. * @param keyCode Defines the keyCode for the current keyboard event.
  55104. * @return {number}
  55105. */
  55106. static GetTypeFromCharacter(keyCode: number): number;
  55107. }
  55108. }
  55109. declare module "babylonjs/Events/index" {
  55110. export * from "babylonjs/Events/keyboardEvents";
  55111. export * from "babylonjs/Events/pointerEvents";
  55112. export * from "babylonjs/Events/clipboardEvents";
  55113. }
  55114. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55115. import { Scene } from "babylonjs/scene";
  55116. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55117. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55118. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55119. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55120. /**
  55121. * Google Daydream controller
  55122. */
  55123. export class DaydreamController extends WebVRController {
  55124. /**
  55125. * Base Url for the controller model.
  55126. */
  55127. static MODEL_BASE_URL: string;
  55128. /**
  55129. * File name for the controller model.
  55130. */
  55131. static MODEL_FILENAME: string;
  55132. /**
  55133. * Gamepad Id prefix used to identify Daydream Controller.
  55134. */
  55135. static readonly GAMEPAD_ID_PREFIX: string;
  55136. /**
  55137. * Creates a new DaydreamController from a gamepad
  55138. * @param vrGamepad the gamepad that the controller should be created from
  55139. */
  55140. constructor(vrGamepad: any);
  55141. /**
  55142. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55143. * @param scene scene in which to add meshes
  55144. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55145. */
  55146. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55147. /**
  55148. * Called once for each button that changed state since the last frame
  55149. * @param buttonIdx Which button index changed
  55150. * @param state New state of the button
  55151. * @param changes Which properties on the state changed since last frame
  55152. */
  55153. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55154. }
  55155. }
  55156. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55157. import { Scene } from "babylonjs/scene";
  55158. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55159. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55160. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55161. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55162. /**
  55163. * Gear VR Controller
  55164. */
  55165. export class GearVRController extends WebVRController {
  55166. /**
  55167. * Base Url for the controller model.
  55168. */
  55169. static MODEL_BASE_URL: string;
  55170. /**
  55171. * File name for the controller model.
  55172. */
  55173. static MODEL_FILENAME: string;
  55174. /**
  55175. * Gamepad Id prefix used to identify this controller.
  55176. */
  55177. static readonly GAMEPAD_ID_PREFIX: string;
  55178. private readonly _buttonIndexToObservableNameMap;
  55179. /**
  55180. * Creates a new GearVRController from a gamepad
  55181. * @param vrGamepad the gamepad that the controller should be created from
  55182. */
  55183. constructor(vrGamepad: any);
  55184. /**
  55185. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55186. * @param scene scene in which to add meshes
  55187. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55188. */
  55189. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55190. /**
  55191. * Called once for each button that changed state since the last frame
  55192. * @param buttonIdx Which button index changed
  55193. * @param state New state of the button
  55194. * @param changes Which properties on the state changed since last frame
  55195. */
  55196. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55197. }
  55198. }
  55199. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55200. import { Scene } from "babylonjs/scene";
  55201. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55202. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55203. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55204. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55205. /**
  55206. * Generic Controller
  55207. */
  55208. export class GenericController extends WebVRController {
  55209. /**
  55210. * Base Url for the controller model.
  55211. */
  55212. static readonly MODEL_BASE_URL: string;
  55213. /**
  55214. * File name for the controller model.
  55215. */
  55216. static readonly MODEL_FILENAME: string;
  55217. /**
  55218. * Creates a new GenericController from a gamepad
  55219. * @param vrGamepad the gamepad that the controller should be created from
  55220. */
  55221. constructor(vrGamepad: any);
  55222. /**
  55223. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55224. * @param scene scene in which to add meshes
  55225. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55226. */
  55227. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55228. /**
  55229. * Called once for each button that changed state since the last frame
  55230. * @param buttonIdx Which button index changed
  55231. * @param state New state of the button
  55232. * @param changes Which properties on the state changed since last frame
  55233. */
  55234. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55235. }
  55236. }
  55237. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55238. import { Observable } from "babylonjs/Misc/observable";
  55239. import { Scene } from "babylonjs/scene";
  55240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55241. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55242. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55243. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55244. /**
  55245. * Oculus Touch Controller
  55246. */
  55247. export class OculusTouchController extends WebVRController {
  55248. /**
  55249. * Base Url for the controller model.
  55250. */
  55251. static MODEL_BASE_URL: string;
  55252. /**
  55253. * File name for the left controller model.
  55254. */
  55255. static MODEL_LEFT_FILENAME: string;
  55256. /**
  55257. * File name for the right controller model.
  55258. */
  55259. static MODEL_RIGHT_FILENAME: string;
  55260. /**
  55261. * Base Url for the Quest controller model.
  55262. */
  55263. static QUEST_MODEL_BASE_URL: string;
  55264. /**
  55265. * @hidden
  55266. * If the controllers are running on a device that needs the updated Quest controller models
  55267. */
  55268. static _IsQuest: boolean;
  55269. /**
  55270. * Fired when the secondary trigger on this controller is modified
  55271. */
  55272. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55273. /**
  55274. * Fired when the thumb rest on this controller is modified
  55275. */
  55276. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55277. /**
  55278. * Creates a new OculusTouchController from a gamepad
  55279. * @param vrGamepad the gamepad that the controller should be created from
  55280. */
  55281. constructor(vrGamepad: any);
  55282. /**
  55283. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55284. * @param scene scene in which to add meshes
  55285. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55286. */
  55287. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55288. /**
  55289. * Fired when the A button on this controller is modified
  55290. */
  55291. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55292. /**
  55293. * Fired when the B button on this controller is modified
  55294. */
  55295. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55296. /**
  55297. * Fired when the X button on this controller is modified
  55298. */
  55299. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55300. /**
  55301. * Fired when the Y button on this controller is modified
  55302. */
  55303. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55304. /**
  55305. * Called once for each button that changed state since the last frame
  55306. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55307. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55308. * 2) secondary trigger (same)
  55309. * 3) A (right) X (left), touch, pressed = value
  55310. * 4) B / Y
  55311. * 5) thumb rest
  55312. * @param buttonIdx Which button index changed
  55313. * @param state New state of the button
  55314. * @param changes Which properties on the state changed since last frame
  55315. */
  55316. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55317. }
  55318. }
  55319. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55320. import { Scene } from "babylonjs/scene";
  55321. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55322. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55323. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55324. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55325. import { Observable } from "babylonjs/Misc/observable";
  55326. /**
  55327. * Vive Controller
  55328. */
  55329. export class ViveController extends WebVRController {
  55330. /**
  55331. * Base Url for the controller model.
  55332. */
  55333. static MODEL_BASE_URL: string;
  55334. /**
  55335. * File name for the controller model.
  55336. */
  55337. static MODEL_FILENAME: string;
  55338. /**
  55339. * Creates a new ViveController from a gamepad
  55340. * @param vrGamepad the gamepad that the controller should be created from
  55341. */
  55342. constructor(vrGamepad: any);
  55343. /**
  55344. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55345. * @param scene scene in which to add meshes
  55346. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55347. */
  55348. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55349. /**
  55350. * Fired when the left button on this controller is modified
  55351. */
  55352. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55353. /**
  55354. * Fired when the right button on this controller is modified
  55355. */
  55356. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55357. /**
  55358. * Fired when the menu button on this controller is modified
  55359. */
  55360. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55361. /**
  55362. * Called once for each button that changed state since the last frame
  55363. * Vive mapping:
  55364. * 0: touchpad
  55365. * 1: trigger
  55366. * 2: left AND right buttons
  55367. * 3: menu button
  55368. * @param buttonIdx Which button index changed
  55369. * @param state New state of the button
  55370. * @param changes Which properties on the state changed since last frame
  55371. */
  55372. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55373. }
  55374. }
  55375. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55376. import { Observable } from "babylonjs/Misc/observable";
  55377. import { Scene } from "babylonjs/scene";
  55378. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55379. import { Ray } from "babylonjs/Culling/ray";
  55380. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55381. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55382. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55383. /**
  55384. * Defines the WindowsMotionController object that the state of the windows motion controller
  55385. */
  55386. export class WindowsMotionController extends WebVRController {
  55387. /**
  55388. * The base url used to load the left and right controller models
  55389. */
  55390. static MODEL_BASE_URL: string;
  55391. /**
  55392. * The name of the left controller model file
  55393. */
  55394. static MODEL_LEFT_FILENAME: string;
  55395. /**
  55396. * The name of the right controller model file
  55397. */
  55398. static MODEL_RIGHT_FILENAME: string;
  55399. /**
  55400. * The controller name prefix for this controller type
  55401. */
  55402. static readonly GAMEPAD_ID_PREFIX: string;
  55403. /**
  55404. * The controller id pattern for this controller type
  55405. */
  55406. private static readonly GAMEPAD_ID_PATTERN;
  55407. private _loadedMeshInfo;
  55408. protected readonly _mapping: {
  55409. buttons: string[];
  55410. buttonMeshNames: {
  55411. trigger: string;
  55412. menu: string;
  55413. grip: string;
  55414. thumbstick: string;
  55415. trackpad: string;
  55416. };
  55417. buttonObservableNames: {
  55418. trigger: string;
  55419. menu: string;
  55420. grip: string;
  55421. thumbstick: string;
  55422. trackpad: string;
  55423. };
  55424. axisMeshNames: string[];
  55425. pointingPoseMeshName: string;
  55426. };
  55427. /**
  55428. * Fired when the trackpad on this controller is clicked
  55429. */
  55430. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55431. /**
  55432. * Fired when the trackpad on this controller is modified
  55433. */
  55434. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55435. /**
  55436. * The current x and y values of this controller's trackpad
  55437. */
  55438. trackpad: StickValues;
  55439. /**
  55440. * Creates a new WindowsMotionController from a gamepad
  55441. * @param vrGamepad the gamepad that the controller should be created from
  55442. */
  55443. constructor(vrGamepad: any);
  55444. /**
  55445. * Fired when the trigger on this controller is modified
  55446. */
  55447. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55448. /**
  55449. * Fired when the menu button on this controller is modified
  55450. */
  55451. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55452. /**
  55453. * Fired when the grip button on this controller is modified
  55454. */
  55455. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55456. /**
  55457. * Fired when the thumbstick button on this controller is modified
  55458. */
  55459. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55460. /**
  55461. * Fired when the touchpad button on this controller is modified
  55462. */
  55463. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55464. /**
  55465. * Fired when the touchpad values on this controller are modified
  55466. */
  55467. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55468. protected _updateTrackpad(): void;
  55469. /**
  55470. * Called once per frame by the engine.
  55471. */
  55472. update(): void;
  55473. /**
  55474. * Called once for each button that changed state since the last frame
  55475. * @param buttonIdx Which button index changed
  55476. * @param state New state of the button
  55477. * @param changes Which properties on the state changed since last frame
  55478. */
  55479. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55480. /**
  55481. * Moves the buttons on the controller mesh based on their current state
  55482. * @param buttonName the name of the button to move
  55483. * @param buttonValue the value of the button which determines the buttons new position
  55484. */
  55485. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55486. /**
  55487. * Moves the axis on the controller mesh based on its current state
  55488. * @param axis the index of the axis
  55489. * @param axisValue the value of the axis which determines the meshes new position
  55490. * @hidden
  55491. */
  55492. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55493. /**
  55494. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55495. * @param scene scene in which to add meshes
  55496. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55497. */
  55498. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55499. /**
  55500. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55501. * can be transformed by button presses and axes values, based on this._mapping.
  55502. *
  55503. * @param scene scene in which the meshes exist
  55504. * @param meshes list of meshes that make up the controller model to process
  55505. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55506. */
  55507. private processModel;
  55508. private createMeshInfo;
  55509. /**
  55510. * Gets the ray of the controller in the direction the controller is pointing
  55511. * @param length the length the resulting ray should be
  55512. * @returns a ray in the direction the controller is pointing
  55513. */
  55514. getForwardRay(length?: number): Ray;
  55515. /**
  55516. * Disposes of the controller
  55517. */
  55518. dispose(): void;
  55519. }
  55520. /**
  55521. * This class represents a new windows motion controller in XR.
  55522. */
  55523. export class XRWindowsMotionController extends WindowsMotionController {
  55524. /**
  55525. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55526. */
  55527. protected readonly _mapping: {
  55528. buttons: string[];
  55529. buttonMeshNames: {
  55530. trigger: string;
  55531. menu: string;
  55532. grip: string;
  55533. thumbstick: string;
  55534. trackpad: string;
  55535. };
  55536. buttonObservableNames: {
  55537. trigger: string;
  55538. menu: string;
  55539. grip: string;
  55540. thumbstick: string;
  55541. trackpad: string;
  55542. };
  55543. axisMeshNames: string[];
  55544. pointingPoseMeshName: string;
  55545. };
  55546. /**
  55547. * Construct a new XR-Based windows motion controller
  55548. *
  55549. * @param gamepadInfo the gamepad object from the browser
  55550. */
  55551. constructor(gamepadInfo: any);
  55552. /**
  55553. * holds the thumbstick values (X,Y)
  55554. */
  55555. thumbstickValues: StickValues;
  55556. /**
  55557. * Fired when the thumbstick on this controller is clicked
  55558. */
  55559. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55560. /**
  55561. * Fired when the thumbstick on this controller is modified
  55562. */
  55563. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55564. /**
  55565. * Fired when the touchpad button on this controller is modified
  55566. */
  55567. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55568. /**
  55569. * Fired when the touchpad values on this controller are modified
  55570. */
  55571. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55572. /**
  55573. * Fired when the thumbstick button on this controller is modified
  55574. * here to prevent breaking changes
  55575. */
  55576. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55577. /**
  55578. * updating the thumbstick(!) and not the trackpad.
  55579. * This is named this way due to the difference between WebVR and XR and to avoid
  55580. * changing the parent class.
  55581. */
  55582. protected _updateTrackpad(): void;
  55583. /**
  55584. * Disposes the class with joy
  55585. */
  55586. dispose(): void;
  55587. }
  55588. }
  55589. declare module "babylonjs/Gamepads/Controllers/index" {
  55590. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55591. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55592. export * from "babylonjs/Gamepads/Controllers/genericController";
  55593. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55594. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55595. export * from "babylonjs/Gamepads/Controllers/viveController";
  55596. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55597. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55598. }
  55599. declare module "babylonjs/Gamepads/index" {
  55600. export * from "babylonjs/Gamepads/Controllers/index";
  55601. export * from "babylonjs/Gamepads/gamepad";
  55602. export * from "babylonjs/Gamepads/gamepadManager";
  55603. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55604. export * from "babylonjs/Gamepads/xboxGamepad";
  55605. export * from "babylonjs/Gamepads/dualShockGamepad";
  55606. }
  55607. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55608. import { Scene } from "babylonjs/scene";
  55609. import { Vector4 } from "babylonjs/Maths/math.vector";
  55610. import { Color4 } from "babylonjs/Maths/math.color";
  55611. import { Mesh } from "babylonjs/Meshes/mesh";
  55612. import { Nullable } from "babylonjs/types";
  55613. /**
  55614. * Class containing static functions to help procedurally build meshes
  55615. */
  55616. export class PolyhedronBuilder {
  55617. /**
  55618. * Creates a polyhedron mesh
  55619. * * 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
  55620. * * The parameter `size` (positive float, default 1) sets the polygon size
  55621. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55622. * * 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`
  55623. * * 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
  55624. * * 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)`)
  55625. * * 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
  55626. * * 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
  55627. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55628. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55629. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55630. * @param name defines the name of the mesh
  55631. * @param options defines the options used to create the mesh
  55632. * @param scene defines the hosting scene
  55633. * @returns the polyhedron mesh
  55634. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55635. */
  55636. static CreatePolyhedron(name: string, options: {
  55637. type?: number;
  55638. size?: number;
  55639. sizeX?: number;
  55640. sizeY?: number;
  55641. sizeZ?: number;
  55642. custom?: any;
  55643. faceUV?: Vector4[];
  55644. faceColors?: Color4[];
  55645. flat?: boolean;
  55646. updatable?: boolean;
  55647. sideOrientation?: number;
  55648. frontUVs?: Vector4;
  55649. backUVs?: Vector4;
  55650. }, scene?: Nullable<Scene>): Mesh;
  55651. }
  55652. }
  55653. declare module "babylonjs/Gizmos/scaleGizmo" {
  55654. import { Observable } from "babylonjs/Misc/observable";
  55655. import { Nullable } from "babylonjs/types";
  55656. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55657. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55658. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55659. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55660. import { Node } from "babylonjs/node";
  55661. /**
  55662. * Gizmo that enables scaling a mesh along 3 axis
  55663. */
  55664. export class ScaleGizmo extends Gizmo {
  55665. /**
  55666. * Internal gizmo used for interactions on the x axis
  55667. */
  55668. xGizmo: AxisScaleGizmo;
  55669. /**
  55670. * Internal gizmo used for interactions on the y axis
  55671. */
  55672. yGizmo: AxisScaleGizmo;
  55673. /**
  55674. * Internal gizmo used for interactions on the z axis
  55675. */
  55676. zGizmo: AxisScaleGizmo;
  55677. /**
  55678. * Internal gizmo used to scale all axis equally
  55679. */
  55680. uniformScaleGizmo: AxisScaleGizmo;
  55681. private _meshAttached;
  55682. private _nodeAttached;
  55683. private _snapDistance;
  55684. private _uniformScalingMesh;
  55685. private _octahedron;
  55686. private _sensitivity;
  55687. /** Fires an event when any of it's sub gizmos are dragged */
  55688. onDragStartObservable: Observable<unknown>;
  55689. /** Fires an event when any of it's sub gizmos are released from dragging */
  55690. onDragEndObservable: Observable<unknown>;
  55691. get attachedMesh(): Nullable<AbstractMesh>;
  55692. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55693. get attachedNode(): Nullable<Node>;
  55694. set attachedNode(node: Nullable<Node>);
  55695. /**
  55696. * Creates a ScaleGizmo
  55697. * @param gizmoLayer The utility layer the gizmo will be added to
  55698. * @param thickness display gizmo axis thickness
  55699. */
  55700. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55701. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55702. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55703. /**
  55704. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55705. */
  55706. set snapDistance(value: number);
  55707. get snapDistance(): number;
  55708. /**
  55709. * Ratio for the scale of the gizmo (Default: 1)
  55710. */
  55711. set scaleRatio(value: number);
  55712. get scaleRatio(): number;
  55713. /**
  55714. * Sensitivity factor for dragging (Default: 1)
  55715. */
  55716. set sensitivity(value: number);
  55717. get sensitivity(): number;
  55718. /**
  55719. * Disposes of the gizmo
  55720. */
  55721. dispose(): void;
  55722. }
  55723. }
  55724. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55725. import { Observable } from "babylonjs/Misc/observable";
  55726. import { Nullable } from "babylonjs/types";
  55727. import { Vector3 } from "babylonjs/Maths/math.vector";
  55728. import { Node } from "babylonjs/node";
  55729. import { Mesh } from "babylonjs/Meshes/mesh";
  55730. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55731. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55732. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55733. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55734. import { Color3 } from "babylonjs/Maths/math.color";
  55735. /**
  55736. * Single axis scale gizmo
  55737. */
  55738. export class AxisScaleGizmo extends Gizmo {
  55739. /**
  55740. * Drag behavior responsible for the gizmos dragging interactions
  55741. */
  55742. dragBehavior: PointerDragBehavior;
  55743. private _pointerObserver;
  55744. /**
  55745. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55746. */
  55747. snapDistance: number;
  55748. /**
  55749. * Event that fires each time the gizmo snaps to a new location.
  55750. * * snapDistance is the the change in distance
  55751. */
  55752. onSnapObservable: Observable<{
  55753. snapDistance: number;
  55754. }>;
  55755. /**
  55756. * If the scaling operation should be done on all axis (default: false)
  55757. */
  55758. uniformScaling: boolean;
  55759. /**
  55760. * Custom sensitivity value for the drag strength
  55761. */
  55762. sensitivity: number;
  55763. private _isEnabled;
  55764. private _parent;
  55765. private _arrow;
  55766. private _coloredMaterial;
  55767. private _hoverMaterial;
  55768. /**
  55769. * Creates an AxisScaleGizmo
  55770. * @param gizmoLayer The utility layer the gizmo will be added to
  55771. * @param dragAxis The axis which the gizmo will be able to scale on
  55772. * @param color The color of the gizmo
  55773. * @param thickness display gizmo axis thickness
  55774. */
  55775. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55776. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55777. /**
  55778. * If the gizmo is enabled
  55779. */
  55780. set isEnabled(value: boolean);
  55781. get isEnabled(): boolean;
  55782. /**
  55783. * Disposes of the gizmo
  55784. */
  55785. dispose(): void;
  55786. /**
  55787. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55788. * @param mesh The mesh to replace the default mesh of the gizmo
  55789. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55790. */
  55791. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55792. }
  55793. }
  55794. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55795. import { Observable } from "babylonjs/Misc/observable";
  55796. import { Nullable } from "babylonjs/types";
  55797. import { Vector3 } from "babylonjs/Maths/math.vector";
  55798. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55799. import { Mesh } from "babylonjs/Meshes/mesh";
  55800. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55801. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55802. import { Color3 } from "babylonjs/Maths/math.color";
  55803. import "babylonjs/Meshes/Builders/boxBuilder";
  55804. /**
  55805. * Bounding box gizmo
  55806. */
  55807. export class BoundingBoxGizmo extends Gizmo {
  55808. private _lineBoundingBox;
  55809. private _rotateSpheresParent;
  55810. private _scaleBoxesParent;
  55811. private _boundingDimensions;
  55812. private _renderObserver;
  55813. private _pointerObserver;
  55814. private _scaleDragSpeed;
  55815. private _tmpQuaternion;
  55816. private _tmpVector;
  55817. private _tmpRotationMatrix;
  55818. /**
  55819. * 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)
  55820. */
  55821. ignoreChildren: boolean;
  55822. /**
  55823. * 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)
  55824. */
  55825. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55826. /**
  55827. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55828. */
  55829. rotationSphereSize: number;
  55830. /**
  55831. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55832. */
  55833. scaleBoxSize: number;
  55834. /**
  55835. * 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)
  55836. */
  55837. fixedDragMeshScreenSize: boolean;
  55838. /**
  55839. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55840. */
  55841. fixedDragMeshScreenSizeDistanceFactor: number;
  55842. /**
  55843. * Fired when a rotation sphere or scale box is dragged
  55844. */
  55845. onDragStartObservable: Observable<{}>;
  55846. /**
  55847. * Fired when a scale box is dragged
  55848. */
  55849. onScaleBoxDragObservable: Observable<{}>;
  55850. /**
  55851. * Fired when a scale box drag is ended
  55852. */
  55853. onScaleBoxDragEndObservable: Observable<{}>;
  55854. /**
  55855. * Fired when a rotation sphere is dragged
  55856. */
  55857. onRotationSphereDragObservable: Observable<{}>;
  55858. /**
  55859. * Fired when a rotation sphere drag is ended
  55860. */
  55861. onRotationSphereDragEndObservable: Observable<{}>;
  55862. /**
  55863. * 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)
  55864. */
  55865. scalePivot: Nullable<Vector3>;
  55866. /**
  55867. * Mesh used as a pivot to rotate the attached node
  55868. */
  55869. private _anchorMesh;
  55870. private _existingMeshScale;
  55871. private _dragMesh;
  55872. private pointerDragBehavior;
  55873. private coloredMaterial;
  55874. private hoverColoredMaterial;
  55875. /**
  55876. * Sets the color of the bounding box gizmo
  55877. * @param color the color to set
  55878. */
  55879. setColor(color: Color3): void;
  55880. /**
  55881. * Creates an BoundingBoxGizmo
  55882. * @param gizmoLayer The utility layer the gizmo will be added to
  55883. * @param color The color of the gizmo
  55884. */
  55885. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55886. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55887. private _selectNode;
  55888. /**
  55889. * Updates the bounding box information for the Gizmo
  55890. */
  55891. updateBoundingBox(): void;
  55892. private _updateRotationSpheres;
  55893. private _updateScaleBoxes;
  55894. /**
  55895. * Enables rotation on the specified axis and disables rotation on the others
  55896. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55897. */
  55898. setEnabledRotationAxis(axis: string): void;
  55899. /**
  55900. * Enables/disables scaling
  55901. * @param enable if scaling should be enabled
  55902. * @param homogeneousScaling defines if scaling should only be homogeneous
  55903. */
  55904. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55905. private _updateDummy;
  55906. /**
  55907. * Enables a pointer drag behavior on the bounding box of the gizmo
  55908. */
  55909. enableDragBehavior(): void;
  55910. /**
  55911. * Disposes of the gizmo
  55912. */
  55913. dispose(): void;
  55914. /**
  55915. * 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)
  55916. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55917. * @returns the bounding box mesh with the passed in mesh as a child
  55918. */
  55919. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55920. /**
  55921. * CustomMeshes are not supported by this gizmo
  55922. * @param mesh The mesh to replace the default mesh of the gizmo
  55923. */
  55924. setCustomMesh(mesh: Mesh): void;
  55925. }
  55926. }
  55927. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55928. import { Observable } from "babylonjs/Misc/observable";
  55929. import { Nullable } from "babylonjs/types";
  55930. import { Vector3 } from "babylonjs/Maths/math.vector";
  55931. import { Color3 } from "babylonjs/Maths/math.color";
  55932. import { Node } from "babylonjs/node";
  55933. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55934. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55935. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55936. import "babylonjs/Meshes/Builders/linesBuilder";
  55937. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55938. /**
  55939. * Single plane rotation gizmo
  55940. */
  55941. export class PlaneRotationGizmo extends Gizmo {
  55942. /**
  55943. * Drag behavior responsible for the gizmos dragging interactions
  55944. */
  55945. dragBehavior: PointerDragBehavior;
  55946. private _pointerObserver;
  55947. /**
  55948. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55949. */
  55950. snapDistance: number;
  55951. /**
  55952. * Event that fires each time the gizmo snaps to a new location.
  55953. * * snapDistance is the the change in distance
  55954. */
  55955. onSnapObservable: Observable<{
  55956. snapDistance: number;
  55957. }>;
  55958. private _isEnabled;
  55959. private _parent;
  55960. /**
  55961. * Creates a PlaneRotationGizmo
  55962. * @param gizmoLayer The utility layer the gizmo will be added to
  55963. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55964. * @param color The color of the gizmo
  55965. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55966. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55967. * @param thickness display gizmo axis thickness
  55968. */
  55969. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55970. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55971. /**
  55972. * If the gizmo is enabled
  55973. */
  55974. set isEnabled(value: boolean);
  55975. get isEnabled(): boolean;
  55976. /**
  55977. * Disposes of the gizmo
  55978. */
  55979. dispose(): void;
  55980. }
  55981. }
  55982. declare module "babylonjs/Gizmos/rotationGizmo" {
  55983. import { Observable } from "babylonjs/Misc/observable";
  55984. import { Nullable } from "babylonjs/types";
  55985. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55986. import { Mesh } from "babylonjs/Meshes/mesh";
  55987. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55988. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55989. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55990. import { Node } from "babylonjs/node";
  55991. /**
  55992. * Gizmo that enables rotating a mesh along 3 axis
  55993. */
  55994. export class RotationGizmo extends Gizmo {
  55995. /**
  55996. * Internal gizmo used for interactions on the x axis
  55997. */
  55998. xGizmo: PlaneRotationGizmo;
  55999. /**
  56000. * Internal gizmo used for interactions on the y axis
  56001. */
  56002. yGizmo: PlaneRotationGizmo;
  56003. /**
  56004. * Internal gizmo used for interactions on the z axis
  56005. */
  56006. zGizmo: PlaneRotationGizmo;
  56007. /** Fires an event when any of it's sub gizmos are dragged */
  56008. onDragStartObservable: Observable<unknown>;
  56009. /** Fires an event when any of it's sub gizmos are released from dragging */
  56010. onDragEndObservable: Observable<unknown>;
  56011. private _meshAttached;
  56012. private _nodeAttached;
  56013. get attachedMesh(): Nullable<AbstractMesh>;
  56014. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56015. get attachedNode(): Nullable<Node>;
  56016. set attachedNode(node: Nullable<Node>);
  56017. /**
  56018. * Creates a RotationGizmo
  56019. * @param gizmoLayer The utility layer the gizmo will be added to
  56020. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56021. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56022. * @param thickness display gizmo axis thickness
  56023. */
  56024. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56025. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56026. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56027. /**
  56028. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56029. */
  56030. set snapDistance(value: number);
  56031. get snapDistance(): number;
  56032. /**
  56033. * Ratio for the scale of the gizmo (Default: 1)
  56034. */
  56035. set scaleRatio(value: number);
  56036. get scaleRatio(): number;
  56037. /**
  56038. * Disposes of the gizmo
  56039. */
  56040. dispose(): void;
  56041. /**
  56042. * CustomMeshes are not supported by this gizmo
  56043. * @param mesh The mesh to replace the default mesh of the gizmo
  56044. */
  56045. setCustomMesh(mesh: Mesh): void;
  56046. }
  56047. }
  56048. declare module "babylonjs/Gizmos/gizmoManager" {
  56049. import { Observable } from "babylonjs/Misc/observable";
  56050. import { Nullable } from "babylonjs/types";
  56051. import { Scene, IDisposable } from "babylonjs/scene";
  56052. import { Node } from "babylonjs/node";
  56053. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56054. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56055. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56056. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56057. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56058. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56059. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56060. /**
  56061. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56062. */
  56063. export class GizmoManager implements IDisposable {
  56064. private scene;
  56065. /**
  56066. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56067. */
  56068. gizmos: {
  56069. positionGizmo: Nullable<PositionGizmo>;
  56070. rotationGizmo: Nullable<RotationGizmo>;
  56071. scaleGizmo: Nullable<ScaleGizmo>;
  56072. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56073. };
  56074. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56075. clearGizmoOnEmptyPointerEvent: boolean;
  56076. /** Fires an event when the manager is attached to a mesh */
  56077. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56078. /** Fires an event when the manager is attached to a node */
  56079. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56080. private _gizmosEnabled;
  56081. private _pointerObserver;
  56082. private _attachedMesh;
  56083. private _attachedNode;
  56084. private _boundingBoxColor;
  56085. private _defaultUtilityLayer;
  56086. private _defaultKeepDepthUtilityLayer;
  56087. private _thickness;
  56088. /**
  56089. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56090. */
  56091. boundingBoxDragBehavior: SixDofDragBehavior;
  56092. /**
  56093. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56094. */
  56095. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56096. /**
  56097. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56098. */
  56099. attachableNodes: Nullable<Array<Node>>;
  56100. /**
  56101. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56102. */
  56103. usePointerToAttachGizmos: boolean;
  56104. /**
  56105. * Utility layer that the bounding box gizmo belongs to
  56106. */
  56107. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56108. /**
  56109. * Utility layer that all gizmos besides bounding box belong to
  56110. */
  56111. get utilityLayer(): UtilityLayerRenderer;
  56112. /**
  56113. * Instatiates a gizmo manager
  56114. * @param scene the scene to overlay the gizmos on top of
  56115. * @param thickness display gizmo axis thickness
  56116. */
  56117. constructor(scene: Scene, thickness?: number);
  56118. /**
  56119. * Attaches a set of gizmos to the specified mesh
  56120. * @param mesh The mesh the gizmo's should be attached to
  56121. */
  56122. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56123. /**
  56124. * Attaches a set of gizmos to the specified node
  56125. * @param node The node the gizmo's should be attached to
  56126. */
  56127. attachToNode(node: Nullable<Node>): void;
  56128. /**
  56129. * If the position gizmo is enabled
  56130. */
  56131. set positionGizmoEnabled(value: boolean);
  56132. get positionGizmoEnabled(): boolean;
  56133. /**
  56134. * If the rotation gizmo is enabled
  56135. */
  56136. set rotationGizmoEnabled(value: boolean);
  56137. get rotationGizmoEnabled(): boolean;
  56138. /**
  56139. * If the scale gizmo is enabled
  56140. */
  56141. set scaleGizmoEnabled(value: boolean);
  56142. get scaleGizmoEnabled(): boolean;
  56143. /**
  56144. * If the boundingBox gizmo is enabled
  56145. */
  56146. set boundingBoxGizmoEnabled(value: boolean);
  56147. get boundingBoxGizmoEnabled(): boolean;
  56148. /**
  56149. * Disposes of the gizmo manager
  56150. */
  56151. dispose(): void;
  56152. }
  56153. }
  56154. declare module "babylonjs/Lights/directionalLight" {
  56155. import { Camera } from "babylonjs/Cameras/camera";
  56156. import { Scene } from "babylonjs/scene";
  56157. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56158. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56159. import { Light } from "babylonjs/Lights/light";
  56160. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56161. import { Effect } from "babylonjs/Materials/effect";
  56162. /**
  56163. * A directional light is defined by a direction (what a surprise!).
  56164. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56165. * 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.
  56166. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56167. */
  56168. export class DirectionalLight extends ShadowLight {
  56169. private _shadowFrustumSize;
  56170. /**
  56171. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56172. */
  56173. get shadowFrustumSize(): number;
  56174. /**
  56175. * Specifies a fix frustum size for the shadow generation.
  56176. */
  56177. set shadowFrustumSize(value: number);
  56178. private _shadowOrthoScale;
  56179. /**
  56180. * Gets the shadow projection scale against the optimal computed one.
  56181. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56182. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56183. */
  56184. get shadowOrthoScale(): number;
  56185. /**
  56186. * Sets the shadow projection scale against the optimal computed one.
  56187. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56188. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56189. */
  56190. set shadowOrthoScale(value: number);
  56191. /**
  56192. * Automatically compute the projection matrix to best fit (including all the casters)
  56193. * on each frame.
  56194. */
  56195. autoUpdateExtends: boolean;
  56196. /**
  56197. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56198. * on each frame. autoUpdateExtends must be set to true for this to work
  56199. */
  56200. autoCalcShadowZBounds: boolean;
  56201. private _orthoLeft;
  56202. private _orthoRight;
  56203. private _orthoTop;
  56204. private _orthoBottom;
  56205. /**
  56206. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56207. * The directional light is emitted from everywhere in the given direction.
  56208. * It can cast shadows.
  56209. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56210. * @param name The friendly name of the light
  56211. * @param direction The direction of the light
  56212. * @param scene The scene the light belongs to
  56213. */
  56214. constructor(name: string, direction: Vector3, scene: Scene);
  56215. /**
  56216. * Returns the string "DirectionalLight".
  56217. * @return The class name
  56218. */
  56219. getClassName(): string;
  56220. /**
  56221. * Returns the integer 1.
  56222. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56223. */
  56224. getTypeID(): number;
  56225. /**
  56226. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56227. * Returns the DirectionalLight Shadow projection matrix.
  56228. */
  56229. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56230. /**
  56231. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56232. * Returns the DirectionalLight Shadow projection matrix.
  56233. */
  56234. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56235. /**
  56236. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56237. * Returns the DirectionalLight Shadow projection matrix.
  56238. */
  56239. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56240. protected _buildUniformLayout(): void;
  56241. /**
  56242. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56243. * @param effect The effect to update
  56244. * @param lightIndex The index of the light in the effect to update
  56245. * @returns The directional light
  56246. */
  56247. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56248. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56249. /**
  56250. * Gets the minZ used for shadow according to both the scene and the light.
  56251. *
  56252. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56253. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56254. * @param activeCamera The camera we are returning the min for
  56255. * @returns the depth min z
  56256. */
  56257. getDepthMinZ(activeCamera: Camera): number;
  56258. /**
  56259. * Gets the maxZ used for shadow according to both the scene and the light.
  56260. *
  56261. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56262. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56263. * @param activeCamera The camera we are returning the max for
  56264. * @returns the depth max z
  56265. */
  56266. getDepthMaxZ(activeCamera: Camera): number;
  56267. /**
  56268. * Prepares the list of defines specific to the light type.
  56269. * @param defines the list of defines
  56270. * @param lightIndex defines the index of the light for the effect
  56271. */
  56272. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56273. }
  56274. }
  56275. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56276. import { Mesh } from "babylonjs/Meshes/mesh";
  56277. /**
  56278. * Class containing static functions to help procedurally build meshes
  56279. */
  56280. export class HemisphereBuilder {
  56281. /**
  56282. * Creates a hemisphere mesh
  56283. * @param name defines the name of the mesh
  56284. * @param options defines the options used to create the mesh
  56285. * @param scene defines the hosting scene
  56286. * @returns the hemisphere mesh
  56287. */
  56288. static CreateHemisphere(name: string, options: {
  56289. segments?: number;
  56290. diameter?: number;
  56291. sideOrientation?: number;
  56292. }, scene: any): Mesh;
  56293. }
  56294. }
  56295. declare module "babylonjs/Lights/spotLight" {
  56296. import { Nullable } from "babylonjs/types";
  56297. import { Scene } from "babylonjs/scene";
  56298. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56299. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56300. import { Effect } from "babylonjs/Materials/effect";
  56301. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56302. import { Light } from "babylonjs/Lights/light";
  56303. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56304. /**
  56305. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56306. * These values define a cone of light starting from the position, emitting toward the direction.
  56307. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56308. * and the exponent defines the speed of the decay of the light with distance (reach).
  56309. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56310. */
  56311. export class SpotLight extends ShadowLight {
  56312. private _angle;
  56313. private _innerAngle;
  56314. private _cosHalfAngle;
  56315. private _lightAngleScale;
  56316. private _lightAngleOffset;
  56317. /**
  56318. * Gets the cone angle of the spot light in Radians.
  56319. */
  56320. get angle(): number;
  56321. /**
  56322. * Sets the cone angle of the spot light in Radians.
  56323. */
  56324. set angle(value: number);
  56325. /**
  56326. * Only used in gltf falloff mode, this defines the angle where
  56327. * the directional falloff will start before cutting at angle which could be seen
  56328. * as outer angle.
  56329. */
  56330. get innerAngle(): number;
  56331. /**
  56332. * Only used in gltf falloff mode, this defines the angle where
  56333. * the directional falloff will start before cutting at angle which could be seen
  56334. * as outer angle.
  56335. */
  56336. set innerAngle(value: number);
  56337. private _shadowAngleScale;
  56338. /**
  56339. * Allows scaling the angle of the light for shadow generation only.
  56340. */
  56341. get shadowAngleScale(): number;
  56342. /**
  56343. * Allows scaling the angle of the light for shadow generation only.
  56344. */
  56345. set shadowAngleScale(value: number);
  56346. /**
  56347. * The light decay speed with the distance from the emission spot.
  56348. */
  56349. exponent: number;
  56350. private _projectionTextureMatrix;
  56351. /**
  56352. * Allows reading the projecton texture
  56353. */
  56354. get projectionTextureMatrix(): Matrix;
  56355. protected _projectionTextureLightNear: number;
  56356. /**
  56357. * Gets the near clip of the Spotlight for texture projection.
  56358. */
  56359. get projectionTextureLightNear(): number;
  56360. /**
  56361. * Sets the near clip of the Spotlight for texture projection.
  56362. */
  56363. set projectionTextureLightNear(value: number);
  56364. protected _projectionTextureLightFar: number;
  56365. /**
  56366. * Gets the far clip of the Spotlight for texture projection.
  56367. */
  56368. get projectionTextureLightFar(): number;
  56369. /**
  56370. * Sets the far clip of the Spotlight for texture projection.
  56371. */
  56372. set projectionTextureLightFar(value: number);
  56373. protected _projectionTextureUpDirection: Vector3;
  56374. /**
  56375. * Gets the Up vector of the Spotlight for texture projection.
  56376. */
  56377. get projectionTextureUpDirection(): Vector3;
  56378. /**
  56379. * Sets the Up vector of the Spotlight for texture projection.
  56380. */
  56381. set projectionTextureUpDirection(value: Vector3);
  56382. private _projectionTexture;
  56383. /**
  56384. * Gets the projection texture of the light.
  56385. */
  56386. get projectionTexture(): Nullable<BaseTexture>;
  56387. /**
  56388. * Sets the projection texture of the light.
  56389. */
  56390. set projectionTexture(value: Nullable<BaseTexture>);
  56391. private _projectionTextureViewLightDirty;
  56392. private _projectionTextureProjectionLightDirty;
  56393. private _projectionTextureDirty;
  56394. private _projectionTextureViewTargetVector;
  56395. private _projectionTextureViewLightMatrix;
  56396. private _projectionTextureProjectionLightMatrix;
  56397. private _projectionTextureScalingMatrix;
  56398. /**
  56399. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56400. * It can cast shadows.
  56401. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56402. * @param name The light friendly name
  56403. * @param position The position of the spot light in the scene
  56404. * @param direction The direction of the light in the scene
  56405. * @param angle The cone angle of the light in Radians
  56406. * @param exponent The light decay speed with the distance from the emission spot
  56407. * @param scene The scene the lights belongs to
  56408. */
  56409. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56410. /**
  56411. * Returns the string "SpotLight".
  56412. * @returns the class name
  56413. */
  56414. getClassName(): string;
  56415. /**
  56416. * Returns the integer 2.
  56417. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56418. */
  56419. getTypeID(): number;
  56420. /**
  56421. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56422. */
  56423. protected _setDirection(value: Vector3): void;
  56424. /**
  56425. * Overrides the position setter to recompute the projection texture view light Matrix.
  56426. */
  56427. protected _setPosition(value: Vector3): void;
  56428. /**
  56429. * 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.
  56430. * Returns the SpotLight.
  56431. */
  56432. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56433. protected _computeProjectionTextureViewLightMatrix(): void;
  56434. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56435. /**
  56436. * Main function for light texture projection matrix computing.
  56437. */
  56438. protected _computeProjectionTextureMatrix(): void;
  56439. protected _buildUniformLayout(): void;
  56440. private _computeAngleValues;
  56441. /**
  56442. * Sets the passed Effect "effect" with the Light textures.
  56443. * @param effect The effect to update
  56444. * @param lightIndex The index of the light in the effect to update
  56445. * @returns The light
  56446. */
  56447. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56448. /**
  56449. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56450. * @param effect The effect to update
  56451. * @param lightIndex The index of the light in the effect to update
  56452. * @returns The spot light
  56453. */
  56454. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56455. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56456. /**
  56457. * Disposes the light and the associated resources.
  56458. */
  56459. dispose(): void;
  56460. /**
  56461. * Prepares the list of defines specific to the light type.
  56462. * @param defines the list of defines
  56463. * @param lightIndex defines the index of the light for the effect
  56464. */
  56465. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56466. }
  56467. }
  56468. declare module "babylonjs/Gizmos/lightGizmo" {
  56469. import { Nullable } from "babylonjs/types";
  56470. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56471. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56472. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56473. import { Light } from "babylonjs/Lights/light";
  56474. /**
  56475. * Gizmo that enables viewing a light
  56476. */
  56477. export class LightGizmo extends Gizmo {
  56478. private _lightMesh;
  56479. private _material;
  56480. private _cachedPosition;
  56481. private _cachedForward;
  56482. private _attachedMeshParent;
  56483. /**
  56484. * Creates a LightGizmo
  56485. * @param gizmoLayer The utility layer the gizmo will be added to
  56486. */
  56487. constructor(gizmoLayer?: UtilityLayerRenderer);
  56488. private _light;
  56489. /**
  56490. * The light that the gizmo is attached to
  56491. */
  56492. set light(light: Nullable<Light>);
  56493. get light(): Nullable<Light>;
  56494. /**
  56495. * Gets the material used to render the light gizmo
  56496. */
  56497. get material(): StandardMaterial;
  56498. /**
  56499. * @hidden
  56500. * Updates the gizmo to match the attached mesh's position/rotation
  56501. */
  56502. protected _update(): void;
  56503. private static _Scale;
  56504. /**
  56505. * Creates the lines for a light mesh
  56506. */
  56507. private static _CreateLightLines;
  56508. /**
  56509. * Disposes of the light gizmo
  56510. */
  56511. dispose(): void;
  56512. private static _CreateHemisphericLightMesh;
  56513. private static _CreatePointLightMesh;
  56514. private static _CreateSpotLightMesh;
  56515. private static _CreateDirectionalLightMesh;
  56516. }
  56517. }
  56518. declare module "babylonjs/Gizmos/cameraGizmo" {
  56519. import { Nullable } from "babylonjs/types";
  56520. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56521. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56522. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56523. import { Camera } from "babylonjs/Cameras/camera";
  56524. /**
  56525. * Gizmo that enables viewing a camera
  56526. */
  56527. export class CameraGizmo extends Gizmo {
  56528. private _cameraMesh;
  56529. private _cameraLinesMesh;
  56530. private _material;
  56531. /**
  56532. * Creates a CameraGizmo
  56533. * @param gizmoLayer The utility layer the gizmo will be added to
  56534. */
  56535. constructor(gizmoLayer?: UtilityLayerRenderer);
  56536. private _camera;
  56537. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56538. get displayFrustum(): boolean;
  56539. set displayFrustum(value: boolean);
  56540. /**
  56541. * The camera that the gizmo is attached to
  56542. */
  56543. set camera(camera: Nullable<Camera>);
  56544. get camera(): Nullable<Camera>;
  56545. /**
  56546. * Gets the material used to render the camera gizmo
  56547. */
  56548. get material(): StandardMaterial;
  56549. /**
  56550. * @hidden
  56551. * Updates the gizmo to match the attached mesh's position/rotation
  56552. */
  56553. protected _update(): void;
  56554. private static _Scale;
  56555. private _invProjection;
  56556. /**
  56557. * Disposes of the camera gizmo
  56558. */
  56559. dispose(): void;
  56560. private static _CreateCameraMesh;
  56561. private static _CreateCameraFrustum;
  56562. }
  56563. }
  56564. declare module "babylonjs/Gizmos/index" {
  56565. export * from "babylonjs/Gizmos/axisDragGizmo";
  56566. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56567. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56568. export * from "babylonjs/Gizmos/gizmo";
  56569. export * from "babylonjs/Gizmos/gizmoManager";
  56570. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56571. export * from "babylonjs/Gizmos/positionGizmo";
  56572. export * from "babylonjs/Gizmos/rotationGizmo";
  56573. export * from "babylonjs/Gizmos/scaleGizmo";
  56574. export * from "babylonjs/Gizmos/lightGizmo";
  56575. export * from "babylonjs/Gizmos/cameraGizmo";
  56576. export * from "babylonjs/Gizmos/planeDragGizmo";
  56577. }
  56578. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56579. /** @hidden */
  56580. export var backgroundFragmentDeclaration: {
  56581. name: string;
  56582. shader: string;
  56583. };
  56584. }
  56585. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56586. /** @hidden */
  56587. export var backgroundUboDeclaration: {
  56588. name: string;
  56589. shader: string;
  56590. };
  56591. }
  56592. declare module "babylonjs/Shaders/background.fragment" {
  56593. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56594. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56595. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56596. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56597. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56598. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56599. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56600. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56601. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56602. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56603. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56604. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56605. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56606. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56607. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56608. /** @hidden */
  56609. export var backgroundPixelShader: {
  56610. name: string;
  56611. shader: string;
  56612. };
  56613. }
  56614. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56615. /** @hidden */
  56616. export var backgroundVertexDeclaration: {
  56617. name: string;
  56618. shader: string;
  56619. };
  56620. }
  56621. declare module "babylonjs/Shaders/background.vertex" {
  56622. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56623. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56624. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56625. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56626. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56627. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56628. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56629. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56630. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56631. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56632. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56633. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56634. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56635. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56636. /** @hidden */
  56637. export var backgroundVertexShader: {
  56638. name: string;
  56639. shader: string;
  56640. };
  56641. }
  56642. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56643. import { Nullable, int, float } from "babylonjs/types";
  56644. import { Scene } from "babylonjs/scene";
  56645. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56646. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56647. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56648. import { Mesh } from "babylonjs/Meshes/mesh";
  56649. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56650. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56651. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56652. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56653. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56654. import { Color3 } from "babylonjs/Maths/math.color";
  56655. import "babylonjs/Shaders/background.fragment";
  56656. import "babylonjs/Shaders/background.vertex";
  56657. /**
  56658. * Background material used to create an efficient environement around your scene.
  56659. */
  56660. export class BackgroundMaterial extends PushMaterial {
  56661. /**
  56662. * Standard reflectance value at parallel view angle.
  56663. */
  56664. static StandardReflectance0: number;
  56665. /**
  56666. * Standard reflectance value at grazing angle.
  56667. */
  56668. static StandardReflectance90: number;
  56669. protected _primaryColor: Color3;
  56670. /**
  56671. * Key light Color (multiply against the environement texture)
  56672. */
  56673. primaryColor: Color3;
  56674. protected __perceptualColor: Nullable<Color3>;
  56675. /**
  56676. * Experimental Internal Use Only.
  56677. *
  56678. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56679. * This acts as a helper to set the primary color to a more "human friendly" value.
  56680. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56681. * output color as close as possible from the chosen value.
  56682. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56683. * part of lighting setup.)
  56684. */
  56685. get _perceptualColor(): Nullable<Color3>;
  56686. set _perceptualColor(value: Nullable<Color3>);
  56687. protected _primaryColorShadowLevel: float;
  56688. /**
  56689. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56690. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56691. */
  56692. get primaryColorShadowLevel(): float;
  56693. set primaryColorShadowLevel(value: float);
  56694. protected _primaryColorHighlightLevel: float;
  56695. /**
  56696. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56697. * The primary color is used at the level chosen to define what the white area would look.
  56698. */
  56699. get primaryColorHighlightLevel(): float;
  56700. set primaryColorHighlightLevel(value: float);
  56701. protected _reflectionTexture: Nullable<BaseTexture>;
  56702. /**
  56703. * Reflection Texture used in the material.
  56704. * Should be author in a specific way for the best result (refer to the documentation).
  56705. */
  56706. reflectionTexture: Nullable<BaseTexture>;
  56707. protected _reflectionBlur: float;
  56708. /**
  56709. * Reflection Texture level of blur.
  56710. *
  56711. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56712. * texture twice.
  56713. */
  56714. reflectionBlur: float;
  56715. protected _diffuseTexture: Nullable<BaseTexture>;
  56716. /**
  56717. * Diffuse Texture used in the material.
  56718. * Should be author in a specific way for the best result (refer to the documentation).
  56719. */
  56720. diffuseTexture: Nullable<BaseTexture>;
  56721. protected _shadowLights: Nullable<IShadowLight[]>;
  56722. /**
  56723. * Specify the list of lights casting shadow on the material.
  56724. * All scene shadow lights will be included if null.
  56725. */
  56726. shadowLights: Nullable<IShadowLight[]>;
  56727. protected _shadowLevel: float;
  56728. /**
  56729. * Helps adjusting the shadow to a softer level if required.
  56730. * 0 means black shadows and 1 means no shadows.
  56731. */
  56732. shadowLevel: float;
  56733. protected _sceneCenter: Vector3;
  56734. /**
  56735. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56736. * It is usually zero but might be interesting to modify according to your setup.
  56737. */
  56738. sceneCenter: Vector3;
  56739. protected _opacityFresnel: boolean;
  56740. /**
  56741. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56742. * This helps ensuring a nice transition when the camera goes under the ground.
  56743. */
  56744. opacityFresnel: boolean;
  56745. protected _reflectionFresnel: boolean;
  56746. /**
  56747. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56748. * This helps adding a mirror texture on the ground.
  56749. */
  56750. reflectionFresnel: boolean;
  56751. protected _reflectionFalloffDistance: number;
  56752. /**
  56753. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56754. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56755. */
  56756. reflectionFalloffDistance: number;
  56757. protected _reflectionAmount: number;
  56758. /**
  56759. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56760. */
  56761. reflectionAmount: number;
  56762. protected _reflectionReflectance0: number;
  56763. /**
  56764. * This specifies the weight of the reflection at grazing angle.
  56765. */
  56766. reflectionReflectance0: number;
  56767. protected _reflectionReflectance90: number;
  56768. /**
  56769. * This specifies the weight of the reflection at a perpendicular point of view.
  56770. */
  56771. reflectionReflectance90: number;
  56772. /**
  56773. * Sets the reflection reflectance fresnel values according to the default standard
  56774. * empirically know to work well :-)
  56775. */
  56776. set reflectionStandardFresnelWeight(value: number);
  56777. protected _useRGBColor: boolean;
  56778. /**
  56779. * Helps to directly use the maps channels instead of their level.
  56780. */
  56781. useRGBColor: boolean;
  56782. protected _enableNoise: boolean;
  56783. /**
  56784. * This helps reducing the banding effect that could occur on the background.
  56785. */
  56786. enableNoise: boolean;
  56787. /**
  56788. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56789. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56790. * Recommended to be keep at 1.0 except for special cases.
  56791. */
  56792. get fovMultiplier(): number;
  56793. set fovMultiplier(value: number);
  56794. private _fovMultiplier;
  56795. /**
  56796. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56797. */
  56798. useEquirectangularFOV: boolean;
  56799. private _maxSimultaneousLights;
  56800. /**
  56801. * Number of Simultaneous lights allowed on the material.
  56802. */
  56803. maxSimultaneousLights: int;
  56804. private _shadowOnly;
  56805. /**
  56806. * Make the material only render shadows
  56807. */
  56808. shadowOnly: boolean;
  56809. /**
  56810. * Default configuration related to image processing available in the Background Material.
  56811. */
  56812. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56813. /**
  56814. * Keep track of the image processing observer to allow dispose and replace.
  56815. */
  56816. private _imageProcessingObserver;
  56817. /**
  56818. * Attaches a new image processing configuration to the PBR Material.
  56819. * @param configuration (if null the scene configuration will be use)
  56820. */
  56821. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56822. /**
  56823. * Gets the image processing configuration used either in this material.
  56824. */
  56825. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56826. /**
  56827. * Sets the Default image processing configuration used either in the this material.
  56828. *
  56829. * If sets to null, the scene one is in use.
  56830. */
  56831. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56832. /**
  56833. * Gets wether the color curves effect is enabled.
  56834. */
  56835. get cameraColorCurvesEnabled(): boolean;
  56836. /**
  56837. * Sets wether the color curves effect is enabled.
  56838. */
  56839. set cameraColorCurvesEnabled(value: boolean);
  56840. /**
  56841. * Gets wether the color grading effect is enabled.
  56842. */
  56843. get cameraColorGradingEnabled(): boolean;
  56844. /**
  56845. * Gets wether the color grading effect is enabled.
  56846. */
  56847. set cameraColorGradingEnabled(value: boolean);
  56848. /**
  56849. * Gets wether tonemapping is enabled or not.
  56850. */
  56851. get cameraToneMappingEnabled(): boolean;
  56852. /**
  56853. * Sets wether tonemapping is enabled or not
  56854. */
  56855. set cameraToneMappingEnabled(value: boolean);
  56856. /**
  56857. * The camera exposure used on this material.
  56858. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56859. * This corresponds to a photographic exposure.
  56860. */
  56861. get cameraExposure(): float;
  56862. /**
  56863. * The camera exposure used on this material.
  56864. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56865. * This corresponds to a photographic exposure.
  56866. */
  56867. set cameraExposure(value: float);
  56868. /**
  56869. * Gets The camera contrast used on this material.
  56870. */
  56871. get cameraContrast(): float;
  56872. /**
  56873. * Sets The camera contrast used on this material.
  56874. */
  56875. set cameraContrast(value: float);
  56876. /**
  56877. * Gets the Color Grading 2D Lookup Texture.
  56878. */
  56879. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56880. /**
  56881. * Sets the Color Grading 2D Lookup Texture.
  56882. */
  56883. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56884. /**
  56885. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56886. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56887. * 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;
  56888. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56889. */
  56890. get cameraColorCurves(): Nullable<ColorCurves>;
  56891. /**
  56892. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56893. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56894. * 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;
  56895. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56896. */
  56897. set cameraColorCurves(value: Nullable<ColorCurves>);
  56898. /**
  56899. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56900. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56901. */
  56902. switchToBGR: boolean;
  56903. private _renderTargets;
  56904. private _reflectionControls;
  56905. private _white;
  56906. private _primaryShadowColor;
  56907. private _primaryHighlightColor;
  56908. /**
  56909. * Instantiates a Background Material in the given scene
  56910. * @param name The friendly name of the material
  56911. * @param scene The scene to add the material to
  56912. */
  56913. constructor(name: string, scene: Scene);
  56914. /**
  56915. * Gets a boolean indicating that current material needs to register RTT
  56916. */
  56917. get hasRenderTargetTextures(): boolean;
  56918. /**
  56919. * The entire material has been created in order to prevent overdraw.
  56920. * @returns false
  56921. */
  56922. needAlphaTesting(): boolean;
  56923. /**
  56924. * The entire material has been created in order to prevent overdraw.
  56925. * @returns true if blending is enable
  56926. */
  56927. needAlphaBlending(): boolean;
  56928. /**
  56929. * Checks wether the material is ready to be rendered for a given mesh.
  56930. * @param mesh The mesh to render
  56931. * @param subMesh The submesh to check against
  56932. * @param useInstances Specify wether or not the material is used with instances
  56933. * @returns true if all the dependencies are ready (Textures, Effects...)
  56934. */
  56935. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56936. /**
  56937. * Compute the primary color according to the chosen perceptual color.
  56938. */
  56939. private _computePrimaryColorFromPerceptualColor;
  56940. /**
  56941. * Compute the highlights and shadow colors according to their chosen levels.
  56942. */
  56943. private _computePrimaryColors;
  56944. /**
  56945. * Build the uniform buffer used in the material.
  56946. */
  56947. buildUniformLayout(): void;
  56948. /**
  56949. * Unbind the material.
  56950. */
  56951. unbind(): void;
  56952. /**
  56953. * Bind only the world matrix to the material.
  56954. * @param world The world matrix to bind.
  56955. */
  56956. bindOnlyWorldMatrix(world: Matrix): void;
  56957. /**
  56958. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56959. * @param world The world matrix to bind.
  56960. * @param subMesh The submesh to bind for.
  56961. */
  56962. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56963. /**
  56964. * Checks to see if a texture is used in the material.
  56965. * @param texture - Base texture to use.
  56966. * @returns - Boolean specifying if a texture is used in the material.
  56967. */
  56968. hasTexture(texture: BaseTexture): boolean;
  56969. /**
  56970. * Dispose the material.
  56971. * @param forceDisposeEffect Force disposal of the associated effect.
  56972. * @param forceDisposeTextures Force disposal of the associated textures.
  56973. */
  56974. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56975. /**
  56976. * Clones the material.
  56977. * @param name The cloned name.
  56978. * @returns The cloned material.
  56979. */
  56980. clone(name: string): BackgroundMaterial;
  56981. /**
  56982. * Serializes the current material to its JSON representation.
  56983. * @returns The JSON representation.
  56984. */
  56985. serialize(): any;
  56986. /**
  56987. * Gets the class name of the material
  56988. * @returns "BackgroundMaterial"
  56989. */
  56990. getClassName(): string;
  56991. /**
  56992. * Parse a JSON input to create back a background material.
  56993. * @param source The JSON data to parse
  56994. * @param scene The scene to create the parsed material in
  56995. * @param rootUrl The root url of the assets the material depends upon
  56996. * @returns the instantiated BackgroundMaterial.
  56997. */
  56998. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56999. }
  57000. }
  57001. declare module "babylonjs/Helpers/environmentHelper" {
  57002. import { Observable } from "babylonjs/Misc/observable";
  57003. import { Nullable } from "babylonjs/types";
  57004. import { Scene } from "babylonjs/scene";
  57005. import { Vector3 } from "babylonjs/Maths/math.vector";
  57006. import { Color3 } from "babylonjs/Maths/math.color";
  57007. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57008. import { Mesh } from "babylonjs/Meshes/mesh";
  57009. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57010. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  57011. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57012. import "babylonjs/Meshes/Builders/planeBuilder";
  57013. import "babylonjs/Meshes/Builders/boxBuilder";
  57014. /**
  57015. * Represents the different options available during the creation of
  57016. * a Environment helper.
  57017. *
  57018. * This can control the default ground, skybox and image processing setup of your scene.
  57019. */
  57020. export interface IEnvironmentHelperOptions {
  57021. /**
  57022. * Specifies whether or not to create a ground.
  57023. * True by default.
  57024. */
  57025. createGround: boolean;
  57026. /**
  57027. * Specifies the ground size.
  57028. * 15 by default.
  57029. */
  57030. groundSize: number;
  57031. /**
  57032. * The texture used on the ground for the main color.
  57033. * Comes from the BabylonJS CDN by default.
  57034. *
  57035. * Remarks: Can be either a texture or a url.
  57036. */
  57037. groundTexture: string | BaseTexture;
  57038. /**
  57039. * The color mixed in the ground texture by default.
  57040. * BabylonJS clearColor by default.
  57041. */
  57042. groundColor: Color3;
  57043. /**
  57044. * Specifies the ground opacity.
  57045. * 1 by default.
  57046. */
  57047. groundOpacity: number;
  57048. /**
  57049. * Enables the ground to receive shadows.
  57050. * True by default.
  57051. */
  57052. enableGroundShadow: boolean;
  57053. /**
  57054. * Helps preventing the shadow to be fully black on the ground.
  57055. * 0.5 by default.
  57056. */
  57057. groundShadowLevel: number;
  57058. /**
  57059. * Creates a mirror texture attach to the ground.
  57060. * false by default.
  57061. */
  57062. enableGroundMirror: boolean;
  57063. /**
  57064. * Specifies the ground mirror size ratio.
  57065. * 0.3 by default as the default kernel is 64.
  57066. */
  57067. groundMirrorSizeRatio: number;
  57068. /**
  57069. * Specifies the ground mirror blur kernel size.
  57070. * 64 by default.
  57071. */
  57072. groundMirrorBlurKernel: number;
  57073. /**
  57074. * Specifies the ground mirror visibility amount.
  57075. * 1 by default
  57076. */
  57077. groundMirrorAmount: number;
  57078. /**
  57079. * Specifies the ground mirror reflectance weight.
  57080. * This uses the standard weight of the background material to setup the fresnel effect
  57081. * of the mirror.
  57082. * 1 by default.
  57083. */
  57084. groundMirrorFresnelWeight: number;
  57085. /**
  57086. * Specifies the ground mirror Falloff distance.
  57087. * This can helps reducing the size of the reflection.
  57088. * 0 by Default.
  57089. */
  57090. groundMirrorFallOffDistance: number;
  57091. /**
  57092. * Specifies the ground mirror texture type.
  57093. * Unsigned Int by Default.
  57094. */
  57095. groundMirrorTextureType: number;
  57096. /**
  57097. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57098. * the shown objects.
  57099. */
  57100. groundYBias: number;
  57101. /**
  57102. * Specifies whether or not to create a skybox.
  57103. * True by default.
  57104. */
  57105. createSkybox: boolean;
  57106. /**
  57107. * Specifies the skybox size.
  57108. * 20 by default.
  57109. */
  57110. skyboxSize: number;
  57111. /**
  57112. * The texture used on the skybox for the main color.
  57113. * Comes from the BabylonJS CDN by default.
  57114. *
  57115. * Remarks: Can be either a texture or a url.
  57116. */
  57117. skyboxTexture: string | BaseTexture;
  57118. /**
  57119. * The color mixed in the skybox texture by default.
  57120. * BabylonJS clearColor by default.
  57121. */
  57122. skyboxColor: Color3;
  57123. /**
  57124. * The background rotation around the Y axis of the scene.
  57125. * This helps aligning the key lights of your scene with the background.
  57126. * 0 by default.
  57127. */
  57128. backgroundYRotation: number;
  57129. /**
  57130. * Compute automatically the size of the elements to best fit with the scene.
  57131. */
  57132. sizeAuto: boolean;
  57133. /**
  57134. * Default position of the rootMesh if autoSize is not true.
  57135. */
  57136. rootPosition: Vector3;
  57137. /**
  57138. * Sets up the image processing in the scene.
  57139. * true by default.
  57140. */
  57141. setupImageProcessing: boolean;
  57142. /**
  57143. * The texture used as your environment texture in the scene.
  57144. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57145. *
  57146. * Remarks: Can be either a texture or a url.
  57147. */
  57148. environmentTexture: string | BaseTexture;
  57149. /**
  57150. * The value of the exposure to apply to the scene.
  57151. * 0.6 by default if setupImageProcessing is true.
  57152. */
  57153. cameraExposure: number;
  57154. /**
  57155. * The value of the contrast to apply to the scene.
  57156. * 1.6 by default if setupImageProcessing is true.
  57157. */
  57158. cameraContrast: number;
  57159. /**
  57160. * Specifies whether or not tonemapping should be enabled in the scene.
  57161. * true by default if setupImageProcessing is true.
  57162. */
  57163. toneMappingEnabled: boolean;
  57164. }
  57165. /**
  57166. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57167. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57168. * It also helps with the default setup of your imageProcessing configuration.
  57169. */
  57170. export class EnvironmentHelper {
  57171. /**
  57172. * Default ground texture URL.
  57173. */
  57174. private static _groundTextureCDNUrl;
  57175. /**
  57176. * Default skybox texture URL.
  57177. */
  57178. private static _skyboxTextureCDNUrl;
  57179. /**
  57180. * Default environment texture URL.
  57181. */
  57182. private static _environmentTextureCDNUrl;
  57183. /**
  57184. * Creates the default options for the helper.
  57185. */
  57186. private static _getDefaultOptions;
  57187. private _rootMesh;
  57188. /**
  57189. * Gets the root mesh created by the helper.
  57190. */
  57191. get rootMesh(): Mesh;
  57192. private _skybox;
  57193. /**
  57194. * Gets the skybox created by the helper.
  57195. */
  57196. get skybox(): Nullable<Mesh>;
  57197. private _skyboxTexture;
  57198. /**
  57199. * Gets the skybox texture created by the helper.
  57200. */
  57201. get skyboxTexture(): Nullable<BaseTexture>;
  57202. private _skyboxMaterial;
  57203. /**
  57204. * Gets the skybox material created by the helper.
  57205. */
  57206. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57207. private _ground;
  57208. /**
  57209. * Gets the ground mesh created by the helper.
  57210. */
  57211. get ground(): Nullable<Mesh>;
  57212. private _groundTexture;
  57213. /**
  57214. * Gets the ground texture created by the helper.
  57215. */
  57216. get groundTexture(): Nullable<BaseTexture>;
  57217. private _groundMirror;
  57218. /**
  57219. * Gets the ground mirror created by the helper.
  57220. */
  57221. get groundMirror(): Nullable<MirrorTexture>;
  57222. /**
  57223. * Gets the ground mirror render list to helps pushing the meshes
  57224. * you wish in the ground reflection.
  57225. */
  57226. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57227. private _groundMaterial;
  57228. /**
  57229. * Gets the ground material created by the helper.
  57230. */
  57231. get groundMaterial(): Nullable<BackgroundMaterial>;
  57232. /**
  57233. * Stores the creation options.
  57234. */
  57235. private readonly _scene;
  57236. private _options;
  57237. /**
  57238. * This observable will be notified with any error during the creation of the environment,
  57239. * mainly texture creation errors.
  57240. */
  57241. onErrorObservable: Observable<{
  57242. message?: string;
  57243. exception?: any;
  57244. }>;
  57245. /**
  57246. * constructor
  57247. * @param options Defines the options we want to customize the helper
  57248. * @param scene The scene to add the material to
  57249. */
  57250. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57251. /**
  57252. * Updates the background according to the new options
  57253. * @param options
  57254. */
  57255. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57256. /**
  57257. * Sets the primary color of all the available elements.
  57258. * @param color the main color to affect to the ground and the background
  57259. */
  57260. setMainColor(color: Color3): void;
  57261. /**
  57262. * Setup the image processing according to the specified options.
  57263. */
  57264. private _setupImageProcessing;
  57265. /**
  57266. * Setup the environment texture according to the specified options.
  57267. */
  57268. private _setupEnvironmentTexture;
  57269. /**
  57270. * Setup the background according to the specified options.
  57271. */
  57272. private _setupBackground;
  57273. /**
  57274. * Get the scene sizes according to the setup.
  57275. */
  57276. private _getSceneSize;
  57277. /**
  57278. * Setup the ground according to the specified options.
  57279. */
  57280. private _setupGround;
  57281. /**
  57282. * Setup the ground material according to the specified options.
  57283. */
  57284. private _setupGroundMaterial;
  57285. /**
  57286. * Setup the ground diffuse texture according to the specified options.
  57287. */
  57288. private _setupGroundDiffuseTexture;
  57289. /**
  57290. * Setup the ground mirror texture according to the specified options.
  57291. */
  57292. private _setupGroundMirrorTexture;
  57293. /**
  57294. * Setup the ground to receive the mirror texture.
  57295. */
  57296. private _setupMirrorInGroundMaterial;
  57297. /**
  57298. * Setup the skybox according to the specified options.
  57299. */
  57300. private _setupSkybox;
  57301. /**
  57302. * Setup the skybox material according to the specified options.
  57303. */
  57304. private _setupSkyboxMaterial;
  57305. /**
  57306. * Setup the skybox reflection texture according to the specified options.
  57307. */
  57308. private _setupSkyboxReflectionTexture;
  57309. private _errorHandler;
  57310. /**
  57311. * Dispose all the elements created by the Helper.
  57312. */
  57313. dispose(): void;
  57314. }
  57315. }
  57316. declare module "babylonjs/Helpers/textureDome" {
  57317. import { Scene } from "babylonjs/scene";
  57318. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57319. import { Mesh } from "babylonjs/Meshes/mesh";
  57320. import { Texture } from "babylonjs/Materials/Textures/texture";
  57321. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57322. import "babylonjs/Meshes/Builders/sphereBuilder";
  57323. import { Nullable } from "babylonjs/types";
  57324. import { Observable } from "babylonjs/Misc/observable";
  57325. /**
  57326. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57327. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57328. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57329. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57330. */
  57331. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57332. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57333. /**
  57334. * Define the source as a Monoscopic panoramic 360/180.
  57335. */
  57336. static readonly MODE_MONOSCOPIC: number;
  57337. /**
  57338. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57339. */
  57340. static readonly MODE_TOPBOTTOM: number;
  57341. /**
  57342. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57343. */
  57344. static readonly MODE_SIDEBYSIDE: number;
  57345. private _halfDome;
  57346. protected _useDirectMapping: boolean;
  57347. /**
  57348. * The texture being displayed on the sphere
  57349. */
  57350. protected _texture: T;
  57351. /**
  57352. * Gets the texture being displayed on the sphere
  57353. */
  57354. get texture(): T;
  57355. /**
  57356. * Sets the texture being displayed on the sphere
  57357. */
  57358. set texture(newTexture: T);
  57359. /**
  57360. * The skybox material
  57361. */
  57362. protected _material: BackgroundMaterial;
  57363. /**
  57364. * The surface used for the dome
  57365. */
  57366. protected _mesh: Mesh;
  57367. /**
  57368. * Gets the mesh used for the dome.
  57369. */
  57370. get mesh(): Mesh;
  57371. /**
  57372. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57373. */
  57374. private _halfDomeMask;
  57375. /**
  57376. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57377. * Also see the options.resolution property.
  57378. */
  57379. get fovMultiplier(): number;
  57380. set fovMultiplier(value: number);
  57381. protected _textureMode: number;
  57382. /**
  57383. * Gets or set the current texture mode for the texture. It can be:
  57384. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57385. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57386. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57387. */
  57388. get textureMode(): number;
  57389. /**
  57390. * Sets the current texture mode for the texture. It can be:
  57391. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57392. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57393. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57394. */
  57395. set textureMode(value: number);
  57396. /**
  57397. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57398. */
  57399. get halfDome(): boolean;
  57400. /**
  57401. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57402. */
  57403. set halfDome(enabled: boolean);
  57404. /**
  57405. * Oberserver used in Stereoscopic VR Mode.
  57406. */
  57407. private _onBeforeCameraRenderObserver;
  57408. /**
  57409. * Observable raised when an error occured while loading the 360 image
  57410. */
  57411. onLoadErrorObservable: Observable<string>;
  57412. /**
  57413. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57414. * @param name Element's name, child elements will append suffixes for their own names.
  57415. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57416. * @param options An object containing optional or exposed sub element properties
  57417. */
  57418. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57419. resolution?: number;
  57420. clickToPlay?: boolean;
  57421. autoPlay?: boolean;
  57422. loop?: boolean;
  57423. size?: number;
  57424. poster?: string;
  57425. faceForward?: boolean;
  57426. useDirectMapping?: boolean;
  57427. halfDomeMode?: boolean;
  57428. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57429. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57430. protected _changeTextureMode(value: number): void;
  57431. /**
  57432. * Releases resources associated with this node.
  57433. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57434. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57435. */
  57436. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57437. }
  57438. }
  57439. declare module "babylonjs/Helpers/photoDome" {
  57440. import { Scene } from "babylonjs/scene";
  57441. import { Texture } from "babylonjs/Materials/Textures/texture";
  57442. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57443. /**
  57444. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57445. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57446. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57447. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57448. */
  57449. export class PhotoDome extends TextureDome<Texture> {
  57450. /**
  57451. * Define the image as a Monoscopic panoramic 360 image.
  57452. */
  57453. static readonly MODE_MONOSCOPIC: number;
  57454. /**
  57455. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57456. */
  57457. static readonly MODE_TOPBOTTOM: number;
  57458. /**
  57459. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57460. */
  57461. static readonly MODE_SIDEBYSIDE: number;
  57462. /**
  57463. * Gets or sets the texture being displayed on the sphere
  57464. */
  57465. get photoTexture(): Texture;
  57466. /**
  57467. * sets the texture being displayed on the sphere
  57468. */
  57469. set photoTexture(value: Texture);
  57470. /**
  57471. * Gets the current video mode for the video. It can be:
  57472. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57473. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57474. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57475. */
  57476. get imageMode(): number;
  57477. /**
  57478. * Sets the current video mode for the video. It can be:
  57479. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57480. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57481. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57482. */
  57483. set imageMode(value: number);
  57484. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57485. }
  57486. }
  57487. declare module "babylonjs/Misc/rgbdTextureTools" {
  57488. import "babylonjs/Shaders/rgbdDecode.fragment";
  57489. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57490. import { Texture } from "babylonjs/Materials/Textures/texture";
  57491. /**
  57492. * Class used to host RGBD texture specific utilities
  57493. */
  57494. export class RGBDTextureTools {
  57495. /**
  57496. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57497. * @param texture the texture to expand.
  57498. */
  57499. static ExpandRGBDTexture(texture: Texture): void;
  57500. }
  57501. }
  57502. declare module "babylonjs/Misc/brdfTextureTools" {
  57503. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57504. import { Scene } from "babylonjs/scene";
  57505. /**
  57506. * Class used to host texture specific utilities
  57507. */
  57508. export class BRDFTextureTools {
  57509. /**
  57510. * Prevents texture cache collision
  57511. */
  57512. private static _instanceNumber;
  57513. /**
  57514. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57515. * @param scene defines the hosting scene
  57516. * @returns the environment BRDF texture
  57517. */
  57518. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57519. private static _environmentBRDFBase64Texture;
  57520. }
  57521. }
  57522. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57523. import { Nullable } from "babylonjs/types";
  57524. import { Color3 } from "babylonjs/Maths/math.color";
  57525. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57526. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57527. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57528. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57529. import { Engine } from "babylonjs/Engines/engine";
  57530. import { Scene } from "babylonjs/scene";
  57531. /**
  57532. * @hidden
  57533. */
  57534. export interface IMaterialClearCoatDefines {
  57535. CLEARCOAT: boolean;
  57536. CLEARCOAT_DEFAULTIOR: boolean;
  57537. CLEARCOAT_TEXTURE: boolean;
  57538. CLEARCOAT_TEXTUREDIRECTUV: number;
  57539. CLEARCOAT_BUMP: boolean;
  57540. CLEARCOAT_BUMPDIRECTUV: number;
  57541. CLEARCOAT_TINT: boolean;
  57542. CLEARCOAT_TINT_TEXTURE: boolean;
  57543. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57544. /** @hidden */
  57545. _areTexturesDirty: boolean;
  57546. }
  57547. /**
  57548. * Define the code related to the clear coat parameters of the pbr material.
  57549. */
  57550. export class PBRClearCoatConfiguration {
  57551. /**
  57552. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57553. * The default fits with a polyurethane material.
  57554. */
  57555. private static readonly _DefaultIndexOfRefraction;
  57556. private _isEnabled;
  57557. /**
  57558. * Defines if the clear coat is enabled in the material.
  57559. */
  57560. isEnabled: boolean;
  57561. /**
  57562. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57563. */
  57564. intensity: number;
  57565. /**
  57566. * Defines the clear coat layer roughness.
  57567. */
  57568. roughness: number;
  57569. private _indexOfRefraction;
  57570. /**
  57571. * Defines the index of refraction of the clear coat.
  57572. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57573. * The default fits with a polyurethane material.
  57574. * Changing the default value is more performance intensive.
  57575. */
  57576. indexOfRefraction: number;
  57577. private _texture;
  57578. /**
  57579. * Stores the clear coat values in a texture.
  57580. */
  57581. texture: Nullable<BaseTexture>;
  57582. private _bumpTexture;
  57583. /**
  57584. * Define the clear coat specific bump texture.
  57585. */
  57586. bumpTexture: Nullable<BaseTexture>;
  57587. private _isTintEnabled;
  57588. /**
  57589. * Defines if the clear coat tint is enabled in the material.
  57590. */
  57591. isTintEnabled: boolean;
  57592. /**
  57593. * Defines the clear coat tint of the material.
  57594. * This is only use if tint is enabled
  57595. */
  57596. tintColor: Color3;
  57597. /**
  57598. * Defines the distance at which the tint color should be found in the
  57599. * clear coat media.
  57600. * This is only use if tint is enabled
  57601. */
  57602. tintColorAtDistance: number;
  57603. /**
  57604. * Defines the clear coat layer thickness.
  57605. * This is only use if tint is enabled
  57606. */
  57607. tintThickness: number;
  57608. private _tintTexture;
  57609. /**
  57610. * Stores the clear tint values in a texture.
  57611. * rgb is tint
  57612. * a is a thickness factor
  57613. */
  57614. tintTexture: Nullable<BaseTexture>;
  57615. /** @hidden */
  57616. private _internalMarkAllSubMeshesAsTexturesDirty;
  57617. /** @hidden */
  57618. _markAllSubMeshesAsTexturesDirty(): void;
  57619. /**
  57620. * Instantiate a new istance of clear coat configuration.
  57621. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57622. */
  57623. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57624. /**
  57625. * Gets wehter the submesh is ready to be used or not.
  57626. * @param defines the list of "defines" to update.
  57627. * @param scene defines the scene the material belongs to.
  57628. * @param engine defines the engine the material belongs to.
  57629. * @param disableBumpMap defines wether the material disables bump or not.
  57630. * @returns - boolean indicating that the submesh is ready or not.
  57631. */
  57632. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57633. /**
  57634. * Checks to see if a texture is used in the material.
  57635. * @param defines the list of "defines" to update.
  57636. * @param scene defines the scene to the material belongs to.
  57637. */
  57638. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57639. /**
  57640. * Binds the material data.
  57641. * @param uniformBuffer defines the Uniform buffer to fill in.
  57642. * @param scene defines the scene the material belongs to.
  57643. * @param engine defines the engine the material belongs to.
  57644. * @param disableBumpMap defines wether the material disables bump or not.
  57645. * @param isFrozen defines wether the material is frozen or not.
  57646. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57647. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57648. */
  57649. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57650. /**
  57651. * Checks to see if a texture is used in the material.
  57652. * @param texture - Base texture to use.
  57653. * @returns - Boolean specifying if a texture is used in the material.
  57654. */
  57655. hasTexture(texture: BaseTexture): boolean;
  57656. /**
  57657. * Returns an array of the actively used textures.
  57658. * @param activeTextures Array of BaseTextures
  57659. */
  57660. getActiveTextures(activeTextures: BaseTexture[]): void;
  57661. /**
  57662. * Returns the animatable textures.
  57663. * @param animatables Array of animatable textures.
  57664. */
  57665. getAnimatables(animatables: IAnimatable[]): void;
  57666. /**
  57667. * Disposes the resources of the material.
  57668. * @param forceDisposeTextures - Forces the disposal of all textures.
  57669. */
  57670. dispose(forceDisposeTextures?: boolean): void;
  57671. /**
  57672. * Get the current class name of the texture useful for serialization or dynamic coding.
  57673. * @returns "PBRClearCoatConfiguration"
  57674. */
  57675. getClassName(): string;
  57676. /**
  57677. * Add fallbacks to the effect fallbacks list.
  57678. * @param defines defines the Base texture to use.
  57679. * @param fallbacks defines the current fallback list.
  57680. * @param currentRank defines the current fallback rank.
  57681. * @returns the new fallback rank.
  57682. */
  57683. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57684. /**
  57685. * Add the required uniforms to the current list.
  57686. * @param uniforms defines the current uniform list.
  57687. */
  57688. static AddUniforms(uniforms: string[]): void;
  57689. /**
  57690. * Add the required samplers to the current list.
  57691. * @param samplers defines the current sampler list.
  57692. */
  57693. static AddSamplers(samplers: string[]): void;
  57694. /**
  57695. * Add the required uniforms to the current buffer.
  57696. * @param uniformBuffer defines the current uniform buffer.
  57697. */
  57698. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57699. /**
  57700. * Makes a duplicate of the current configuration into another one.
  57701. * @param clearCoatConfiguration define the config where to copy the info
  57702. */
  57703. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57704. /**
  57705. * Serializes this clear coat configuration.
  57706. * @returns - An object with the serialized config.
  57707. */
  57708. serialize(): any;
  57709. /**
  57710. * Parses a anisotropy Configuration from a serialized object.
  57711. * @param source - Serialized object.
  57712. * @param scene Defines the scene we are parsing for
  57713. * @param rootUrl Defines the rootUrl to load from
  57714. */
  57715. parse(source: any, scene: Scene, rootUrl: string): void;
  57716. }
  57717. }
  57718. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57719. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57720. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57721. import { Vector2 } from "babylonjs/Maths/math.vector";
  57722. import { Scene } from "babylonjs/scene";
  57723. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57724. import { Nullable } from "babylonjs/types";
  57725. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57726. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57727. /**
  57728. * @hidden
  57729. */
  57730. export interface IMaterialAnisotropicDefines {
  57731. ANISOTROPIC: boolean;
  57732. ANISOTROPIC_TEXTURE: boolean;
  57733. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57734. MAINUV1: boolean;
  57735. _areTexturesDirty: boolean;
  57736. _needUVs: boolean;
  57737. }
  57738. /**
  57739. * Define the code related to the anisotropic parameters of the pbr material.
  57740. */
  57741. export class PBRAnisotropicConfiguration {
  57742. private _isEnabled;
  57743. /**
  57744. * Defines if the anisotropy is enabled in the material.
  57745. */
  57746. isEnabled: boolean;
  57747. /**
  57748. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57749. */
  57750. intensity: number;
  57751. /**
  57752. * Defines if the effect is along the tangents, bitangents or in between.
  57753. * By default, the effect is "strectching" the highlights along the tangents.
  57754. */
  57755. direction: Vector2;
  57756. private _texture;
  57757. /**
  57758. * Stores the anisotropy values in a texture.
  57759. * rg is direction (like normal from -1 to 1)
  57760. * b is a intensity
  57761. */
  57762. texture: Nullable<BaseTexture>;
  57763. /** @hidden */
  57764. private _internalMarkAllSubMeshesAsTexturesDirty;
  57765. /** @hidden */
  57766. _markAllSubMeshesAsTexturesDirty(): void;
  57767. /**
  57768. * Instantiate a new istance of anisotropy configuration.
  57769. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57770. */
  57771. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57772. /**
  57773. * Specifies that the submesh is ready to be used.
  57774. * @param defines the list of "defines" to update.
  57775. * @param scene defines the scene the material belongs to.
  57776. * @returns - boolean indicating that the submesh is ready or not.
  57777. */
  57778. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57779. /**
  57780. * Checks to see if a texture is used in the material.
  57781. * @param defines the list of "defines" to update.
  57782. * @param mesh the mesh we are preparing the defines for.
  57783. * @param scene defines the scene the material belongs to.
  57784. */
  57785. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57786. /**
  57787. * Binds the material data.
  57788. * @param uniformBuffer defines the Uniform buffer to fill in.
  57789. * @param scene defines the scene the material belongs to.
  57790. * @param isFrozen defines wether the material is frozen or not.
  57791. */
  57792. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57793. /**
  57794. * Checks to see if a texture is used in the material.
  57795. * @param texture - Base texture to use.
  57796. * @returns - Boolean specifying if a texture is used in the material.
  57797. */
  57798. hasTexture(texture: BaseTexture): boolean;
  57799. /**
  57800. * Returns an array of the actively used textures.
  57801. * @param activeTextures Array of BaseTextures
  57802. */
  57803. getActiveTextures(activeTextures: BaseTexture[]): void;
  57804. /**
  57805. * Returns the animatable textures.
  57806. * @param animatables Array of animatable textures.
  57807. */
  57808. getAnimatables(animatables: IAnimatable[]): void;
  57809. /**
  57810. * Disposes the resources of the material.
  57811. * @param forceDisposeTextures - Forces the disposal of all textures.
  57812. */
  57813. dispose(forceDisposeTextures?: boolean): void;
  57814. /**
  57815. * Get the current class name of the texture useful for serialization or dynamic coding.
  57816. * @returns "PBRAnisotropicConfiguration"
  57817. */
  57818. getClassName(): string;
  57819. /**
  57820. * Add fallbacks to the effect fallbacks list.
  57821. * @param defines defines the Base texture to use.
  57822. * @param fallbacks defines the current fallback list.
  57823. * @param currentRank defines the current fallback rank.
  57824. * @returns the new fallback rank.
  57825. */
  57826. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57827. /**
  57828. * Add the required uniforms to the current list.
  57829. * @param uniforms defines the current uniform list.
  57830. */
  57831. static AddUniforms(uniforms: string[]): void;
  57832. /**
  57833. * Add the required uniforms to the current buffer.
  57834. * @param uniformBuffer defines the current uniform buffer.
  57835. */
  57836. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57837. /**
  57838. * Add the required samplers to the current list.
  57839. * @param samplers defines the current sampler list.
  57840. */
  57841. static AddSamplers(samplers: string[]): void;
  57842. /**
  57843. * Makes a duplicate of the current configuration into another one.
  57844. * @param anisotropicConfiguration define the config where to copy the info
  57845. */
  57846. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57847. /**
  57848. * Serializes this anisotropy configuration.
  57849. * @returns - An object with the serialized config.
  57850. */
  57851. serialize(): any;
  57852. /**
  57853. * Parses a anisotropy Configuration from a serialized object.
  57854. * @param source - Serialized object.
  57855. * @param scene Defines the scene we are parsing for
  57856. * @param rootUrl Defines the rootUrl to load from
  57857. */
  57858. parse(source: any, scene: Scene, rootUrl: string): void;
  57859. }
  57860. }
  57861. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57862. import { Scene } from "babylonjs/scene";
  57863. /**
  57864. * @hidden
  57865. */
  57866. export interface IMaterialBRDFDefines {
  57867. BRDF_V_HEIGHT_CORRELATED: boolean;
  57868. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57869. SPHERICAL_HARMONICS: boolean;
  57870. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57871. /** @hidden */
  57872. _areMiscDirty: boolean;
  57873. }
  57874. /**
  57875. * Define the code related to the BRDF parameters of the pbr material.
  57876. */
  57877. export class PBRBRDFConfiguration {
  57878. /**
  57879. * Default value used for the energy conservation.
  57880. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57881. */
  57882. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57883. /**
  57884. * Default value used for the Smith Visibility Height Correlated mode.
  57885. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57886. */
  57887. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57888. /**
  57889. * Default value used for the IBL diffuse part.
  57890. * This can help switching back to the polynomials mode globally which is a tiny bit
  57891. * less GPU intensive at the drawback of a lower quality.
  57892. */
  57893. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57894. /**
  57895. * Default value used for activating energy conservation for the specular workflow.
  57896. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57897. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57898. */
  57899. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57900. private _useEnergyConservation;
  57901. /**
  57902. * Defines if the material uses energy conservation.
  57903. */
  57904. useEnergyConservation: boolean;
  57905. private _useSmithVisibilityHeightCorrelated;
  57906. /**
  57907. * LEGACY Mode set to false
  57908. * Defines if the material uses height smith correlated visibility term.
  57909. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57910. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57911. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57912. * Not relying on height correlated will also disable energy conservation.
  57913. */
  57914. useSmithVisibilityHeightCorrelated: boolean;
  57915. private _useSphericalHarmonics;
  57916. /**
  57917. * LEGACY Mode set to false
  57918. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57919. * diffuse part of the IBL.
  57920. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57921. * to the ground truth.
  57922. */
  57923. useSphericalHarmonics: boolean;
  57924. private _useSpecularGlossinessInputEnergyConservation;
  57925. /**
  57926. * Defines if the material uses energy conservation, when the specular workflow is active.
  57927. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57928. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57929. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57930. */
  57931. useSpecularGlossinessInputEnergyConservation: boolean;
  57932. /** @hidden */
  57933. private _internalMarkAllSubMeshesAsMiscDirty;
  57934. /** @hidden */
  57935. _markAllSubMeshesAsMiscDirty(): void;
  57936. /**
  57937. * Instantiate a new istance of clear coat configuration.
  57938. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57939. */
  57940. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57941. /**
  57942. * Checks to see if a texture is used in the material.
  57943. * @param defines the list of "defines" to update.
  57944. */
  57945. prepareDefines(defines: IMaterialBRDFDefines): void;
  57946. /**
  57947. * Get the current class name of the texture useful for serialization or dynamic coding.
  57948. * @returns "PBRClearCoatConfiguration"
  57949. */
  57950. getClassName(): string;
  57951. /**
  57952. * Makes a duplicate of the current configuration into another one.
  57953. * @param brdfConfiguration define the config where to copy the info
  57954. */
  57955. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57956. /**
  57957. * Serializes this BRDF configuration.
  57958. * @returns - An object with the serialized config.
  57959. */
  57960. serialize(): any;
  57961. /**
  57962. * Parses a anisotropy Configuration from a serialized object.
  57963. * @param source - Serialized object.
  57964. * @param scene Defines the scene we are parsing for
  57965. * @param rootUrl Defines the rootUrl to load from
  57966. */
  57967. parse(source: any, scene: Scene, rootUrl: string): void;
  57968. }
  57969. }
  57970. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57971. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57972. import { Color3 } from "babylonjs/Maths/math.color";
  57973. import { Scene } from "babylonjs/scene";
  57974. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57975. import { Nullable } from "babylonjs/types";
  57976. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57977. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57978. /**
  57979. * @hidden
  57980. */
  57981. export interface IMaterialSheenDefines {
  57982. SHEEN: boolean;
  57983. SHEEN_TEXTURE: boolean;
  57984. SHEEN_TEXTUREDIRECTUV: number;
  57985. SHEEN_LINKWITHALBEDO: boolean;
  57986. SHEEN_ROUGHNESS: boolean;
  57987. SHEEN_ALBEDOSCALING: boolean;
  57988. /** @hidden */
  57989. _areTexturesDirty: boolean;
  57990. }
  57991. /**
  57992. * Define the code related to the Sheen parameters of the pbr material.
  57993. */
  57994. export class PBRSheenConfiguration {
  57995. private _isEnabled;
  57996. /**
  57997. * Defines if the material uses sheen.
  57998. */
  57999. isEnabled: boolean;
  58000. private _linkSheenWithAlbedo;
  58001. /**
  58002. * Defines if the sheen is linked to the sheen color.
  58003. */
  58004. linkSheenWithAlbedo: boolean;
  58005. /**
  58006. * Defines the sheen intensity.
  58007. */
  58008. intensity: number;
  58009. /**
  58010. * Defines the sheen color.
  58011. */
  58012. color: Color3;
  58013. private _texture;
  58014. /**
  58015. * Stores the sheen tint values in a texture.
  58016. * rgb is tint
  58017. * a is a intensity or roughness if roughness has been defined
  58018. */
  58019. texture: Nullable<BaseTexture>;
  58020. private _roughness;
  58021. /**
  58022. * Defines the sheen roughness.
  58023. * It is not taken into account if linkSheenWithAlbedo is true.
  58024. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58025. */
  58026. roughness: Nullable<number>;
  58027. private _albedoScaling;
  58028. /**
  58029. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58030. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58031. * making it easier to setup and tweak the effect
  58032. */
  58033. albedoScaling: boolean;
  58034. /** @hidden */
  58035. private _internalMarkAllSubMeshesAsTexturesDirty;
  58036. /** @hidden */
  58037. _markAllSubMeshesAsTexturesDirty(): void;
  58038. /**
  58039. * Instantiate a new istance of clear coat configuration.
  58040. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58041. */
  58042. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58043. /**
  58044. * Specifies that the submesh is ready to be used.
  58045. * @param defines the list of "defines" to update.
  58046. * @param scene defines the scene the material belongs to.
  58047. * @returns - boolean indicating that the submesh is ready or not.
  58048. */
  58049. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58050. /**
  58051. * Checks to see if a texture is used in the material.
  58052. * @param defines the list of "defines" to update.
  58053. * @param scene defines the scene the material belongs to.
  58054. */
  58055. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58056. /**
  58057. * Binds the material data.
  58058. * @param uniformBuffer defines the Uniform buffer to fill in.
  58059. * @param scene defines the scene the material belongs to.
  58060. * @param isFrozen defines wether the material is frozen or not.
  58061. */
  58062. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58063. /**
  58064. * Checks to see if a texture is used in the material.
  58065. * @param texture - Base texture to use.
  58066. * @returns - Boolean specifying if a texture is used in the material.
  58067. */
  58068. hasTexture(texture: BaseTexture): boolean;
  58069. /**
  58070. * Returns an array of the actively used textures.
  58071. * @param activeTextures Array of BaseTextures
  58072. */
  58073. getActiveTextures(activeTextures: BaseTexture[]): void;
  58074. /**
  58075. * Returns the animatable textures.
  58076. * @param animatables Array of animatable textures.
  58077. */
  58078. getAnimatables(animatables: IAnimatable[]): void;
  58079. /**
  58080. * Disposes the resources of the material.
  58081. * @param forceDisposeTextures - Forces the disposal of all textures.
  58082. */
  58083. dispose(forceDisposeTextures?: boolean): void;
  58084. /**
  58085. * Get the current class name of the texture useful for serialization or dynamic coding.
  58086. * @returns "PBRSheenConfiguration"
  58087. */
  58088. getClassName(): string;
  58089. /**
  58090. * Add fallbacks to the effect fallbacks list.
  58091. * @param defines defines the Base texture to use.
  58092. * @param fallbacks defines the current fallback list.
  58093. * @param currentRank defines the current fallback rank.
  58094. * @returns the new fallback rank.
  58095. */
  58096. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58097. /**
  58098. * Add the required uniforms to the current list.
  58099. * @param uniforms defines the current uniform list.
  58100. */
  58101. static AddUniforms(uniforms: string[]): void;
  58102. /**
  58103. * Add the required uniforms to the current buffer.
  58104. * @param uniformBuffer defines the current uniform buffer.
  58105. */
  58106. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58107. /**
  58108. * Add the required samplers to the current list.
  58109. * @param samplers defines the current sampler list.
  58110. */
  58111. static AddSamplers(samplers: string[]): void;
  58112. /**
  58113. * Makes a duplicate of the current configuration into another one.
  58114. * @param sheenConfiguration define the config where to copy the info
  58115. */
  58116. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58117. /**
  58118. * Serializes this BRDF configuration.
  58119. * @returns - An object with the serialized config.
  58120. */
  58121. serialize(): any;
  58122. /**
  58123. * Parses a anisotropy Configuration from a serialized object.
  58124. * @param source - Serialized object.
  58125. * @param scene Defines the scene we are parsing for
  58126. * @param rootUrl Defines the rootUrl to load from
  58127. */
  58128. parse(source: any, scene: Scene, rootUrl: string): void;
  58129. }
  58130. }
  58131. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58132. import { Nullable } from "babylonjs/types";
  58133. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58134. import { Color3 } from "babylonjs/Maths/math.color";
  58135. import { SmartArray } from "babylonjs/Misc/smartArray";
  58136. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58137. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58138. import { Effect } from "babylonjs/Materials/effect";
  58139. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58140. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58141. import { Engine } from "babylonjs/Engines/engine";
  58142. import { Scene } from "babylonjs/scene";
  58143. /**
  58144. * @hidden
  58145. */
  58146. export interface IMaterialSubSurfaceDefines {
  58147. SUBSURFACE: boolean;
  58148. SS_REFRACTION: boolean;
  58149. SS_TRANSLUCENCY: boolean;
  58150. SS_SCATTERING: boolean;
  58151. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58152. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58153. SS_REFRACTIONMAP_3D: boolean;
  58154. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58155. SS_LODINREFRACTIONALPHA: boolean;
  58156. SS_GAMMAREFRACTION: boolean;
  58157. SS_RGBDREFRACTION: boolean;
  58158. SS_LINEARSPECULARREFRACTION: boolean;
  58159. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58160. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58161. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58162. /** @hidden */
  58163. _areTexturesDirty: boolean;
  58164. }
  58165. /**
  58166. * Define the code related to the sub surface parameters of the pbr material.
  58167. */
  58168. export class PBRSubSurfaceConfiguration {
  58169. private _isRefractionEnabled;
  58170. /**
  58171. * Defines if the refraction is enabled in the material.
  58172. */
  58173. isRefractionEnabled: boolean;
  58174. private _isTranslucencyEnabled;
  58175. /**
  58176. * Defines if the translucency is enabled in the material.
  58177. */
  58178. isTranslucencyEnabled: boolean;
  58179. private _isScatteringEnabled;
  58180. /**
  58181. * Defines if the sub surface scattering is enabled in the material.
  58182. */
  58183. isScatteringEnabled: boolean;
  58184. private _scatteringDiffusionProfileIndex;
  58185. /**
  58186. * Diffusion profile for subsurface scattering.
  58187. * Useful for better scattering in the skins or foliages.
  58188. */
  58189. get scatteringDiffusionProfile(): Nullable<Color3>;
  58190. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58191. /**
  58192. * Defines the refraction intensity of the material.
  58193. * The refraction when enabled replaces the Diffuse part of the material.
  58194. * The intensity helps transitionning between diffuse and refraction.
  58195. */
  58196. refractionIntensity: number;
  58197. /**
  58198. * Defines the translucency intensity of the material.
  58199. * When translucency has been enabled, this defines how much of the "translucency"
  58200. * is addded to the diffuse part of the material.
  58201. */
  58202. translucencyIntensity: number;
  58203. /**
  58204. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58205. */
  58206. useAlbedoToTintRefraction: boolean;
  58207. private _thicknessTexture;
  58208. /**
  58209. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58210. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58211. * 0 would mean minimumThickness
  58212. * 1 would mean maximumThickness
  58213. * The other channels might be use as a mask to vary the different effects intensity.
  58214. */
  58215. thicknessTexture: Nullable<BaseTexture>;
  58216. private _refractionTexture;
  58217. /**
  58218. * Defines the texture to use for refraction.
  58219. */
  58220. refractionTexture: Nullable<BaseTexture>;
  58221. private _indexOfRefraction;
  58222. /**
  58223. * Index of refraction of the material base layer.
  58224. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58225. *
  58226. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58227. *
  58228. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58229. */
  58230. indexOfRefraction: number;
  58231. private _volumeIndexOfRefraction;
  58232. /**
  58233. * Index of refraction of the material's volume.
  58234. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58235. *
  58236. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58237. * the volume will use the same IOR as the surface.
  58238. */
  58239. get volumeIndexOfRefraction(): number;
  58240. set volumeIndexOfRefraction(value: number);
  58241. private _invertRefractionY;
  58242. /**
  58243. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58244. */
  58245. invertRefractionY: boolean;
  58246. private _linkRefractionWithTransparency;
  58247. /**
  58248. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58249. * Materials half opaque for instance using refraction could benefit from this control.
  58250. */
  58251. linkRefractionWithTransparency: boolean;
  58252. /**
  58253. * Defines the minimum thickness stored in the thickness map.
  58254. * If no thickness map is defined, this value will be used to simulate thickness.
  58255. */
  58256. minimumThickness: number;
  58257. /**
  58258. * Defines the maximum thickness stored in the thickness map.
  58259. */
  58260. maximumThickness: number;
  58261. /**
  58262. * Defines the volume tint of the material.
  58263. * This is used for both translucency and scattering.
  58264. */
  58265. tintColor: Color3;
  58266. /**
  58267. * Defines the distance at which the tint color should be found in the media.
  58268. * This is used for refraction only.
  58269. */
  58270. tintColorAtDistance: number;
  58271. /**
  58272. * Defines how far each channel transmit through the media.
  58273. * It is defined as a color to simplify it selection.
  58274. */
  58275. diffusionDistance: Color3;
  58276. private _useMaskFromThicknessTexture;
  58277. /**
  58278. * Stores the intensity of the different subsurface effects in the thickness texture.
  58279. * * the green channel is the translucency intensity.
  58280. * * the blue channel is the scattering intensity.
  58281. * * the alpha channel is the refraction intensity.
  58282. */
  58283. useMaskFromThicknessTexture: boolean;
  58284. private _scene;
  58285. /** @hidden */
  58286. private _internalMarkAllSubMeshesAsTexturesDirty;
  58287. private _internalMarkScenePrePassDirty;
  58288. /** @hidden */
  58289. _markAllSubMeshesAsTexturesDirty(): void;
  58290. /** @hidden */
  58291. _markScenePrePassDirty(): void;
  58292. /**
  58293. * Instantiate a new istance of sub surface configuration.
  58294. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58295. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58296. * @param scene The scene
  58297. */
  58298. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58299. /**
  58300. * Gets wehter the submesh is ready to be used or not.
  58301. * @param defines the list of "defines" to update.
  58302. * @param scene defines the scene the material belongs to.
  58303. * @returns - boolean indicating that the submesh is ready or not.
  58304. */
  58305. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58306. /**
  58307. * Checks to see if a texture is used in the material.
  58308. * @param defines the list of "defines" to update.
  58309. * @param scene defines the scene to the material belongs to.
  58310. */
  58311. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58312. /**
  58313. * Binds the material data.
  58314. * @param uniformBuffer defines the Uniform buffer to fill in.
  58315. * @param scene defines the scene the material belongs to.
  58316. * @param engine defines the engine the material belongs to.
  58317. * @param isFrozen defines whether the material is frozen or not.
  58318. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58319. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58320. */
  58321. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58322. /**
  58323. * Unbinds the material from the mesh.
  58324. * @param activeEffect defines the effect that should be unbound from.
  58325. * @returns true if unbound, otherwise false
  58326. */
  58327. unbind(activeEffect: Effect): boolean;
  58328. /**
  58329. * Returns the texture used for refraction or null if none is used.
  58330. * @param scene defines the scene the material belongs to.
  58331. * @returns - Refraction texture if present. If no refraction texture and refraction
  58332. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58333. */
  58334. private _getRefractionTexture;
  58335. /**
  58336. * Returns true if alpha blending should be disabled.
  58337. */
  58338. get disableAlphaBlending(): boolean;
  58339. /**
  58340. * Fills the list of render target textures.
  58341. * @param renderTargets the list of render targets to update
  58342. */
  58343. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58344. /**
  58345. * Checks to see if a texture is used in the material.
  58346. * @param texture - Base texture to use.
  58347. * @returns - Boolean specifying if a texture is used in the material.
  58348. */
  58349. hasTexture(texture: BaseTexture): boolean;
  58350. /**
  58351. * Gets a boolean indicating that current material needs to register RTT
  58352. * @returns true if this uses a render target otherwise false.
  58353. */
  58354. hasRenderTargetTextures(): boolean;
  58355. /**
  58356. * Returns an array of the actively used textures.
  58357. * @param activeTextures Array of BaseTextures
  58358. */
  58359. getActiveTextures(activeTextures: BaseTexture[]): void;
  58360. /**
  58361. * Returns the animatable textures.
  58362. * @param animatables Array of animatable textures.
  58363. */
  58364. getAnimatables(animatables: IAnimatable[]): void;
  58365. /**
  58366. * Disposes the resources of the material.
  58367. * @param forceDisposeTextures - Forces the disposal of all textures.
  58368. */
  58369. dispose(forceDisposeTextures?: boolean): void;
  58370. /**
  58371. * Get the current class name of the texture useful for serialization or dynamic coding.
  58372. * @returns "PBRSubSurfaceConfiguration"
  58373. */
  58374. getClassName(): string;
  58375. /**
  58376. * Add fallbacks to the effect fallbacks list.
  58377. * @param defines defines the Base texture to use.
  58378. * @param fallbacks defines the current fallback list.
  58379. * @param currentRank defines the current fallback rank.
  58380. * @returns the new fallback rank.
  58381. */
  58382. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58383. /**
  58384. * Add the required uniforms to the current list.
  58385. * @param uniforms defines the current uniform list.
  58386. */
  58387. static AddUniforms(uniforms: string[]): void;
  58388. /**
  58389. * Add the required samplers to the current list.
  58390. * @param samplers defines the current sampler list.
  58391. */
  58392. static AddSamplers(samplers: string[]): void;
  58393. /**
  58394. * Add the required uniforms to the current buffer.
  58395. * @param uniformBuffer defines the current uniform buffer.
  58396. */
  58397. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58398. /**
  58399. * Makes a duplicate of the current configuration into another one.
  58400. * @param configuration define the config where to copy the info
  58401. */
  58402. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58403. /**
  58404. * Serializes this Sub Surface configuration.
  58405. * @returns - An object with the serialized config.
  58406. */
  58407. serialize(): any;
  58408. /**
  58409. * Parses a anisotropy Configuration from a serialized object.
  58410. * @param source - Serialized object.
  58411. * @param scene Defines the scene we are parsing for
  58412. * @param rootUrl Defines the rootUrl to load from
  58413. */
  58414. parse(source: any, scene: Scene, rootUrl: string): void;
  58415. }
  58416. }
  58417. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58418. /** @hidden */
  58419. export var pbrFragmentDeclaration: {
  58420. name: string;
  58421. shader: string;
  58422. };
  58423. }
  58424. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58425. /** @hidden */
  58426. export var pbrUboDeclaration: {
  58427. name: string;
  58428. shader: string;
  58429. };
  58430. }
  58431. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58432. /** @hidden */
  58433. export var pbrFragmentExtraDeclaration: {
  58434. name: string;
  58435. shader: string;
  58436. };
  58437. }
  58438. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58439. /** @hidden */
  58440. export var pbrFragmentSamplersDeclaration: {
  58441. name: string;
  58442. shader: string;
  58443. };
  58444. }
  58445. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58446. /** @hidden */
  58447. export var importanceSampling: {
  58448. name: string;
  58449. shader: string;
  58450. };
  58451. }
  58452. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58453. /** @hidden */
  58454. export var pbrHelperFunctions: {
  58455. name: string;
  58456. shader: string;
  58457. };
  58458. }
  58459. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58460. /** @hidden */
  58461. export var harmonicsFunctions: {
  58462. name: string;
  58463. shader: string;
  58464. };
  58465. }
  58466. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58467. /** @hidden */
  58468. export var pbrDirectLightingSetupFunctions: {
  58469. name: string;
  58470. shader: string;
  58471. };
  58472. }
  58473. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58474. /** @hidden */
  58475. export var pbrDirectLightingFalloffFunctions: {
  58476. name: string;
  58477. shader: string;
  58478. };
  58479. }
  58480. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58481. /** @hidden */
  58482. export var pbrBRDFFunctions: {
  58483. name: string;
  58484. shader: string;
  58485. };
  58486. }
  58487. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58488. /** @hidden */
  58489. export var hdrFilteringFunctions: {
  58490. name: string;
  58491. shader: string;
  58492. };
  58493. }
  58494. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58495. /** @hidden */
  58496. export var pbrDirectLightingFunctions: {
  58497. name: string;
  58498. shader: string;
  58499. };
  58500. }
  58501. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58502. /** @hidden */
  58503. export var pbrIBLFunctions: {
  58504. name: string;
  58505. shader: string;
  58506. };
  58507. }
  58508. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58509. /** @hidden */
  58510. export var pbrBlockAlbedoOpacity: {
  58511. name: string;
  58512. shader: string;
  58513. };
  58514. }
  58515. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58516. /** @hidden */
  58517. export var pbrBlockReflectivity: {
  58518. name: string;
  58519. shader: string;
  58520. };
  58521. }
  58522. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58523. /** @hidden */
  58524. export var pbrBlockAmbientOcclusion: {
  58525. name: string;
  58526. shader: string;
  58527. };
  58528. }
  58529. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58530. /** @hidden */
  58531. export var pbrBlockAlphaFresnel: {
  58532. name: string;
  58533. shader: string;
  58534. };
  58535. }
  58536. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58537. /** @hidden */
  58538. export var pbrBlockAnisotropic: {
  58539. name: string;
  58540. shader: string;
  58541. };
  58542. }
  58543. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58544. /** @hidden */
  58545. export var pbrBlockReflection: {
  58546. name: string;
  58547. shader: string;
  58548. };
  58549. }
  58550. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58551. /** @hidden */
  58552. export var pbrBlockSheen: {
  58553. name: string;
  58554. shader: string;
  58555. };
  58556. }
  58557. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58558. /** @hidden */
  58559. export var pbrBlockClearcoat: {
  58560. name: string;
  58561. shader: string;
  58562. };
  58563. }
  58564. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58565. /** @hidden */
  58566. export var pbrBlockSubSurface: {
  58567. name: string;
  58568. shader: string;
  58569. };
  58570. }
  58571. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58572. /** @hidden */
  58573. export var pbrBlockNormalGeometric: {
  58574. name: string;
  58575. shader: string;
  58576. };
  58577. }
  58578. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58579. /** @hidden */
  58580. export var pbrBlockNormalFinal: {
  58581. name: string;
  58582. shader: string;
  58583. };
  58584. }
  58585. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58586. /** @hidden */
  58587. export var pbrBlockLightmapInit: {
  58588. name: string;
  58589. shader: string;
  58590. };
  58591. }
  58592. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58593. /** @hidden */
  58594. export var pbrBlockGeometryInfo: {
  58595. name: string;
  58596. shader: string;
  58597. };
  58598. }
  58599. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58600. /** @hidden */
  58601. export var pbrBlockReflectance0: {
  58602. name: string;
  58603. shader: string;
  58604. };
  58605. }
  58606. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58607. /** @hidden */
  58608. export var pbrBlockReflectance: {
  58609. name: string;
  58610. shader: string;
  58611. };
  58612. }
  58613. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58614. /** @hidden */
  58615. export var pbrBlockDirectLighting: {
  58616. name: string;
  58617. shader: string;
  58618. };
  58619. }
  58620. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58621. /** @hidden */
  58622. export var pbrBlockFinalLitComponents: {
  58623. name: string;
  58624. shader: string;
  58625. };
  58626. }
  58627. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58628. /** @hidden */
  58629. export var pbrBlockFinalUnlitComponents: {
  58630. name: string;
  58631. shader: string;
  58632. };
  58633. }
  58634. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58635. /** @hidden */
  58636. export var pbrBlockFinalColorComposition: {
  58637. name: string;
  58638. shader: string;
  58639. };
  58640. }
  58641. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58642. /** @hidden */
  58643. export var pbrBlockImageProcessing: {
  58644. name: string;
  58645. shader: string;
  58646. };
  58647. }
  58648. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58649. /** @hidden */
  58650. export var pbrDebug: {
  58651. name: string;
  58652. shader: string;
  58653. };
  58654. }
  58655. declare module "babylonjs/Shaders/pbr.fragment" {
  58656. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58657. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58658. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58659. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58660. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58661. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58662. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58663. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58664. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58665. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58666. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58667. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58668. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58669. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58670. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58671. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58672. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58673. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58674. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58675. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58676. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58677. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58678. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58679. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58680. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58681. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58682. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58683. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58684. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58685. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58686. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58687. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58688. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58689. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58690. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58691. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58692. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58693. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58694. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58695. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58696. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58697. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58698. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58699. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58700. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58701. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58702. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58703. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58704. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58705. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58706. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58707. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58708. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58709. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58710. /** @hidden */
  58711. export var pbrPixelShader: {
  58712. name: string;
  58713. shader: string;
  58714. };
  58715. }
  58716. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58717. /** @hidden */
  58718. export var pbrVertexDeclaration: {
  58719. name: string;
  58720. shader: string;
  58721. };
  58722. }
  58723. declare module "babylonjs/Shaders/pbr.vertex" {
  58724. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58725. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58726. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58727. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58728. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58729. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58730. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58731. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58732. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58733. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58734. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58735. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58736. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58737. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58738. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58739. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58740. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58741. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58742. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58743. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58744. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58745. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58746. /** @hidden */
  58747. export var pbrVertexShader: {
  58748. name: string;
  58749. shader: string;
  58750. };
  58751. }
  58752. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58753. import { Nullable } from "babylonjs/types";
  58754. import { Scene } from "babylonjs/scene";
  58755. import { Matrix } from "babylonjs/Maths/math.vector";
  58756. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58757. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58758. import { Mesh } from "babylonjs/Meshes/mesh";
  58759. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58760. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58761. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58762. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58763. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58764. import { Color3 } from "babylonjs/Maths/math.color";
  58765. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58766. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58767. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58768. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58769. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58770. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58771. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58772. import "babylonjs/Shaders/pbr.fragment";
  58773. import "babylonjs/Shaders/pbr.vertex";
  58774. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58775. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58776. /**
  58777. * Manages the defines for the PBR Material.
  58778. * @hidden
  58779. */
  58780. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58781. PBR: boolean;
  58782. NUM_SAMPLES: string;
  58783. REALTIME_FILTERING: boolean;
  58784. MAINUV1: boolean;
  58785. MAINUV2: boolean;
  58786. UV1: boolean;
  58787. UV2: boolean;
  58788. ALBEDO: boolean;
  58789. GAMMAALBEDO: boolean;
  58790. ALBEDODIRECTUV: number;
  58791. VERTEXCOLOR: boolean;
  58792. DETAIL: boolean;
  58793. DETAILDIRECTUV: number;
  58794. DETAIL_NORMALBLENDMETHOD: number;
  58795. AMBIENT: boolean;
  58796. AMBIENTDIRECTUV: number;
  58797. AMBIENTINGRAYSCALE: boolean;
  58798. OPACITY: boolean;
  58799. VERTEXALPHA: boolean;
  58800. OPACITYDIRECTUV: number;
  58801. OPACITYRGB: boolean;
  58802. ALPHATEST: boolean;
  58803. DEPTHPREPASS: boolean;
  58804. ALPHABLEND: boolean;
  58805. ALPHAFROMALBEDO: boolean;
  58806. ALPHATESTVALUE: string;
  58807. SPECULAROVERALPHA: boolean;
  58808. RADIANCEOVERALPHA: boolean;
  58809. ALPHAFRESNEL: boolean;
  58810. LINEARALPHAFRESNEL: boolean;
  58811. PREMULTIPLYALPHA: boolean;
  58812. EMISSIVE: boolean;
  58813. EMISSIVEDIRECTUV: number;
  58814. REFLECTIVITY: boolean;
  58815. REFLECTIVITYDIRECTUV: number;
  58816. SPECULARTERM: boolean;
  58817. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58818. MICROSURFACEAUTOMATIC: boolean;
  58819. LODBASEDMICROSFURACE: boolean;
  58820. MICROSURFACEMAP: boolean;
  58821. MICROSURFACEMAPDIRECTUV: number;
  58822. METALLICWORKFLOW: boolean;
  58823. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58824. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58825. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58826. AOSTOREINMETALMAPRED: boolean;
  58827. METALLIC_REFLECTANCE: boolean;
  58828. METALLIC_REFLECTANCEDIRECTUV: number;
  58829. ENVIRONMENTBRDF: boolean;
  58830. ENVIRONMENTBRDF_RGBD: boolean;
  58831. NORMAL: boolean;
  58832. TANGENT: boolean;
  58833. BUMP: boolean;
  58834. BUMPDIRECTUV: number;
  58835. OBJECTSPACE_NORMALMAP: boolean;
  58836. PARALLAX: boolean;
  58837. PARALLAXOCCLUSION: boolean;
  58838. NORMALXYSCALE: boolean;
  58839. LIGHTMAP: boolean;
  58840. LIGHTMAPDIRECTUV: number;
  58841. USELIGHTMAPASSHADOWMAP: boolean;
  58842. GAMMALIGHTMAP: boolean;
  58843. RGBDLIGHTMAP: boolean;
  58844. REFLECTION: boolean;
  58845. REFLECTIONMAP_3D: boolean;
  58846. REFLECTIONMAP_SPHERICAL: boolean;
  58847. REFLECTIONMAP_PLANAR: boolean;
  58848. REFLECTIONMAP_CUBIC: boolean;
  58849. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58850. REFLECTIONMAP_PROJECTION: boolean;
  58851. REFLECTIONMAP_SKYBOX: boolean;
  58852. REFLECTIONMAP_EXPLICIT: boolean;
  58853. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58854. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58855. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58856. INVERTCUBICMAP: boolean;
  58857. USESPHERICALFROMREFLECTIONMAP: boolean;
  58858. USEIRRADIANCEMAP: boolean;
  58859. SPHERICAL_HARMONICS: boolean;
  58860. USESPHERICALINVERTEX: boolean;
  58861. REFLECTIONMAP_OPPOSITEZ: boolean;
  58862. LODINREFLECTIONALPHA: boolean;
  58863. GAMMAREFLECTION: boolean;
  58864. RGBDREFLECTION: boolean;
  58865. LINEARSPECULARREFLECTION: boolean;
  58866. RADIANCEOCCLUSION: boolean;
  58867. HORIZONOCCLUSION: boolean;
  58868. INSTANCES: boolean;
  58869. THIN_INSTANCES: boolean;
  58870. PREPASS: boolean;
  58871. SCENE_MRT_COUNT: number;
  58872. NUM_BONE_INFLUENCERS: number;
  58873. BonesPerMesh: number;
  58874. BONETEXTURE: boolean;
  58875. NONUNIFORMSCALING: boolean;
  58876. MORPHTARGETS: boolean;
  58877. MORPHTARGETS_NORMAL: boolean;
  58878. MORPHTARGETS_TANGENT: boolean;
  58879. MORPHTARGETS_UV: boolean;
  58880. NUM_MORPH_INFLUENCERS: number;
  58881. IMAGEPROCESSING: boolean;
  58882. VIGNETTE: boolean;
  58883. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58884. VIGNETTEBLENDMODEOPAQUE: boolean;
  58885. TONEMAPPING: boolean;
  58886. TONEMAPPING_ACES: boolean;
  58887. CONTRAST: boolean;
  58888. COLORCURVES: boolean;
  58889. COLORGRADING: boolean;
  58890. COLORGRADING3D: boolean;
  58891. SAMPLER3DGREENDEPTH: boolean;
  58892. SAMPLER3DBGRMAP: boolean;
  58893. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58894. EXPOSURE: boolean;
  58895. MULTIVIEW: boolean;
  58896. USEPHYSICALLIGHTFALLOFF: boolean;
  58897. USEGLTFLIGHTFALLOFF: boolean;
  58898. TWOSIDEDLIGHTING: boolean;
  58899. SHADOWFLOAT: boolean;
  58900. CLIPPLANE: boolean;
  58901. CLIPPLANE2: boolean;
  58902. CLIPPLANE3: boolean;
  58903. CLIPPLANE4: boolean;
  58904. CLIPPLANE5: boolean;
  58905. CLIPPLANE6: boolean;
  58906. POINTSIZE: boolean;
  58907. FOG: boolean;
  58908. LOGARITHMICDEPTH: boolean;
  58909. FORCENORMALFORWARD: boolean;
  58910. SPECULARAA: boolean;
  58911. CLEARCOAT: boolean;
  58912. CLEARCOAT_DEFAULTIOR: boolean;
  58913. CLEARCOAT_TEXTURE: boolean;
  58914. CLEARCOAT_TEXTUREDIRECTUV: number;
  58915. CLEARCOAT_BUMP: boolean;
  58916. CLEARCOAT_BUMPDIRECTUV: number;
  58917. CLEARCOAT_TINT: boolean;
  58918. CLEARCOAT_TINT_TEXTURE: boolean;
  58919. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58920. ANISOTROPIC: boolean;
  58921. ANISOTROPIC_TEXTURE: boolean;
  58922. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58923. BRDF_V_HEIGHT_CORRELATED: boolean;
  58924. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58925. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58926. SHEEN: boolean;
  58927. SHEEN_TEXTURE: boolean;
  58928. SHEEN_TEXTUREDIRECTUV: number;
  58929. SHEEN_LINKWITHALBEDO: boolean;
  58930. SHEEN_ROUGHNESS: boolean;
  58931. SHEEN_ALBEDOSCALING: boolean;
  58932. SUBSURFACE: boolean;
  58933. SS_REFRACTION: boolean;
  58934. SS_TRANSLUCENCY: boolean;
  58935. SS_SCATTERING: boolean;
  58936. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58937. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58938. SS_REFRACTIONMAP_3D: boolean;
  58939. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58940. SS_LODINREFRACTIONALPHA: boolean;
  58941. SS_GAMMAREFRACTION: boolean;
  58942. SS_RGBDREFRACTION: boolean;
  58943. SS_LINEARSPECULARREFRACTION: boolean;
  58944. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58945. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58946. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58947. UNLIT: boolean;
  58948. DEBUGMODE: number;
  58949. /**
  58950. * Initializes the PBR Material defines.
  58951. */
  58952. constructor();
  58953. /**
  58954. * Resets the PBR Material defines.
  58955. */
  58956. reset(): void;
  58957. }
  58958. /**
  58959. * The Physically based material base class of BJS.
  58960. *
  58961. * This offers the main features of a standard PBR material.
  58962. * For more information, please refer to the documentation :
  58963. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58964. */
  58965. export abstract class PBRBaseMaterial extends PushMaterial {
  58966. /**
  58967. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58968. */
  58969. static readonly PBRMATERIAL_OPAQUE: number;
  58970. /**
  58971. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58972. */
  58973. static readonly PBRMATERIAL_ALPHATEST: number;
  58974. /**
  58975. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58976. */
  58977. static readonly PBRMATERIAL_ALPHABLEND: number;
  58978. /**
  58979. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58980. * They are also discarded below the alpha cutoff threshold to improve performances.
  58981. */
  58982. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58983. /**
  58984. * Defines the default value of how much AO map is occluding the analytical lights
  58985. * (point spot...).
  58986. */
  58987. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58988. /**
  58989. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58990. */
  58991. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58992. /**
  58993. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58994. * to enhance interoperability with other engines.
  58995. */
  58996. static readonly LIGHTFALLOFF_GLTF: number;
  58997. /**
  58998. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58999. * to enhance interoperability with other materials.
  59000. */
  59001. static readonly LIGHTFALLOFF_STANDARD: number;
  59002. /**
  59003. * Intensity of the direct lights e.g. the four lights available in your scene.
  59004. * This impacts both the direct diffuse and specular highlights.
  59005. */
  59006. protected _directIntensity: number;
  59007. /**
  59008. * Intensity of the emissive part of the material.
  59009. * This helps controlling the emissive effect without modifying the emissive color.
  59010. */
  59011. protected _emissiveIntensity: number;
  59012. /**
  59013. * Intensity of the environment e.g. how much the environment will light the object
  59014. * either through harmonics for rough material or through the refelction for shiny ones.
  59015. */
  59016. protected _environmentIntensity: number;
  59017. /**
  59018. * This is a special control allowing the reduction of the specular highlights coming from the
  59019. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59020. */
  59021. protected _specularIntensity: number;
  59022. /**
  59023. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59024. */
  59025. private _lightingInfos;
  59026. /**
  59027. * Debug Control allowing disabling the bump map on this material.
  59028. */
  59029. protected _disableBumpMap: boolean;
  59030. /**
  59031. * AKA Diffuse Texture in standard nomenclature.
  59032. */
  59033. protected _albedoTexture: Nullable<BaseTexture>;
  59034. /**
  59035. * AKA Occlusion Texture in other nomenclature.
  59036. */
  59037. protected _ambientTexture: Nullable<BaseTexture>;
  59038. /**
  59039. * AKA Occlusion Texture Intensity in other nomenclature.
  59040. */
  59041. protected _ambientTextureStrength: number;
  59042. /**
  59043. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59044. * 1 means it completely occludes it
  59045. * 0 mean it has no impact
  59046. */
  59047. protected _ambientTextureImpactOnAnalyticalLights: number;
  59048. /**
  59049. * Stores the alpha values in a texture.
  59050. */
  59051. protected _opacityTexture: Nullable<BaseTexture>;
  59052. /**
  59053. * Stores the reflection values in a texture.
  59054. */
  59055. protected _reflectionTexture: Nullable<BaseTexture>;
  59056. /**
  59057. * Stores the emissive values in a texture.
  59058. */
  59059. protected _emissiveTexture: Nullable<BaseTexture>;
  59060. /**
  59061. * AKA Specular texture in other nomenclature.
  59062. */
  59063. protected _reflectivityTexture: Nullable<BaseTexture>;
  59064. /**
  59065. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59066. */
  59067. protected _metallicTexture: Nullable<BaseTexture>;
  59068. /**
  59069. * Specifies the metallic scalar of the metallic/roughness workflow.
  59070. * Can also be used to scale the metalness values of the metallic texture.
  59071. */
  59072. protected _metallic: Nullable<number>;
  59073. /**
  59074. * Specifies the roughness scalar of the metallic/roughness workflow.
  59075. * Can also be used to scale the roughness values of the metallic texture.
  59076. */
  59077. protected _roughness: Nullable<number>;
  59078. /**
  59079. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59080. * By default the indexOfrefraction is used to compute F0;
  59081. *
  59082. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59083. *
  59084. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59085. * F90 = metallicReflectanceColor;
  59086. */
  59087. protected _metallicF0Factor: number;
  59088. /**
  59089. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59090. * By default the F90 is always 1;
  59091. *
  59092. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59093. *
  59094. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59095. * F90 = metallicReflectanceColor;
  59096. */
  59097. protected _metallicReflectanceColor: Color3;
  59098. /**
  59099. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59100. * This is multiply against the scalar values defined in the material.
  59101. */
  59102. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59103. /**
  59104. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59105. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59106. */
  59107. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59108. /**
  59109. * Stores surface normal data used to displace a mesh in a texture.
  59110. */
  59111. protected _bumpTexture: Nullable<BaseTexture>;
  59112. /**
  59113. * Stores the pre-calculated light information of a mesh in a texture.
  59114. */
  59115. protected _lightmapTexture: Nullable<BaseTexture>;
  59116. /**
  59117. * The color of a material in ambient lighting.
  59118. */
  59119. protected _ambientColor: Color3;
  59120. /**
  59121. * AKA Diffuse Color in other nomenclature.
  59122. */
  59123. protected _albedoColor: Color3;
  59124. /**
  59125. * AKA Specular Color in other nomenclature.
  59126. */
  59127. protected _reflectivityColor: Color3;
  59128. /**
  59129. * The color applied when light is reflected from a material.
  59130. */
  59131. protected _reflectionColor: Color3;
  59132. /**
  59133. * The color applied when light is emitted from a material.
  59134. */
  59135. protected _emissiveColor: Color3;
  59136. /**
  59137. * AKA Glossiness in other nomenclature.
  59138. */
  59139. protected _microSurface: number;
  59140. /**
  59141. * Specifies that the material will use the light map as a show map.
  59142. */
  59143. protected _useLightmapAsShadowmap: boolean;
  59144. /**
  59145. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59146. * makes the reflect vector face the model (under horizon).
  59147. */
  59148. protected _useHorizonOcclusion: boolean;
  59149. /**
  59150. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59151. * too much the area relying on ambient texture to define their ambient occlusion.
  59152. */
  59153. protected _useRadianceOcclusion: boolean;
  59154. /**
  59155. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59156. */
  59157. protected _useAlphaFromAlbedoTexture: boolean;
  59158. /**
  59159. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59160. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59161. */
  59162. protected _useSpecularOverAlpha: boolean;
  59163. /**
  59164. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59165. */
  59166. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59167. /**
  59168. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59169. */
  59170. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59171. /**
  59172. * Specifies if the metallic texture contains the roughness information in its green channel.
  59173. */
  59174. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59175. /**
  59176. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59177. */
  59178. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59179. /**
  59180. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59181. */
  59182. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59183. /**
  59184. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59185. */
  59186. protected _useAmbientInGrayScale: boolean;
  59187. /**
  59188. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59189. * The material will try to infer what glossiness each pixel should be.
  59190. */
  59191. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59192. /**
  59193. * Defines the falloff type used in this material.
  59194. * It by default is Physical.
  59195. */
  59196. protected _lightFalloff: number;
  59197. /**
  59198. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59199. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59200. */
  59201. protected _useRadianceOverAlpha: boolean;
  59202. /**
  59203. * Allows using an object space normal map (instead of tangent space).
  59204. */
  59205. protected _useObjectSpaceNormalMap: boolean;
  59206. /**
  59207. * Allows using the bump map in parallax mode.
  59208. */
  59209. protected _useParallax: boolean;
  59210. /**
  59211. * Allows using the bump map in parallax occlusion mode.
  59212. */
  59213. protected _useParallaxOcclusion: boolean;
  59214. /**
  59215. * Controls the scale bias of the parallax mode.
  59216. */
  59217. protected _parallaxScaleBias: number;
  59218. /**
  59219. * If sets to true, disables all the lights affecting the material.
  59220. */
  59221. protected _disableLighting: boolean;
  59222. /**
  59223. * Number of Simultaneous lights allowed on the material.
  59224. */
  59225. protected _maxSimultaneousLights: number;
  59226. /**
  59227. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59228. */
  59229. protected _invertNormalMapX: boolean;
  59230. /**
  59231. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59232. */
  59233. protected _invertNormalMapY: boolean;
  59234. /**
  59235. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59236. */
  59237. protected _twoSidedLighting: boolean;
  59238. /**
  59239. * Defines the alpha limits in alpha test mode.
  59240. */
  59241. protected _alphaCutOff: number;
  59242. /**
  59243. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59244. */
  59245. protected _forceAlphaTest: boolean;
  59246. /**
  59247. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59248. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59249. */
  59250. protected _useAlphaFresnel: boolean;
  59251. /**
  59252. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59253. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59254. */
  59255. protected _useLinearAlphaFresnel: boolean;
  59256. /**
  59257. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59258. * from cos thetav and roughness:
  59259. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59260. */
  59261. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59262. /**
  59263. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59264. */
  59265. protected _forceIrradianceInFragment: boolean;
  59266. private _realTimeFiltering;
  59267. /**
  59268. * Enables realtime filtering on the texture.
  59269. */
  59270. get realTimeFiltering(): boolean;
  59271. set realTimeFiltering(b: boolean);
  59272. private _realTimeFilteringQuality;
  59273. /**
  59274. * Quality switch for realtime filtering
  59275. */
  59276. get realTimeFilteringQuality(): number;
  59277. set realTimeFilteringQuality(n: number);
  59278. /**
  59279. * Can this material render to several textures at once
  59280. */
  59281. get canRenderToMRT(): boolean;
  59282. /**
  59283. * Force normal to face away from face.
  59284. */
  59285. protected _forceNormalForward: boolean;
  59286. /**
  59287. * Enables specular anti aliasing in the PBR shader.
  59288. * It will both interacts on the Geometry for analytical and IBL lighting.
  59289. * It also prefilter the roughness map based on the bump values.
  59290. */
  59291. protected _enableSpecularAntiAliasing: boolean;
  59292. /**
  59293. * Default configuration related to image processing available in the PBR Material.
  59294. */
  59295. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59296. /**
  59297. * Keep track of the image processing observer to allow dispose and replace.
  59298. */
  59299. private _imageProcessingObserver;
  59300. /**
  59301. * Attaches a new image processing configuration to the PBR Material.
  59302. * @param configuration
  59303. */
  59304. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59305. /**
  59306. * Stores the available render targets.
  59307. */
  59308. private _renderTargets;
  59309. /**
  59310. * Sets the global ambient color for the material used in lighting calculations.
  59311. */
  59312. private _globalAmbientColor;
  59313. /**
  59314. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59315. */
  59316. private _useLogarithmicDepth;
  59317. /**
  59318. * If set to true, no lighting calculations will be applied.
  59319. */
  59320. private _unlit;
  59321. private _debugMode;
  59322. /**
  59323. * @hidden
  59324. * This is reserved for the inspector.
  59325. * Defines the material debug mode.
  59326. * It helps seeing only some components of the material while troubleshooting.
  59327. */
  59328. debugMode: number;
  59329. /**
  59330. * @hidden
  59331. * This is reserved for the inspector.
  59332. * Specify from where on screen the debug mode should start.
  59333. * The value goes from -1 (full screen) to 1 (not visible)
  59334. * It helps with side by side comparison against the final render
  59335. * This defaults to -1
  59336. */
  59337. private debugLimit;
  59338. /**
  59339. * @hidden
  59340. * This is reserved for the inspector.
  59341. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59342. * You can use the factor to better multiply the final value.
  59343. */
  59344. private debugFactor;
  59345. /**
  59346. * Defines the clear coat layer parameters for the material.
  59347. */
  59348. readonly clearCoat: PBRClearCoatConfiguration;
  59349. /**
  59350. * Defines the anisotropic parameters for the material.
  59351. */
  59352. readonly anisotropy: PBRAnisotropicConfiguration;
  59353. /**
  59354. * Defines the BRDF parameters for the material.
  59355. */
  59356. readonly brdf: PBRBRDFConfiguration;
  59357. /**
  59358. * Defines the Sheen parameters for the material.
  59359. */
  59360. readonly sheen: PBRSheenConfiguration;
  59361. /**
  59362. * Defines the SubSurface parameters for the material.
  59363. */
  59364. readonly subSurface: PBRSubSurfaceConfiguration;
  59365. /**
  59366. * Defines the detail map parameters for the material.
  59367. */
  59368. readonly detailMap: DetailMapConfiguration;
  59369. protected _rebuildInParallel: boolean;
  59370. /**
  59371. * Instantiates a new PBRMaterial instance.
  59372. *
  59373. * @param name The material name
  59374. * @param scene The scene the material will be use in.
  59375. */
  59376. constructor(name: string, scene: Scene);
  59377. /**
  59378. * Gets a boolean indicating that current material needs to register RTT
  59379. */
  59380. get hasRenderTargetTextures(): boolean;
  59381. /**
  59382. * Gets the name of the material class.
  59383. */
  59384. getClassName(): string;
  59385. /**
  59386. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59387. */
  59388. get useLogarithmicDepth(): boolean;
  59389. /**
  59390. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59391. */
  59392. set useLogarithmicDepth(value: boolean);
  59393. /**
  59394. * Returns true if alpha blending should be disabled.
  59395. */
  59396. protected get _disableAlphaBlending(): boolean;
  59397. /**
  59398. * Specifies whether or not this material should be rendered in alpha blend mode.
  59399. */
  59400. needAlphaBlending(): boolean;
  59401. /**
  59402. * Specifies whether or not this material should be rendered in alpha test mode.
  59403. */
  59404. needAlphaTesting(): boolean;
  59405. /**
  59406. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59407. */
  59408. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59409. /**
  59410. * Gets the texture used for the alpha test.
  59411. */
  59412. getAlphaTestTexture(): Nullable<BaseTexture>;
  59413. /**
  59414. * Specifies that the submesh is ready to be used.
  59415. * @param mesh - BJS mesh.
  59416. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59417. * @param useInstances - Specifies that instances should be used.
  59418. * @returns - boolean indicating that the submesh is ready or not.
  59419. */
  59420. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59421. /**
  59422. * Specifies if the material uses metallic roughness workflow.
  59423. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59424. */
  59425. isMetallicWorkflow(): boolean;
  59426. private _prepareEffect;
  59427. private _prepareDefines;
  59428. /**
  59429. * Force shader compilation
  59430. */
  59431. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59432. /**
  59433. * Initializes the uniform buffer layout for the shader.
  59434. */
  59435. buildUniformLayout(): void;
  59436. /**
  59437. * Unbinds the material from the mesh
  59438. */
  59439. unbind(): void;
  59440. /**
  59441. * Binds the submesh data.
  59442. * @param world - The world matrix.
  59443. * @param mesh - The BJS mesh.
  59444. * @param subMesh - A submesh of the BJS mesh.
  59445. */
  59446. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59447. /**
  59448. * Returns the animatable textures.
  59449. * @returns - Array of animatable textures.
  59450. */
  59451. getAnimatables(): IAnimatable[];
  59452. /**
  59453. * Returns the texture used for reflections.
  59454. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59455. */
  59456. private _getReflectionTexture;
  59457. /**
  59458. * Returns an array of the actively used textures.
  59459. * @returns - Array of BaseTextures
  59460. */
  59461. getActiveTextures(): BaseTexture[];
  59462. /**
  59463. * Checks to see if a texture is used in the material.
  59464. * @param texture - Base texture to use.
  59465. * @returns - Boolean specifying if a texture is used in the material.
  59466. */
  59467. hasTexture(texture: BaseTexture): boolean;
  59468. /**
  59469. * Sets the required values to the prepass renderer.
  59470. * @param prePassRenderer defines the prepass renderer to setup
  59471. */
  59472. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59473. /**
  59474. * Disposes the resources of the material.
  59475. * @param forceDisposeEffect - Forces the disposal of effects.
  59476. * @param forceDisposeTextures - Forces the disposal of all textures.
  59477. */
  59478. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59479. }
  59480. }
  59481. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59482. import { Nullable } from "babylonjs/types";
  59483. import { Scene } from "babylonjs/scene";
  59484. import { Color3 } from "babylonjs/Maths/math.color";
  59485. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59486. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59487. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59488. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59489. /**
  59490. * The Physically based material of BJS.
  59491. *
  59492. * This offers the main features of a standard PBR material.
  59493. * For more information, please refer to the documentation :
  59494. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59495. */
  59496. export class PBRMaterial extends PBRBaseMaterial {
  59497. /**
  59498. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59499. */
  59500. static readonly PBRMATERIAL_OPAQUE: number;
  59501. /**
  59502. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59503. */
  59504. static readonly PBRMATERIAL_ALPHATEST: number;
  59505. /**
  59506. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59507. */
  59508. static readonly PBRMATERIAL_ALPHABLEND: number;
  59509. /**
  59510. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59511. * They are also discarded below the alpha cutoff threshold to improve performances.
  59512. */
  59513. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59514. /**
  59515. * Defines the default value of how much AO map is occluding the analytical lights
  59516. * (point spot...).
  59517. */
  59518. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59519. /**
  59520. * Intensity of the direct lights e.g. the four lights available in your scene.
  59521. * This impacts both the direct diffuse and specular highlights.
  59522. */
  59523. directIntensity: number;
  59524. /**
  59525. * Intensity of the emissive part of the material.
  59526. * This helps controlling the emissive effect without modifying the emissive color.
  59527. */
  59528. emissiveIntensity: number;
  59529. /**
  59530. * Intensity of the environment e.g. how much the environment will light the object
  59531. * either through harmonics for rough material or through the refelction for shiny ones.
  59532. */
  59533. environmentIntensity: number;
  59534. /**
  59535. * This is a special control allowing the reduction of the specular highlights coming from the
  59536. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59537. */
  59538. specularIntensity: number;
  59539. /**
  59540. * Debug Control allowing disabling the bump map on this material.
  59541. */
  59542. disableBumpMap: boolean;
  59543. /**
  59544. * AKA Diffuse Texture in standard nomenclature.
  59545. */
  59546. albedoTexture: BaseTexture;
  59547. /**
  59548. * AKA Occlusion Texture in other nomenclature.
  59549. */
  59550. ambientTexture: BaseTexture;
  59551. /**
  59552. * AKA Occlusion Texture Intensity in other nomenclature.
  59553. */
  59554. ambientTextureStrength: number;
  59555. /**
  59556. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59557. * 1 means it completely occludes it
  59558. * 0 mean it has no impact
  59559. */
  59560. ambientTextureImpactOnAnalyticalLights: number;
  59561. /**
  59562. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59563. */
  59564. opacityTexture: BaseTexture;
  59565. /**
  59566. * Stores the reflection values in a texture.
  59567. */
  59568. reflectionTexture: Nullable<BaseTexture>;
  59569. /**
  59570. * Stores the emissive values in a texture.
  59571. */
  59572. emissiveTexture: BaseTexture;
  59573. /**
  59574. * AKA Specular texture in other nomenclature.
  59575. */
  59576. reflectivityTexture: BaseTexture;
  59577. /**
  59578. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59579. */
  59580. metallicTexture: BaseTexture;
  59581. /**
  59582. * Specifies the metallic scalar of the metallic/roughness workflow.
  59583. * Can also be used to scale the metalness values of the metallic texture.
  59584. */
  59585. metallic: Nullable<number>;
  59586. /**
  59587. * Specifies the roughness scalar of the metallic/roughness workflow.
  59588. * Can also be used to scale the roughness values of the metallic texture.
  59589. */
  59590. roughness: Nullable<number>;
  59591. /**
  59592. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59593. * By default the indexOfrefraction is used to compute F0;
  59594. *
  59595. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59596. *
  59597. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59598. * F90 = metallicReflectanceColor;
  59599. */
  59600. metallicF0Factor: number;
  59601. /**
  59602. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59603. * By default the F90 is always 1;
  59604. *
  59605. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59606. *
  59607. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59608. * F90 = metallicReflectanceColor;
  59609. */
  59610. metallicReflectanceColor: Color3;
  59611. /**
  59612. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59613. * This is multiply against the scalar values defined in the material.
  59614. */
  59615. metallicReflectanceTexture: Nullable<BaseTexture>;
  59616. /**
  59617. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59618. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59619. */
  59620. microSurfaceTexture: BaseTexture;
  59621. /**
  59622. * Stores surface normal data used to displace a mesh in a texture.
  59623. */
  59624. bumpTexture: BaseTexture;
  59625. /**
  59626. * Stores the pre-calculated light information of a mesh in a texture.
  59627. */
  59628. lightmapTexture: BaseTexture;
  59629. /**
  59630. * Stores the refracted light information in a texture.
  59631. */
  59632. get refractionTexture(): Nullable<BaseTexture>;
  59633. set refractionTexture(value: Nullable<BaseTexture>);
  59634. /**
  59635. * The color of a material in ambient lighting.
  59636. */
  59637. ambientColor: Color3;
  59638. /**
  59639. * AKA Diffuse Color in other nomenclature.
  59640. */
  59641. albedoColor: Color3;
  59642. /**
  59643. * AKA Specular Color in other nomenclature.
  59644. */
  59645. reflectivityColor: Color3;
  59646. /**
  59647. * The color reflected from the material.
  59648. */
  59649. reflectionColor: Color3;
  59650. /**
  59651. * The color emitted from the material.
  59652. */
  59653. emissiveColor: Color3;
  59654. /**
  59655. * AKA Glossiness in other nomenclature.
  59656. */
  59657. microSurface: number;
  59658. /**
  59659. * Index of refraction of the material base layer.
  59660. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59661. *
  59662. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59663. *
  59664. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59665. */
  59666. get indexOfRefraction(): number;
  59667. set indexOfRefraction(value: number);
  59668. /**
  59669. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59670. */
  59671. get invertRefractionY(): boolean;
  59672. set invertRefractionY(value: boolean);
  59673. /**
  59674. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59675. * Materials half opaque for instance using refraction could benefit from this control.
  59676. */
  59677. get linkRefractionWithTransparency(): boolean;
  59678. set linkRefractionWithTransparency(value: boolean);
  59679. /**
  59680. * If true, the light map contains occlusion information instead of lighting info.
  59681. */
  59682. useLightmapAsShadowmap: boolean;
  59683. /**
  59684. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59685. */
  59686. useAlphaFromAlbedoTexture: boolean;
  59687. /**
  59688. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59689. */
  59690. forceAlphaTest: boolean;
  59691. /**
  59692. * Defines the alpha limits in alpha test mode.
  59693. */
  59694. alphaCutOff: number;
  59695. /**
  59696. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59697. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59698. */
  59699. useSpecularOverAlpha: boolean;
  59700. /**
  59701. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59702. */
  59703. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59704. /**
  59705. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59706. */
  59707. useRoughnessFromMetallicTextureAlpha: boolean;
  59708. /**
  59709. * Specifies if the metallic texture contains the roughness information in its green channel.
  59710. */
  59711. useRoughnessFromMetallicTextureGreen: boolean;
  59712. /**
  59713. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59714. */
  59715. useMetallnessFromMetallicTextureBlue: boolean;
  59716. /**
  59717. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59718. */
  59719. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59720. /**
  59721. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59722. */
  59723. useAmbientInGrayScale: boolean;
  59724. /**
  59725. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59726. * The material will try to infer what glossiness each pixel should be.
  59727. */
  59728. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59729. /**
  59730. * BJS is using an harcoded light falloff based on a manually sets up range.
  59731. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59732. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59733. */
  59734. get usePhysicalLightFalloff(): boolean;
  59735. /**
  59736. * BJS is using an harcoded light falloff based on a manually sets up range.
  59737. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59738. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59739. */
  59740. set usePhysicalLightFalloff(value: boolean);
  59741. /**
  59742. * In order to support the falloff compatibility with gltf, a special mode has been added
  59743. * to reproduce the gltf light falloff.
  59744. */
  59745. get useGLTFLightFalloff(): boolean;
  59746. /**
  59747. * In order to support the falloff compatibility with gltf, a special mode has been added
  59748. * to reproduce the gltf light falloff.
  59749. */
  59750. set useGLTFLightFalloff(value: boolean);
  59751. /**
  59752. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59753. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59754. */
  59755. useRadianceOverAlpha: boolean;
  59756. /**
  59757. * Allows using an object space normal map (instead of tangent space).
  59758. */
  59759. useObjectSpaceNormalMap: boolean;
  59760. /**
  59761. * Allows using the bump map in parallax mode.
  59762. */
  59763. useParallax: boolean;
  59764. /**
  59765. * Allows using the bump map in parallax occlusion mode.
  59766. */
  59767. useParallaxOcclusion: boolean;
  59768. /**
  59769. * Controls the scale bias of the parallax mode.
  59770. */
  59771. parallaxScaleBias: number;
  59772. /**
  59773. * If sets to true, disables all the lights affecting the material.
  59774. */
  59775. disableLighting: boolean;
  59776. /**
  59777. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59778. */
  59779. forceIrradianceInFragment: boolean;
  59780. /**
  59781. * Number of Simultaneous lights allowed on the material.
  59782. */
  59783. maxSimultaneousLights: number;
  59784. /**
  59785. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59786. */
  59787. invertNormalMapX: boolean;
  59788. /**
  59789. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59790. */
  59791. invertNormalMapY: boolean;
  59792. /**
  59793. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59794. */
  59795. twoSidedLighting: boolean;
  59796. /**
  59797. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59798. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59799. */
  59800. useAlphaFresnel: boolean;
  59801. /**
  59802. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59803. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59804. */
  59805. useLinearAlphaFresnel: boolean;
  59806. /**
  59807. * Let user defines the brdf lookup texture used for IBL.
  59808. * A default 8bit version is embedded but you could point at :
  59809. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59810. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59811. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59812. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59813. */
  59814. environmentBRDFTexture: Nullable<BaseTexture>;
  59815. /**
  59816. * Force normal to face away from face.
  59817. */
  59818. forceNormalForward: boolean;
  59819. /**
  59820. * Enables specular anti aliasing in the PBR shader.
  59821. * It will both interacts on the Geometry for analytical and IBL lighting.
  59822. * It also prefilter the roughness map based on the bump values.
  59823. */
  59824. enableSpecularAntiAliasing: boolean;
  59825. /**
  59826. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59827. * makes the reflect vector face the model (under horizon).
  59828. */
  59829. useHorizonOcclusion: boolean;
  59830. /**
  59831. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59832. * too much the area relying on ambient texture to define their ambient occlusion.
  59833. */
  59834. useRadianceOcclusion: boolean;
  59835. /**
  59836. * If set to true, no lighting calculations will be applied.
  59837. */
  59838. unlit: boolean;
  59839. /**
  59840. * Gets the image processing configuration used either in this material.
  59841. */
  59842. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59843. /**
  59844. * Sets the Default image processing configuration used either in the this material.
  59845. *
  59846. * If sets to null, the scene one is in use.
  59847. */
  59848. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59849. /**
  59850. * Gets wether the color curves effect is enabled.
  59851. */
  59852. get cameraColorCurvesEnabled(): boolean;
  59853. /**
  59854. * Sets wether the color curves effect is enabled.
  59855. */
  59856. set cameraColorCurvesEnabled(value: boolean);
  59857. /**
  59858. * Gets wether the color grading effect is enabled.
  59859. */
  59860. get cameraColorGradingEnabled(): boolean;
  59861. /**
  59862. * Gets wether the color grading effect is enabled.
  59863. */
  59864. set cameraColorGradingEnabled(value: boolean);
  59865. /**
  59866. * Gets wether tonemapping is enabled or not.
  59867. */
  59868. get cameraToneMappingEnabled(): boolean;
  59869. /**
  59870. * Sets wether tonemapping is enabled or not
  59871. */
  59872. set cameraToneMappingEnabled(value: boolean);
  59873. /**
  59874. * The camera exposure used on this material.
  59875. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59876. * This corresponds to a photographic exposure.
  59877. */
  59878. get cameraExposure(): number;
  59879. /**
  59880. * The camera exposure used on this material.
  59881. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59882. * This corresponds to a photographic exposure.
  59883. */
  59884. set cameraExposure(value: number);
  59885. /**
  59886. * Gets The camera contrast used on this material.
  59887. */
  59888. get cameraContrast(): number;
  59889. /**
  59890. * Sets The camera contrast used on this material.
  59891. */
  59892. set cameraContrast(value: number);
  59893. /**
  59894. * Gets the Color Grading 2D Lookup Texture.
  59895. */
  59896. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59897. /**
  59898. * Sets the Color Grading 2D Lookup Texture.
  59899. */
  59900. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59901. /**
  59902. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59903. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59904. * 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;
  59905. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59906. */
  59907. get cameraColorCurves(): Nullable<ColorCurves>;
  59908. /**
  59909. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59910. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59911. * 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;
  59912. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59913. */
  59914. set cameraColorCurves(value: Nullable<ColorCurves>);
  59915. /**
  59916. * Instantiates a new PBRMaterial instance.
  59917. *
  59918. * @param name The material name
  59919. * @param scene The scene the material will be use in.
  59920. */
  59921. constructor(name: string, scene: Scene);
  59922. /**
  59923. * Returns the name of this material class.
  59924. */
  59925. getClassName(): string;
  59926. /**
  59927. * Makes a duplicate of the current material.
  59928. * @param name - name to use for the new material.
  59929. */
  59930. clone(name: string): PBRMaterial;
  59931. /**
  59932. * Serializes this PBR Material.
  59933. * @returns - An object with the serialized material.
  59934. */
  59935. serialize(): any;
  59936. /**
  59937. * Parses a PBR Material from a serialized object.
  59938. * @param source - Serialized object.
  59939. * @param scene - BJS scene instance.
  59940. * @param rootUrl - url for the scene object
  59941. * @returns - PBRMaterial
  59942. */
  59943. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59944. }
  59945. }
  59946. declare module "babylonjs/Misc/dds" {
  59947. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59948. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59949. import { Nullable } from "babylonjs/types";
  59950. import { Scene } from "babylonjs/scene";
  59951. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59952. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59953. /**
  59954. * Direct draw surface info
  59955. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59956. */
  59957. export interface DDSInfo {
  59958. /**
  59959. * Width of the texture
  59960. */
  59961. width: number;
  59962. /**
  59963. * Width of the texture
  59964. */
  59965. height: number;
  59966. /**
  59967. * Number of Mipmaps for the texture
  59968. * @see https://en.wikipedia.org/wiki/Mipmap
  59969. */
  59970. mipmapCount: number;
  59971. /**
  59972. * If the textures format is a known fourCC format
  59973. * @see https://www.fourcc.org/
  59974. */
  59975. isFourCC: boolean;
  59976. /**
  59977. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59978. */
  59979. isRGB: boolean;
  59980. /**
  59981. * If the texture is a lumincance format
  59982. */
  59983. isLuminance: boolean;
  59984. /**
  59985. * If this is a cube texture
  59986. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59987. */
  59988. isCube: boolean;
  59989. /**
  59990. * If the texture is a compressed format eg. FOURCC_DXT1
  59991. */
  59992. isCompressed: boolean;
  59993. /**
  59994. * The dxgiFormat of the texture
  59995. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59996. */
  59997. dxgiFormat: number;
  59998. /**
  59999. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  60000. */
  60001. textureType: number;
  60002. /**
  60003. * Sphericle polynomial created for the dds texture
  60004. */
  60005. sphericalPolynomial?: SphericalPolynomial;
  60006. }
  60007. /**
  60008. * Class used to provide DDS decompression tools
  60009. */
  60010. export class DDSTools {
  60011. /**
  60012. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60013. */
  60014. static StoreLODInAlphaChannel: boolean;
  60015. /**
  60016. * Gets DDS information from an array buffer
  60017. * @param data defines the array buffer view to read data from
  60018. * @returns the DDS information
  60019. */
  60020. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60021. private static _FloatView;
  60022. private static _Int32View;
  60023. private static _ToHalfFloat;
  60024. private static _FromHalfFloat;
  60025. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60026. private static _GetHalfFloatRGBAArrayBuffer;
  60027. private static _GetFloatRGBAArrayBuffer;
  60028. private static _GetFloatAsUIntRGBAArrayBuffer;
  60029. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60030. private static _GetRGBAArrayBuffer;
  60031. private static _ExtractLongWordOrder;
  60032. private static _GetRGBArrayBuffer;
  60033. private static _GetLuminanceArrayBuffer;
  60034. /**
  60035. * Uploads DDS Levels to a Babylon Texture
  60036. * @hidden
  60037. */
  60038. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60039. }
  60040. module "babylonjs/Engines/thinEngine" {
  60041. interface ThinEngine {
  60042. /**
  60043. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60044. * @param rootUrl defines the url where the file to load is located
  60045. * @param scene defines the current scene
  60046. * @param lodScale defines scale to apply to the mip map selection
  60047. * @param lodOffset defines offset to apply to the mip map selection
  60048. * @param onLoad defines an optional callback raised when the texture is loaded
  60049. * @param onError defines an optional callback raised if there is an issue to load the texture
  60050. * @param format defines the format of the data
  60051. * @param forcedExtension defines the extension to use to pick the right loader
  60052. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60053. * @returns the cube texture as an InternalTexture
  60054. */
  60055. 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;
  60056. }
  60057. }
  60058. }
  60059. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60060. import { Nullable } from "babylonjs/types";
  60061. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60062. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60063. /**
  60064. * Implementation of the DDS Texture Loader.
  60065. * @hidden
  60066. */
  60067. export class _DDSTextureLoader implements IInternalTextureLoader {
  60068. /**
  60069. * Defines wether the loader supports cascade loading the different faces.
  60070. */
  60071. readonly supportCascades: boolean;
  60072. /**
  60073. * This returns if the loader support the current file information.
  60074. * @param extension defines the file extension of the file being loaded
  60075. * @returns true if the loader can load the specified file
  60076. */
  60077. canLoad(extension: string): boolean;
  60078. /**
  60079. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60080. * @param data contains the texture data
  60081. * @param texture defines the BabylonJS internal texture
  60082. * @param createPolynomials will be true if polynomials have been requested
  60083. * @param onLoad defines the callback to trigger once the texture is ready
  60084. * @param onError defines the callback to trigger in case of error
  60085. */
  60086. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60087. /**
  60088. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60089. * @param data contains the texture data
  60090. * @param texture defines the BabylonJS internal texture
  60091. * @param callback defines the method to call once ready to upload
  60092. */
  60093. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60094. }
  60095. }
  60096. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60097. import { Nullable } from "babylonjs/types";
  60098. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60099. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60100. /**
  60101. * Implementation of the ENV Texture Loader.
  60102. * @hidden
  60103. */
  60104. export class _ENVTextureLoader implements IInternalTextureLoader {
  60105. /**
  60106. * Defines wether the loader supports cascade loading the different faces.
  60107. */
  60108. readonly supportCascades: boolean;
  60109. /**
  60110. * This returns if the loader support the current file information.
  60111. * @param extension defines the file extension of the file being loaded
  60112. * @returns true if the loader can load the specified file
  60113. */
  60114. canLoad(extension: string): boolean;
  60115. /**
  60116. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60117. * @param data contains the texture data
  60118. * @param texture defines the BabylonJS internal texture
  60119. * @param createPolynomials will be true if polynomials have been requested
  60120. * @param onLoad defines the callback to trigger once the texture is ready
  60121. * @param onError defines the callback to trigger in case of error
  60122. */
  60123. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60124. /**
  60125. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60126. * @param data contains the texture data
  60127. * @param texture defines the BabylonJS internal texture
  60128. * @param callback defines the method to call once ready to upload
  60129. */
  60130. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60131. }
  60132. }
  60133. declare module "babylonjs/Misc/khronosTextureContainer" {
  60134. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60135. /**
  60136. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60137. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60138. */
  60139. export class KhronosTextureContainer {
  60140. /** contents of the KTX container file */
  60141. data: ArrayBufferView;
  60142. private static HEADER_LEN;
  60143. private static COMPRESSED_2D;
  60144. private static COMPRESSED_3D;
  60145. private static TEX_2D;
  60146. private static TEX_3D;
  60147. /**
  60148. * Gets the openGL type
  60149. */
  60150. glType: number;
  60151. /**
  60152. * Gets the openGL type size
  60153. */
  60154. glTypeSize: number;
  60155. /**
  60156. * Gets the openGL format
  60157. */
  60158. glFormat: number;
  60159. /**
  60160. * Gets the openGL internal format
  60161. */
  60162. glInternalFormat: number;
  60163. /**
  60164. * Gets the base internal format
  60165. */
  60166. glBaseInternalFormat: number;
  60167. /**
  60168. * Gets image width in pixel
  60169. */
  60170. pixelWidth: number;
  60171. /**
  60172. * Gets image height in pixel
  60173. */
  60174. pixelHeight: number;
  60175. /**
  60176. * Gets image depth in pixels
  60177. */
  60178. pixelDepth: number;
  60179. /**
  60180. * Gets the number of array elements
  60181. */
  60182. numberOfArrayElements: number;
  60183. /**
  60184. * Gets the number of faces
  60185. */
  60186. numberOfFaces: number;
  60187. /**
  60188. * Gets the number of mipmap levels
  60189. */
  60190. numberOfMipmapLevels: number;
  60191. /**
  60192. * Gets the bytes of key value data
  60193. */
  60194. bytesOfKeyValueData: number;
  60195. /**
  60196. * Gets the load type
  60197. */
  60198. loadType: number;
  60199. /**
  60200. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60201. */
  60202. isInvalid: boolean;
  60203. /**
  60204. * Creates a new KhronosTextureContainer
  60205. * @param data contents of the KTX container file
  60206. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60207. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60208. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60209. */
  60210. constructor(
  60211. /** contents of the KTX container file */
  60212. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60213. /**
  60214. * Uploads KTX content to a Babylon Texture.
  60215. * It is assumed that the texture has already been created & is currently bound
  60216. * @hidden
  60217. */
  60218. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60219. private _upload2DCompressedLevels;
  60220. /**
  60221. * Checks if the given data starts with a KTX file identifier.
  60222. * @param data the data to check
  60223. * @returns true if the data is a KTX file or false otherwise
  60224. */
  60225. static IsValid(data: ArrayBufferView): boolean;
  60226. }
  60227. }
  60228. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60229. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60230. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60231. /**
  60232. * Class for loading KTX2 files
  60233. * !!! Experimental Extension Subject to Changes !!!
  60234. * @hidden
  60235. */
  60236. export class KhronosTextureContainer2 {
  60237. private static _ModulePromise;
  60238. private static _TranscodeFormat;
  60239. constructor(engine: ThinEngine);
  60240. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60241. private _determineTranscodeFormat;
  60242. /**
  60243. * Checks if the given data starts with a KTX2 file identifier.
  60244. * @param data the data to check
  60245. * @returns true if the data is a KTX2 file or false otherwise
  60246. */
  60247. static IsValid(data: ArrayBufferView): boolean;
  60248. }
  60249. }
  60250. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60251. import { Nullable } from "babylonjs/types";
  60252. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60253. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60254. /**
  60255. * Implementation of the KTX Texture Loader.
  60256. * @hidden
  60257. */
  60258. export class _KTXTextureLoader implements IInternalTextureLoader {
  60259. /**
  60260. * Defines wether the loader supports cascade loading the different faces.
  60261. */
  60262. readonly supportCascades: boolean;
  60263. /**
  60264. * This returns if the loader support the current file information.
  60265. * @param extension defines the file extension of the file being loaded
  60266. * @param mimeType defines the optional mime type of the file being loaded
  60267. * @returns true if the loader can load the specified file
  60268. */
  60269. canLoad(extension: string, mimeType?: string): boolean;
  60270. /**
  60271. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60272. * @param data contains the texture data
  60273. * @param texture defines the BabylonJS internal texture
  60274. * @param createPolynomials will be true if polynomials have been requested
  60275. * @param onLoad defines the callback to trigger once the texture is ready
  60276. * @param onError defines the callback to trigger in case of error
  60277. */
  60278. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60279. /**
  60280. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60281. * @param data contains the texture data
  60282. * @param texture defines the BabylonJS internal texture
  60283. * @param callback defines the method to call once ready to upload
  60284. */
  60285. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60286. }
  60287. }
  60288. declare module "babylonjs/Helpers/sceneHelpers" {
  60289. import { Nullable } from "babylonjs/types";
  60290. import { Mesh } from "babylonjs/Meshes/mesh";
  60291. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60292. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60293. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60294. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60295. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60296. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60297. import "babylonjs/Meshes/Builders/boxBuilder";
  60298. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60299. /** @hidden */
  60300. export var _forceSceneHelpersToBundle: boolean;
  60301. module "babylonjs/scene" {
  60302. interface Scene {
  60303. /**
  60304. * Creates a default light for the scene.
  60305. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60306. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60307. */
  60308. createDefaultLight(replace?: boolean): void;
  60309. /**
  60310. * Creates a default camera for the scene.
  60311. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60312. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60313. * @param replace has default false, when true replaces the active camera in the scene
  60314. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60315. */
  60316. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60317. /**
  60318. * Creates a default camera and a default light.
  60319. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60320. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60321. * @param replace has the default false, when true replaces the active camera/light in the scene
  60322. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60323. */
  60324. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60325. /**
  60326. * Creates a new sky box
  60327. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60328. * @param environmentTexture defines the texture to use as environment texture
  60329. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60330. * @param scale defines the overall scale of the skybox
  60331. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60332. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60333. * @returns a new mesh holding the sky box
  60334. */
  60335. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60336. /**
  60337. * Creates a new environment
  60338. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60339. * @param options defines the options you can use to configure the environment
  60340. * @returns the new EnvironmentHelper
  60341. */
  60342. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60343. /**
  60344. * Creates a new VREXperienceHelper
  60345. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60346. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60347. * @returns a new VREXperienceHelper
  60348. */
  60349. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60350. /**
  60351. * Creates a new WebXRDefaultExperience
  60352. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60353. * @param options experience options
  60354. * @returns a promise for a new WebXRDefaultExperience
  60355. */
  60356. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60357. }
  60358. }
  60359. }
  60360. declare module "babylonjs/Helpers/videoDome" {
  60361. import { Scene } from "babylonjs/scene";
  60362. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60363. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60364. /**
  60365. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60366. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60367. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60368. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60369. */
  60370. export class VideoDome extends TextureDome<VideoTexture> {
  60371. /**
  60372. * Define the video source as a Monoscopic panoramic 360 video.
  60373. */
  60374. static readonly MODE_MONOSCOPIC: number;
  60375. /**
  60376. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60377. */
  60378. static readonly MODE_TOPBOTTOM: number;
  60379. /**
  60380. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60381. */
  60382. static readonly MODE_SIDEBYSIDE: number;
  60383. /**
  60384. * Get the video texture associated with this video dome
  60385. */
  60386. get videoTexture(): VideoTexture;
  60387. /**
  60388. * Get the video mode of this dome
  60389. */
  60390. get videoMode(): number;
  60391. /**
  60392. * Set the video mode of this dome.
  60393. * @see textureMode
  60394. */
  60395. set videoMode(value: number);
  60396. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60397. }
  60398. }
  60399. declare module "babylonjs/Helpers/index" {
  60400. export * from "babylonjs/Helpers/environmentHelper";
  60401. export * from "babylonjs/Helpers/photoDome";
  60402. export * from "babylonjs/Helpers/sceneHelpers";
  60403. export * from "babylonjs/Helpers/videoDome";
  60404. }
  60405. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60406. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60407. import { IDisposable } from "babylonjs/scene";
  60408. import { Engine } from "babylonjs/Engines/engine";
  60409. /**
  60410. * This class can be used to get instrumentation data from a Babylon engine
  60411. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60412. */
  60413. export class EngineInstrumentation implements IDisposable {
  60414. /**
  60415. * Define the instrumented engine.
  60416. */
  60417. engine: Engine;
  60418. private _captureGPUFrameTime;
  60419. private _gpuFrameTimeToken;
  60420. private _gpuFrameTime;
  60421. private _captureShaderCompilationTime;
  60422. private _shaderCompilationTime;
  60423. private _onBeginFrameObserver;
  60424. private _onEndFrameObserver;
  60425. private _onBeforeShaderCompilationObserver;
  60426. private _onAfterShaderCompilationObserver;
  60427. /**
  60428. * Gets the perf counter used for GPU frame time
  60429. */
  60430. get gpuFrameTimeCounter(): PerfCounter;
  60431. /**
  60432. * Gets the GPU frame time capture status
  60433. */
  60434. get captureGPUFrameTime(): boolean;
  60435. /**
  60436. * Enable or disable the GPU frame time capture
  60437. */
  60438. set captureGPUFrameTime(value: boolean);
  60439. /**
  60440. * Gets the perf counter used for shader compilation time
  60441. */
  60442. get shaderCompilationTimeCounter(): PerfCounter;
  60443. /**
  60444. * Gets the shader compilation time capture status
  60445. */
  60446. get captureShaderCompilationTime(): boolean;
  60447. /**
  60448. * Enable or disable the shader compilation time capture
  60449. */
  60450. set captureShaderCompilationTime(value: boolean);
  60451. /**
  60452. * Instantiates a new engine instrumentation.
  60453. * This class can be used to get instrumentation data from a Babylon engine
  60454. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60455. * @param engine Defines the engine to instrument
  60456. */
  60457. constructor(
  60458. /**
  60459. * Define the instrumented engine.
  60460. */
  60461. engine: Engine);
  60462. /**
  60463. * Dispose and release associated resources.
  60464. */
  60465. dispose(): void;
  60466. }
  60467. }
  60468. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60469. import { Scene, IDisposable } from "babylonjs/scene";
  60470. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60471. /**
  60472. * This class can be used to get instrumentation data from a Babylon engine
  60473. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60474. */
  60475. export class SceneInstrumentation implements IDisposable {
  60476. /**
  60477. * Defines the scene to instrument
  60478. */
  60479. scene: Scene;
  60480. private _captureActiveMeshesEvaluationTime;
  60481. private _activeMeshesEvaluationTime;
  60482. private _captureRenderTargetsRenderTime;
  60483. private _renderTargetsRenderTime;
  60484. private _captureFrameTime;
  60485. private _frameTime;
  60486. private _captureRenderTime;
  60487. private _renderTime;
  60488. private _captureInterFrameTime;
  60489. private _interFrameTime;
  60490. private _captureParticlesRenderTime;
  60491. private _particlesRenderTime;
  60492. private _captureSpritesRenderTime;
  60493. private _spritesRenderTime;
  60494. private _capturePhysicsTime;
  60495. private _physicsTime;
  60496. private _captureAnimationsTime;
  60497. private _animationsTime;
  60498. private _captureCameraRenderTime;
  60499. private _cameraRenderTime;
  60500. private _onBeforeActiveMeshesEvaluationObserver;
  60501. private _onAfterActiveMeshesEvaluationObserver;
  60502. private _onBeforeRenderTargetsRenderObserver;
  60503. private _onAfterRenderTargetsRenderObserver;
  60504. private _onAfterRenderObserver;
  60505. private _onBeforeDrawPhaseObserver;
  60506. private _onAfterDrawPhaseObserver;
  60507. private _onBeforeAnimationsObserver;
  60508. private _onBeforeParticlesRenderingObserver;
  60509. private _onAfterParticlesRenderingObserver;
  60510. private _onBeforeSpritesRenderingObserver;
  60511. private _onAfterSpritesRenderingObserver;
  60512. private _onBeforePhysicsObserver;
  60513. private _onAfterPhysicsObserver;
  60514. private _onAfterAnimationsObserver;
  60515. private _onBeforeCameraRenderObserver;
  60516. private _onAfterCameraRenderObserver;
  60517. /**
  60518. * Gets the perf counter used for active meshes evaluation time
  60519. */
  60520. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60521. /**
  60522. * Gets the active meshes evaluation time capture status
  60523. */
  60524. get captureActiveMeshesEvaluationTime(): boolean;
  60525. /**
  60526. * Enable or disable the active meshes evaluation time capture
  60527. */
  60528. set captureActiveMeshesEvaluationTime(value: boolean);
  60529. /**
  60530. * Gets the perf counter used for render targets render time
  60531. */
  60532. get renderTargetsRenderTimeCounter(): PerfCounter;
  60533. /**
  60534. * Gets the render targets render time capture status
  60535. */
  60536. get captureRenderTargetsRenderTime(): boolean;
  60537. /**
  60538. * Enable or disable the render targets render time capture
  60539. */
  60540. set captureRenderTargetsRenderTime(value: boolean);
  60541. /**
  60542. * Gets the perf counter used for particles render time
  60543. */
  60544. get particlesRenderTimeCounter(): PerfCounter;
  60545. /**
  60546. * Gets the particles render time capture status
  60547. */
  60548. get captureParticlesRenderTime(): boolean;
  60549. /**
  60550. * Enable or disable the particles render time capture
  60551. */
  60552. set captureParticlesRenderTime(value: boolean);
  60553. /**
  60554. * Gets the perf counter used for sprites render time
  60555. */
  60556. get spritesRenderTimeCounter(): PerfCounter;
  60557. /**
  60558. * Gets the sprites render time capture status
  60559. */
  60560. get captureSpritesRenderTime(): boolean;
  60561. /**
  60562. * Enable or disable the sprites render time capture
  60563. */
  60564. set captureSpritesRenderTime(value: boolean);
  60565. /**
  60566. * Gets the perf counter used for physics time
  60567. */
  60568. get physicsTimeCounter(): PerfCounter;
  60569. /**
  60570. * Gets the physics time capture status
  60571. */
  60572. get capturePhysicsTime(): boolean;
  60573. /**
  60574. * Enable or disable the physics time capture
  60575. */
  60576. set capturePhysicsTime(value: boolean);
  60577. /**
  60578. * Gets the perf counter used for animations time
  60579. */
  60580. get animationsTimeCounter(): PerfCounter;
  60581. /**
  60582. * Gets the animations time capture status
  60583. */
  60584. get captureAnimationsTime(): boolean;
  60585. /**
  60586. * Enable or disable the animations time capture
  60587. */
  60588. set captureAnimationsTime(value: boolean);
  60589. /**
  60590. * Gets the perf counter used for frame time capture
  60591. */
  60592. get frameTimeCounter(): PerfCounter;
  60593. /**
  60594. * Gets the frame time capture status
  60595. */
  60596. get captureFrameTime(): boolean;
  60597. /**
  60598. * Enable or disable the frame time capture
  60599. */
  60600. set captureFrameTime(value: boolean);
  60601. /**
  60602. * Gets the perf counter used for inter-frames time capture
  60603. */
  60604. get interFrameTimeCounter(): PerfCounter;
  60605. /**
  60606. * Gets the inter-frames time capture status
  60607. */
  60608. get captureInterFrameTime(): boolean;
  60609. /**
  60610. * Enable or disable the inter-frames time capture
  60611. */
  60612. set captureInterFrameTime(value: boolean);
  60613. /**
  60614. * Gets the perf counter used for render time capture
  60615. */
  60616. get renderTimeCounter(): PerfCounter;
  60617. /**
  60618. * Gets the render time capture status
  60619. */
  60620. get captureRenderTime(): boolean;
  60621. /**
  60622. * Enable or disable the render time capture
  60623. */
  60624. set captureRenderTime(value: boolean);
  60625. /**
  60626. * Gets the perf counter used for camera render time capture
  60627. */
  60628. get cameraRenderTimeCounter(): PerfCounter;
  60629. /**
  60630. * Gets the camera render time capture status
  60631. */
  60632. get captureCameraRenderTime(): boolean;
  60633. /**
  60634. * Enable or disable the camera render time capture
  60635. */
  60636. set captureCameraRenderTime(value: boolean);
  60637. /**
  60638. * Gets the perf counter used for draw calls
  60639. */
  60640. get drawCallsCounter(): PerfCounter;
  60641. /**
  60642. * Instantiates a new scene instrumentation.
  60643. * This class can be used to get instrumentation data from a Babylon engine
  60644. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60645. * @param scene Defines the scene to instrument
  60646. */
  60647. constructor(
  60648. /**
  60649. * Defines the scene to instrument
  60650. */
  60651. scene: Scene);
  60652. /**
  60653. * Dispose and release associated resources.
  60654. */
  60655. dispose(): void;
  60656. }
  60657. }
  60658. declare module "babylonjs/Instrumentation/index" {
  60659. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60660. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60661. export * from "babylonjs/Instrumentation/timeToken";
  60662. }
  60663. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60664. /** @hidden */
  60665. export var glowMapGenerationPixelShader: {
  60666. name: string;
  60667. shader: string;
  60668. };
  60669. }
  60670. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60671. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60672. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60673. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60674. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60675. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60676. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60677. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60678. /** @hidden */
  60679. export var glowMapGenerationVertexShader: {
  60680. name: string;
  60681. shader: string;
  60682. };
  60683. }
  60684. declare module "babylonjs/Layers/effectLayer" {
  60685. import { Observable } from "babylonjs/Misc/observable";
  60686. import { Nullable } from "babylonjs/types";
  60687. import { Camera } from "babylonjs/Cameras/camera";
  60688. import { Scene } from "babylonjs/scene";
  60689. import { ISize } from "babylonjs/Maths/math.size";
  60690. import { Color4 } from "babylonjs/Maths/math.color";
  60691. import { Engine } from "babylonjs/Engines/engine";
  60692. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60693. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60694. import { Mesh } from "babylonjs/Meshes/mesh";
  60695. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60696. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60697. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60698. import { Effect } from "babylonjs/Materials/effect";
  60699. import { Material } from "babylonjs/Materials/material";
  60700. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60701. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60702. /**
  60703. * Effect layer options. This helps customizing the behaviour
  60704. * of the effect layer.
  60705. */
  60706. export interface IEffectLayerOptions {
  60707. /**
  60708. * Multiplication factor apply to the canvas size to compute the render target size
  60709. * used to generated the objects (the smaller the faster).
  60710. */
  60711. mainTextureRatio: number;
  60712. /**
  60713. * Enforces a fixed size texture to ensure effect stability across devices.
  60714. */
  60715. mainTextureFixedSize?: number;
  60716. /**
  60717. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60718. */
  60719. alphaBlendingMode: number;
  60720. /**
  60721. * The camera attached to the layer.
  60722. */
  60723. camera: Nullable<Camera>;
  60724. /**
  60725. * The rendering group to draw the layer in.
  60726. */
  60727. renderingGroupId: number;
  60728. }
  60729. /**
  60730. * The effect layer Helps adding post process effect blended with the main pass.
  60731. *
  60732. * This can be for instance use to generate glow or higlight effects on the scene.
  60733. *
  60734. * The effect layer class can not be used directly and is intented to inherited from to be
  60735. * customized per effects.
  60736. */
  60737. export abstract class EffectLayer {
  60738. private _vertexBuffers;
  60739. private _indexBuffer;
  60740. private _cachedDefines;
  60741. private _effectLayerMapGenerationEffect;
  60742. private _effectLayerOptions;
  60743. private _mergeEffect;
  60744. protected _scene: Scene;
  60745. protected _engine: Engine;
  60746. protected _maxSize: number;
  60747. protected _mainTextureDesiredSize: ISize;
  60748. protected _mainTexture: RenderTargetTexture;
  60749. protected _shouldRender: boolean;
  60750. protected _postProcesses: PostProcess[];
  60751. protected _textures: BaseTexture[];
  60752. protected _emissiveTextureAndColor: {
  60753. texture: Nullable<BaseTexture>;
  60754. color: Color4;
  60755. };
  60756. /**
  60757. * The name of the layer
  60758. */
  60759. name: string;
  60760. /**
  60761. * The clear color of the texture used to generate the glow map.
  60762. */
  60763. neutralColor: Color4;
  60764. /**
  60765. * Specifies whether the highlight layer is enabled or not.
  60766. */
  60767. isEnabled: boolean;
  60768. /**
  60769. * Gets the camera attached to the layer.
  60770. */
  60771. get camera(): Nullable<Camera>;
  60772. /**
  60773. * Gets the rendering group id the layer should render in.
  60774. */
  60775. get renderingGroupId(): number;
  60776. set renderingGroupId(renderingGroupId: number);
  60777. /**
  60778. * An event triggered when the effect layer has been disposed.
  60779. */
  60780. onDisposeObservable: Observable<EffectLayer>;
  60781. /**
  60782. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60783. */
  60784. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60785. /**
  60786. * An event triggered when the generated texture is being merged in the scene.
  60787. */
  60788. onBeforeComposeObservable: Observable<EffectLayer>;
  60789. /**
  60790. * An event triggered when the mesh is rendered into the effect render target.
  60791. */
  60792. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60793. /**
  60794. * An event triggered after the mesh has been rendered into the effect render target.
  60795. */
  60796. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60797. /**
  60798. * An event triggered when the generated texture has been merged in the scene.
  60799. */
  60800. onAfterComposeObservable: Observable<EffectLayer>;
  60801. /**
  60802. * An event triggered when the efffect layer changes its size.
  60803. */
  60804. onSizeChangedObservable: Observable<EffectLayer>;
  60805. /** @hidden */
  60806. static _SceneComponentInitialization: (scene: Scene) => void;
  60807. /**
  60808. * Instantiates a new effect Layer and references it in the scene.
  60809. * @param name The name of the layer
  60810. * @param scene The scene to use the layer in
  60811. */
  60812. constructor(
  60813. /** The Friendly of the effect in the scene */
  60814. name: string, scene: Scene);
  60815. /**
  60816. * Get the effect name of the layer.
  60817. * @return The effect name
  60818. */
  60819. abstract getEffectName(): string;
  60820. /**
  60821. * Checks for the readiness of the element composing the layer.
  60822. * @param subMesh the mesh to check for
  60823. * @param useInstances specify whether or not to use instances to render the mesh
  60824. * @return true if ready otherwise, false
  60825. */
  60826. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60827. /**
  60828. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60829. * @returns true if the effect requires stencil during the main canvas render pass.
  60830. */
  60831. abstract needStencil(): boolean;
  60832. /**
  60833. * Create the merge effect. This is the shader use to blit the information back
  60834. * to the main canvas at the end of the scene rendering.
  60835. * @returns The effect containing the shader used to merge the effect on the main canvas
  60836. */
  60837. protected abstract _createMergeEffect(): Effect;
  60838. /**
  60839. * Creates the render target textures and post processes used in the effect layer.
  60840. */
  60841. protected abstract _createTextureAndPostProcesses(): void;
  60842. /**
  60843. * Implementation specific of rendering the generating effect on the main canvas.
  60844. * @param effect The effect used to render through
  60845. */
  60846. protected abstract _internalRender(effect: Effect): void;
  60847. /**
  60848. * Sets the required values for both the emissive texture and and the main color.
  60849. */
  60850. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60851. /**
  60852. * Free any resources and references associated to a mesh.
  60853. * Internal use
  60854. * @param mesh The mesh to free.
  60855. */
  60856. abstract _disposeMesh(mesh: Mesh): void;
  60857. /**
  60858. * Serializes this layer (Glow or Highlight for example)
  60859. * @returns a serialized layer object
  60860. */
  60861. abstract serialize?(): any;
  60862. /**
  60863. * Initializes the effect layer with the required options.
  60864. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60865. */
  60866. protected _init(options: Partial<IEffectLayerOptions>): void;
  60867. /**
  60868. * Generates the index buffer of the full screen quad blending to the main canvas.
  60869. */
  60870. private _generateIndexBuffer;
  60871. /**
  60872. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60873. */
  60874. private _generateVertexBuffer;
  60875. /**
  60876. * Sets the main texture desired size which is the closest power of two
  60877. * of the engine canvas size.
  60878. */
  60879. private _setMainTextureSize;
  60880. /**
  60881. * Creates the main texture for the effect layer.
  60882. */
  60883. protected _createMainTexture(): void;
  60884. /**
  60885. * Adds specific effects defines.
  60886. * @param defines The defines to add specifics to.
  60887. */
  60888. protected _addCustomEffectDefines(defines: string[]): void;
  60889. /**
  60890. * Checks for the readiness of the element composing the layer.
  60891. * @param subMesh the mesh to check for
  60892. * @param useInstances specify whether or not to use instances to render the mesh
  60893. * @param emissiveTexture the associated emissive texture used to generate the glow
  60894. * @return true if ready otherwise, false
  60895. */
  60896. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60897. /**
  60898. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60899. */
  60900. render(): void;
  60901. /**
  60902. * Determine if a given mesh will be used in the current effect.
  60903. * @param mesh mesh to test
  60904. * @returns true if the mesh will be used
  60905. */
  60906. hasMesh(mesh: AbstractMesh): boolean;
  60907. /**
  60908. * Returns true if the layer contains information to display, otherwise false.
  60909. * @returns true if the glow layer should be rendered
  60910. */
  60911. shouldRender(): boolean;
  60912. /**
  60913. * Returns true if the mesh should render, otherwise false.
  60914. * @param mesh The mesh to render
  60915. * @returns true if it should render otherwise false
  60916. */
  60917. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60918. /**
  60919. * Returns true if the mesh can be rendered, otherwise false.
  60920. * @param mesh The mesh to render
  60921. * @param material The material used on the mesh
  60922. * @returns true if it can be rendered otherwise false
  60923. */
  60924. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60925. /**
  60926. * Returns true if the mesh should render, otherwise false.
  60927. * @param mesh The mesh to render
  60928. * @returns true if it should render otherwise false
  60929. */
  60930. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60931. /**
  60932. * Renders the submesh passed in parameter to the generation map.
  60933. */
  60934. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60935. /**
  60936. * Defines whether the current material of the mesh should be use to render the effect.
  60937. * @param mesh defines the current mesh to render
  60938. */
  60939. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60940. /**
  60941. * Rebuild the required buffers.
  60942. * @hidden Internal use only.
  60943. */
  60944. _rebuild(): void;
  60945. /**
  60946. * Dispose only the render target textures and post process.
  60947. */
  60948. private _disposeTextureAndPostProcesses;
  60949. /**
  60950. * Dispose the highlight layer and free resources.
  60951. */
  60952. dispose(): void;
  60953. /**
  60954. * Gets the class name of the effect layer
  60955. * @returns the string with the class name of the effect layer
  60956. */
  60957. getClassName(): string;
  60958. /**
  60959. * Creates an effect layer from parsed effect layer data
  60960. * @param parsedEffectLayer defines effect layer data
  60961. * @param scene defines the current scene
  60962. * @param rootUrl defines the root URL containing the effect layer information
  60963. * @returns a parsed effect Layer
  60964. */
  60965. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60966. }
  60967. }
  60968. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60969. import { Scene } from "babylonjs/scene";
  60970. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60971. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60972. import { AbstractScene } from "babylonjs/abstractScene";
  60973. module "babylonjs/abstractScene" {
  60974. interface AbstractScene {
  60975. /**
  60976. * The list of effect layers (highlights/glow) added to the scene
  60977. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60978. * @see https://doc.babylonjs.com/how_to/glow_layer
  60979. */
  60980. effectLayers: Array<EffectLayer>;
  60981. /**
  60982. * Removes the given effect layer from this scene.
  60983. * @param toRemove defines the effect layer to remove
  60984. * @returns the index of the removed effect layer
  60985. */
  60986. removeEffectLayer(toRemove: EffectLayer): number;
  60987. /**
  60988. * Adds the given effect layer to this scene
  60989. * @param newEffectLayer defines the effect layer to add
  60990. */
  60991. addEffectLayer(newEffectLayer: EffectLayer): void;
  60992. }
  60993. }
  60994. /**
  60995. * Defines the layer scene component responsible to manage any effect layers
  60996. * in a given scene.
  60997. */
  60998. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60999. /**
  61000. * The component name helpfull to identify the component in the list of scene components.
  61001. */
  61002. readonly name: string;
  61003. /**
  61004. * The scene the component belongs to.
  61005. */
  61006. scene: Scene;
  61007. private _engine;
  61008. private _renderEffects;
  61009. private _needStencil;
  61010. private _previousStencilState;
  61011. /**
  61012. * Creates a new instance of the component for the given scene
  61013. * @param scene Defines the scene to register the component in
  61014. */
  61015. constructor(scene: Scene);
  61016. /**
  61017. * Registers the component in a given scene
  61018. */
  61019. register(): void;
  61020. /**
  61021. * Rebuilds the elements related to this component in case of
  61022. * context lost for instance.
  61023. */
  61024. rebuild(): void;
  61025. /**
  61026. * Serializes the component data to the specified json object
  61027. * @param serializationObject The object to serialize to
  61028. */
  61029. serialize(serializationObject: any): void;
  61030. /**
  61031. * Adds all the elements from the container to the scene
  61032. * @param container the container holding the elements
  61033. */
  61034. addFromContainer(container: AbstractScene): void;
  61035. /**
  61036. * Removes all the elements in the container from the scene
  61037. * @param container contains the elements to remove
  61038. * @param dispose if the removed element should be disposed (default: false)
  61039. */
  61040. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61041. /**
  61042. * Disposes the component and the associated ressources.
  61043. */
  61044. dispose(): void;
  61045. private _isReadyForMesh;
  61046. private _renderMainTexture;
  61047. private _setStencil;
  61048. private _setStencilBack;
  61049. private _draw;
  61050. private _drawCamera;
  61051. private _drawRenderingGroup;
  61052. }
  61053. }
  61054. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61055. /** @hidden */
  61056. export var glowMapMergePixelShader: {
  61057. name: string;
  61058. shader: string;
  61059. };
  61060. }
  61061. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61062. /** @hidden */
  61063. export var glowMapMergeVertexShader: {
  61064. name: string;
  61065. shader: string;
  61066. };
  61067. }
  61068. declare module "babylonjs/Layers/glowLayer" {
  61069. import { Nullable } from "babylonjs/types";
  61070. import { Camera } from "babylonjs/Cameras/camera";
  61071. import { Scene } from "babylonjs/scene";
  61072. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61073. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61074. import { Mesh } from "babylonjs/Meshes/mesh";
  61075. import { Texture } from "babylonjs/Materials/Textures/texture";
  61076. import { Effect } from "babylonjs/Materials/effect";
  61077. import { Material } from "babylonjs/Materials/material";
  61078. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61079. import { Color4 } from "babylonjs/Maths/math.color";
  61080. import "babylonjs/Shaders/glowMapMerge.fragment";
  61081. import "babylonjs/Shaders/glowMapMerge.vertex";
  61082. import "babylonjs/Layers/effectLayerSceneComponent";
  61083. module "babylonjs/abstractScene" {
  61084. interface AbstractScene {
  61085. /**
  61086. * Return a the first highlight layer of the scene with a given name.
  61087. * @param name The name of the highlight layer to look for.
  61088. * @return The highlight layer if found otherwise null.
  61089. */
  61090. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61091. }
  61092. }
  61093. /**
  61094. * Glow layer options. This helps customizing the behaviour
  61095. * of the glow layer.
  61096. */
  61097. export interface IGlowLayerOptions {
  61098. /**
  61099. * Multiplication factor apply to the canvas size to compute the render target size
  61100. * used to generated the glowing objects (the smaller the faster).
  61101. */
  61102. mainTextureRatio: number;
  61103. /**
  61104. * Enforces a fixed size texture to ensure resize independant blur.
  61105. */
  61106. mainTextureFixedSize?: number;
  61107. /**
  61108. * How big is the kernel of the blur texture.
  61109. */
  61110. blurKernelSize: number;
  61111. /**
  61112. * The camera attached to the layer.
  61113. */
  61114. camera: Nullable<Camera>;
  61115. /**
  61116. * Enable MSAA by chosing the number of samples.
  61117. */
  61118. mainTextureSamples?: number;
  61119. /**
  61120. * The rendering group to draw the layer in.
  61121. */
  61122. renderingGroupId: number;
  61123. }
  61124. /**
  61125. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61126. *
  61127. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61128. *
  61129. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61130. */
  61131. export class GlowLayer extends EffectLayer {
  61132. /**
  61133. * Effect Name of the layer.
  61134. */
  61135. static readonly EffectName: string;
  61136. /**
  61137. * The default blur kernel size used for the glow.
  61138. */
  61139. static DefaultBlurKernelSize: number;
  61140. /**
  61141. * The default texture size ratio used for the glow.
  61142. */
  61143. static DefaultTextureRatio: number;
  61144. /**
  61145. * Sets the kernel size of the blur.
  61146. */
  61147. set blurKernelSize(value: number);
  61148. /**
  61149. * Gets the kernel size of the blur.
  61150. */
  61151. get blurKernelSize(): number;
  61152. /**
  61153. * Sets the glow intensity.
  61154. */
  61155. set intensity(value: number);
  61156. /**
  61157. * Gets the glow intensity.
  61158. */
  61159. get intensity(): number;
  61160. private _options;
  61161. private _intensity;
  61162. private _horizontalBlurPostprocess1;
  61163. private _verticalBlurPostprocess1;
  61164. private _horizontalBlurPostprocess2;
  61165. private _verticalBlurPostprocess2;
  61166. private _blurTexture1;
  61167. private _blurTexture2;
  61168. private _postProcesses1;
  61169. private _postProcesses2;
  61170. private _includedOnlyMeshes;
  61171. private _excludedMeshes;
  61172. private _meshesUsingTheirOwnMaterials;
  61173. /**
  61174. * Callback used to let the user override the color selection on a per mesh basis
  61175. */
  61176. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61177. /**
  61178. * Callback used to let the user override the texture selection on a per mesh basis
  61179. */
  61180. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61181. /**
  61182. * Instantiates a new glow Layer and references it to the scene.
  61183. * @param name The name of the layer
  61184. * @param scene The scene to use the layer in
  61185. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61186. */
  61187. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61188. /**
  61189. * Get the effect name of the layer.
  61190. * @return The effect name
  61191. */
  61192. getEffectName(): string;
  61193. /**
  61194. * Create the merge effect. This is the shader use to blit the information back
  61195. * to the main canvas at the end of the scene rendering.
  61196. */
  61197. protected _createMergeEffect(): Effect;
  61198. /**
  61199. * Creates the render target textures and post processes used in the glow layer.
  61200. */
  61201. protected _createTextureAndPostProcesses(): void;
  61202. /**
  61203. * Checks for the readiness of the element composing the layer.
  61204. * @param subMesh the mesh to check for
  61205. * @param useInstances specify wether or not to use instances to render the mesh
  61206. * @param emissiveTexture the associated emissive texture used to generate the glow
  61207. * @return true if ready otherwise, false
  61208. */
  61209. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61210. /**
  61211. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61212. */
  61213. needStencil(): boolean;
  61214. /**
  61215. * Returns true if the mesh can be rendered, otherwise false.
  61216. * @param mesh The mesh to render
  61217. * @param material The material used on the mesh
  61218. * @returns true if it can be rendered otherwise false
  61219. */
  61220. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61221. /**
  61222. * Implementation specific of rendering the generating effect on the main canvas.
  61223. * @param effect The effect used to render through
  61224. */
  61225. protected _internalRender(effect: Effect): void;
  61226. /**
  61227. * Sets the required values for both the emissive texture and and the main color.
  61228. */
  61229. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61230. /**
  61231. * Returns true if the mesh should render, otherwise false.
  61232. * @param mesh The mesh to render
  61233. * @returns true if it should render otherwise false
  61234. */
  61235. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61236. /**
  61237. * Adds specific effects defines.
  61238. * @param defines The defines to add specifics to.
  61239. */
  61240. protected _addCustomEffectDefines(defines: string[]): void;
  61241. /**
  61242. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61243. * @param mesh The mesh to exclude from the glow layer
  61244. */
  61245. addExcludedMesh(mesh: Mesh): void;
  61246. /**
  61247. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61248. * @param mesh The mesh to remove
  61249. */
  61250. removeExcludedMesh(mesh: Mesh): void;
  61251. /**
  61252. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61253. * @param mesh The mesh to include in the glow layer
  61254. */
  61255. addIncludedOnlyMesh(mesh: Mesh): void;
  61256. /**
  61257. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61258. * @param mesh The mesh to remove
  61259. */
  61260. removeIncludedOnlyMesh(mesh: Mesh): void;
  61261. /**
  61262. * Determine if a given mesh will be used in the glow layer
  61263. * @param mesh The mesh to test
  61264. * @returns true if the mesh will be highlighted by the current glow layer
  61265. */
  61266. hasMesh(mesh: AbstractMesh): boolean;
  61267. /**
  61268. * Defines whether the current material of the mesh should be use to render the effect.
  61269. * @param mesh defines the current mesh to render
  61270. */
  61271. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61272. /**
  61273. * Add a mesh to be rendered through its own material and not with emissive only.
  61274. * @param mesh The mesh for which we need to use its material
  61275. */
  61276. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61277. /**
  61278. * Remove a mesh from being rendered through its own material and not with emissive only.
  61279. * @param mesh The mesh for which we need to not use its material
  61280. */
  61281. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61282. /**
  61283. * Free any resources and references associated to a mesh.
  61284. * Internal use
  61285. * @param mesh The mesh to free.
  61286. * @hidden
  61287. */
  61288. _disposeMesh(mesh: Mesh): void;
  61289. /**
  61290. * Gets the class name of the effect layer
  61291. * @returns the string with the class name of the effect layer
  61292. */
  61293. getClassName(): string;
  61294. /**
  61295. * Serializes this glow layer
  61296. * @returns a serialized glow layer object
  61297. */
  61298. serialize(): any;
  61299. /**
  61300. * Creates a Glow Layer from parsed glow layer data
  61301. * @param parsedGlowLayer defines glow layer data
  61302. * @param scene defines the current scene
  61303. * @param rootUrl defines the root URL containing the glow layer information
  61304. * @returns a parsed Glow Layer
  61305. */
  61306. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61307. }
  61308. }
  61309. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61310. /** @hidden */
  61311. export var glowBlurPostProcessPixelShader: {
  61312. name: string;
  61313. shader: string;
  61314. };
  61315. }
  61316. declare module "babylonjs/Layers/highlightLayer" {
  61317. import { Observable } from "babylonjs/Misc/observable";
  61318. import { Nullable } from "babylonjs/types";
  61319. import { Camera } from "babylonjs/Cameras/camera";
  61320. import { Scene } from "babylonjs/scene";
  61321. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61323. import { Mesh } from "babylonjs/Meshes/mesh";
  61324. import { Effect } from "babylonjs/Materials/effect";
  61325. import { Material } from "babylonjs/Materials/material";
  61326. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61327. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61328. import "babylonjs/Shaders/glowMapMerge.fragment";
  61329. import "babylonjs/Shaders/glowMapMerge.vertex";
  61330. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61331. module "babylonjs/abstractScene" {
  61332. interface AbstractScene {
  61333. /**
  61334. * Return a the first highlight layer of the scene with a given name.
  61335. * @param name The name of the highlight layer to look for.
  61336. * @return The highlight layer if found otherwise null.
  61337. */
  61338. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61339. }
  61340. }
  61341. /**
  61342. * Highlight layer options. This helps customizing the behaviour
  61343. * of the highlight layer.
  61344. */
  61345. export interface IHighlightLayerOptions {
  61346. /**
  61347. * Multiplication factor apply to the canvas size to compute the render target size
  61348. * used to generated the glowing objects (the smaller the faster).
  61349. */
  61350. mainTextureRatio: number;
  61351. /**
  61352. * Enforces a fixed size texture to ensure resize independant blur.
  61353. */
  61354. mainTextureFixedSize?: number;
  61355. /**
  61356. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61357. * of the picture to blur (the smaller the faster).
  61358. */
  61359. blurTextureSizeRatio: number;
  61360. /**
  61361. * How big in texel of the blur texture is the vertical blur.
  61362. */
  61363. blurVerticalSize: number;
  61364. /**
  61365. * How big in texel of the blur texture is the horizontal blur.
  61366. */
  61367. blurHorizontalSize: number;
  61368. /**
  61369. * Alpha blending mode used to apply the blur. Default is combine.
  61370. */
  61371. alphaBlendingMode: number;
  61372. /**
  61373. * The camera attached to the layer.
  61374. */
  61375. camera: Nullable<Camera>;
  61376. /**
  61377. * Should we display highlight as a solid stroke?
  61378. */
  61379. isStroke?: boolean;
  61380. /**
  61381. * The rendering group to draw the layer in.
  61382. */
  61383. renderingGroupId: number;
  61384. }
  61385. /**
  61386. * The highlight layer Helps adding a glow effect around a mesh.
  61387. *
  61388. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61389. * glowy meshes to your scene.
  61390. *
  61391. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61392. */
  61393. export class HighlightLayer extends EffectLayer {
  61394. name: string;
  61395. /**
  61396. * Effect Name of the highlight layer.
  61397. */
  61398. static readonly EffectName: string;
  61399. /**
  61400. * The neutral color used during the preparation of the glow effect.
  61401. * This is black by default as the blend operation is a blend operation.
  61402. */
  61403. static NeutralColor: Color4;
  61404. /**
  61405. * Stencil value used for glowing meshes.
  61406. */
  61407. static GlowingMeshStencilReference: number;
  61408. /**
  61409. * Stencil value used for the other meshes in the scene.
  61410. */
  61411. static NormalMeshStencilReference: number;
  61412. /**
  61413. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61414. */
  61415. innerGlow: boolean;
  61416. /**
  61417. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61418. */
  61419. outerGlow: boolean;
  61420. /**
  61421. * Specifies the horizontal size of the blur.
  61422. */
  61423. set blurHorizontalSize(value: number);
  61424. /**
  61425. * Specifies the vertical size of the blur.
  61426. */
  61427. set blurVerticalSize(value: number);
  61428. /**
  61429. * Gets the horizontal size of the blur.
  61430. */
  61431. get blurHorizontalSize(): number;
  61432. /**
  61433. * Gets the vertical size of the blur.
  61434. */
  61435. get blurVerticalSize(): number;
  61436. /**
  61437. * An event triggered when the highlight layer is being blurred.
  61438. */
  61439. onBeforeBlurObservable: Observable<HighlightLayer>;
  61440. /**
  61441. * An event triggered when the highlight layer has been blurred.
  61442. */
  61443. onAfterBlurObservable: Observable<HighlightLayer>;
  61444. private _instanceGlowingMeshStencilReference;
  61445. private _options;
  61446. private _downSamplePostprocess;
  61447. private _horizontalBlurPostprocess;
  61448. private _verticalBlurPostprocess;
  61449. private _blurTexture;
  61450. private _meshes;
  61451. private _excludedMeshes;
  61452. /**
  61453. * Instantiates a new highlight Layer and references it to the scene..
  61454. * @param name The name of the layer
  61455. * @param scene The scene to use the layer in
  61456. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61457. */
  61458. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61459. /**
  61460. * Get the effect name of the layer.
  61461. * @return The effect name
  61462. */
  61463. getEffectName(): string;
  61464. /**
  61465. * Create the merge effect. This is the shader use to blit the information back
  61466. * to the main canvas at the end of the scene rendering.
  61467. */
  61468. protected _createMergeEffect(): Effect;
  61469. /**
  61470. * Creates the render target textures and post processes used in the highlight layer.
  61471. */
  61472. protected _createTextureAndPostProcesses(): void;
  61473. /**
  61474. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61475. */
  61476. needStencil(): boolean;
  61477. /**
  61478. * Checks for the readiness of the element composing the layer.
  61479. * @param subMesh the mesh to check for
  61480. * @param useInstances specify wether or not to use instances to render the mesh
  61481. * @param emissiveTexture the associated emissive texture used to generate the glow
  61482. * @return true if ready otherwise, false
  61483. */
  61484. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61485. /**
  61486. * Implementation specific of rendering the generating effect on the main canvas.
  61487. * @param effect The effect used to render through
  61488. */
  61489. protected _internalRender(effect: Effect): void;
  61490. /**
  61491. * Returns true if the layer contains information to display, otherwise false.
  61492. */
  61493. shouldRender(): boolean;
  61494. /**
  61495. * Returns true if the mesh should render, otherwise false.
  61496. * @param mesh The mesh to render
  61497. * @returns true if it should render otherwise false
  61498. */
  61499. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61500. /**
  61501. * Returns true if the mesh can be rendered, otherwise false.
  61502. * @param mesh The mesh to render
  61503. * @param material The material used on the mesh
  61504. * @returns true if it can be rendered otherwise false
  61505. */
  61506. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61507. /**
  61508. * Adds specific effects defines.
  61509. * @param defines The defines to add specifics to.
  61510. */
  61511. protected _addCustomEffectDefines(defines: string[]): void;
  61512. /**
  61513. * Sets the required values for both the emissive texture and and the main color.
  61514. */
  61515. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61516. /**
  61517. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61518. * @param mesh The mesh to exclude from the highlight layer
  61519. */
  61520. addExcludedMesh(mesh: Mesh): void;
  61521. /**
  61522. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61523. * @param mesh The mesh to highlight
  61524. */
  61525. removeExcludedMesh(mesh: Mesh): void;
  61526. /**
  61527. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61528. * @param mesh mesh to test
  61529. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61530. */
  61531. hasMesh(mesh: AbstractMesh): boolean;
  61532. /**
  61533. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61534. * @param mesh The mesh to highlight
  61535. * @param color The color of the highlight
  61536. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61537. */
  61538. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61539. /**
  61540. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61541. * @param mesh The mesh to highlight
  61542. */
  61543. removeMesh(mesh: Mesh): void;
  61544. /**
  61545. * Remove all the meshes currently referenced in the highlight layer
  61546. */
  61547. removeAllMeshes(): void;
  61548. /**
  61549. * Force the stencil to the normal expected value for none glowing parts
  61550. */
  61551. private _defaultStencilReference;
  61552. /**
  61553. * Free any resources and references associated to a mesh.
  61554. * Internal use
  61555. * @param mesh The mesh to free.
  61556. * @hidden
  61557. */
  61558. _disposeMesh(mesh: Mesh): void;
  61559. /**
  61560. * Dispose the highlight layer and free resources.
  61561. */
  61562. dispose(): void;
  61563. /**
  61564. * Gets the class name of the effect layer
  61565. * @returns the string with the class name of the effect layer
  61566. */
  61567. getClassName(): string;
  61568. /**
  61569. * Serializes this Highlight layer
  61570. * @returns a serialized Highlight layer object
  61571. */
  61572. serialize(): any;
  61573. /**
  61574. * Creates a Highlight layer from parsed Highlight layer data
  61575. * @param parsedHightlightLayer defines the Highlight layer data
  61576. * @param scene defines the current scene
  61577. * @param rootUrl defines the root URL containing the Highlight layer information
  61578. * @returns a parsed Highlight layer
  61579. */
  61580. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61581. }
  61582. }
  61583. declare module "babylonjs/Layers/layerSceneComponent" {
  61584. import { Scene } from "babylonjs/scene";
  61585. import { ISceneComponent } from "babylonjs/sceneComponent";
  61586. import { Layer } from "babylonjs/Layers/layer";
  61587. import { AbstractScene } from "babylonjs/abstractScene";
  61588. module "babylonjs/abstractScene" {
  61589. interface AbstractScene {
  61590. /**
  61591. * The list of layers (background and foreground) of the scene
  61592. */
  61593. layers: Array<Layer>;
  61594. }
  61595. }
  61596. /**
  61597. * Defines the layer scene component responsible to manage any layers
  61598. * in a given scene.
  61599. */
  61600. export class LayerSceneComponent implements ISceneComponent {
  61601. /**
  61602. * The component name helpfull to identify the component in the list of scene components.
  61603. */
  61604. readonly name: string;
  61605. /**
  61606. * The scene the component belongs to.
  61607. */
  61608. scene: Scene;
  61609. private _engine;
  61610. /**
  61611. * Creates a new instance of the component for the given scene
  61612. * @param scene Defines the scene to register the component in
  61613. */
  61614. constructor(scene: Scene);
  61615. /**
  61616. * Registers the component in a given scene
  61617. */
  61618. register(): void;
  61619. /**
  61620. * Rebuilds the elements related to this component in case of
  61621. * context lost for instance.
  61622. */
  61623. rebuild(): void;
  61624. /**
  61625. * Disposes the component and the associated ressources.
  61626. */
  61627. dispose(): void;
  61628. private _draw;
  61629. private _drawCameraPredicate;
  61630. private _drawCameraBackground;
  61631. private _drawCameraForeground;
  61632. private _drawRenderTargetPredicate;
  61633. private _drawRenderTargetBackground;
  61634. private _drawRenderTargetForeground;
  61635. /**
  61636. * Adds all the elements from the container to the scene
  61637. * @param container the container holding the elements
  61638. */
  61639. addFromContainer(container: AbstractScene): void;
  61640. /**
  61641. * Removes all the elements in the container from the scene
  61642. * @param container contains the elements to remove
  61643. * @param dispose if the removed element should be disposed (default: false)
  61644. */
  61645. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61646. }
  61647. }
  61648. declare module "babylonjs/Shaders/layer.fragment" {
  61649. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61650. /** @hidden */
  61651. export var layerPixelShader: {
  61652. name: string;
  61653. shader: string;
  61654. };
  61655. }
  61656. declare module "babylonjs/Shaders/layer.vertex" {
  61657. /** @hidden */
  61658. export var layerVertexShader: {
  61659. name: string;
  61660. shader: string;
  61661. };
  61662. }
  61663. declare module "babylonjs/Layers/layer" {
  61664. import { Observable } from "babylonjs/Misc/observable";
  61665. import { Nullable } from "babylonjs/types";
  61666. import { Scene } from "babylonjs/scene";
  61667. import { Vector2 } from "babylonjs/Maths/math.vector";
  61668. import { Color4 } from "babylonjs/Maths/math.color";
  61669. import { Texture } from "babylonjs/Materials/Textures/texture";
  61670. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61671. import "babylonjs/Shaders/layer.fragment";
  61672. import "babylonjs/Shaders/layer.vertex";
  61673. /**
  61674. * This represents a full screen 2d layer.
  61675. * This can be useful to display a picture in the background of your scene for instance.
  61676. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61677. */
  61678. export class Layer {
  61679. /**
  61680. * Define the name of the layer.
  61681. */
  61682. name: string;
  61683. /**
  61684. * Define the texture the layer should display.
  61685. */
  61686. texture: Nullable<Texture>;
  61687. /**
  61688. * Is the layer in background or foreground.
  61689. */
  61690. isBackground: boolean;
  61691. /**
  61692. * Define the color of the layer (instead of texture).
  61693. */
  61694. color: Color4;
  61695. /**
  61696. * Define the scale of the layer in order to zoom in out of the texture.
  61697. */
  61698. scale: Vector2;
  61699. /**
  61700. * Define an offset for the layer in order to shift the texture.
  61701. */
  61702. offset: Vector2;
  61703. /**
  61704. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61705. */
  61706. alphaBlendingMode: number;
  61707. /**
  61708. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61709. * Alpha test will not mix with the background color in case of transparency.
  61710. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61711. */
  61712. alphaTest: boolean;
  61713. /**
  61714. * Define a mask to restrict the layer to only some of the scene cameras.
  61715. */
  61716. layerMask: number;
  61717. /**
  61718. * Define the list of render target the layer is visible into.
  61719. */
  61720. renderTargetTextures: RenderTargetTexture[];
  61721. /**
  61722. * Define if the layer is only used in renderTarget or if it also
  61723. * renders in the main frame buffer of the canvas.
  61724. */
  61725. renderOnlyInRenderTargetTextures: boolean;
  61726. private _scene;
  61727. private _vertexBuffers;
  61728. private _indexBuffer;
  61729. private _effect;
  61730. private _previousDefines;
  61731. /**
  61732. * An event triggered when the layer is disposed.
  61733. */
  61734. onDisposeObservable: Observable<Layer>;
  61735. private _onDisposeObserver;
  61736. /**
  61737. * Back compatibility with callback before the onDisposeObservable existed.
  61738. * The set callback will be triggered when the layer has been disposed.
  61739. */
  61740. set onDispose(callback: () => void);
  61741. /**
  61742. * An event triggered before rendering the scene
  61743. */
  61744. onBeforeRenderObservable: Observable<Layer>;
  61745. private _onBeforeRenderObserver;
  61746. /**
  61747. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61748. * The set callback will be triggered just before rendering the layer.
  61749. */
  61750. set onBeforeRender(callback: () => void);
  61751. /**
  61752. * An event triggered after rendering the scene
  61753. */
  61754. onAfterRenderObservable: Observable<Layer>;
  61755. private _onAfterRenderObserver;
  61756. /**
  61757. * Back compatibility with callback before the onAfterRenderObservable existed.
  61758. * The set callback will be triggered just after rendering the layer.
  61759. */
  61760. set onAfterRender(callback: () => void);
  61761. /**
  61762. * Instantiates a new layer.
  61763. * This represents a full screen 2d layer.
  61764. * This can be useful to display a picture in the background of your scene for instance.
  61765. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61766. * @param name Define the name of the layer in the scene
  61767. * @param imgUrl Define the url of the texture to display in the layer
  61768. * @param scene Define the scene the layer belongs to
  61769. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61770. * @param color Defines a color for the layer
  61771. */
  61772. constructor(
  61773. /**
  61774. * Define the name of the layer.
  61775. */
  61776. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61777. private _createIndexBuffer;
  61778. /** @hidden */
  61779. _rebuild(): void;
  61780. /**
  61781. * Renders the layer in the scene.
  61782. */
  61783. render(): void;
  61784. /**
  61785. * Disposes and releases the associated ressources.
  61786. */
  61787. dispose(): void;
  61788. }
  61789. }
  61790. declare module "babylonjs/Layers/index" {
  61791. export * from "babylonjs/Layers/effectLayer";
  61792. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61793. export * from "babylonjs/Layers/glowLayer";
  61794. export * from "babylonjs/Layers/highlightLayer";
  61795. export * from "babylonjs/Layers/layer";
  61796. export * from "babylonjs/Layers/layerSceneComponent";
  61797. }
  61798. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61799. /** @hidden */
  61800. export var lensFlarePixelShader: {
  61801. name: string;
  61802. shader: string;
  61803. };
  61804. }
  61805. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61806. /** @hidden */
  61807. export var lensFlareVertexShader: {
  61808. name: string;
  61809. shader: string;
  61810. };
  61811. }
  61812. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61813. import { Scene } from "babylonjs/scene";
  61814. import { Vector3 } from "babylonjs/Maths/math.vector";
  61815. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61816. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61817. import "babylonjs/Shaders/lensFlare.fragment";
  61818. import "babylonjs/Shaders/lensFlare.vertex";
  61819. import { Viewport } from "babylonjs/Maths/math.viewport";
  61820. /**
  61821. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61822. * It is usually composed of several `lensFlare`.
  61823. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61824. */
  61825. export class LensFlareSystem {
  61826. /**
  61827. * Define the name of the lens flare system
  61828. */
  61829. name: string;
  61830. /**
  61831. * List of lens flares used in this system.
  61832. */
  61833. lensFlares: LensFlare[];
  61834. /**
  61835. * Define a limit from the border the lens flare can be visible.
  61836. */
  61837. borderLimit: number;
  61838. /**
  61839. * Define a viewport border we do not want to see the lens flare in.
  61840. */
  61841. viewportBorder: number;
  61842. /**
  61843. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61844. */
  61845. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61846. /**
  61847. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61848. */
  61849. layerMask: number;
  61850. /**
  61851. * Define the id of the lens flare system in the scene.
  61852. * (equal to name by default)
  61853. */
  61854. id: string;
  61855. private _scene;
  61856. private _emitter;
  61857. private _vertexBuffers;
  61858. private _indexBuffer;
  61859. private _effect;
  61860. private _positionX;
  61861. private _positionY;
  61862. private _isEnabled;
  61863. /** @hidden */
  61864. static _SceneComponentInitialization: (scene: Scene) => void;
  61865. /**
  61866. * Instantiates a lens flare system.
  61867. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61868. * It is usually composed of several `lensFlare`.
  61869. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61870. * @param name Define the name of the lens flare system in the scene
  61871. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61872. * @param scene Define the scene the lens flare system belongs to
  61873. */
  61874. constructor(
  61875. /**
  61876. * Define the name of the lens flare system
  61877. */
  61878. name: string, emitter: any, scene: Scene);
  61879. /**
  61880. * Define if the lens flare system is enabled.
  61881. */
  61882. get isEnabled(): boolean;
  61883. set isEnabled(value: boolean);
  61884. /**
  61885. * Get the scene the effects belongs to.
  61886. * @returns the scene holding the lens flare system
  61887. */
  61888. getScene(): Scene;
  61889. /**
  61890. * Get the emitter of the lens flare system.
  61891. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61892. * @returns the emitter of the lens flare system
  61893. */
  61894. getEmitter(): any;
  61895. /**
  61896. * Set the emitter of the lens flare system.
  61897. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61898. * @param newEmitter Define the new emitter of the system
  61899. */
  61900. setEmitter(newEmitter: any): void;
  61901. /**
  61902. * Get the lens flare system emitter position.
  61903. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61904. * @returns the position
  61905. */
  61906. getEmitterPosition(): Vector3;
  61907. /**
  61908. * @hidden
  61909. */
  61910. computeEffectivePosition(globalViewport: Viewport): boolean;
  61911. /** @hidden */
  61912. _isVisible(): boolean;
  61913. /**
  61914. * @hidden
  61915. */
  61916. render(): boolean;
  61917. /**
  61918. * Dispose and release the lens flare with its associated resources.
  61919. */
  61920. dispose(): void;
  61921. /**
  61922. * Parse a lens flare system from a JSON repressentation
  61923. * @param parsedLensFlareSystem Define the JSON to parse
  61924. * @param scene Define the scene the parsed system should be instantiated in
  61925. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61926. * @returns the parsed system
  61927. */
  61928. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61929. /**
  61930. * Serialize the current Lens Flare System into a JSON representation.
  61931. * @returns the serialized JSON
  61932. */
  61933. serialize(): any;
  61934. }
  61935. }
  61936. declare module "babylonjs/LensFlares/lensFlare" {
  61937. import { Nullable } from "babylonjs/types";
  61938. import { Color3 } from "babylonjs/Maths/math.color";
  61939. import { Texture } from "babylonjs/Materials/Textures/texture";
  61940. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61941. /**
  61942. * This represents one of the lens effect in a `lensFlareSystem`.
  61943. * It controls one of the indiviual texture used in the effect.
  61944. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61945. */
  61946. export class LensFlare {
  61947. /**
  61948. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61949. */
  61950. size: number;
  61951. /**
  61952. * 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.
  61953. */
  61954. position: number;
  61955. /**
  61956. * Define the lens color.
  61957. */
  61958. color: Color3;
  61959. /**
  61960. * Define the lens texture.
  61961. */
  61962. texture: Nullable<Texture>;
  61963. /**
  61964. * Define the alpha mode to render this particular lens.
  61965. */
  61966. alphaMode: number;
  61967. private _system;
  61968. /**
  61969. * Creates a new Lens Flare.
  61970. * This represents one of the lens effect in a `lensFlareSystem`.
  61971. * It controls one of the indiviual texture used in the effect.
  61972. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61973. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61974. * @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.
  61975. * @param color Define the lens color
  61976. * @param imgUrl Define the lens texture url
  61977. * @param system Define the `lensFlareSystem` this flare is part of
  61978. * @returns The newly created Lens Flare
  61979. */
  61980. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61981. /**
  61982. * Instantiates a new Lens Flare.
  61983. * This represents one of the lens effect in a `lensFlareSystem`.
  61984. * It controls one of the indiviual texture used in the effect.
  61985. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61986. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61987. * @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.
  61988. * @param color Define the lens color
  61989. * @param imgUrl Define the lens texture url
  61990. * @param system Define the `lensFlareSystem` this flare is part of
  61991. */
  61992. constructor(
  61993. /**
  61994. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61995. */
  61996. size: number,
  61997. /**
  61998. * 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.
  61999. */
  62000. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  62001. /**
  62002. * Dispose and release the lens flare with its associated resources.
  62003. */
  62004. dispose(): void;
  62005. }
  62006. }
  62007. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62008. import { Nullable } from "babylonjs/types";
  62009. import { Scene } from "babylonjs/scene";
  62010. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62011. import { AbstractScene } from "babylonjs/abstractScene";
  62012. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62013. module "babylonjs/abstractScene" {
  62014. interface AbstractScene {
  62015. /**
  62016. * The list of lens flare system added to the scene
  62017. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62018. */
  62019. lensFlareSystems: Array<LensFlareSystem>;
  62020. /**
  62021. * Removes the given lens flare system from this scene.
  62022. * @param toRemove The lens flare system to remove
  62023. * @returns The index of the removed lens flare system
  62024. */
  62025. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62026. /**
  62027. * Adds the given lens flare system to this scene
  62028. * @param newLensFlareSystem The lens flare system to add
  62029. */
  62030. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62031. /**
  62032. * Gets a lens flare system using its name
  62033. * @param name defines the name to look for
  62034. * @returns the lens flare system or null if not found
  62035. */
  62036. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62037. /**
  62038. * Gets a lens flare system using its id
  62039. * @param id defines the id to look for
  62040. * @returns the lens flare system or null if not found
  62041. */
  62042. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62043. }
  62044. }
  62045. /**
  62046. * Defines the lens flare scene component responsible to manage any lens flares
  62047. * in a given scene.
  62048. */
  62049. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62050. /**
  62051. * The component name helpfull to identify the component in the list of scene components.
  62052. */
  62053. readonly name: string;
  62054. /**
  62055. * The scene the component belongs to.
  62056. */
  62057. scene: Scene;
  62058. /**
  62059. * Creates a new instance of the component for the given scene
  62060. * @param scene Defines the scene to register the component in
  62061. */
  62062. constructor(scene: Scene);
  62063. /**
  62064. * Registers the component in a given scene
  62065. */
  62066. register(): void;
  62067. /**
  62068. * Rebuilds the elements related to this component in case of
  62069. * context lost for instance.
  62070. */
  62071. rebuild(): void;
  62072. /**
  62073. * Adds all the elements from the container to the scene
  62074. * @param container the container holding the elements
  62075. */
  62076. addFromContainer(container: AbstractScene): void;
  62077. /**
  62078. * Removes all the elements in the container from the scene
  62079. * @param container contains the elements to remove
  62080. * @param dispose if the removed element should be disposed (default: false)
  62081. */
  62082. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62083. /**
  62084. * Serializes the component data to the specified json object
  62085. * @param serializationObject The object to serialize to
  62086. */
  62087. serialize(serializationObject: any): void;
  62088. /**
  62089. * Disposes the component and the associated ressources.
  62090. */
  62091. dispose(): void;
  62092. private _draw;
  62093. }
  62094. }
  62095. declare module "babylonjs/LensFlares/index" {
  62096. export * from "babylonjs/LensFlares/lensFlare";
  62097. export * from "babylonjs/LensFlares/lensFlareSystem";
  62098. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62099. }
  62100. declare module "babylonjs/Shaders/depth.fragment" {
  62101. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62102. /** @hidden */
  62103. export var depthPixelShader: {
  62104. name: string;
  62105. shader: string;
  62106. };
  62107. }
  62108. declare module "babylonjs/Shaders/depth.vertex" {
  62109. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62110. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62111. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62112. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62113. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62114. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62115. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62116. /** @hidden */
  62117. export var depthVertexShader: {
  62118. name: string;
  62119. shader: string;
  62120. };
  62121. }
  62122. declare module "babylonjs/Rendering/depthRenderer" {
  62123. import { Nullable } from "babylonjs/types";
  62124. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62125. import { Scene } from "babylonjs/scene";
  62126. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62127. import { Camera } from "babylonjs/Cameras/camera";
  62128. import "babylonjs/Shaders/depth.fragment";
  62129. import "babylonjs/Shaders/depth.vertex";
  62130. /**
  62131. * This represents a depth renderer in Babylon.
  62132. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62133. */
  62134. export class DepthRenderer {
  62135. private _scene;
  62136. private _depthMap;
  62137. private _effect;
  62138. private readonly _storeNonLinearDepth;
  62139. private readonly _clearColor;
  62140. /** Get if the depth renderer is using packed depth or not */
  62141. readonly isPacked: boolean;
  62142. private _cachedDefines;
  62143. private _camera;
  62144. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62145. enabled: boolean;
  62146. /**
  62147. * Specifiess that the depth renderer will only be used within
  62148. * the camera it is created for.
  62149. * This can help forcing its rendering during the camera processing.
  62150. */
  62151. useOnlyInActiveCamera: boolean;
  62152. /** @hidden */
  62153. static _SceneComponentInitialization: (scene: Scene) => void;
  62154. /**
  62155. * Instantiates a depth renderer
  62156. * @param scene The scene the renderer belongs to
  62157. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62158. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62159. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62160. */
  62161. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62162. /**
  62163. * Creates the depth rendering effect and checks if the effect is ready.
  62164. * @param subMesh The submesh to be used to render the depth map of
  62165. * @param useInstances If multiple world instances should be used
  62166. * @returns if the depth renderer is ready to render the depth map
  62167. */
  62168. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62169. /**
  62170. * Gets the texture which the depth map will be written to.
  62171. * @returns The depth map texture
  62172. */
  62173. getDepthMap(): RenderTargetTexture;
  62174. /**
  62175. * Disposes of the depth renderer.
  62176. */
  62177. dispose(): void;
  62178. }
  62179. }
  62180. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62181. /** @hidden */
  62182. export var minmaxReduxPixelShader: {
  62183. name: string;
  62184. shader: string;
  62185. };
  62186. }
  62187. declare module "babylonjs/Misc/minMaxReducer" {
  62188. import { Nullable } from "babylonjs/types";
  62189. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62190. import { Camera } from "babylonjs/Cameras/camera";
  62191. import { Observer } from "babylonjs/Misc/observable";
  62192. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62193. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62194. import { Observable } from "babylonjs/Misc/observable";
  62195. import "babylonjs/Shaders/minmaxRedux.fragment";
  62196. /**
  62197. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62198. * and maximum values from all values of the texture.
  62199. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62200. * The source values are read from the red channel of the texture.
  62201. */
  62202. export class MinMaxReducer {
  62203. /**
  62204. * Observable triggered when the computation has been performed
  62205. */
  62206. onAfterReductionPerformed: Observable<{
  62207. min: number;
  62208. max: number;
  62209. }>;
  62210. protected _camera: Camera;
  62211. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62212. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62213. protected _postProcessManager: PostProcessManager;
  62214. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62215. protected _forceFullscreenViewport: boolean;
  62216. /**
  62217. * Creates a min/max reducer
  62218. * @param camera The camera to use for the post processes
  62219. */
  62220. constructor(camera: Camera);
  62221. /**
  62222. * Gets the texture used to read the values from.
  62223. */
  62224. get sourceTexture(): Nullable<RenderTargetTexture>;
  62225. /**
  62226. * Sets the source texture to read the values from.
  62227. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62228. * because in such textures '1' value must not be taken into account to compute the maximum
  62229. * as this value is used to clear the texture.
  62230. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62231. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62232. * @param depthRedux Indicates if the texture is a depth texture or not
  62233. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62234. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62235. */
  62236. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62237. /**
  62238. * Defines the refresh rate of the computation.
  62239. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62240. */
  62241. get refreshRate(): number;
  62242. set refreshRate(value: number);
  62243. protected _activated: boolean;
  62244. /**
  62245. * Gets the activation status of the reducer
  62246. */
  62247. get activated(): boolean;
  62248. /**
  62249. * Activates the reduction computation.
  62250. * When activated, the observers registered in onAfterReductionPerformed are
  62251. * called after the compuation is performed
  62252. */
  62253. activate(): void;
  62254. /**
  62255. * Deactivates the reduction computation.
  62256. */
  62257. deactivate(): void;
  62258. /**
  62259. * Disposes the min/max reducer
  62260. * @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.
  62261. */
  62262. dispose(disposeAll?: boolean): void;
  62263. }
  62264. }
  62265. declare module "babylonjs/Misc/depthReducer" {
  62266. import { Nullable } from "babylonjs/types";
  62267. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62268. import { Camera } from "babylonjs/Cameras/camera";
  62269. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62270. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62271. /**
  62272. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62273. */
  62274. export class DepthReducer extends MinMaxReducer {
  62275. private _depthRenderer;
  62276. private _depthRendererId;
  62277. /**
  62278. * Gets the depth renderer used for the computation.
  62279. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62280. */
  62281. get depthRenderer(): Nullable<DepthRenderer>;
  62282. /**
  62283. * Creates a depth reducer
  62284. * @param camera The camera used to render the depth texture
  62285. */
  62286. constructor(camera: Camera);
  62287. /**
  62288. * Sets the depth renderer to use to generate the depth map
  62289. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62290. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62291. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62292. */
  62293. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62294. /** @hidden */
  62295. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62296. /**
  62297. * Activates the reduction computation.
  62298. * When activated, the observers registered in onAfterReductionPerformed are
  62299. * called after the compuation is performed
  62300. */
  62301. activate(): void;
  62302. /**
  62303. * Deactivates the reduction computation.
  62304. */
  62305. deactivate(): void;
  62306. /**
  62307. * Disposes the depth reducer
  62308. * @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.
  62309. */
  62310. dispose(disposeAll?: boolean): void;
  62311. }
  62312. }
  62313. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62314. import { Nullable } from "babylonjs/types";
  62315. import { Scene } from "babylonjs/scene";
  62316. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62317. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62318. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62319. import { Effect } from "babylonjs/Materials/effect";
  62320. import "babylonjs/Shaders/shadowMap.fragment";
  62321. import "babylonjs/Shaders/shadowMap.vertex";
  62322. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62323. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62324. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62325. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62326. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62327. /**
  62328. * A CSM implementation allowing casting shadows on large scenes.
  62329. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62330. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62331. */
  62332. export class CascadedShadowGenerator extends ShadowGenerator {
  62333. private static readonly frustumCornersNDCSpace;
  62334. /**
  62335. * Name of the CSM class
  62336. */
  62337. static CLASSNAME: string;
  62338. /**
  62339. * Defines the default number of cascades used by the CSM.
  62340. */
  62341. static readonly DEFAULT_CASCADES_COUNT: number;
  62342. /**
  62343. * Defines the minimum number of cascades used by the CSM.
  62344. */
  62345. static readonly MIN_CASCADES_COUNT: number;
  62346. /**
  62347. * Defines the maximum number of cascades used by the CSM.
  62348. */
  62349. static readonly MAX_CASCADES_COUNT: number;
  62350. protected _validateFilter(filter: number): number;
  62351. /**
  62352. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62353. */
  62354. penumbraDarkness: number;
  62355. private _numCascades;
  62356. /**
  62357. * Gets or set the number of cascades used by the CSM.
  62358. */
  62359. get numCascades(): number;
  62360. set numCascades(value: number);
  62361. /**
  62362. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62363. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62364. */
  62365. stabilizeCascades: boolean;
  62366. private _freezeShadowCastersBoundingInfo;
  62367. private _freezeShadowCastersBoundingInfoObservable;
  62368. /**
  62369. * Enables or disables the shadow casters bounding info computation.
  62370. * If your shadow casters don't move, you can disable this feature.
  62371. * If it is enabled, the bounding box computation is done every frame.
  62372. */
  62373. get freezeShadowCastersBoundingInfo(): boolean;
  62374. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62375. private _scbiMin;
  62376. private _scbiMax;
  62377. protected _computeShadowCastersBoundingInfo(): void;
  62378. protected _shadowCastersBoundingInfo: BoundingInfo;
  62379. /**
  62380. * Gets or sets the shadow casters bounding info.
  62381. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62382. * so that the system won't overwrite the bounds you provide
  62383. */
  62384. get shadowCastersBoundingInfo(): BoundingInfo;
  62385. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62386. protected _breaksAreDirty: boolean;
  62387. protected _minDistance: number;
  62388. protected _maxDistance: number;
  62389. /**
  62390. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62391. *
  62392. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62393. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62394. * @param min minimal distance for the breaks (default to 0.)
  62395. * @param max maximal distance for the breaks (default to 1.)
  62396. */
  62397. setMinMaxDistance(min: number, max: number): void;
  62398. /** Gets the minimal distance used in the cascade break computation */
  62399. get minDistance(): number;
  62400. /** Gets the maximal distance used in the cascade break computation */
  62401. get maxDistance(): number;
  62402. /**
  62403. * Gets the class name of that object
  62404. * @returns "CascadedShadowGenerator"
  62405. */
  62406. getClassName(): string;
  62407. private _cascadeMinExtents;
  62408. private _cascadeMaxExtents;
  62409. /**
  62410. * Gets a cascade minimum extents
  62411. * @param cascadeIndex index of the cascade
  62412. * @returns the minimum cascade extents
  62413. */
  62414. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62415. /**
  62416. * Gets a cascade maximum extents
  62417. * @param cascadeIndex index of the cascade
  62418. * @returns the maximum cascade extents
  62419. */
  62420. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62421. private _cascades;
  62422. private _currentLayer;
  62423. private _viewSpaceFrustumsZ;
  62424. private _viewMatrices;
  62425. private _projectionMatrices;
  62426. private _transformMatrices;
  62427. private _transformMatricesAsArray;
  62428. private _frustumLengths;
  62429. private _lightSizeUVCorrection;
  62430. private _depthCorrection;
  62431. private _frustumCornersWorldSpace;
  62432. private _frustumCenter;
  62433. private _shadowCameraPos;
  62434. private _shadowMaxZ;
  62435. /**
  62436. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62437. * It defaults to camera.maxZ
  62438. */
  62439. get shadowMaxZ(): number;
  62440. /**
  62441. * Sets the shadow max z distance.
  62442. */
  62443. set shadowMaxZ(value: number);
  62444. protected _debug: boolean;
  62445. /**
  62446. * Gets or sets the debug flag.
  62447. * When enabled, the cascades are materialized by different colors on the screen.
  62448. */
  62449. get debug(): boolean;
  62450. set debug(dbg: boolean);
  62451. private _depthClamp;
  62452. /**
  62453. * Gets or sets the depth clamping value.
  62454. *
  62455. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62456. * to account for the shadow casters far away.
  62457. *
  62458. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62459. */
  62460. get depthClamp(): boolean;
  62461. set depthClamp(value: boolean);
  62462. private _cascadeBlendPercentage;
  62463. /**
  62464. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62465. * It defaults to 0.1 (10% blending).
  62466. */
  62467. get cascadeBlendPercentage(): number;
  62468. set cascadeBlendPercentage(value: number);
  62469. private _lambda;
  62470. /**
  62471. * Gets or set the lambda parameter.
  62472. * This parameter is used to split the camera frustum and create the cascades.
  62473. * 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.
  62474. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62475. */
  62476. get lambda(): number;
  62477. set lambda(value: number);
  62478. /**
  62479. * Gets the view matrix corresponding to a given cascade
  62480. * @param cascadeNum cascade to retrieve the view matrix from
  62481. * @returns the cascade view matrix
  62482. */
  62483. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62484. /**
  62485. * Gets the projection matrix corresponding to a given cascade
  62486. * @param cascadeNum cascade to retrieve the projection matrix from
  62487. * @returns the cascade projection matrix
  62488. */
  62489. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62490. /**
  62491. * Gets the transformation matrix corresponding to a given cascade
  62492. * @param cascadeNum cascade to retrieve the transformation matrix from
  62493. * @returns the cascade transformation matrix
  62494. */
  62495. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62496. private _depthRenderer;
  62497. /**
  62498. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62499. *
  62500. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62501. *
  62502. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62503. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62504. * @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
  62505. */
  62506. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62507. private _depthReducer;
  62508. private _autoCalcDepthBounds;
  62509. /**
  62510. * Gets or sets the autoCalcDepthBounds property.
  62511. *
  62512. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62513. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62514. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62515. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62516. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62517. */
  62518. get autoCalcDepthBounds(): boolean;
  62519. set autoCalcDepthBounds(value: boolean);
  62520. /**
  62521. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62522. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62523. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62524. * for setting the refresh rate on the renderer yourself!
  62525. */
  62526. get autoCalcDepthBoundsRefreshRate(): number;
  62527. set autoCalcDepthBoundsRefreshRate(value: number);
  62528. /**
  62529. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62530. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62531. * you change the camera near/far planes!
  62532. */
  62533. splitFrustum(): void;
  62534. private _splitFrustum;
  62535. private _computeMatrices;
  62536. private _computeFrustumInWorldSpace;
  62537. private _computeCascadeFrustum;
  62538. /**
  62539. * Support test.
  62540. */
  62541. static get IsSupported(): boolean;
  62542. /** @hidden */
  62543. static _SceneComponentInitialization: (scene: Scene) => void;
  62544. /**
  62545. * Creates a Cascaded Shadow Generator object.
  62546. * A ShadowGenerator is the required tool to use the shadows.
  62547. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62548. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62549. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62550. * @param light The directional light object generating the shadows.
  62551. * @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.
  62552. */
  62553. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62554. protected _initializeGenerator(): void;
  62555. protected _createTargetRenderTexture(): void;
  62556. protected _initializeShadowMap(): void;
  62557. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62558. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62559. /**
  62560. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62561. * @param defines Defines of the material we want to update
  62562. * @param lightIndex Index of the light in the enabled light list of the material
  62563. */
  62564. prepareDefines(defines: any, lightIndex: number): void;
  62565. /**
  62566. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62567. * defined in the generator but impacting the effect).
  62568. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62569. * @param effect The effect we are binfing the information for
  62570. */
  62571. bindShadowLight(lightIndex: string, effect: Effect): void;
  62572. /**
  62573. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62574. * (eq to view projection * shadow projection matrices)
  62575. * @returns The transform matrix used to create the shadow map
  62576. */
  62577. getTransformMatrix(): Matrix;
  62578. /**
  62579. * Disposes the ShadowGenerator.
  62580. * Returns nothing.
  62581. */
  62582. dispose(): void;
  62583. /**
  62584. * Serializes the shadow generator setup to a json object.
  62585. * @returns The serialized JSON object
  62586. */
  62587. serialize(): any;
  62588. /**
  62589. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62590. * @param parsedShadowGenerator The JSON object to parse
  62591. * @param scene The scene to create the shadow map for
  62592. * @returns The parsed shadow generator
  62593. */
  62594. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62595. }
  62596. }
  62597. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62598. import { Scene } from "babylonjs/scene";
  62599. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62600. import { AbstractScene } from "babylonjs/abstractScene";
  62601. /**
  62602. * Defines the shadow generator component responsible to manage any shadow generators
  62603. * in a given scene.
  62604. */
  62605. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62606. /**
  62607. * The component name helpfull to identify the component in the list of scene components.
  62608. */
  62609. readonly name: string;
  62610. /**
  62611. * The scene the component belongs to.
  62612. */
  62613. scene: Scene;
  62614. /**
  62615. * Creates a new instance of the component for the given scene
  62616. * @param scene Defines the scene to register the component in
  62617. */
  62618. constructor(scene: Scene);
  62619. /**
  62620. * Registers the component in a given scene
  62621. */
  62622. register(): void;
  62623. /**
  62624. * Rebuilds the elements related to this component in case of
  62625. * context lost for instance.
  62626. */
  62627. rebuild(): void;
  62628. /**
  62629. * Serializes the component data to the specified json object
  62630. * @param serializationObject The object to serialize to
  62631. */
  62632. serialize(serializationObject: any): void;
  62633. /**
  62634. * Adds all the elements from the container to the scene
  62635. * @param container the container holding the elements
  62636. */
  62637. addFromContainer(container: AbstractScene): void;
  62638. /**
  62639. * Removes all the elements in the container from the scene
  62640. * @param container contains the elements to remove
  62641. * @param dispose if the removed element should be disposed (default: false)
  62642. */
  62643. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62644. /**
  62645. * Rebuilds the elements related to this component in case of
  62646. * context lost for instance.
  62647. */
  62648. dispose(): void;
  62649. private _gatherRenderTargets;
  62650. }
  62651. }
  62652. declare module "babylonjs/Lights/Shadows/index" {
  62653. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62654. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62655. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62656. }
  62657. declare module "babylonjs/Lights/pointLight" {
  62658. import { Scene } from "babylonjs/scene";
  62659. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62660. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62661. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62662. import { Effect } from "babylonjs/Materials/effect";
  62663. /**
  62664. * A point light is a light defined by an unique point in world space.
  62665. * The light is emitted in every direction from this point.
  62666. * A good example of a point light is a standard light bulb.
  62667. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62668. */
  62669. export class PointLight extends ShadowLight {
  62670. private _shadowAngle;
  62671. /**
  62672. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62673. * This specifies what angle the shadow will use to be created.
  62674. *
  62675. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62676. */
  62677. get shadowAngle(): number;
  62678. /**
  62679. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62680. * This specifies what angle the shadow will use to be created.
  62681. *
  62682. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62683. */
  62684. set shadowAngle(value: number);
  62685. /**
  62686. * Gets the direction if it has been set.
  62687. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62688. */
  62689. get direction(): Vector3;
  62690. /**
  62691. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62692. */
  62693. set direction(value: Vector3);
  62694. /**
  62695. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62696. * A PointLight emits the light in every direction.
  62697. * It can cast shadows.
  62698. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62699. * ```javascript
  62700. * var pointLight = new PointLight("pl", camera.position, scene);
  62701. * ```
  62702. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62703. * @param name The light friendly name
  62704. * @param position The position of the point light in the scene
  62705. * @param scene The scene the lights belongs to
  62706. */
  62707. constructor(name: string, position: Vector3, scene: Scene);
  62708. /**
  62709. * Returns the string "PointLight"
  62710. * @returns the class name
  62711. */
  62712. getClassName(): string;
  62713. /**
  62714. * Returns the integer 0.
  62715. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62716. */
  62717. getTypeID(): number;
  62718. /**
  62719. * Specifies wether or not the shadowmap should be a cube texture.
  62720. * @returns true if the shadowmap needs to be a cube texture.
  62721. */
  62722. needCube(): boolean;
  62723. /**
  62724. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62725. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62726. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62727. */
  62728. getShadowDirection(faceIndex?: number): Vector3;
  62729. /**
  62730. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62731. * - fov = PI / 2
  62732. * - aspect ratio : 1.0
  62733. * - z-near and far equal to the active camera minZ and maxZ.
  62734. * Returns the PointLight.
  62735. */
  62736. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62737. protected _buildUniformLayout(): void;
  62738. /**
  62739. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62740. * @param effect The effect to update
  62741. * @param lightIndex The index of the light in the effect to update
  62742. * @returns The point light
  62743. */
  62744. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62745. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62746. /**
  62747. * Prepares the list of defines specific to the light type.
  62748. * @param defines the list of defines
  62749. * @param lightIndex defines the index of the light for the effect
  62750. */
  62751. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62752. }
  62753. }
  62754. declare module "babylonjs/Lights/index" {
  62755. export * from "babylonjs/Lights/light";
  62756. export * from "babylonjs/Lights/shadowLight";
  62757. export * from "babylonjs/Lights/Shadows/index";
  62758. export * from "babylonjs/Lights/directionalLight";
  62759. export * from "babylonjs/Lights/hemisphericLight";
  62760. export * from "babylonjs/Lights/pointLight";
  62761. export * from "babylonjs/Lights/spotLight";
  62762. }
  62763. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62764. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62765. /**
  62766. * Header information of HDR texture files.
  62767. */
  62768. export interface HDRInfo {
  62769. /**
  62770. * The height of the texture in pixels.
  62771. */
  62772. height: number;
  62773. /**
  62774. * The width of the texture in pixels.
  62775. */
  62776. width: number;
  62777. /**
  62778. * The index of the beginning of the data in the binary file.
  62779. */
  62780. dataPosition: number;
  62781. }
  62782. /**
  62783. * This groups tools to convert HDR texture to native colors array.
  62784. */
  62785. export class HDRTools {
  62786. private static Ldexp;
  62787. private static Rgbe2float;
  62788. private static readStringLine;
  62789. /**
  62790. * Reads header information from an RGBE texture stored in a native array.
  62791. * More information on this format are available here:
  62792. * https://en.wikipedia.org/wiki/RGBE_image_format
  62793. *
  62794. * @param uint8array The binary file stored in native array.
  62795. * @return The header information.
  62796. */
  62797. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62798. /**
  62799. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62800. * This RGBE texture needs to store the information as a panorama.
  62801. *
  62802. * More information on this format are available here:
  62803. * https://en.wikipedia.org/wiki/RGBE_image_format
  62804. *
  62805. * @param buffer The binary file stored in an array buffer.
  62806. * @param size The expected size of the extracted cubemap.
  62807. * @return The Cube Map information.
  62808. */
  62809. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62810. /**
  62811. * Returns the pixels data extracted from an RGBE texture.
  62812. * This pixels will be stored left to right up to down in the R G B order in one array.
  62813. *
  62814. * More information on this format are available here:
  62815. * https://en.wikipedia.org/wiki/RGBE_image_format
  62816. *
  62817. * @param uint8array The binary file stored in an array buffer.
  62818. * @param hdrInfo The header information of the file.
  62819. * @return The pixels data in RGB right to left up to down order.
  62820. */
  62821. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62822. private static RGBE_ReadPixels_RLE;
  62823. private static RGBE_ReadPixels_NOT_RLE;
  62824. }
  62825. }
  62826. declare module "babylonjs/Materials/effectRenderer" {
  62827. import { Nullable } from "babylonjs/types";
  62828. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62829. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62830. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62831. import { Viewport } from "babylonjs/Maths/math.viewport";
  62832. import { Observable } from "babylonjs/Misc/observable";
  62833. import { Effect } from "babylonjs/Materials/effect";
  62834. import "babylonjs/Shaders/postprocess.vertex";
  62835. /**
  62836. * Effect Render Options
  62837. */
  62838. export interface IEffectRendererOptions {
  62839. /**
  62840. * Defines the vertices positions.
  62841. */
  62842. positions?: number[];
  62843. /**
  62844. * Defines the indices.
  62845. */
  62846. indices?: number[];
  62847. }
  62848. /**
  62849. * Helper class to render one or more effects.
  62850. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62851. */
  62852. export class EffectRenderer {
  62853. private engine;
  62854. private static _DefaultOptions;
  62855. private _vertexBuffers;
  62856. private _indexBuffer;
  62857. private _fullscreenViewport;
  62858. /**
  62859. * Creates an effect renderer
  62860. * @param engine the engine to use for rendering
  62861. * @param options defines the options of the effect renderer
  62862. */
  62863. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62864. /**
  62865. * Sets the current viewport in normalized coordinates 0-1
  62866. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62867. */
  62868. setViewport(viewport?: Viewport): void;
  62869. /**
  62870. * Binds the embedded attributes buffer to the effect.
  62871. * @param effect Defines the effect to bind the attributes for
  62872. */
  62873. bindBuffers(effect: Effect): void;
  62874. /**
  62875. * Sets the current effect wrapper to use during draw.
  62876. * The effect needs to be ready before calling this api.
  62877. * This also sets the default full screen position attribute.
  62878. * @param effectWrapper Defines the effect to draw with
  62879. */
  62880. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62881. /**
  62882. * Restores engine states
  62883. */
  62884. restoreStates(): void;
  62885. /**
  62886. * Draws a full screen quad.
  62887. */
  62888. draw(): void;
  62889. private isRenderTargetTexture;
  62890. /**
  62891. * renders one or more effects to a specified texture
  62892. * @param effectWrapper the effect to renderer
  62893. * @param outputTexture texture to draw to, if null it will render to the screen.
  62894. */
  62895. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62896. /**
  62897. * Disposes of the effect renderer
  62898. */
  62899. dispose(): void;
  62900. }
  62901. /**
  62902. * Options to create an EffectWrapper
  62903. */
  62904. interface EffectWrapperCreationOptions {
  62905. /**
  62906. * Engine to use to create the effect
  62907. */
  62908. engine: ThinEngine;
  62909. /**
  62910. * Fragment shader for the effect
  62911. */
  62912. fragmentShader: string;
  62913. /**
  62914. * Use the shader store instead of direct source code
  62915. */
  62916. useShaderStore?: boolean;
  62917. /**
  62918. * Vertex shader for the effect
  62919. */
  62920. vertexShader?: string;
  62921. /**
  62922. * Attributes to use in the shader
  62923. */
  62924. attributeNames?: Array<string>;
  62925. /**
  62926. * Uniforms to use in the shader
  62927. */
  62928. uniformNames?: Array<string>;
  62929. /**
  62930. * Texture sampler names to use in the shader
  62931. */
  62932. samplerNames?: Array<string>;
  62933. /**
  62934. * Defines to use in the shader
  62935. */
  62936. defines?: Array<string>;
  62937. /**
  62938. * Callback when effect is compiled
  62939. */
  62940. onCompiled?: Nullable<(effect: Effect) => void>;
  62941. /**
  62942. * The friendly name of the effect displayed in Spector.
  62943. */
  62944. name?: string;
  62945. }
  62946. /**
  62947. * Wraps an effect to be used for rendering
  62948. */
  62949. export class EffectWrapper {
  62950. /**
  62951. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62952. */
  62953. onApplyObservable: Observable<{}>;
  62954. /**
  62955. * The underlying effect
  62956. */
  62957. effect: Effect;
  62958. /**
  62959. * Creates an effect to be renderer
  62960. * @param creationOptions options to create the effect
  62961. */
  62962. constructor(creationOptions: EffectWrapperCreationOptions);
  62963. /**
  62964. * Disposes of the effect wrapper
  62965. */
  62966. dispose(): void;
  62967. }
  62968. }
  62969. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62970. /** @hidden */
  62971. export var hdrFilteringVertexShader: {
  62972. name: string;
  62973. shader: string;
  62974. };
  62975. }
  62976. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62977. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62978. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62979. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62980. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62981. /** @hidden */
  62982. export var hdrFilteringPixelShader: {
  62983. name: string;
  62984. shader: string;
  62985. };
  62986. }
  62987. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62988. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62989. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62990. import { Nullable } from "babylonjs/types";
  62991. import "babylonjs/Shaders/hdrFiltering.vertex";
  62992. import "babylonjs/Shaders/hdrFiltering.fragment";
  62993. /**
  62994. * Options for texture filtering
  62995. */
  62996. interface IHDRFilteringOptions {
  62997. /**
  62998. * Scales pixel intensity for the input HDR map.
  62999. */
  63000. hdrScale?: number;
  63001. /**
  63002. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  63003. */
  63004. quality?: number;
  63005. }
  63006. /**
  63007. * Filters HDR maps to get correct renderings of PBR reflections
  63008. */
  63009. export class HDRFiltering {
  63010. private _engine;
  63011. private _effectRenderer;
  63012. private _effectWrapper;
  63013. private _lodGenerationOffset;
  63014. private _lodGenerationScale;
  63015. /**
  63016. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63017. * you care about baking speed.
  63018. */
  63019. quality: number;
  63020. /**
  63021. * Scales pixel intensity for the input HDR map.
  63022. */
  63023. hdrScale: number;
  63024. /**
  63025. * Instantiates HDR filter for reflection maps
  63026. *
  63027. * @param engine Thin engine
  63028. * @param options Options
  63029. */
  63030. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63031. private _createRenderTarget;
  63032. private _prefilterInternal;
  63033. private _createEffect;
  63034. /**
  63035. * Get a value indicating if the filter is ready to be used
  63036. * @param texture Texture to filter
  63037. * @returns true if the filter is ready
  63038. */
  63039. isReady(texture: BaseTexture): boolean;
  63040. /**
  63041. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63042. * Prefiltering will be invoked at the end of next rendering pass.
  63043. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63044. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63045. * @param texture Texture to filter
  63046. * @param onFinished Callback when filtering is done
  63047. * @return Promise called when prefiltering is done
  63048. */
  63049. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63050. }
  63051. }
  63052. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63053. import { Nullable } from "babylonjs/types";
  63054. import { Scene } from "babylonjs/scene";
  63055. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63056. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63057. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63058. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63059. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63060. /**
  63061. * This represents a texture coming from an HDR input.
  63062. *
  63063. * The only supported format is currently panorama picture stored in RGBE format.
  63064. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63065. */
  63066. export class HDRCubeTexture extends BaseTexture {
  63067. private static _facesMapping;
  63068. private _generateHarmonics;
  63069. private _noMipmap;
  63070. private _prefilterOnLoad;
  63071. private _textureMatrix;
  63072. private _size;
  63073. private _onLoad;
  63074. private _onError;
  63075. /**
  63076. * The texture URL.
  63077. */
  63078. url: string;
  63079. protected _isBlocking: boolean;
  63080. /**
  63081. * Sets wether or not the texture is blocking during loading.
  63082. */
  63083. set isBlocking(value: boolean);
  63084. /**
  63085. * Gets wether or not the texture is blocking during loading.
  63086. */
  63087. get isBlocking(): boolean;
  63088. protected _rotationY: number;
  63089. /**
  63090. * Sets texture matrix rotation angle around Y axis in radians.
  63091. */
  63092. set rotationY(value: number);
  63093. /**
  63094. * Gets texture matrix rotation angle around Y axis radians.
  63095. */
  63096. get rotationY(): number;
  63097. /**
  63098. * Gets or sets the center of the bounding box associated with the cube texture
  63099. * It must define where the camera used to render the texture was set
  63100. */
  63101. boundingBoxPosition: Vector3;
  63102. private _boundingBoxSize;
  63103. /**
  63104. * Gets or sets the size of the bounding box associated with the cube texture
  63105. * When defined, the cubemap will switch to local mode
  63106. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63107. * @example https://www.babylonjs-playground.com/#RNASML
  63108. */
  63109. set boundingBoxSize(value: Vector3);
  63110. get boundingBoxSize(): Vector3;
  63111. /**
  63112. * Instantiates an HDRTexture from the following parameters.
  63113. *
  63114. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63115. * @param sceneOrEngine The scene or engine the texture will be used in
  63116. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63117. * @param noMipmap Forces to not generate the mipmap if true
  63118. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63119. * @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)
  63120. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63121. */
  63122. 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>);
  63123. /**
  63124. * Get the current class name of the texture useful for serialization or dynamic coding.
  63125. * @returns "HDRCubeTexture"
  63126. */
  63127. getClassName(): string;
  63128. /**
  63129. * Occurs when the file is raw .hdr file.
  63130. */
  63131. private loadTexture;
  63132. clone(): HDRCubeTexture;
  63133. delayLoad(): void;
  63134. /**
  63135. * Get the texture reflection matrix used to rotate/transform the reflection.
  63136. * @returns the reflection matrix
  63137. */
  63138. getReflectionTextureMatrix(): Matrix;
  63139. /**
  63140. * Set the texture reflection matrix used to rotate/transform the reflection.
  63141. * @param value Define the reflection matrix to set
  63142. */
  63143. setReflectionTextureMatrix(value: Matrix): void;
  63144. /**
  63145. * Parses a JSON representation of an HDR Texture in order to create the texture
  63146. * @param parsedTexture Define the JSON representation
  63147. * @param scene Define the scene the texture should be created in
  63148. * @param rootUrl Define the root url in case we need to load relative dependencies
  63149. * @returns the newly created texture after parsing
  63150. */
  63151. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63152. serialize(): any;
  63153. }
  63154. }
  63155. declare module "babylonjs/Physics/physicsEngine" {
  63156. import { Nullable } from "babylonjs/types";
  63157. import { Vector3 } from "babylonjs/Maths/math.vector";
  63158. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63159. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63160. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63161. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63162. /**
  63163. * Class used to control physics engine
  63164. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63165. */
  63166. export class PhysicsEngine implements IPhysicsEngine {
  63167. private _physicsPlugin;
  63168. /**
  63169. * Global value used to control the smallest number supported by the simulation
  63170. */
  63171. static Epsilon: number;
  63172. private _impostors;
  63173. private _joints;
  63174. private _subTimeStep;
  63175. /**
  63176. * Gets the gravity vector used by the simulation
  63177. */
  63178. gravity: Vector3;
  63179. /**
  63180. * Factory used to create the default physics plugin.
  63181. * @returns The default physics plugin
  63182. */
  63183. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63184. /**
  63185. * Creates a new Physics Engine
  63186. * @param gravity defines the gravity vector used by the simulation
  63187. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63188. */
  63189. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63190. /**
  63191. * Sets the gravity vector used by the simulation
  63192. * @param gravity defines the gravity vector to use
  63193. */
  63194. setGravity(gravity: Vector3): void;
  63195. /**
  63196. * Set the time step of the physics engine.
  63197. * Default is 1/60.
  63198. * To slow it down, enter 1/600 for example.
  63199. * To speed it up, 1/30
  63200. * @param newTimeStep defines the new timestep to apply to this world.
  63201. */
  63202. setTimeStep(newTimeStep?: number): void;
  63203. /**
  63204. * Get the time step of the physics engine.
  63205. * @returns the current time step
  63206. */
  63207. getTimeStep(): number;
  63208. /**
  63209. * Set the sub time step of the physics engine.
  63210. * Default is 0 meaning there is no sub steps
  63211. * To increase physics resolution precision, set a small value (like 1 ms)
  63212. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63213. */
  63214. setSubTimeStep(subTimeStep?: number): void;
  63215. /**
  63216. * Get the sub time step of the physics engine.
  63217. * @returns the current sub time step
  63218. */
  63219. getSubTimeStep(): number;
  63220. /**
  63221. * Release all resources
  63222. */
  63223. dispose(): void;
  63224. /**
  63225. * Gets the name of the current physics plugin
  63226. * @returns the name of the plugin
  63227. */
  63228. getPhysicsPluginName(): string;
  63229. /**
  63230. * Adding a new impostor for the impostor tracking.
  63231. * This will be done by the impostor itself.
  63232. * @param impostor the impostor to add
  63233. */
  63234. addImpostor(impostor: PhysicsImpostor): void;
  63235. /**
  63236. * Remove an impostor from the engine.
  63237. * This impostor and its mesh will not longer be updated by the physics engine.
  63238. * @param impostor the impostor to remove
  63239. */
  63240. removeImpostor(impostor: PhysicsImpostor): void;
  63241. /**
  63242. * Add a joint to the physics engine
  63243. * @param mainImpostor defines the main impostor to which the joint is added.
  63244. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63245. * @param joint defines the joint that will connect both impostors.
  63246. */
  63247. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63248. /**
  63249. * Removes a joint from the simulation
  63250. * @param mainImpostor defines the impostor used with the joint
  63251. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63252. * @param joint defines the joint to remove
  63253. */
  63254. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63255. /**
  63256. * Called by the scene. No need to call it.
  63257. * @param delta defines the timespam between frames
  63258. */
  63259. _step(delta: number): void;
  63260. /**
  63261. * Gets the current plugin used to run the simulation
  63262. * @returns current plugin
  63263. */
  63264. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63265. /**
  63266. * Gets the list of physic impostors
  63267. * @returns an array of PhysicsImpostor
  63268. */
  63269. getImpostors(): Array<PhysicsImpostor>;
  63270. /**
  63271. * Gets the impostor for a physics enabled object
  63272. * @param object defines the object impersonated by the impostor
  63273. * @returns the PhysicsImpostor or null if not found
  63274. */
  63275. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63276. /**
  63277. * Gets the impostor for a physics body object
  63278. * @param body defines physics body used by the impostor
  63279. * @returns the PhysicsImpostor or null if not found
  63280. */
  63281. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63282. /**
  63283. * Does a raycast in the physics world
  63284. * @param from when should the ray start?
  63285. * @param to when should the ray end?
  63286. * @returns PhysicsRaycastResult
  63287. */
  63288. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63289. }
  63290. }
  63291. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63292. import { Nullable } from "babylonjs/types";
  63293. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63294. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63295. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63296. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63297. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63298. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63299. /** @hidden */
  63300. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63301. private _useDeltaForWorldStep;
  63302. world: any;
  63303. name: string;
  63304. private _physicsMaterials;
  63305. private _fixedTimeStep;
  63306. private _cannonRaycastResult;
  63307. private _raycastResult;
  63308. private _physicsBodysToRemoveAfterStep;
  63309. private _firstFrame;
  63310. BJSCANNON: any;
  63311. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63312. setGravity(gravity: Vector3): void;
  63313. setTimeStep(timeStep: number): void;
  63314. getTimeStep(): number;
  63315. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63316. private _removeMarkedPhysicsBodiesFromWorld;
  63317. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63318. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63319. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63320. private _processChildMeshes;
  63321. removePhysicsBody(impostor: PhysicsImpostor): void;
  63322. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63323. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63324. private _addMaterial;
  63325. private _checkWithEpsilon;
  63326. private _createShape;
  63327. private _createHeightmap;
  63328. private _minus90X;
  63329. private _plus90X;
  63330. private _tmpPosition;
  63331. private _tmpDeltaPosition;
  63332. private _tmpUnityRotation;
  63333. private _updatePhysicsBodyTransformation;
  63334. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63335. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63336. isSupported(): boolean;
  63337. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63338. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63339. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63340. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63341. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63342. getBodyMass(impostor: PhysicsImpostor): number;
  63343. getBodyFriction(impostor: PhysicsImpostor): number;
  63344. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63345. getBodyRestitution(impostor: PhysicsImpostor): number;
  63346. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63347. sleepBody(impostor: PhysicsImpostor): void;
  63348. wakeUpBody(impostor: PhysicsImpostor): void;
  63349. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63350. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63351. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63352. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63353. getRadius(impostor: PhysicsImpostor): number;
  63354. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63355. dispose(): void;
  63356. private _extendNamespace;
  63357. /**
  63358. * Does a raycast in the physics world
  63359. * @param from when should the ray start?
  63360. * @param to when should the ray end?
  63361. * @returns PhysicsRaycastResult
  63362. */
  63363. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63364. }
  63365. }
  63366. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63367. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63368. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63369. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63370. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63371. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63372. import { Nullable } from "babylonjs/types";
  63373. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63374. /** @hidden */
  63375. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63376. private _useDeltaForWorldStep;
  63377. world: any;
  63378. name: string;
  63379. BJSOIMO: any;
  63380. private _raycastResult;
  63381. private _fixedTimeStep;
  63382. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63383. setGravity(gravity: Vector3): void;
  63384. setTimeStep(timeStep: number): void;
  63385. getTimeStep(): number;
  63386. private _tmpImpostorsArray;
  63387. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63388. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63389. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63390. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63391. private _tmpPositionVector;
  63392. removePhysicsBody(impostor: PhysicsImpostor): void;
  63393. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63394. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63395. isSupported(): boolean;
  63396. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63397. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63398. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63399. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63400. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63401. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63402. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63403. getBodyMass(impostor: PhysicsImpostor): number;
  63404. getBodyFriction(impostor: PhysicsImpostor): number;
  63405. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63406. getBodyRestitution(impostor: PhysicsImpostor): number;
  63407. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63408. sleepBody(impostor: PhysicsImpostor): void;
  63409. wakeUpBody(impostor: PhysicsImpostor): void;
  63410. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63411. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63412. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63413. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63414. getRadius(impostor: PhysicsImpostor): number;
  63415. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63416. dispose(): void;
  63417. /**
  63418. * Does a raycast in the physics world
  63419. * @param from when should the ray start?
  63420. * @param to when should the ray end?
  63421. * @returns PhysicsRaycastResult
  63422. */
  63423. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63424. }
  63425. }
  63426. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63427. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63428. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63429. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63430. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63431. import { Nullable } from "babylonjs/types";
  63432. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63433. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63434. /**
  63435. * AmmoJS Physics plugin
  63436. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63437. * @see https://github.com/kripken/ammo.js/
  63438. */
  63439. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63440. private _useDeltaForWorldStep;
  63441. /**
  63442. * Reference to the Ammo library
  63443. */
  63444. bjsAMMO: any;
  63445. /**
  63446. * Created ammoJS world which physics bodies are added to
  63447. */
  63448. world: any;
  63449. /**
  63450. * Name of the plugin
  63451. */
  63452. name: string;
  63453. private _timeStep;
  63454. private _fixedTimeStep;
  63455. private _maxSteps;
  63456. private _tmpQuaternion;
  63457. private _tmpAmmoTransform;
  63458. private _tmpAmmoQuaternion;
  63459. private _tmpAmmoConcreteContactResultCallback;
  63460. private _collisionConfiguration;
  63461. private _dispatcher;
  63462. private _overlappingPairCache;
  63463. private _solver;
  63464. private _softBodySolver;
  63465. private _tmpAmmoVectorA;
  63466. private _tmpAmmoVectorB;
  63467. private _tmpAmmoVectorC;
  63468. private _tmpAmmoVectorD;
  63469. private _tmpContactCallbackResult;
  63470. private _tmpAmmoVectorRCA;
  63471. private _tmpAmmoVectorRCB;
  63472. private _raycastResult;
  63473. private static readonly DISABLE_COLLISION_FLAG;
  63474. private static readonly KINEMATIC_FLAG;
  63475. private static readonly DISABLE_DEACTIVATION_FLAG;
  63476. /**
  63477. * Initializes the ammoJS plugin
  63478. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63479. * @param ammoInjection can be used to inject your own ammo reference
  63480. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63481. */
  63482. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63483. /**
  63484. * Sets the gravity of the physics world (m/(s^2))
  63485. * @param gravity Gravity to set
  63486. */
  63487. setGravity(gravity: Vector3): void;
  63488. /**
  63489. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63490. * @param timeStep timestep to use in seconds
  63491. */
  63492. setTimeStep(timeStep: number): void;
  63493. /**
  63494. * 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)
  63495. * @param fixedTimeStep fixedTimeStep to use in seconds
  63496. */
  63497. setFixedTimeStep(fixedTimeStep: number): void;
  63498. /**
  63499. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63500. * @param maxSteps the maximum number of steps by the physics engine per frame
  63501. */
  63502. setMaxSteps(maxSteps: number): void;
  63503. /**
  63504. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63505. * @returns the current timestep in seconds
  63506. */
  63507. getTimeStep(): number;
  63508. /**
  63509. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63510. */
  63511. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63512. private _isImpostorInContact;
  63513. private _isImpostorPairInContact;
  63514. private _stepSimulation;
  63515. /**
  63516. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63517. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63518. * After the step the babylon meshes are set to the position of the physics imposters
  63519. * @param delta amount of time to step forward
  63520. * @param impostors array of imposters to update before/after the step
  63521. */
  63522. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63523. /**
  63524. * Update babylon mesh to match physics world object
  63525. * @param impostor imposter to match
  63526. */
  63527. private _afterSoftStep;
  63528. /**
  63529. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63530. * @param impostor imposter to match
  63531. */
  63532. private _ropeStep;
  63533. /**
  63534. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63535. * @param impostor imposter to match
  63536. */
  63537. private _softbodyOrClothStep;
  63538. private _tmpMatrix;
  63539. /**
  63540. * Applies an impulse on the imposter
  63541. * @param impostor imposter to apply impulse to
  63542. * @param force amount of force to be applied to the imposter
  63543. * @param contactPoint the location to apply the impulse on the imposter
  63544. */
  63545. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63546. /**
  63547. * Applies a force on the imposter
  63548. * @param impostor imposter to apply force
  63549. * @param force amount of force to be applied to the imposter
  63550. * @param contactPoint the location to apply the force on the imposter
  63551. */
  63552. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63553. /**
  63554. * Creates a physics body using the plugin
  63555. * @param impostor the imposter to create the physics body on
  63556. */
  63557. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63558. /**
  63559. * Removes the physics body from the imposter and disposes of the body's memory
  63560. * @param impostor imposter to remove the physics body from
  63561. */
  63562. removePhysicsBody(impostor: PhysicsImpostor): void;
  63563. /**
  63564. * Generates a joint
  63565. * @param impostorJoint the imposter joint to create the joint with
  63566. */
  63567. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63568. /**
  63569. * Removes a joint
  63570. * @param impostorJoint the imposter joint to remove the joint from
  63571. */
  63572. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63573. private _addMeshVerts;
  63574. /**
  63575. * Initialise the soft body vertices to match its object's (mesh) vertices
  63576. * Softbody vertices (nodes) are in world space and to match this
  63577. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63578. * @param impostor to create the softbody for
  63579. */
  63580. private _softVertexData;
  63581. /**
  63582. * Create an impostor's soft body
  63583. * @param impostor to create the softbody for
  63584. */
  63585. private _createSoftbody;
  63586. /**
  63587. * Create cloth for an impostor
  63588. * @param impostor to create the softbody for
  63589. */
  63590. private _createCloth;
  63591. /**
  63592. * Create rope for an impostor
  63593. * @param impostor to create the softbody for
  63594. */
  63595. private _createRope;
  63596. /**
  63597. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63598. * @param impostor to create the custom physics shape for
  63599. */
  63600. private _createCustom;
  63601. private _addHullVerts;
  63602. private _createShape;
  63603. /**
  63604. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63605. * @param impostor imposter containing the physics body and babylon object
  63606. */
  63607. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63608. /**
  63609. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63610. * @param impostor imposter containing the physics body and babylon object
  63611. * @param newPosition new position
  63612. * @param newRotation new rotation
  63613. */
  63614. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63615. /**
  63616. * If this plugin is supported
  63617. * @returns true if its supported
  63618. */
  63619. isSupported(): boolean;
  63620. /**
  63621. * Sets the linear velocity of the physics body
  63622. * @param impostor imposter to set the velocity on
  63623. * @param velocity velocity to set
  63624. */
  63625. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63626. /**
  63627. * Sets the angular velocity of the physics body
  63628. * @param impostor imposter to set the velocity on
  63629. * @param velocity velocity to set
  63630. */
  63631. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63632. /**
  63633. * gets the linear velocity
  63634. * @param impostor imposter to get linear velocity from
  63635. * @returns linear velocity
  63636. */
  63637. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63638. /**
  63639. * gets the angular velocity
  63640. * @param impostor imposter to get angular velocity from
  63641. * @returns angular velocity
  63642. */
  63643. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63644. /**
  63645. * Sets the mass of physics body
  63646. * @param impostor imposter to set the mass on
  63647. * @param mass mass to set
  63648. */
  63649. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63650. /**
  63651. * Gets the mass of the physics body
  63652. * @param impostor imposter to get the mass from
  63653. * @returns mass
  63654. */
  63655. getBodyMass(impostor: PhysicsImpostor): number;
  63656. /**
  63657. * Gets friction of the impostor
  63658. * @param impostor impostor to get friction from
  63659. * @returns friction value
  63660. */
  63661. getBodyFriction(impostor: PhysicsImpostor): number;
  63662. /**
  63663. * Sets friction of the impostor
  63664. * @param impostor impostor to set friction on
  63665. * @param friction friction value
  63666. */
  63667. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63668. /**
  63669. * Gets restitution of the impostor
  63670. * @param impostor impostor to get restitution from
  63671. * @returns restitution value
  63672. */
  63673. getBodyRestitution(impostor: PhysicsImpostor): number;
  63674. /**
  63675. * Sets resitution of the impostor
  63676. * @param impostor impostor to set resitution on
  63677. * @param restitution resitution value
  63678. */
  63679. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63680. /**
  63681. * Gets pressure inside the impostor
  63682. * @param impostor impostor to get pressure from
  63683. * @returns pressure value
  63684. */
  63685. getBodyPressure(impostor: PhysicsImpostor): number;
  63686. /**
  63687. * Sets pressure inside a soft body impostor
  63688. * Cloth and rope must remain 0 pressure
  63689. * @param impostor impostor to set pressure on
  63690. * @param pressure pressure value
  63691. */
  63692. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63693. /**
  63694. * Gets stiffness of the impostor
  63695. * @param impostor impostor to get stiffness from
  63696. * @returns pressure value
  63697. */
  63698. getBodyStiffness(impostor: PhysicsImpostor): number;
  63699. /**
  63700. * Sets stiffness of the impostor
  63701. * @param impostor impostor to set stiffness on
  63702. * @param stiffness stiffness value from 0 to 1
  63703. */
  63704. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63705. /**
  63706. * Gets velocityIterations of the impostor
  63707. * @param impostor impostor to get velocity iterations from
  63708. * @returns velocityIterations value
  63709. */
  63710. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63711. /**
  63712. * Sets velocityIterations of the impostor
  63713. * @param impostor impostor to set velocity iterations on
  63714. * @param velocityIterations velocityIterations value
  63715. */
  63716. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63717. /**
  63718. * Gets positionIterations of the impostor
  63719. * @param impostor impostor to get position iterations from
  63720. * @returns positionIterations value
  63721. */
  63722. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63723. /**
  63724. * Sets positionIterations of the impostor
  63725. * @param impostor impostor to set position on
  63726. * @param positionIterations positionIterations value
  63727. */
  63728. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63729. /**
  63730. * Append an anchor to a cloth object
  63731. * @param impostor is the cloth impostor to add anchor to
  63732. * @param otherImpostor is the rigid impostor to anchor to
  63733. * @param width ratio across width from 0 to 1
  63734. * @param height ratio up height from 0 to 1
  63735. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63736. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63737. */
  63738. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63739. /**
  63740. * Append an hook to a rope object
  63741. * @param impostor is the rope impostor to add hook to
  63742. * @param otherImpostor is the rigid impostor to hook to
  63743. * @param length ratio along the rope from 0 to 1
  63744. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63745. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63746. */
  63747. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63748. /**
  63749. * Sleeps the physics body and stops it from being active
  63750. * @param impostor impostor to sleep
  63751. */
  63752. sleepBody(impostor: PhysicsImpostor): void;
  63753. /**
  63754. * Activates the physics body
  63755. * @param impostor impostor to activate
  63756. */
  63757. wakeUpBody(impostor: PhysicsImpostor): void;
  63758. /**
  63759. * Updates the distance parameters of the joint
  63760. * @param joint joint to update
  63761. * @param maxDistance maximum distance of the joint
  63762. * @param minDistance minimum distance of the joint
  63763. */
  63764. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63765. /**
  63766. * Sets a motor on the joint
  63767. * @param joint joint to set motor on
  63768. * @param speed speed of the motor
  63769. * @param maxForce maximum force of the motor
  63770. * @param motorIndex index of the motor
  63771. */
  63772. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63773. /**
  63774. * Sets the motors limit
  63775. * @param joint joint to set limit on
  63776. * @param upperLimit upper limit
  63777. * @param lowerLimit lower limit
  63778. */
  63779. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63780. /**
  63781. * Syncs the position and rotation of a mesh with the impostor
  63782. * @param mesh mesh to sync
  63783. * @param impostor impostor to update the mesh with
  63784. */
  63785. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63786. /**
  63787. * Gets the radius of the impostor
  63788. * @param impostor impostor to get radius from
  63789. * @returns the radius
  63790. */
  63791. getRadius(impostor: PhysicsImpostor): number;
  63792. /**
  63793. * Gets the box size of the impostor
  63794. * @param impostor impostor to get box size from
  63795. * @param result the resulting box size
  63796. */
  63797. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63798. /**
  63799. * Disposes of the impostor
  63800. */
  63801. dispose(): void;
  63802. /**
  63803. * Does a raycast in the physics world
  63804. * @param from when should the ray start?
  63805. * @param to when should the ray end?
  63806. * @returns PhysicsRaycastResult
  63807. */
  63808. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63809. }
  63810. }
  63811. declare module "babylonjs/Probes/reflectionProbe" {
  63812. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63813. import { Vector3 } from "babylonjs/Maths/math.vector";
  63814. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63815. import { Nullable } from "babylonjs/types";
  63816. import { Scene } from "babylonjs/scene";
  63817. module "babylonjs/abstractScene" {
  63818. interface AbstractScene {
  63819. /**
  63820. * The list of reflection probes added to the scene
  63821. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63822. */
  63823. reflectionProbes: Array<ReflectionProbe>;
  63824. /**
  63825. * Removes the given reflection probe from this scene.
  63826. * @param toRemove The reflection probe to remove
  63827. * @returns The index of the removed reflection probe
  63828. */
  63829. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63830. /**
  63831. * Adds the given reflection probe to this scene.
  63832. * @param newReflectionProbe The reflection probe to add
  63833. */
  63834. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63835. }
  63836. }
  63837. /**
  63838. * Class used to generate realtime reflection / refraction cube textures
  63839. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63840. */
  63841. export class ReflectionProbe {
  63842. /** defines the name of the probe */
  63843. name: string;
  63844. private _scene;
  63845. private _renderTargetTexture;
  63846. private _projectionMatrix;
  63847. private _viewMatrix;
  63848. private _target;
  63849. private _add;
  63850. private _attachedMesh;
  63851. private _invertYAxis;
  63852. /** Gets or sets probe position (center of the cube map) */
  63853. position: Vector3;
  63854. /**
  63855. * Creates a new reflection probe
  63856. * @param name defines the name of the probe
  63857. * @param size defines the texture resolution (for each face)
  63858. * @param scene defines the hosting scene
  63859. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63860. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63861. */
  63862. constructor(
  63863. /** defines the name of the probe */
  63864. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63865. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63866. get samples(): number;
  63867. set samples(value: number);
  63868. /** Gets or sets the refresh rate to use (on every frame by default) */
  63869. get refreshRate(): number;
  63870. set refreshRate(value: number);
  63871. /**
  63872. * Gets the hosting scene
  63873. * @returns a Scene
  63874. */
  63875. getScene(): Scene;
  63876. /** Gets the internal CubeTexture used to render to */
  63877. get cubeTexture(): RenderTargetTexture;
  63878. /** Gets the list of meshes to render */
  63879. get renderList(): Nullable<AbstractMesh[]>;
  63880. /**
  63881. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63882. * @param mesh defines the mesh to attach to
  63883. */
  63884. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63885. /**
  63886. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63887. * @param renderingGroupId The rendering group id corresponding to its index
  63888. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63889. */
  63890. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63891. /**
  63892. * Clean all associated resources
  63893. */
  63894. dispose(): void;
  63895. /**
  63896. * Converts the reflection probe information to a readable string for debug purpose.
  63897. * @param fullDetails Supports for multiple levels of logging within scene loading
  63898. * @returns the human readable reflection probe info
  63899. */
  63900. toString(fullDetails?: boolean): string;
  63901. /**
  63902. * Get the class name of the relfection probe.
  63903. * @returns "ReflectionProbe"
  63904. */
  63905. getClassName(): string;
  63906. /**
  63907. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63908. * @returns The JSON representation of the texture
  63909. */
  63910. serialize(): any;
  63911. /**
  63912. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63913. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63914. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63915. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63916. * @returns The parsed reflection probe if successful
  63917. */
  63918. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63919. }
  63920. }
  63921. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63922. /** @hidden */
  63923. export var _BabylonLoaderRegistered: boolean;
  63924. /**
  63925. * Helps setting up some configuration for the babylon file loader.
  63926. */
  63927. export class BabylonFileLoaderConfiguration {
  63928. /**
  63929. * The loader does not allow injecting custom physix engine into the plugins.
  63930. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63931. * So you could set this variable to your engine import to make it work.
  63932. */
  63933. static LoaderInjectedPhysicsEngine: any;
  63934. }
  63935. }
  63936. declare module "babylonjs/Loading/Plugins/index" {
  63937. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63938. }
  63939. declare module "babylonjs/Loading/index" {
  63940. export * from "babylonjs/Loading/loadingScreen";
  63941. export * from "babylonjs/Loading/Plugins/index";
  63942. export * from "babylonjs/Loading/sceneLoader";
  63943. export * from "babylonjs/Loading/sceneLoaderFlags";
  63944. }
  63945. declare module "babylonjs/Materials/Background/index" {
  63946. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63947. }
  63948. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63949. import { Scene } from "babylonjs/scene";
  63950. import { Color3 } from "babylonjs/Maths/math.color";
  63951. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63953. /**
  63954. * The Physically based simple base material of BJS.
  63955. *
  63956. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63957. * It is used as the base class for both the specGloss and metalRough conventions.
  63958. */
  63959. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63960. /**
  63961. * Number of Simultaneous lights allowed on the material.
  63962. */
  63963. maxSimultaneousLights: number;
  63964. /**
  63965. * If sets to true, disables all the lights affecting the material.
  63966. */
  63967. disableLighting: boolean;
  63968. /**
  63969. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63970. */
  63971. environmentTexture: BaseTexture;
  63972. /**
  63973. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63974. */
  63975. invertNormalMapX: boolean;
  63976. /**
  63977. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63978. */
  63979. invertNormalMapY: boolean;
  63980. /**
  63981. * Normal map used in the model.
  63982. */
  63983. normalTexture: BaseTexture;
  63984. /**
  63985. * Emissivie color used to self-illuminate the model.
  63986. */
  63987. emissiveColor: Color3;
  63988. /**
  63989. * Emissivie texture used to self-illuminate the model.
  63990. */
  63991. emissiveTexture: BaseTexture;
  63992. /**
  63993. * Occlusion Channel Strenght.
  63994. */
  63995. occlusionStrength: number;
  63996. /**
  63997. * Occlusion Texture of the material (adding extra occlusion effects).
  63998. */
  63999. occlusionTexture: BaseTexture;
  64000. /**
  64001. * Defines the alpha limits in alpha test mode.
  64002. */
  64003. alphaCutOff: number;
  64004. /**
  64005. * Gets the current double sided mode.
  64006. */
  64007. get doubleSided(): boolean;
  64008. /**
  64009. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64010. */
  64011. set doubleSided(value: boolean);
  64012. /**
  64013. * Stores the pre-calculated light information of a mesh in a texture.
  64014. */
  64015. lightmapTexture: BaseTexture;
  64016. /**
  64017. * If true, the light map contains occlusion information instead of lighting info.
  64018. */
  64019. useLightmapAsShadowmap: boolean;
  64020. /**
  64021. * Instantiates a new PBRMaterial instance.
  64022. *
  64023. * @param name The material name
  64024. * @param scene The scene the material will be use in.
  64025. */
  64026. constructor(name: string, scene: Scene);
  64027. getClassName(): string;
  64028. }
  64029. }
  64030. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64031. import { Scene } from "babylonjs/scene";
  64032. import { Color3 } from "babylonjs/Maths/math.color";
  64033. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64034. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64035. /**
  64036. * The PBR material of BJS following the metal roughness convention.
  64037. *
  64038. * This fits to the PBR convention in the GLTF definition:
  64039. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64040. */
  64041. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64042. /**
  64043. * The base color has two different interpretations depending on the value of metalness.
  64044. * When the material is a metal, the base color is the specific measured reflectance value
  64045. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64046. * of the material.
  64047. */
  64048. baseColor: Color3;
  64049. /**
  64050. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64051. * well as opacity information in the alpha channel.
  64052. */
  64053. baseTexture: BaseTexture;
  64054. /**
  64055. * Specifies the metallic scalar value of the material.
  64056. * Can also be used to scale the metalness values of the metallic texture.
  64057. */
  64058. metallic: number;
  64059. /**
  64060. * Specifies the roughness scalar value of the material.
  64061. * Can also be used to scale the roughness values of the metallic texture.
  64062. */
  64063. roughness: number;
  64064. /**
  64065. * Texture containing both the metallic value in the B channel and the
  64066. * roughness value in the G channel to keep better precision.
  64067. */
  64068. metallicRoughnessTexture: BaseTexture;
  64069. /**
  64070. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64071. *
  64072. * @param name The material name
  64073. * @param scene The scene the material will be use in.
  64074. */
  64075. constructor(name: string, scene: Scene);
  64076. /**
  64077. * Return the currrent class name of the material.
  64078. */
  64079. getClassName(): string;
  64080. /**
  64081. * Makes a duplicate of the current material.
  64082. * @param name - name to use for the new material.
  64083. */
  64084. clone(name: string): PBRMetallicRoughnessMaterial;
  64085. /**
  64086. * Serialize the material to a parsable JSON object.
  64087. */
  64088. serialize(): any;
  64089. /**
  64090. * Parses a JSON object correponding to the serialize function.
  64091. */
  64092. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64093. }
  64094. }
  64095. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64096. import { Scene } from "babylonjs/scene";
  64097. import { Color3 } from "babylonjs/Maths/math.color";
  64098. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64099. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64100. /**
  64101. * The PBR material of BJS following the specular glossiness convention.
  64102. *
  64103. * This fits to the PBR convention in the GLTF definition:
  64104. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64105. */
  64106. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64107. /**
  64108. * Specifies the diffuse color of the material.
  64109. */
  64110. diffuseColor: Color3;
  64111. /**
  64112. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64113. * channel.
  64114. */
  64115. diffuseTexture: BaseTexture;
  64116. /**
  64117. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64118. */
  64119. specularColor: Color3;
  64120. /**
  64121. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64122. */
  64123. glossiness: number;
  64124. /**
  64125. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64126. */
  64127. specularGlossinessTexture: BaseTexture;
  64128. /**
  64129. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64130. *
  64131. * @param name The material name
  64132. * @param scene The scene the material will be use in.
  64133. */
  64134. constructor(name: string, scene: Scene);
  64135. /**
  64136. * Return the currrent class name of the material.
  64137. */
  64138. getClassName(): string;
  64139. /**
  64140. * Makes a duplicate of the current material.
  64141. * @param name - name to use for the new material.
  64142. */
  64143. clone(name: string): PBRSpecularGlossinessMaterial;
  64144. /**
  64145. * Serialize the material to a parsable JSON object.
  64146. */
  64147. serialize(): any;
  64148. /**
  64149. * Parses a JSON object correponding to the serialize function.
  64150. */
  64151. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64152. }
  64153. }
  64154. declare module "babylonjs/Materials/PBR/index" {
  64155. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64156. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64157. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64158. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64159. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64160. }
  64161. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64162. import { Nullable } from "babylonjs/types";
  64163. import { Scene } from "babylonjs/scene";
  64164. import { Matrix } from "babylonjs/Maths/math.vector";
  64165. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64166. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64167. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64168. /**
  64169. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64170. * It can help converting any input color in a desired output one. This can then be used to create effects
  64171. * from sepia, black and white to sixties or futuristic rendering...
  64172. *
  64173. * The only supported format is currently 3dl.
  64174. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64175. */
  64176. export class ColorGradingTexture extends BaseTexture {
  64177. /**
  64178. * The texture URL.
  64179. */
  64180. url: string;
  64181. /**
  64182. * Empty line regex stored for GC.
  64183. */
  64184. private static _noneEmptyLineRegex;
  64185. private _textureMatrix;
  64186. private _onLoad;
  64187. /**
  64188. * Instantiates a ColorGradingTexture from the following parameters.
  64189. *
  64190. * @param url The location of the color gradind data (currently only supporting 3dl)
  64191. * @param sceneOrEngine The scene or engine the texture will be used in
  64192. * @param onLoad defines a callback triggered when the texture has been loaded
  64193. */
  64194. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64195. /**
  64196. * Fires the onload event from the constructor if requested.
  64197. */
  64198. private _triggerOnLoad;
  64199. /**
  64200. * Returns the texture matrix used in most of the material.
  64201. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64202. */
  64203. getTextureMatrix(): Matrix;
  64204. /**
  64205. * Occurs when the file being loaded is a .3dl LUT file.
  64206. */
  64207. private load3dlTexture;
  64208. /**
  64209. * Starts the loading process of the texture.
  64210. */
  64211. private loadTexture;
  64212. /**
  64213. * Clones the color gradind texture.
  64214. */
  64215. clone(): ColorGradingTexture;
  64216. /**
  64217. * Called during delayed load for textures.
  64218. */
  64219. delayLoad(): void;
  64220. /**
  64221. * Parses a color grading texture serialized by Babylon.
  64222. * @param parsedTexture The texture information being parsedTexture
  64223. * @param scene The scene to load the texture in
  64224. * @param rootUrl The root url of the data assets to load
  64225. * @return A color gradind texture
  64226. */
  64227. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64228. /**
  64229. * Serializes the LUT texture to json format.
  64230. */
  64231. serialize(): any;
  64232. }
  64233. }
  64234. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64235. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64236. import { Scene } from "babylonjs/scene";
  64237. import { Nullable } from "babylonjs/types";
  64238. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64239. /**
  64240. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64241. */
  64242. export class EquiRectangularCubeTexture extends BaseTexture {
  64243. /** The six faces of the cube. */
  64244. private static _FacesMapping;
  64245. private _noMipmap;
  64246. private _onLoad;
  64247. private _onError;
  64248. /** The size of the cubemap. */
  64249. private _size;
  64250. /** The buffer of the image. */
  64251. private _buffer;
  64252. /** The width of the input image. */
  64253. private _width;
  64254. /** The height of the input image. */
  64255. private _height;
  64256. /** The URL to the image. */
  64257. url: string;
  64258. /**
  64259. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64260. * @param url The location of the image
  64261. * @param scene The scene the texture will be used in
  64262. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64263. * @param noMipmap Forces to not generate the mipmap if true
  64264. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64265. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64266. * @param onLoad — defines a callback called when texture is loaded
  64267. * @param onError — defines a callback called if there is an error
  64268. */
  64269. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64270. /**
  64271. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64272. */
  64273. private loadImage;
  64274. /**
  64275. * Convert the image buffer into a cubemap and create a CubeTexture.
  64276. */
  64277. private loadTexture;
  64278. /**
  64279. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64280. * @param buffer The ArrayBuffer that should be converted.
  64281. * @returns The buffer as Float32Array.
  64282. */
  64283. private getFloat32ArrayFromArrayBuffer;
  64284. /**
  64285. * Get the current class name of the texture useful for serialization or dynamic coding.
  64286. * @returns "EquiRectangularCubeTexture"
  64287. */
  64288. getClassName(): string;
  64289. /**
  64290. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64291. * @returns A clone of the current EquiRectangularCubeTexture.
  64292. */
  64293. clone(): EquiRectangularCubeTexture;
  64294. }
  64295. }
  64296. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64297. import { Nullable } from "babylonjs/types";
  64298. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64299. import { Matrix } from "babylonjs/Maths/math.vector";
  64300. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64301. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64302. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64303. import { Scene } from "babylonjs/scene";
  64304. /**
  64305. * Defines the options related to the creation of an HtmlElementTexture
  64306. */
  64307. export interface IHtmlElementTextureOptions {
  64308. /**
  64309. * Defines wether mip maps should be created or not.
  64310. */
  64311. generateMipMaps?: boolean;
  64312. /**
  64313. * Defines the sampling mode of the texture.
  64314. */
  64315. samplingMode?: number;
  64316. /**
  64317. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64318. */
  64319. engine: Nullable<ThinEngine>;
  64320. /**
  64321. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64322. */
  64323. scene: Nullable<Scene>;
  64324. }
  64325. /**
  64326. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64327. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64328. * is automatically managed.
  64329. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64330. * in your application.
  64331. *
  64332. * As the update is not automatic, you need to call them manually.
  64333. */
  64334. export class HtmlElementTexture extends BaseTexture {
  64335. /**
  64336. * The texture URL.
  64337. */
  64338. element: HTMLVideoElement | HTMLCanvasElement;
  64339. private static readonly DefaultOptions;
  64340. private _textureMatrix;
  64341. private _isVideo;
  64342. private _generateMipMaps;
  64343. private _samplingMode;
  64344. /**
  64345. * Instantiates a HtmlElementTexture from the following parameters.
  64346. *
  64347. * @param name Defines the name of the texture
  64348. * @param element Defines the video or canvas the texture is filled with
  64349. * @param options Defines the other none mandatory texture creation options
  64350. */
  64351. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64352. private _createInternalTexture;
  64353. /**
  64354. * Returns the texture matrix used in most of the material.
  64355. */
  64356. getTextureMatrix(): Matrix;
  64357. /**
  64358. * Updates the content of the texture.
  64359. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64360. */
  64361. update(invertY?: Nullable<boolean>): void;
  64362. }
  64363. }
  64364. declare module "babylonjs/Misc/tga" {
  64365. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64366. /**
  64367. * Based on jsTGALoader - Javascript loader for TGA file
  64368. * By Vincent Thibault
  64369. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64370. */
  64371. export class TGATools {
  64372. private static _TYPE_INDEXED;
  64373. private static _TYPE_RGB;
  64374. private static _TYPE_GREY;
  64375. private static _TYPE_RLE_INDEXED;
  64376. private static _TYPE_RLE_RGB;
  64377. private static _TYPE_RLE_GREY;
  64378. private static _ORIGIN_MASK;
  64379. private static _ORIGIN_SHIFT;
  64380. private static _ORIGIN_BL;
  64381. private static _ORIGIN_BR;
  64382. private static _ORIGIN_UL;
  64383. private static _ORIGIN_UR;
  64384. /**
  64385. * Gets the header of a TGA file
  64386. * @param data defines the TGA data
  64387. * @returns the header
  64388. */
  64389. static GetTGAHeader(data: Uint8Array): any;
  64390. /**
  64391. * Uploads TGA content to a Babylon Texture
  64392. * @hidden
  64393. */
  64394. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64395. /** @hidden */
  64396. 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;
  64397. /** @hidden */
  64398. 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;
  64399. /** @hidden */
  64400. 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;
  64401. /** @hidden */
  64402. 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;
  64403. /** @hidden */
  64404. 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;
  64405. /** @hidden */
  64406. 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;
  64407. }
  64408. }
  64409. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64410. import { Nullable } from "babylonjs/types";
  64411. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64412. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64413. /**
  64414. * Implementation of the TGA Texture Loader.
  64415. * @hidden
  64416. */
  64417. export class _TGATextureLoader implements IInternalTextureLoader {
  64418. /**
  64419. * Defines wether the loader supports cascade loading the different faces.
  64420. */
  64421. readonly supportCascades: boolean;
  64422. /**
  64423. * This returns if the loader support the current file information.
  64424. * @param extension defines the file extension of the file being loaded
  64425. * @returns true if the loader can load the specified file
  64426. */
  64427. canLoad(extension: string): boolean;
  64428. /**
  64429. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64430. * @param data contains the texture data
  64431. * @param texture defines the BabylonJS internal texture
  64432. * @param createPolynomials will be true if polynomials have been requested
  64433. * @param onLoad defines the callback to trigger once the texture is ready
  64434. * @param onError defines the callback to trigger in case of error
  64435. */
  64436. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64437. /**
  64438. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64439. * @param data contains the texture data
  64440. * @param texture defines the BabylonJS internal texture
  64441. * @param callback defines the method to call once ready to upload
  64442. */
  64443. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64444. }
  64445. }
  64446. declare module "babylonjs/Misc/basis" {
  64447. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64448. /**
  64449. * Info about the .basis files
  64450. */
  64451. class BasisFileInfo {
  64452. /**
  64453. * If the file has alpha
  64454. */
  64455. hasAlpha: boolean;
  64456. /**
  64457. * Info about each image of the basis file
  64458. */
  64459. images: Array<{
  64460. levels: Array<{
  64461. width: number;
  64462. height: number;
  64463. transcodedPixels: ArrayBufferView;
  64464. }>;
  64465. }>;
  64466. }
  64467. /**
  64468. * Result of transcoding a basis file
  64469. */
  64470. class TranscodeResult {
  64471. /**
  64472. * Info about the .basis file
  64473. */
  64474. fileInfo: BasisFileInfo;
  64475. /**
  64476. * Format to use when loading the file
  64477. */
  64478. format: number;
  64479. }
  64480. /**
  64481. * Configuration options for the Basis transcoder
  64482. */
  64483. export class BasisTranscodeConfiguration {
  64484. /**
  64485. * Supported compression formats used to determine the supported output format of the transcoder
  64486. */
  64487. supportedCompressionFormats?: {
  64488. /**
  64489. * etc1 compression format
  64490. */
  64491. etc1?: boolean;
  64492. /**
  64493. * s3tc compression format
  64494. */
  64495. s3tc?: boolean;
  64496. /**
  64497. * pvrtc compression format
  64498. */
  64499. pvrtc?: boolean;
  64500. /**
  64501. * etc2 compression format
  64502. */
  64503. etc2?: boolean;
  64504. };
  64505. /**
  64506. * If mipmap levels should be loaded for transcoded images (Default: true)
  64507. */
  64508. loadMipmapLevels?: boolean;
  64509. /**
  64510. * Index of a single image to load (Default: all images)
  64511. */
  64512. loadSingleImage?: number;
  64513. }
  64514. /**
  64515. * Used to load .Basis files
  64516. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64517. */
  64518. export class BasisTools {
  64519. private static _IgnoreSupportedFormats;
  64520. /**
  64521. * URL to use when loading the basis transcoder
  64522. */
  64523. static JSModuleURL: string;
  64524. /**
  64525. * URL to use when loading the wasm module for the transcoder
  64526. */
  64527. static WasmModuleURL: string;
  64528. /**
  64529. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64530. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64531. * @returns internal format corresponding to the Basis format
  64532. */
  64533. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64534. private static _WorkerPromise;
  64535. private static _Worker;
  64536. private static _actionId;
  64537. private static _CreateWorkerAsync;
  64538. /**
  64539. * Transcodes a loaded image file to compressed pixel data
  64540. * @param data image data to transcode
  64541. * @param config configuration options for the transcoding
  64542. * @returns a promise resulting in the transcoded image
  64543. */
  64544. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64545. /**
  64546. * Loads a texture from the transcode result
  64547. * @param texture texture load to
  64548. * @param transcodeResult the result of transcoding the basis file to load from
  64549. */
  64550. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64551. }
  64552. }
  64553. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64554. import { Nullable } from "babylonjs/types";
  64555. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64556. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64557. /**
  64558. * Loader for .basis file format
  64559. */
  64560. export class _BasisTextureLoader implements IInternalTextureLoader {
  64561. /**
  64562. * Defines whether the loader supports cascade loading the different faces.
  64563. */
  64564. readonly supportCascades: boolean;
  64565. /**
  64566. * This returns if the loader support the current file information.
  64567. * @param extension defines the file extension of the file being loaded
  64568. * @returns true if the loader can load the specified file
  64569. */
  64570. canLoad(extension: string): boolean;
  64571. /**
  64572. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64573. * @param data contains the texture data
  64574. * @param texture defines the BabylonJS internal texture
  64575. * @param createPolynomials will be true if polynomials have been requested
  64576. * @param onLoad defines the callback to trigger once the texture is ready
  64577. * @param onError defines the callback to trigger in case of error
  64578. */
  64579. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64580. /**
  64581. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64582. * @param data contains the texture data
  64583. * @param texture defines the BabylonJS internal texture
  64584. * @param callback defines the method to call once ready to upload
  64585. */
  64586. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64587. }
  64588. }
  64589. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64590. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64591. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64592. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64593. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64594. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64595. }
  64596. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64597. import { Vector2 } from "babylonjs/Maths/math.vector";
  64598. /**
  64599. * Defines the basic options interface of a TexturePacker Frame
  64600. */
  64601. export interface ITexturePackerFrame {
  64602. /**
  64603. * The frame ID
  64604. */
  64605. id: number;
  64606. /**
  64607. * The frames Scale
  64608. */
  64609. scale: Vector2;
  64610. /**
  64611. * The Frames offset
  64612. */
  64613. offset: Vector2;
  64614. }
  64615. /**
  64616. * This is a support class for frame Data on texture packer sets.
  64617. */
  64618. export class TexturePackerFrame implements ITexturePackerFrame {
  64619. /**
  64620. * The frame ID
  64621. */
  64622. id: number;
  64623. /**
  64624. * The frames Scale
  64625. */
  64626. scale: Vector2;
  64627. /**
  64628. * The Frames offset
  64629. */
  64630. offset: Vector2;
  64631. /**
  64632. * Initializes a texture package frame.
  64633. * @param id The numerical frame identifier
  64634. * @param scale Scalar Vector2 for UV frame
  64635. * @param offset Vector2 for the frame position in UV units.
  64636. * @returns TexturePackerFrame
  64637. */
  64638. constructor(id: number, scale: Vector2, offset: Vector2);
  64639. }
  64640. }
  64641. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64643. import { Scene } from "babylonjs/scene";
  64644. import { Nullable } from "babylonjs/types";
  64645. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64646. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64647. /**
  64648. * Defines the basic options interface of a TexturePacker
  64649. */
  64650. export interface ITexturePackerOptions {
  64651. /**
  64652. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64653. */
  64654. map?: string[];
  64655. /**
  64656. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64657. */
  64658. uvsIn?: string;
  64659. /**
  64660. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64661. */
  64662. uvsOut?: string;
  64663. /**
  64664. * number representing the layout style. Defaults to LAYOUT_STRIP
  64665. */
  64666. layout?: number;
  64667. /**
  64668. * number of columns if using custom column count layout(2). This defaults to 4.
  64669. */
  64670. colnum?: number;
  64671. /**
  64672. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64673. */
  64674. updateInputMeshes?: boolean;
  64675. /**
  64676. * boolean flag to dispose all the source textures. Defaults to true.
  64677. */
  64678. disposeSources?: boolean;
  64679. /**
  64680. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64681. */
  64682. fillBlanks?: boolean;
  64683. /**
  64684. * string value representing the context fill style color. Defaults to 'black'.
  64685. */
  64686. customFillColor?: string;
  64687. /**
  64688. * Width and Height Value of each Frame in the TexturePacker Sets
  64689. */
  64690. frameSize?: number;
  64691. /**
  64692. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64693. */
  64694. paddingRatio?: number;
  64695. /**
  64696. * Number that declares the fill method for the padding gutter.
  64697. */
  64698. paddingMode?: number;
  64699. /**
  64700. * If in SUBUV_COLOR padding mode what color to use.
  64701. */
  64702. paddingColor?: Color3 | Color4;
  64703. }
  64704. /**
  64705. * Defines the basic interface of a TexturePacker JSON File
  64706. */
  64707. export interface ITexturePackerJSON {
  64708. /**
  64709. * The frame ID
  64710. */
  64711. name: string;
  64712. /**
  64713. * The base64 channel data
  64714. */
  64715. sets: any;
  64716. /**
  64717. * The options of the Packer
  64718. */
  64719. options: ITexturePackerOptions;
  64720. /**
  64721. * The frame data of the Packer
  64722. */
  64723. frames: Array<number>;
  64724. }
  64725. /**
  64726. * This is a support class that generates a series of packed texture sets.
  64727. * @see https://doc.babylonjs.com/babylon101/materials
  64728. */
  64729. export class TexturePacker {
  64730. /** Packer Layout Constant 0 */
  64731. static readonly LAYOUT_STRIP: number;
  64732. /** Packer Layout Constant 1 */
  64733. static readonly LAYOUT_POWER2: number;
  64734. /** Packer Layout Constant 2 */
  64735. static readonly LAYOUT_COLNUM: number;
  64736. /** Packer Layout Constant 0 */
  64737. static readonly SUBUV_WRAP: number;
  64738. /** Packer Layout Constant 1 */
  64739. static readonly SUBUV_EXTEND: number;
  64740. /** Packer Layout Constant 2 */
  64741. static readonly SUBUV_COLOR: number;
  64742. /** The Name of the Texture Package */
  64743. name: string;
  64744. /** The scene scope of the TexturePacker */
  64745. scene: Scene;
  64746. /** The Meshes to target */
  64747. meshes: AbstractMesh[];
  64748. /** Arguments passed with the Constructor */
  64749. options: ITexturePackerOptions;
  64750. /** The promise that is started upon initialization */
  64751. promise: Nullable<Promise<TexturePacker | string>>;
  64752. /** The Container object for the channel sets that are generated */
  64753. sets: object;
  64754. /** The Container array for the frames that are generated */
  64755. frames: TexturePackerFrame[];
  64756. /** The expected number of textures the system is parsing. */
  64757. private _expecting;
  64758. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64759. private _paddingValue;
  64760. /**
  64761. * Initializes a texture package series from an array of meshes or a single mesh.
  64762. * @param name The name of the package
  64763. * @param meshes The target meshes to compose the package from
  64764. * @param options The arguments that texture packer should follow while building.
  64765. * @param scene The scene which the textures are scoped to.
  64766. * @returns TexturePacker
  64767. */
  64768. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64769. /**
  64770. * Starts the package process
  64771. * @param resolve The promises resolution function
  64772. * @returns TexturePacker
  64773. */
  64774. private _createFrames;
  64775. /**
  64776. * Calculates the Size of the Channel Sets
  64777. * @returns Vector2
  64778. */
  64779. private _calculateSize;
  64780. /**
  64781. * Calculates the UV data for the frames.
  64782. * @param baseSize the base frameSize
  64783. * @param padding the base frame padding
  64784. * @param dtSize size of the Dynamic Texture for that channel
  64785. * @param dtUnits is 1/dtSize
  64786. * @param update flag to update the input meshes
  64787. */
  64788. private _calculateMeshUVFrames;
  64789. /**
  64790. * Calculates the frames Offset.
  64791. * @param index of the frame
  64792. * @returns Vector2
  64793. */
  64794. private _getFrameOffset;
  64795. /**
  64796. * Updates a Mesh to the frame data
  64797. * @param mesh that is the target
  64798. * @param frameID or the frame index
  64799. */
  64800. private _updateMeshUV;
  64801. /**
  64802. * Updates a Meshes materials to use the texture packer channels
  64803. * @param m is the mesh to target
  64804. * @param force all channels on the packer to be set.
  64805. */
  64806. private _updateTextureReferences;
  64807. /**
  64808. * Public method to set a Mesh to a frame
  64809. * @param m that is the target
  64810. * @param frameID or the frame index
  64811. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64812. */
  64813. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64814. /**
  64815. * Starts the async promise to compile the texture packer.
  64816. * @returns Promise<void>
  64817. */
  64818. processAsync(): Promise<void>;
  64819. /**
  64820. * Disposes all textures associated with this packer
  64821. */
  64822. dispose(): void;
  64823. /**
  64824. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64825. * @param imageType is the image type to use.
  64826. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64827. */
  64828. download(imageType?: string, quality?: number): void;
  64829. /**
  64830. * Public method to load a texturePacker JSON file.
  64831. * @param data of the JSON file in string format.
  64832. */
  64833. updateFromJSON(data: string): void;
  64834. }
  64835. }
  64836. declare module "babylonjs/Materials/Textures/Packer/index" {
  64837. export * from "babylonjs/Materials/Textures/Packer/packer";
  64838. export * from "babylonjs/Materials/Textures/Packer/frame";
  64839. }
  64840. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64841. import { Scene } from "babylonjs/scene";
  64842. import { Texture } from "babylonjs/Materials/Textures/texture";
  64843. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64844. /**
  64845. * 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.
  64846. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64847. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64848. */
  64849. export class CustomProceduralTexture extends ProceduralTexture {
  64850. private _animate;
  64851. private _time;
  64852. private _config;
  64853. private _texturePath;
  64854. /**
  64855. * Instantiates a new Custom Procedural Texture.
  64856. * 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.
  64857. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64858. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64859. * @param name Define the name of the texture
  64860. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64861. * @param size Define the size of the texture to create
  64862. * @param scene Define the scene the texture belongs to
  64863. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64864. * @param generateMipMaps Define if the texture should creates mip maps or not
  64865. */
  64866. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64867. private _loadJson;
  64868. /**
  64869. * Is the texture ready to be used ? (rendered at least once)
  64870. * @returns true if ready, otherwise, false.
  64871. */
  64872. isReady(): boolean;
  64873. /**
  64874. * Render the texture to its associated render target.
  64875. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64876. */
  64877. render(useCameraPostProcess?: boolean): void;
  64878. /**
  64879. * Update the list of dependant textures samplers in the shader.
  64880. */
  64881. updateTextures(): void;
  64882. /**
  64883. * Update the uniform values of the procedural texture in the shader.
  64884. */
  64885. updateShaderUniforms(): void;
  64886. /**
  64887. * Define if the texture animates or not.
  64888. */
  64889. get animate(): boolean;
  64890. set animate(value: boolean);
  64891. }
  64892. }
  64893. declare module "babylonjs/Shaders/noise.fragment" {
  64894. /** @hidden */
  64895. export var noisePixelShader: {
  64896. name: string;
  64897. shader: string;
  64898. };
  64899. }
  64900. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64901. import { Nullable } from "babylonjs/types";
  64902. import { Scene } from "babylonjs/scene";
  64903. import { Texture } from "babylonjs/Materials/Textures/texture";
  64904. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64905. import "babylonjs/Shaders/noise.fragment";
  64906. /**
  64907. * Class used to generate noise procedural textures
  64908. */
  64909. export class NoiseProceduralTexture extends ProceduralTexture {
  64910. /** Gets or sets the start time (default is 0) */
  64911. time: number;
  64912. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64913. brightness: number;
  64914. /** Defines the number of octaves to process */
  64915. octaves: number;
  64916. /** Defines the level of persistence (0.8 by default) */
  64917. persistence: number;
  64918. /** Gets or sets animation speed factor (default is 1) */
  64919. animationSpeedFactor: number;
  64920. /**
  64921. * Creates a new NoiseProceduralTexture
  64922. * @param name defines the name fo the texture
  64923. * @param size defines the size of the texture (default is 256)
  64924. * @param scene defines the hosting scene
  64925. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64926. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64927. */
  64928. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64929. private _updateShaderUniforms;
  64930. protected _getDefines(): string;
  64931. /** Generate the current state of the procedural texture */
  64932. render(useCameraPostProcess?: boolean): void;
  64933. /**
  64934. * Serializes this noise procedural texture
  64935. * @returns a serialized noise procedural texture object
  64936. */
  64937. serialize(): any;
  64938. /**
  64939. * Clone the texture.
  64940. * @returns the cloned texture
  64941. */
  64942. clone(): NoiseProceduralTexture;
  64943. /**
  64944. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64945. * @param parsedTexture defines parsed texture data
  64946. * @param scene defines the current scene
  64947. * @param rootUrl defines the root URL containing noise procedural texture information
  64948. * @returns a parsed NoiseProceduralTexture
  64949. */
  64950. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64951. }
  64952. }
  64953. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64954. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64955. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64956. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64957. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64958. }
  64959. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64960. import { Nullable } from "babylonjs/types";
  64961. import { Scene } from "babylonjs/scene";
  64962. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64963. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64964. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64965. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64966. /**
  64967. * Raw cube texture where the raw buffers are passed in
  64968. */
  64969. export class RawCubeTexture extends CubeTexture {
  64970. /**
  64971. * Creates a cube texture where the raw buffers are passed in.
  64972. * @param scene defines the scene the texture is attached to
  64973. * @param data defines the array of data to use to create each face
  64974. * @param size defines the size of the textures
  64975. * @param format defines the format of the data
  64976. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64977. * @param generateMipMaps defines if the engine should generate the mip levels
  64978. * @param invertY defines if data must be stored with Y axis inverted
  64979. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64980. * @param compression defines the compression used (null by default)
  64981. */
  64982. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64983. /**
  64984. * Updates the raw cube texture.
  64985. * @param data defines the data to store
  64986. * @param format defines the data format
  64987. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64988. * @param invertY defines if data must be stored with Y axis inverted
  64989. * @param compression defines the compression used (null by default)
  64990. * @param level defines which level of the texture to update
  64991. */
  64992. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64993. /**
  64994. * Updates a raw cube texture with RGBD encoded data.
  64995. * @param data defines the array of data [mipmap][face] to use to create each face
  64996. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64997. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64998. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64999. * @returns a promsie that resolves when the operation is complete
  65000. */
  65001. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  65002. /**
  65003. * Clones the raw cube texture.
  65004. * @return a new cube texture
  65005. */
  65006. clone(): CubeTexture;
  65007. /** @hidden */
  65008. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65009. }
  65010. }
  65011. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65012. import { Scene } from "babylonjs/scene";
  65013. import { Texture } from "babylonjs/Materials/Textures/texture";
  65014. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65015. /**
  65016. * Class used to store 2D array textures containing user data
  65017. */
  65018. export class RawTexture2DArray extends Texture {
  65019. /** Gets or sets the texture format to use */
  65020. format: number;
  65021. /**
  65022. * Create a new RawTexture2DArray
  65023. * @param data defines the data of the texture
  65024. * @param width defines the width of the texture
  65025. * @param height defines the height of the texture
  65026. * @param depth defines the number of layers of the texture
  65027. * @param format defines the texture format to use
  65028. * @param scene defines the hosting scene
  65029. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65030. * @param invertY defines if texture must be stored with Y axis inverted
  65031. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65032. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65033. */
  65034. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65035. /** Gets or sets the texture format to use */
  65036. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65037. /**
  65038. * Update the texture with new data
  65039. * @param data defines the data to store in the texture
  65040. */
  65041. update(data: ArrayBufferView): void;
  65042. }
  65043. }
  65044. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65045. import { Scene } from "babylonjs/scene";
  65046. import { Texture } from "babylonjs/Materials/Textures/texture";
  65047. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65048. /**
  65049. * Class used to store 3D textures containing user data
  65050. */
  65051. export class RawTexture3D extends Texture {
  65052. /** Gets or sets the texture format to use */
  65053. format: number;
  65054. /**
  65055. * Create a new RawTexture3D
  65056. * @param data defines the data of the texture
  65057. * @param width defines the width of the texture
  65058. * @param height defines the height of the texture
  65059. * @param depth defines the depth of the texture
  65060. * @param format defines the texture format to use
  65061. * @param scene defines the hosting scene
  65062. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65063. * @param invertY defines if texture must be stored with Y axis inverted
  65064. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65065. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65066. */
  65067. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65068. /** Gets or sets the texture format to use */
  65069. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65070. /**
  65071. * Update the texture with new data
  65072. * @param data defines the data to store in the texture
  65073. */
  65074. update(data: ArrayBufferView): void;
  65075. }
  65076. }
  65077. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65078. import { Scene } from "babylonjs/scene";
  65079. import { Plane } from "babylonjs/Maths/math.plane";
  65080. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65081. /**
  65082. * Creates a refraction texture used by refraction channel of the standard material.
  65083. * It is like a mirror but to see through a material.
  65084. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65085. */
  65086. export class RefractionTexture extends RenderTargetTexture {
  65087. /**
  65088. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65089. * 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.
  65090. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65091. */
  65092. refractionPlane: Plane;
  65093. /**
  65094. * Define how deep under the surface we should see.
  65095. */
  65096. depth: number;
  65097. /**
  65098. * Creates a refraction texture used by refraction channel of the standard material.
  65099. * It is like a mirror but to see through a material.
  65100. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65101. * @param name Define the texture name
  65102. * @param size Define the size of the underlying texture
  65103. * @param scene Define the scene the refraction belongs to
  65104. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65105. */
  65106. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65107. /**
  65108. * Clone the refraction texture.
  65109. * @returns the cloned texture
  65110. */
  65111. clone(): RefractionTexture;
  65112. /**
  65113. * Serialize the texture to a JSON representation you could use in Parse later on
  65114. * @returns the serialized JSON representation
  65115. */
  65116. serialize(): any;
  65117. }
  65118. }
  65119. declare module "babylonjs/Materials/Textures/index" {
  65120. export * from "babylonjs/Materials/Textures/baseTexture";
  65121. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65122. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65123. export * from "babylonjs/Materials/Textures/cubeTexture";
  65124. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65125. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65126. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65127. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65128. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65129. export * from "babylonjs/Materials/Textures/internalTexture";
  65130. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65131. export * from "babylonjs/Materials/Textures/Loaders/index";
  65132. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65133. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65134. export * from "babylonjs/Materials/Textures/Packer/index";
  65135. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65136. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65137. export * from "babylonjs/Materials/Textures/rawTexture";
  65138. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65139. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65140. export * from "babylonjs/Materials/Textures/refractionTexture";
  65141. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65142. export * from "babylonjs/Materials/Textures/texture";
  65143. export * from "babylonjs/Materials/Textures/videoTexture";
  65144. }
  65145. declare module "babylonjs/Materials/Node/Enums/index" {
  65146. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65147. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65148. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65149. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65150. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65151. }
  65152. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65153. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65154. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65155. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65156. import { Mesh } from "babylonjs/Meshes/mesh";
  65157. import { Effect } from "babylonjs/Materials/effect";
  65158. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65159. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65160. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65161. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65162. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65163. /**
  65164. * Block used to add support for vertex skinning (bones)
  65165. */
  65166. export class BonesBlock extends NodeMaterialBlock {
  65167. /**
  65168. * Creates a new BonesBlock
  65169. * @param name defines the block name
  65170. */
  65171. constructor(name: string);
  65172. /**
  65173. * Initialize the block and prepare the context for build
  65174. * @param state defines the state that will be used for the build
  65175. */
  65176. initialize(state: NodeMaterialBuildState): void;
  65177. /**
  65178. * Gets the current class name
  65179. * @returns the class name
  65180. */
  65181. getClassName(): string;
  65182. /**
  65183. * Gets the matrix indices input component
  65184. */
  65185. get matricesIndices(): NodeMaterialConnectionPoint;
  65186. /**
  65187. * Gets the matrix weights input component
  65188. */
  65189. get matricesWeights(): NodeMaterialConnectionPoint;
  65190. /**
  65191. * Gets the extra matrix indices input component
  65192. */
  65193. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65194. /**
  65195. * Gets the extra matrix weights input component
  65196. */
  65197. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65198. /**
  65199. * Gets the world input component
  65200. */
  65201. get world(): NodeMaterialConnectionPoint;
  65202. /**
  65203. * Gets the output component
  65204. */
  65205. get output(): NodeMaterialConnectionPoint;
  65206. autoConfigure(material: NodeMaterial): void;
  65207. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65208. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65209. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65210. protected _buildBlock(state: NodeMaterialBuildState): this;
  65211. }
  65212. }
  65213. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65214. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65215. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65216. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65217. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65218. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65219. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65220. /**
  65221. * Block used to add support for instances
  65222. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65223. */
  65224. export class InstancesBlock extends NodeMaterialBlock {
  65225. /**
  65226. * Creates a new InstancesBlock
  65227. * @param name defines the block name
  65228. */
  65229. constructor(name: string);
  65230. /**
  65231. * Gets the current class name
  65232. * @returns the class name
  65233. */
  65234. getClassName(): string;
  65235. /**
  65236. * Gets the first world row input component
  65237. */
  65238. get world0(): NodeMaterialConnectionPoint;
  65239. /**
  65240. * Gets the second world row input component
  65241. */
  65242. get world1(): NodeMaterialConnectionPoint;
  65243. /**
  65244. * Gets the third world row input component
  65245. */
  65246. get world2(): NodeMaterialConnectionPoint;
  65247. /**
  65248. * Gets the forth world row input component
  65249. */
  65250. get world3(): NodeMaterialConnectionPoint;
  65251. /**
  65252. * Gets the world input component
  65253. */
  65254. get world(): NodeMaterialConnectionPoint;
  65255. /**
  65256. * Gets the output component
  65257. */
  65258. get output(): NodeMaterialConnectionPoint;
  65259. /**
  65260. * Gets the isntanceID component
  65261. */
  65262. get instanceID(): NodeMaterialConnectionPoint;
  65263. autoConfigure(material: NodeMaterial): void;
  65264. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65265. protected _buildBlock(state: NodeMaterialBuildState): this;
  65266. }
  65267. }
  65268. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65269. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65270. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65271. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65272. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65273. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65274. import { Effect } from "babylonjs/Materials/effect";
  65275. import { Mesh } from "babylonjs/Meshes/mesh";
  65276. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65277. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65278. /**
  65279. * Block used to add morph targets support to vertex shader
  65280. */
  65281. export class MorphTargetsBlock extends NodeMaterialBlock {
  65282. private _repeatableContentAnchor;
  65283. /**
  65284. * Create a new MorphTargetsBlock
  65285. * @param name defines the block name
  65286. */
  65287. constructor(name: string);
  65288. /**
  65289. * Gets the current class name
  65290. * @returns the class name
  65291. */
  65292. getClassName(): string;
  65293. /**
  65294. * Gets the position input component
  65295. */
  65296. get position(): NodeMaterialConnectionPoint;
  65297. /**
  65298. * Gets the normal input component
  65299. */
  65300. get normal(): NodeMaterialConnectionPoint;
  65301. /**
  65302. * Gets the tangent input component
  65303. */
  65304. get tangent(): NodeMaterialConnectionPoint;
  65305. /**
  65306. * Gets the tangent input component
  65307. */
  65308. get uv(): NodeMaterialConnectionPoint;
  65309. /**
  65310. * Gets the position output component
  65311. */
  65312. get positionOutput(): NodeMaterialConnectionPoint;
  65313. /**
  65314. * Gets the normal output component
  65315. */
  65316. get normalOutput(): NodeMaterialConnectionPoint;
  65317. /**
  65318. * Gets the tangent output component
  65319. */
  65320. get tangentOutput(): NodeMaterialConnectionPoint;
  65321. /**
  65322. * Gets the tangent output component
  65323. */
  65324. get uvOutput(): NodeMaterialConnectionPoint;
  65325. initialize(state: NodeMaterialBuildState): void;
  65326. autoConfigure(material: NodeMaterial): void;
  65327. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65328. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65329. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65330. protected _buildBlock(state: NodeMaterialBuildState): this;
  65331. }
  65332. }
  65333. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65334. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65335. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65336. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65337. import { Nullable } from "babylonjs/types";
  65338. import { Scene } from "babylonjs/scene";
  65339. import { Effect } from "babylonjs/Materials/effect";
  65340. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65341. import { Mesh } from "babylonjs/Meshes/mesh";
  65342. import { Light } from "babylonjs/Lights/light";
  65343. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65344. /**
  65345. * Block used to get data information from a light
  65346. */
  65347. export class LightInformationBlock extends NodeMaterialBlock {
  65348. private _lightDataUniformName;
  65349. private _lightColorUniformName;
  65350. private _lightTypeDefineName;
  65351. /**
  65352. * Gets or sets the light associated with this block
  65353. */
  65354. light: Nullable<Light>;
  65355. /**
  65356. * Creates a new LightInformationBlock
  65357. * @param name defines the block name
  65358. */
  65359. constructor(name: string);
  65360. /**
  65361. * Gets the current class name
  65362. * @returns the class name
  65363. */
  65364. getClassName(): string;
  65365. /**
  65366. * Gets the world position input component
  65367. */
  65368. get worldPosition(): NodeMaterialConnectionPoint;
  65369. /**
  65370. * Gets the direction output component
  65371. */
  65372. get direction(): NodeMaterialConnectionPoint;
  65373. /**
  65374. * Gets the direction output component
  65375. */
  65376. get color(): NodeMaterialConnectionPoint;
  65377. /**
  65378. * Gets the direction output component
  65379. */
  65380. get intensity(): NodeMaterialConnectionPoint;
  65381. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65382. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65383. protected _buildBlock(state: NodeMaterialBuildState): this;
  65384. serialize(): any;
  65385. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65386. }
  65387. }
  65388. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65389. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65390. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65391. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65392. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65393. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65394. }
  65395. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65396. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65397. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65398. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65400. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65401. import { Effect } from "babylonjs/Materials/effect";
  65402. import { Mesh } from "babylonjs/Meshes/mesh";
  65403. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65404. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65405. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65406. /**
  65407. * Block used to add image processing support to fragment shader
  65408. */
  65409. export class ImageProcessingBlock extends NodeMaterialBlock {
  65410. /**
  65411. * Create a new ImageProcessingBlock
  65412. * @param name defines the block name
  65413. */
  65414. constructor(name: string);
  65415. /**
  65416. * Gets the current class name
  65417. * @returns the class name
  65418. */
  65419. getClassName(): string;
  65420. /**
  65421. * Gets the color input component
  65422. */
  65423. get color(): NodeMaterialConnectionPoint;
  65424. /**
  65425. * Gets the output component
  65426. */
  65427. get output(): NodeMaterialConnectionPoint;
  65428. /**
  65429. * Initialize the block and prepare the context for build
  65430. * @param state defines the state that will be used for the build
  65431. */
  65432. initialize(state: NodeMaterialBuildState): void;
  65433. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65434. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65435. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65436. protected _buildBlock(state: NodeMaterialBuildState): this;
  65437. }
  65438. }
  65439. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65440. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65441. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65442. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65443. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65444. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65445. import { Effect } from "babylonjs/Materials/effect";
  65446. import { Mesh } from "babylonjs/Meshes/mesh";
  65447. import { Scene } from "babylonjs/scene";
  65448. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65449. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65450. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65451. /**
  65452. * Block used to pertub normals based on a normal map
  65453. */
  65454. export class PerturbNormalBlock extends NodeMaterialBlock {
  65455. private _tangentSpaceParameterName;
  65456. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65457. invertX: boolean;
  65458. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65459. invertY: boolean;
  65460. /**
  65461. * Create a new PerturbNormalBlock
  65462. * @param name defines the block name
  65463. */
  65464. constructor(name: string);
  65465. /**
  65466. * Gets the current class name
  65467. * @returns the class name
  65468. */
  65469. getClassName(): string;
  65470. /**
  65471. * Gets the world position input component
  65472. */
  65473. get worldPosition(): NodeMaterialConnectionPoint;
  65474. /**
  65475. * Gets the world normal input component
  65476. */
  65477. get worldNormal(): NodeMaterialConnectionPoint;
  65478. /**
  65479. * Gets the world tangent input component
  65480. */
  65481. get worldTangent(): NodeMaterialConnectionPoint;
  65482. /**
  65483. * Gets the uv input component
  65484. */
  65485. get uv(): NodeMaterialConnectionPoint;
  65486. /**
  65487. * Gets the normal map color input component
  65488. */
  65489. get normalMapColor(): NodeMaterialConnectionPoint;
  65490. /**
  65491. * Gets the strength input component
  65492. */
  65493. get strength(): NodeMaterialConnectionPoint;
  65494. /**
  65495. * Gets the output component
  65496. */
  65497. get output(): NodeMaterialConnectionPoint;
  65498. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65499. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65500. autoConfigure(material: NodeMaterial): void;
  65501. protected _buildBlock(state: NodeMaterialBuildState): this;
  65502. protected _dumpPropertiesCode(): string;
  65503. serialize(): any;
  65504. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65505. }
  65506. }
  65507. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65508. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65509. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65510. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65511. /**
  65512. * Block used to discard a pixel if a value is smaller than a cutoff
  65513. */
  65514. export class DiscardBlock extends NodeMaterialBlock {
  65515. /**
  65516. * Create a new DiscardBlock
  65517. * @param name defines the block name
  65518. */
  65519. constructor(name: string);
  65520. /**
  65521. * Gets the current class name
  65522. * @returns the class name
  65523. */
  65524. getClassName(): string;
  65525. /**
  65526. * Gets the color input component
  65527. */
  65528. get value(): NodeMaterialConnectionPoint;
  65529. /**
  65530. * Gets the cutoff input component
  65531. */
  65532. get cutoff(): NodeMaterialConnectionPoint;
  65533. protected _buildBlock(state: NodeMaterialBuildState): this;
  65534. }
  65535. }
  65536. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65537. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65538. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65539. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65540. /**
  65541. * Block used to test if the fragment shader is front facing
  65542. */
  65543. export class FrontFacingBlock extends NodeMaterialBlock {
  65544. /**
  65545. * Creates a new FrontFacingBlock
  65546. * @param name defines the block name
  65547. */
  65548. constructor(name: string);
  65549. /**
  65550. * Gets the current class name
  65551. * @returns the class name
  65552. */
  65553. getClassName(): string;
  65554. /**
  65555. * Gets the output component
  65556. */
  65557. get output(): NodeMaterialConnectionPoint;
  65558. protected _buildBlock(state: NodeMaterialBuildState): this;
  65559. }
  65560. }
  65561. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65562. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65563. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65564. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65565. /**
  65566. * Block used to get the derivative value on x and y of a given input
  65567. */
  65568. export class DerivativeBlock extends NodeMaterialBlock {
  65569. /**
  65570. * Create a new DerivativeBlock
  65571. * @param name defines the block name
  65572. */
  65573. constructor(name: string);
  65574. /**
  65575. * Gets the current class name
  65576. * @returns the class name
  65577. */
  65578. getClassName(): string;
  65579. /**
  65580. * Gets the input component
  65581. */
  65582. get input(): NodeMaterialConnectionPoint;
  65583. /**
  65584. * Gets the derivative output on x
  65585. */
  65586. get dx(): NodeMaterialConnectionPoint;
  65587. /**
  65588. * Gets the derivative output on y
  65589. */
  65590. get dy(): NodeMaterialConnectionPoint;
  65591. protected _buildBlock(state: NodeMaterialBuildState): this;
  65592. }
  65593. }
  65594. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65595. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65596. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65597. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65598. /**
  65599. * Block used to make gl_FragCoord available
  65600. */
  65601. export class FragCoordBlock extends NodeMaterialBlock {
  65602. /**
  65603. * Creates a new FragCoordBlock
  65604. * @param name defines the block name
  65605. */
  65606. constructor(name: string);
  65607. /**
  65608. * Gets the current class name
  65609. * @returns the class name
  65610. */
  65611. getClassName(): string;
  65612. /**
  65613. * Gets the xy component
  65614. */
  65615. get xy(): NodeMaterialConnectionPoint;
  65616. /**
  65617. * Gets the xyz component
  65618. */
  65619. get xyz(): NodeMaterialConnectionPoint;
  65620. /**
  65621. * Gets the xyzw component
  65622. */
  65623. get xyzw(): NodeMaterialConnectionPoint;
  65624. /**
  65625. * Gets the x component
  65626. */
  65627. get x(): NodeMaterialConnectionPoint;
  65628. /**
  65629. * Gets the y component
  65630. */
  65631. get y(): NodeMaterialConnectionPoint;
  65632. /**
  65633. * Gets the z component
  65634. */
  65635. get z(): NodeMaterialConnectionPoint;
  65636. /**
  65637. * Gets the w component
  65638. */
  65639. get output(): NodeMaterialConnectionPoint;
  65640. protected writeOutputs(state: NodeMaterialBuildState): string;
  65641. protected _buildBlock(state: NodeMaterialBuildState): this;
  65642. }
  65643. }
  65644. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65645. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65646. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65647. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65648. import { Effect } from "babylonjs/Materials/effect";
  65649. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65650. import { Mesh } from "babylonjs/Meshes/mesh";
  65651. /**
  65652. * Block used to get the screen sizes
  65653. */
  65654. export class ScreenSizeBlock extends NodeMaterialBlock {
  65655. private _varName;
  65656. private _scene;
  65657. /**
  65658. * Creates a new ScreenSizeBlock
  65659. * @param name defines the block name
  65660. */
  65661. constructor(name: string);
  65662. /**
  65663. * Gets the current class name
  65664. * @returns the class name
  65665. */
  65666. getClassName(): string;
  65667. /**
  65668. * Gets the xy component
  65669. */
  65670. get xy(): NodeMaterialConnectionPoint;
  65671. /**
  65672. * Gets the x component
  65673. */
  65674. get x(): NodeMaterialConnectionPoint;
  65675. /**
  65676. * Gets the y component
  65677. */
  65678. get y(): NodeMaterialConnectionPoint;
  65679. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65680. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65681. protected _buildBlock(state: NodeMaterialBuildState): this;
  65682. }
  65683. }
  65684. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65685. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65686. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65687. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65688. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65689. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65690. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65691. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65692. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65693. }
  65694. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65695. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65696. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65697. import { Mesh } from "babylonjs/Meshes/mesh";
  65698. import { Effect } from "babylonjs/Materials/effect";
  65699. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65700. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65701. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65702. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65703. /**
  65704. * Block used to add support for scene fog
  65705. */
  65706. export class FogBlock extends NodeMaterialBlock {
  65707. private _fogDistanceName;
  65708. private _fogParameters;
  65709. /**
  65710. * Create a new FogBlock
  65711. * @param name defines the block name
  65712. */
  65713. constructor(name: string);
  65714. /**
  65715. * Gets the current class name
  65716. * @returns the class name
  65717. */
  65718. getClassName(): string;
  65719. /**
  65720. * Gets the world position input component
  65721. */
  65722. get worldPosition(): NodeMaterialConnectionPoint;
  65723. /**
  65724. * Gets the view input component
  65725. */
  65726. get view(): NodeMaterialConnectionPoint;
  65727. /**
  65728. * Gets the color input component
  65729. */
  65730. get input(): NodeMaterialConnectionPoint;
  65731. /**
  65732. * Gets the fog color input component
  65733. */
  65734. get fogColor(): NodeMaterialConnectionPoint;
  65735. /**
  65736. * Gets the output component
  65737. */
  65738. get output(): NodeMaterialConnectionPoint;
  65739. autoConfigure(material: NodeMaterial): void;
  65740. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65741. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65742. protected _buildBlock(state: NodeMaterialBuildState): this;
  65743. }
  65744. }
  65745. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65746. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65747. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65748. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65750. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65751. import { Effect } from "babylonjs/Materials/effect";
  65752. import { Mesh } from "babylonjs/Meshes/mesh";
  65753. import { Light } from "babylonjs/Lights/light";
  65754. import { Nullable } from "babylonjs/types";
  65755. import { Scene } from "babylonjs/scene";
  65756. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65757. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65758. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65759. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65760. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65761. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65762. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65763. /**
  65764. * Block used to add light in the fragment shader
  65765. */
  65766. export class LightBlock extends NodeMaterialBlock {
  65767. private _lightId;
  65768. /**
  65769. * Gets or sets the light associated with this block
  65770. */
  65771. light: Nullable<Light>;
  65772. /**
  65773. * Create a new LightBlock
  65774. * @param name defines the block name
  65775. */
  65776. constructor(name: string);
  65777. /**
  65778. * Gets the current class name
  65779. * @returns the class name
  65780. */
  65781. getClassName(): string;
  65782. /**
  65783. * Gets the world position input component
  65784. */
  65785. get worldPosition(): NodeMaterialConnectionPoint;
  65786. /**
  65787. * Gets the world normal input component
  65788. */
  65789. get worldNormal(): NodeMaterialConnectionPoint;
  65790. /**
  65791. * Gets the camera (or eye) position component
  65792. */
  65793. get cameraPosition(): NodeMaterialConnectionPoint;
  65794. /**
  65795. * Gets the glossiness component
  65796. */
  65797. get glossiness(): NodeMaterialConnectionPoint;
  65798. /**
  65799. * Gets the glossinness power component
  65800. */
  65801. get glossPower(): NodeMaterialConnectionPoint;
  65802. /**
  65803. * Gets the diffuse color component
  65804. */
  65805. get diffuseColor(): NodeMaterialConnectionPoint;
  65806. /**
  65807. * Gets the specular color component
  65808. */
  65809. get specularColor(): NodeMaterialConnectionPoint;
  65810. /**
  65811. * Gets the diffuse output component
  65812. */
  65813. get diffuseOutput(): NodeMaterialConnectionPoint;
  65814. /**
  65815. * Gets the specular output component
  65816. */
  65817. get specularOutput(): NodeMaterialConnectionPoint;
  65818. /**
  65819. * Gets the shadow output component
  65820. */
  65821. get shadow(): NodeMaterialConnectionPoint;
  65822. autoConfigure(material: NodeMaterial): void;
  65823. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65824. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65825. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65826. private _injectVertexCode;
  65827. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65828. serialize(): any;
  65829. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65830. }
  65831. }
  65832. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65834. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65835. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65836. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65837. /**
  65838. * Block used to read a reflection texture from a sampler
  65839. */
  65840. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65841. /**
  65842. * Create a new ReflectionTextureBlock
  65843. * @param name defines the block name
  65844. */
  65845. constructor(name: string);
  65846. /**
  65847. * Gets the current class name
  65848. * @returns the class name
  65849. */
  65850. getClassName(): string;
  65851. /**
  65852. * Gets the world position input component
  65853. */
  65854. get position(): NodeMaterialConnectionPoint;
  65855. /**
  65856. * Gets the world position input component
  65857. */
  65858. get worldPosition(): NodeMaterialConnectionPoint;
  65859. /**
  65860. * Gets the world normal input component
  65861. */
  65862. get worldNormal(): NodeMaterialConnectionPoint;
  65863. /**
  65864. * Gets the world input component
  65865. */
  65866. get world(): NodeMaterialConnectionPoint;
  65867. /**
  65868. * Gets the camera (or eye) position component
  65869. */
  65870. get cameraPosition(): NodeMaterialConnectionPoint;
  65871. /**
  65872. * Gets the view input component
  65873. */
  65874. get view(): NodeMaterialConnectionPoint;
  65875. /**
  65876. * Gets the rgb output component
  65877. */
  65878. get rgb(): NodeMaterialConnectionPoint;
  65879. /**
  65880. * Gets the rgba output component
  65881. */
  65882. get rgba(): NodeMaterialConnectionPoint;
  65883. /**
  65884. * Gets the r output component
  65885. */
  65886. get r(): NodeMaterialConnectionPoint;
  65887. /**
  65888. * Gets the g output component
  65889. */
  65890. get g(): NodeMaterialConnectionPoint;
  65891. /**
  65892. * Gets the b output component
  65893. */
  65894. get b(): NodeMaterialConnectionPoint;
  65895. /**
  65896. * Gets the a output component
  65897. */
  65898. get a(): NodeMaterialConnectionPoint;
  65899. autoConfigure(material: NodeMaterial): void;
  65900. protected _buildBlock(state: NodeMaterialBuildState): this;
  65901. }
  65902. }
  65903. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65904. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65905. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65906. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65907. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65908. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65909. }
  65910. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65911. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65912. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65913. }
  65914. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65915. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65916. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65917. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65918. /**
  65919. * Block used to add 2 vectors
  65920. */
  65921. export class AddBlock extends NodeMaterialBlock {
  65922. /**
  65923. * Creates a new AddBlock
  65924. * @param name defines the block name
  65925. */
  65926. constructor(name: string);
  65927. /**
  65928. * Gets the current class name
  65929. * @returns the class name
  65930. */
  65931. getClassName(): string;
  65932. /**
  65933. * Gets the left operand input component
  65934. */
  65935. get left(): NodeMaterialConnectionPoint;
  65936. /**
  65937. * Gets the right operand input component
  65938. */
  65939. get right(): NodeMaterialConnectionPoint;
  65940. /**
  65941. * Gets the output component
  65942. */
  65943. get output(): NodeMaterialConnectionPoint;
  65944. protected _buildBlock(state: NodeMaterialBuildState): this;
  65945. }
  65946. }
  65947. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65948. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65949. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65950. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65951. /**
  65952. * Block used to scale a vector by a float
  65953. */
  65954. export class ScaleBlock extends NodeMaterialBlock {
  65955. /**
  65956. * Creates a new ScaleBlock
  65957. * @param name defines the block name
  65958. */
  65959. constructor(name: string);
  65960. /**
  65961. * Gets the current class name
  65962. * @returns the class name
  65963. */
  65964. getClassName(): string;
  65965. /**
  65966. * Gets the input component
  65967. */
  65968. get input(): NodeMaterialConnectionPoint;
  65969. /**
  65970. * Gets the factor input component
  65971. */
  65972. get factor(): NodeMaterialConnectionPoint;
  65973. /**
  65974. * Gets the output component
  65975. */
  65976. get output(): NodeMaterialConnectionPoint;
  65977. protected _buildBlock(state: NodeMaterialBuildState): this;
  65978. }
  65979. }
  65980. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65981. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65982. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65983. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65984. import { Scene } from "babylonjs/scene";
  65985. /**
  65986. * Block used to clamp a float
  65987. */
  65988. export class ClampBlock extends NodeMaterialBlock {
  65989. /** Gets or sets the minimum range */
  65990. minimum: number;
  65991. /** Gets or sets the maximum range */
  65992. maximum: number;
  65993. /**
  65994. * Creates a new ClampBlock
  65995. * @param name defines the block name
  65996. */
  65997. constructor(name: string);
  65998. /**
  65999. * Gets the current class name
  66000. * @returns the class name
  66001. */
  66002. getClassName(): string;
  66003. /**
  66004. * Gets the value input component
  66005. */
  66006. get value(): NodeMaterialConnectionPoint;
  66007. /**
  66008. * Gets the output component
  66009. */
  66010. get output(): NodeMaterialConnectionPoint;
  66011. protected _buildBlock(state: NodeMaterialBuildState): this;
  66012. protected _dumpPropertiesCode(): string;
  66013. serialize(): any;
  66014. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66015. }
  66016. }
  66017. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66018. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66019. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66020. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66021. /**
  66022. * Block used to apply a cross product between 2 vectors
  66023. */
  66024. export class CrossBlock extends NodeMaterialBlock {
  66025. /**
  66026. * Creates a new CrossBlock
  66027. * @param name defines the block name
  66028. */
  66029. constructor(name: string);
  66030. /**
  66031. * Gets the current class name
  66032. * @returns the class name
  66033. */
  66034. getClassName(): string;
  66035. /**
  66036. * Gets the left operand input component
  66037. */
  66038. get left(): NodeMaterialConnectionPoint;
  66039. /**
  66040. * Gets the right operand input component
  66041. */
  66042. get right(): NodeMaterialConnectionPoint;
  66043. /**
  66044. * Gets the output component
  66045. */
  66046. get output(): NodeMaterialConnectionPoint;
  66047. protected _buildBlock(state: NodeMaterialBuildState): this;
  66048. }
  66049. }
  66050. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66051. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66052. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66053. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66054. /**
  66055. * Block used to apply a dot product between 2 vectors
  66056. */
  66057. export class DotBlock extends NodeMaterialBlock {
  66058. /**
  66059. * Creates a new DotBlock
  66060. * @param name defines the block name
  66061. */
  66062. constructor(name: string);
  66063. /**
  66064. * Gets the current class name
  66065. * @returns the class name
  66066. */
  66067. getClassName(): string;
  66068. /**
  66069. * Gets the left operand input component
  66070. */
  66071. get left(): NodeMaterialConnectionPoint;
  66072. /**
  66073. * Gets the right operand input component
  66074. */
  66075. get right(): NodeMaterialConnectionPoint;
  66076. /**
  66077. * Gets the output component
  66078. */
  66079. get output(): NodeMaterialConnectionPoint;
  66080. protected _buildBlock(state: NodeMaterialBuildState): this;
  66081. }
  66082. }
  66083. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66084. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66085. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66086. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66087. /**
  66088. * Block used to normalize a vector
  66089. */
  66090. export class NormalizeBlock extends NodeMaterialBlock {
  66091. /**
  66092. * Creates a new NormalizeBlock
  66093. * @param name defines the block name
  66094. */
  66095. constructor(name: string);
  66096. /**
  66097. * Gets the current class name
  66098. * @returns the class name
  66099. */
  66100. getClassName(): string;
  66101. /**
  66102. * Gets the input component
  66103. */
  66104. get input(): NodeMaterialConnectionPoint;
  66105. /**
  66106. * Gets the output component
  66107. */
  66108. get output(): NodeMaterialConnectionPoint;
  66109. protected _buildBlock(state: NodeMaterialBuildState): this;
  66110. }
  66111. }
  66112. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66113. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66114. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66115. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66116. import { Scene } from "babylonjs/scene";
  66117. /**
  66118. * Operations supported by the Trigonometry block
  66119. */
  66120. export enum TrigonometryBlockOperations {
  66121. /** Cos */
  66122. Cos = 0,
  66123. /** Sin */
  66124. Sin = 1,
  66125. /** Abs */
  66126. Abs = 2,
  66127. /** Exp */
  66128. Exp = 3,
  66129. /** Exp2 */
  66130. Exp2 = 4,
  66131. /** Round */
  66132. Round = 5,
  66133. /** Floor */
  66134. Floor = 6,
  66135. /** Ceiling */
  66136. Ceiling = 7,
  66137. /** Square root */
  66138. Sqrt = 8,
  66139. /** Log */
  66140. Log = 9,
  66141. /** Tangent */
  66142. Tan = 10,
  66143. /** Arc tangent */
  66144. ArcTan = 11,
  66145. /** Arc cosinus */
  66146. ArcCos = 12,
  66147. /** Arc sinus */
  66148. ArcSin = 13,
  66149. /** Fraction */
  66150. Fract = 14,
  66151. /** Sign */
  66152. Sign = 15,
  66153. /** To radians (from degrees) */
  66154. Radians = 16,
  66155. /** To degrees (from radians) */
  66156. Degrees = 17
  66157. }
  66158. /**
  66159. * Block used to apply trigonometry operation to floats
  66160. */
  66161. export class TrigonometryBlock extends NodeMaterialBlock {
  66162. /**
  66163. * Gets or sets the operation applied by the block
  66164. */
  66165. operation: TrigonometryBlockOperations;
  66166. /**
  66167. * Creates a new TrigonometryBlock
  66168. * @param name defines the block name
  66169. */
  66170. constructor(name: string);
  66171. /**
  66172. * Gets the current class name
  66173. * @returns the class name
  66174. */
  66175. getClassName(): string;
  66176. /**
  66177. * Gets the input component
  66178. */
  66179. get input(): NodeMaterialConnectionPoint;
  66180. /**
  66181. * Gets the output component
  66182. */
  66183. get output(): NodeMaterialConnectionPoint;
  66184. protected _buildBlock(state: NodeMaterialBuildState): this;
  66185. serialize(): any;
  66186. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66187. protected _dumpPropertiesCode(): string;
  66188. }
  66189. }
  66190. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66191. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66192. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66193. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66194. /**
  66195. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66196. */
  66197. export class ColorMergerBlock extends NodeMaterialBlock {
  66198. /**
  66199. * Create a new ColorMergerBlock
  66200. * @param name defines the block name
  66201. */
  66202. constructor(name: string);
  66203. /**
  66204. * Gets the current class name
  66205. * @returns the class name
  66206. */
  66207. getClassName(): string;
  66208. /**
  66209. * Gets the rgb component (input)
  66210. */
  66211. get rgbIn(): NodeMaterialConnectionPoint;
  66212. /**
  66213. * Gets the r component (input)
  66214. */
  66215. get r(): NodeMaterialConnectionPoint;
  66216. /**
  66217. * Gets the g component (input)
  66218. */
  66219. get g(): NodeMaterialConnectionPoint;
  66220. /**
  66221. * Gets the b component (input)
  66222. */
  66223. get b(): NodeMaterialConnectionPoint;
  66224. /**
  66225. * Gets the a component (input)
  66226. */
  66227. get a(): NodeMaterialConnectionPoint;
  66228. /**
  66229. * Gets the rgba component (output)
  66230. */
  66231. get rgba(): NodeMaterialConnectionPoint;
  66232. /**
  66233. * Gets the rgb component (output)
  66234. */
  66235. get rgbOut(): NodeMaterialConnectionPoint;
  66236. /**
  66237. * Gets the rgb component (output)
  66238. * @deprecated Please use rgbOut instead.
  66239. */
  66240. get rgb(): NodeMaterialConnectionPoint;
  66241. protected _buildBlock(state: NodeMaterialBuildState): this;
  66242. }
  66243. }
  66244. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66245. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66247. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66248. /**
  66249. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66250. */
  66251. export class VectorSplitterBlock extends NodeMaterialBlock {
  66252. /**
  66253. * Create a new VectorSplitterBlock
  66254. * @param name defines the block name
  66255. */
  66256. constructor(name: string);
  66257. /**
  66258. * Gets the current class name
  66259. * @returns the class name
  66260. */
  66261. getClassName(): string;
  66262. /**
  66263. * Gets the xyzw component (input)
  66264. */
  66265. get xyzw(): NodeMaterialConnectionPoint;
  66266. /**
  66267. * Gets the xyz component (input)
  66268. */
  66269. get xyzIn(): NodeMaterialConnectionPoint;
  66270. /**
  66271. * Gets the xy component (input)
  66272. */
  66273. get xyIn(): NodeMaterialConnectionPoint;
  66274. /**
  66275. * Gets the xyz component (output)
  66276. */
  66277. get xyzOut(): NodeMaterialConnectionPoint;
  66278. /**
  66279. * Gets the xy component (output)
  66280. */
  66281. get xyOut(): NodeMaterialConnectionPoint;
  66282. /**
  66283. * Gets the x component (output)
  66284. */
  66285. get x(): NodeMaterialConnectionPoint;
  66286. /**
  66287. * Gets the y component (output)
  66288. */
  66289. get y(): NodeMaterialConnectionPoint;
  66290. /**
  66291. * Gets the z component (output)
  66292. */
  66293. get z(): NodeMaterialConnectionPoint;
  66294. /**
  66295. * Gets the w component (output)
  66296. */
  66297. get w(): NodeMaterialConnectionPoint;
  66298. protected _inputRename(name: string): string;
  66299. protected _outputRename(name: string): string;
  66300. protected _buildBlock(state: NodeMaterialBuildState): this;
  66301. }
  66302. }
  66303. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66304. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66305. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66306. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66307. /**
  66308. * Block used to lerp between 2 values
  66309. */
  66310. export class LerpBlock extends NodeMaterialBlock {
  66311. /**
  66312. * Creates a new LerpBlock
  66313. * @param name defines the block name
  66314. */
  66315. constructor(name: string);
  66316. /**
  66317. * Gets the current class name
  66318. * @returns the class name
  66319. */
  66320. getClassName(): string;
  66321. /**
  66322. * Gets the left operand input component
  66323. */
  66324. get left(): NodeMaterialConnectionPoint;
  66325. /**
  66326. * Gets the right operand input component
  66327. */
  66328. get right(): NodeMaterialConnectionPoint;
  66329. /**
  66330. * Gets the gradient operand input component
  66331. */
  66332. get gradient(): NodeMaterialConnectionPoint;
  66333. /**
  66334. * Gets the output component
  66335. */
  66336. get output(): NodeMaterialConnectionPoint;
  66337. protected _buildBlock(state: NodeMaterialBuildState): this;
  66338. }
  66339. }
  66340. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66341. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66342. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66343. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66344. /**
  66345. * Block used to divide 2 vectors
  66346. */
  66347. export class DivideBlock extends NodeMaterialBlock {
  66348. /**
  66349. * Creates a new DivideBlock
  66350. * @param name defines the block name
  66351. */
  66352. constructor(name: string);
  66353. /**
  66354. * Gets the current class name
  66355. * @returns the class name
  66356. */
  66357. getClassName(): string;
  66358. /**
  66359. * Gets the left operand input component
  66360. */
  66361. get left(): NodeMaterialConnectionPoint;
  66362. /**
  66363. * Gets the right operand input component
  66364. */
  66365. get right(): NodeMaterialConnectionPoint;
  66366. /**
  66367. * Gets the output component
  66368. */
  66369. get output(): NodeMaterialConnectionPoint;
  66370. protected _buildBlock(state: NodeMaterialBuildState): this;
  66371. }
  66372. }
  66373. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66374. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66375. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66376. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66377. /**
  66378. * Block used to subtract 2 vectors
  66379. */
  66380. export class SubtractBlock extends NodeMaterialBlock {
  66381. /**
  66382. * Creates a new SubtractBlock
  66383. * @param name defines the block name
  66384. */
  66385. constructor(name: string);
  66386. /**
  66387. * Gets the current class name
  66388. * @returns the class name
  66389. */
  66390. getClassName(): string;
  66391. /**
  66392. * Gets the left operand input component
  66393. */
  66394. get left(): NodeMaterialConnectionPoint;
  66395. /**
  66396. * Gets the right operand input component
  66397. */
  66398. get right(): NodeMaterialConnectionPoint;
  66399. /**
  66400. * Gets the output component
  66401. */
  66402. get output(): NodeMaterialConnectionPoint;
  66403. protected _buildBlock(state: NodeMaterialBuildState): this;
  66404. }
  66405. }
  66406. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66407. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66408. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66409. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66410. /**
  66411. * Block used to step a value
  66412. */
  66413. export class StepBlock extends NodeMaterialBlock {
  66414. /**
  66415. * Creates a new StepBlock
  66416. * @param name defines the block name
  66417. */
  66418. constructor(name: string);
  66419. /**
  66420. * Gets the current class name
  66421. * @returns the class name
  66422. */
  66423. getClassName(): string;
  66424. /**
  66425. * Gets the value operand input component
  66426. */
  66427. get value(): NodeMaterialConnectionPoint;
  66428. /**
  66429. * Gets the edge operand input component
  66430. */
  66431. get edge(): NodeMaterialConnectionPoint;
  66432. /**
  66433. * Gets the output component
  66434. */
  66435. get output(): NodeMaterialConnectionPoint;
  66436. protected _buildBlock(state: NodeMaterialBuildState): this;
  66437. }
  66438. }
  66439. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66440. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66441. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66442. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66443. /**
  66444. * Block used to get the opposite (1 - x) of a value
  66445. */
  66446. export class OneMinusBlock extends NodeMaterialBlock {
  66447. /**
  66448. * Creates a new OneMinusBlock
  66449. * @param name defines the block name
  66450. */
  66451. constructor(name: string);
  66452. /**
  66453. * Gets the current class name
  66454. * @returns the class name
  66455. */
  66456. getClassName(): string;
  66457. /**
  66458. * Gets the input component
  66459. */
  66460. get input(): NodeMaterialConnectionPoint;
  66461. /**
  66462. * Gets the output component
  66463. */
  66464. get output(): NodeMaterialConnectionPoint;
  66465. protected _buildBlock(state: NodeMaterialBuildState): this;
  66466. }
  66467. }
  66468. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66469. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66470. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66471. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66472. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66473. /**
  66474. * Block used to get the view direction
  66475. */
  66476. export class ViewDirectionBlock extends NodeMaterialBlock {
  66477. /**
  66478. * Creates a new ViewDirectionBlock
  66479. * @param name defines the block name
  66480. */
  66481. constructor(name: string);
  66482. /**
  66483. * Gets the current class name
  66484. * @returns the class name
  66485. */
  66486. getClassName(): string;
  66487. /**
  66488. * Gets the world position component
  66489. */
  66490. get worldPosition(): NodeMaterialConnectionPoint;
  66491. /**
  66492. * Gets the camera position component
  66493. */
  66494. get cameraPosition(): NodeMaterialConnectionPoint;
  66495. /**
  66496. * Gets the output component
  66497. */
  66498. get output(): NodeMaterialConnectionPoint;
  66499. autoConfigure(material: NodeMaterial): void;
  66500. protected _buildBlock(state: NodeMaterialBuildState): this;
  66501. }
  66502. }
  66503. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66504. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66505. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66506. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66507. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66508. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66509. /**
  66510. * Block used to compute fresnel value
  66511. */
  66512. export class FresnelBlock extends NodeMaterialBlock {
  66513. /**
  66514. * Create a new FresnelBlock
  66515. * @param name defines the block name
  66516. */
  66517. constructor(name: string);
  66518. /**
  66519. * Gets the current class name
  66520. * @returns the class name
  66521. */
  66522. getClassName(): string;
  66523. /**
  66524. * Gets the world normal input component
  66525. */
  66526. get worldNormal(): NodeMaterialConnectionPoint;
  66527. /**
  66528. * Gets the view direction input component
  66529. */
  66530. get viewDirection(): NodeMaterialConnectionPoint;
  66531. /**
  66532. * Gets the bias input component
  66533. */
  66534. get bias(): NodeMaterialConnectionPoint;
  66535. /**
  66536. * Gets the camera (or eye) position component
  66537. */
  66538. get power(): NodeMaterialConnectionPoint;
  66539. /**
  66540. * Gets the fresnel output component
  66541. */
  66542. get fresnel(): NodeMaterialConnectionPoint;
  66543. autoConfigure(material: NodeMaterial): void;
  66544. protected _buildBlock(state: NodeMaterialBuildState): this;
  66545. }
  66546. }
  66547. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66548. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66549. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66550. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66551. /**
  66552. * Block used to get the max of 2 values
  66553. */
  66554. export class MaxBlock extends NodeMaterialBlock {
  66555. /**
  66556. * Creates a new MaxBlock
  66557. * @param name defines the block name
  66558. */
  66559. constructor(name: string);
  66560. /**
  66561. * Gets the current class name
  66562. * @returns the class name
  66563. */
  66564. getClassName(): string;
  66565. /**
  66566. * Gets the left operand input component
  66567. */
  66568. get left(): NodeMaterialConnectionPoint;
  66569. /**
  66570. * Gets the right operand input component
  66571. */
  66572. get right(): NodeMaterialConnectionPoint;
  66573. /**
  66574. * Gets the output component
  66575. */
  66576. get output(): NodeMaterialConnectionPoint;
  66577. protected _buildBlock(state: NodeMaterialBuildState): this;
  66578. }
  66579. }
  66580. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66581. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66582. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66583. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66584. /**
  66585. * Block used to get the min of 2 values
  66586. */
  66587. export class MinBlock extends NodeMaterialBlock {
  66588. /**
  66589. * Creates a new MinBlock
  66590. * @param name defines the block name
  66591. */
  66592. constructor(name: string);
  66593. /**
  66594. * Gets the current class name
  66595. * @returns the class name
  66596. */
  66597. getClassName(): string;
  66598. /**
  66599. * Gets the left operand input component
  66600. */
  66601. get left(): NodeMaterialConnectionPoint;
  66602. /**
  66603. * Gets the right operand input component
  66604. */
  66605. get right(): NodeMaterialConnectionPoint;
  66606. /**
  66607. * Gets the output component
  66608. */
  66609. get output(): NodeMaterialConnectionPoint;
  66610. protected _buildBlock(state: NodeMaterialBuildState): this;
  66611. }
  66612. }
  66613. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66614. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66615. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66616. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66617. /**
  66618. * Block used to get the distance between 2 values
  66619. */
  66620. export class DistanceBlock extends NodeMaterialBlock {
  66621. /**
  66622. * Creates a new DistanceBlock
  66623. * @param name defines the block name
  66624. */
  66625. constructor(name: string);
  66626. /**
  66627. * Gets the current class name
  66628. * @returns the class name
  66629. */
  66630. getClassName(): string;
  66631. /**
  66632. * Gets the left operand input component
  66633. */
  66634. get left(): NodeMaterialConnectionPoint;
  66635. /**
  66636. * Gets the right operand input component
  66637. */
  66638. get right(): NodeMaterialConnectionPoint;
  66639. /**
  66640. * Gets the output component
  66641. */
  66642. get output(): NodeMaterialConnectionPoint;
  66643. protected _buildBlock(state: NodeMaterialBuildState): this;
  66644. }
  66645. }
  66646. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66647. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66648. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66649. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66650. /**
  66651. * Block used to get the length of a vector
  66652. */
  66653. export class LengthBlock extends NodeMaterialBlock {
  66654. /**
  66655. * Creates a new LengthBlock
  66656. * @param name defines the block name
  66657. */
  66658. constructor(name: string);
  66659. /**
  66660. * Gets the current class name
  66661. * @returns the class name
  66662. */
  66663. getClassName(): string;
  66664. /**
  66665. * Gets the value input component
  66666. */
  66667. get value(): NodeMaterialConnectionPoint;
  66668. /**
  66669. * Gets the output component
  66670. */
  66671. get output(): NodeMaterialConnectionPoint;
  66672. protected _buildBlock(state: NodeMaterialBuildState): this;
  66673. }
  66674. }
  66675. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66676. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66677. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66678. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66679. /**
  66680. * Block used to get negative version of a value (i.e. x * -1)
  66681. */
  66682. export class NegateBlock extends NodeMaterialBlock {
  66683. /**
  66684. * Creates a new NegateBlock
  66685. * @param name defines the block name
  66686. */
  66687. constructor(name: string);
  66688. /**
  66689. * Gets the current class name
  66690. * @returns the class name
  66691. */
  66692. getClassName(): string;
  66693. /**
  66694. * Gets the value input component
  66695. */
  66696. get value(): NodeMaterialConnectionPoint;
  66697. /**
  66698. * Gets the output component
  66699. */
  66700. get output(): NodeMaterialConnectionPoint;
  66701. protected _buildBlock(state: NodeMaterialBuildState): this;
  66702. }
  66703. }
  66704. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66705. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66706. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66707. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66708. /**
  66709. * Block used to get the value of the first parameter raised to the power of the second
  66710. */
  66711. export class PowBlock extends NodeMaterialBlock {
  66712. /**
  66713. * Creates a new PowBlock
  66714. * @param name defines the block name
  66715. */
  66716. constructor(name: string);
  66717. /**
  66718. * Gets the current class name
  66719. * @returns the class name
  66720. */
  66721. getClassName(): string;
  66722. /**
  66723. * Gets the value operand input component
  66724. */
  66725. get value(): NodeMaterialConnectionPoint;
  66726. /**
  66727. * Gets the power operand input component
  66728. */
  66729. get power(): NodeMaterialConnectionPoint;
  66730. /**
  66731. * Gets the output component
  66732. */
  66733. get output(): NodeMaterialConnectionPoint;
  66734. protected _buildBlock(state: NodeMaterialBuildState): this;
  66735. }
  66736. }
  66737. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66738. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66739. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66740. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66741. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66742. /**
  66743. * Block used to get a random number
  66744. */
  66745. export class RandomNumberBlock extends NodeMaterialBlock {
  66746. /**
  66747. * Creates a new RandomNumberBlock
  66748. * @param name defines the block name
  66749. */
  66750. constructor(name: string);
  66751. /**
  66752. * Gets the current class name
  66753. * @returns the class name
  66754. */
  66755. getClassName(): string;
  66756. /**
  66757. * Gets the seed input component
  66758. */
  66759. get seed(): NodeMaterialConnectionPoint;
  66760. /**
  66761. * Gets the output component
  66762. */
  66763. get output(): NodeMaterialConnectionPoint;
  66764. protected _buildBlock(state: NodeMaterialBuildState): this;
  66765. }
  66766. }
  66767. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66768. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66769. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66770. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66771. /**
  66772. * Block used to compute arc tangent of 2 values
  66773. */
  66774. export class ArcTan2Block extends NodeMaterialBlock {
  66775. /**
  66776. * Creates a new ArcTan2Block
  66777. * @param name defines the block name
  66778. */
  66779. constructor(name: string);
  66780. /**
  66781. * Gets the current class name
  66782. * @returns the class name
  66783. */
  66784. getClassName(): string;
  66785. /**
  66786. * Gets the x operand input component
  66787. */
  66788. get x(): NodeMaterialConnectionPoint;
  66789. /**
  66790. * Gets the y operand input component
  66791. */
  66792. get y(): NodeMaterialConnectionPoint;
  66793. /**
  66794. * Gets the output component
  66795. */
  66796. get output(): NodeMaterialConnectionPoint;
  66797. protected _buildBlock(state: NodeMaterialBuildState): this;
  66798. }
  66799. }
  66800. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66801. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66802. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66803. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66804. /**
  66805. * Block used to smooth step a value
  66806. */
  66807. export class SmoothStepBlock extends NodeMaterialBlock {
  66808. /**
  66809. * Creates a new SmoothStepBlock
  66810. * @param name defines the block name
  66811. */
  66812. constructor(name: string);
  66813. /**
  66814. * Gets the current class name
  66815. * @returns the class name
  66816. */
  66817. getClassName(): string;
  66818. /**
  66819. * Gets the value operand input component
  66820. */
  66821. get value(): NodeMaterialConnectionPoint;
  66822. /**
  66823. * Gets the first edge operand input component
  66824. */
  66825. get edge0(): NodeMaterialConnectionPoint;
  66826. /**
  66827. * Gets the second edge operand input component
  66828. */
  66829. get edge1(): NodeMaterialConnectionPoint;
  66830. /**
  66831. * Gets the output component
  66832. */
  66833. get output(): NodeMaterialConnectionPoint;
  66834. protected _buildBlock(state: NodeMaterialBuildState): this;
  66835. }
  66836. }
  66837. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66838. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66839. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66840. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66841. /**
  66842. * Block used to get the reciprocal (1 / x) of a value
  66843. */
  66844. export class ReciprocalBlock extends NodeMaterialBlock {
  66845. /**
  66846. * Creates a new ReciprocalBlock
  66847. * @param name defines the block name
  66848. */
  66849. constructor(name: string);
  66850. /**
  66851. * Gets the current class name
  66852. * @returns the class name
  66853. */
  66854. getClassName(): string;
  66855. /**
  66856. * Gets the input component
  66857. */
  66858. get input(): NodeMaterialConnectionPoint;
  66859. /**
  66860. * Gets the output component
  66861. */
  66862. get output(): NodeMaterialConnectionPoint;
  66863. protected _buildBlock(state: NodeMaterialBuildState): this;
  66864. }
  66865. }
  66866. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66867. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66868. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66869. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66870. /**
  66871. * Block used to replace a color by another one
  66872. */
  66873. export class ReplaceColorBlock extends NodeMaterialBlock {
  66874. /**
  66875. * Creates a new ReplaceColorBlock
  66876. * @param name defines the block name
  66877. */
  66878. constructor(name: string);
  66879. /**
  66880. * Gets the current class name
  66881. * @returns the class name
  66882. */
  66883. getClassName(): string;
  66884. /**
  66885. * Gets the value input component
  66886. */
  66887. get value(): NodeMaterialConnectionPoint;
  66888. /**
  66889. * Gets the reference input component
  66890. */
  66891. get reference(): NodeMaterialConnectionPoint;
  66892. /**
  66893. * Gets the distance input component
  66894. */
  66895. get distance(): NodeMaterialConnectionPoint;
  66896. /**
  66897. * Gets the replacement input component
  66898. */
  66899. get replacement(): NodeMaterialConnectionPoint;
  66900. /**
  66901. * Gets the output component
  66902. */
  66903. get output(): NodeMaterialConnectionPoint;
  66904. protected _buildBlock(state: NodeMaterialBuildState): this;
  66905. }
  66906. }
  66907. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66908. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66909. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66910. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66911. /**
  66912. * Block used to posterize a value
  66913. * @see https://en.wikipedia.org/wiki/Posterization
  66914. */
  66915. export class PosterizeBlock extends NodeMaterialBlock {
  66916. /**
  66917. * Creates a new PosterizeBlock
  66918. * @param name defines the block name
  66919. */
  66920. constructor(name: string);
  66921. /**
  66922. * Gets the current class name
  66923. * @returns the class name
  66924. */
  66925. getClassName(): string;
  66926. /**
  66927. * Gets the value input component
  66928. */
  66929. get value(): NodeMaterialConnectionPoint;
  66930. /**
  66931. * Gets the steps input component
  66932. */
  66933. get steps(): NodeMaterialConnectionPoint;
  66934. /**
  66935. * Gets the output component
  66936. */
  66937. get output(): NodeMaterialConnectionPoint;
  66938. protected _buildBlock(state: NodeMaterialBuildState): this;
  66939. }
  66940. }
  66941. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66942. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66943. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66944. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66945. import { Scene } from "babylonjs/scene";
  66946. /**
  66947. * Operations supported by the Wave block
  66948. */
  66949. export enum WaveBlockKind {
  66950. /** SawTooth */
  66951. SawTooth = 0,
  66952. /** Square */
  66953. Square = 1,
  66954. /** Triangle */
  66955. Triangle = 2
  66956. }
  66957. /**
  66958. * Block used to apply wave operation to floats
  66959. */
  66960. export class WaveBlock extends NodeMaterialBlock {
  66961. /**
  66962. * Gets or sets the kibnd of wave to be applied by the block
  66963. */
  66964. kind: WaveBlockKind;
  66965. /**
  66966. * Creates a new WaveBlock
  66967. * @param name defines the block name
  66968. */
  66969. constructor(name: string);
  66970. /**
  66971. * Gets the current class name
  66972. * @returns the class name
  66973. */
  66974. getClassName(): string;
  66975. /**
  66976. * Gets the input component
  66977. */
  66978. get input(): NodeMaterialConnectionPoint;
  66979. /**
  66980. * Gets the output component
  66981. */
  66982. get output(): NodeMaterialConnectionPoint;
  66983. protected _buildBlock(state: NodeMaterialBuildState): this;
  66984. serialize(): any;
  66985. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66986. }
  66987. }
  66988. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66989. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66990. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66991. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66992. import { Color3 } from "babylonjs/Maths/math.color";
  66993. import { Scene } from "babylonjs/scene";
  66994. /**
  66995. * Class used to store a color step for the GradientBlock
  66996. */
  66997. export class GradientBlockColorStep {
  66998. /**
  66999. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67000. */
  67001. step: number;
  67002. /**
  67003. * Gets or sets the color associated with this step
  67004. */
  67005. color: Color3;
  67006. /**
  67007. * Creates a new GradientBlockColorStep
  67008. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67009. * @param color defines the color associated with this step
  67010. */
  67011. constructor(
  67012. /**
  67013. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67014. */
  67015. step: number,
  67016. /**
  67017. * Gets or sets the color associated with this step
  67018. */
  67019. color: Color3);
  67020. }
  67021. /**
  67022. * Block used to return a color from a gradient based on an input value between 0 and 1
  67023. */
  67024. export class GradientBlock extends NodeMaterialBlock {
  67025. /**
  67026. * Gets or sets the list of color steps
  67027. */
  67028. colorSteps: GradientBlockColorStep[];
  67029. /**
  67030. * Creates a new GradientBlock
  67031. * @param name defines the block name
  67032. */
  67033. constructor(name: string);
  67034. /**
  67035. * Gets the current class name
  67036. * @returns the class name
  67037. */
  67038. getClassName(): string;
  67039. /**
  67040. * Gets the gradient input component
  67041. */
  67042. get gradient(): NodeMaterialConnectionPoint;
  67043. /**
  67044. * Gets the output component
  67045. */
  67046. get output(): NodeMaterialConnectionPoint;
  67047. private _writeColorConstant;
  67048. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67049. serialize(): any;
  67050. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67051. protected _dumpPropertiesCode(): string;
  67052. }
  67053. }
  67054. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67055. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67056. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67057. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67058. /**
  67059. * Block used to normalize lerp between 2 values
  67060. */
  67061. export class NLerpBlock extends NodeMaterialBlock {
  67062. /**
  67063. * Creates a new NLerpBlock
  67064. * @param name defines the block name
  67065. */
  67066. constructor(name: string);
  67067. /**
  67068. * Gets the current class name
  67069. * @returns the class name
  67070. */
  67071. getClassName(): string;
  67072. /**
  67073. * Gets the left operand input component
  67074. */
  67075. get left(): NodeMaterialConnectionPoint;
  67076. /**
  67077. * Gets the right operand input component
  67078. */
  67079. get right(): NodeMaterialConnectionPoint;
  67080. /**
  67081. * Gets the gradient operand input component
  67082. */
  67083. get gradient(): NodeMaterialConnectionPoint;
  67084. /**
  67085. * Gets the output component
  67086. */
  67087. get output(): NodeMaterialConnectionPoint;
  67088. protected _buildBlock(state: NodeMaterialBuildState): this;
  67089. }
  67090. }
  67091. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67092. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67093. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67094. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67095. import { Scene } from "babylonjs/scene";
  67096. /**
  67097. * block used to Generate a Worley Noise 3D Noise Pattern
  67098. */
  67099. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67100. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67101. manhattanDistance: boolean;
  67102. /**
  67103. * Creates a new WorleyNoise3DBlock
  67104. * @param name defines the block name
  67105. */
  67106. constructor(name: string);
  67107. /**
  67108. * Gets the current class name
  67109. * @returns the class name
  67110. */
  67111. getClassName(): string;
  67112. /**
  67113. * Gets the seed input component
  67114. */
  67115. get seed(): NodeMaterialConnectionPoint;
  67116. /**
  67117. * Gets the jitter input component
  67118. */
  67119. get jitter(): NodeMaterialConnectionPoint;
  67120. /**
  67121. * Gets the output component
  67122. */
  67123. get output(): NodeMaterialConnectionPoint;
  67124. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67125. /**
  67126. * Exposes the properties to the UI?
  67127. */
  67128. protected _dumpPropertiesCode(): string;
  67129. /**
  67130. * Exposes the properties to the Seralize?
  67131. */
  67132. serialize(): any;
  67133. /**
  67134. * Exposes the properties to the deseralize?
  67135. */
  67136. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67137. }
  67138. }
  67139. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67140. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67141. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67142. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67143. /**
  67144. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67145. */
  67146. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67147. /**
  67148. * Creates a new SimplexPerlin3DBlock
  67149. * @param name defines the block name
  67150. */
  67151. constructor(name: string);
  67152. /**
  67153. * Gets the current class name
  67154. * @returns the class name
  67155. */
  67156. getClassName(): string;
  67157. /**
  67158. * Gets the seed operand input component
  67159. */
  67160. get seed(): NodeMaterialConnectionPoint;
  67161. /**
  67162. * Gets the output component
  67163. */
  67164. get output(): NodeMaterialConnectionPoint;
  67165. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67166. }
  67167. }
  67168. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67169. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67170. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67171. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67172. /**
  67173. * Block used to blend normals
  67174. */
  67175. export class NormalBlendBlock extends NodeMaterialBlock {
  67176. /**
  67177. * Creates a new NormalBlendBlock
  67178. * @param name defines the block name
  67179. */
  67180. constructor(name: string);
  67181. /**
  67182. * Gets the current class name
  67183. * @returns the class name
  67184. */
  67185. getClassName(): string;
  67186. /**
  67187. * Gets the first input component
  67188. */
  67189. get normalMap0(): NodeMaterialConnectionPoint;
  67190. /**
  67191. * Gets the second input component
  67192. */
  67193. get normalMap1(): NodeMaterialConnectionPoint;
  67194. /**
  67195. * Gets the output component
  67196. */
  67197. get output(): NodeMaterialConnectionPoint;
  67198. protected _buildBlock(state: NodeMaterialBuildState): this;
  67199. }
  67200. }
  67201. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67202. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67203. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67204. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67205. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67206. /**
  67207. * Block used to rotate a 2d vector by a given angle
  67208. */
  67209. export class Rotate2dBlock extends NodeMaterialBlock {
  67210. /**
  67211. * Creates a new Rotate2dBlock
  67212. * @param name defines the block name
  67213. */
  67214. constructor(name: string);
  67215. /**
  67216. * Gets the current class name
  67217. * @returns the class name
  67218. */
  67219. getClassName(): string;
  67220. /**
  67221. * Gets the input vector
  67222. */
  67223. get input(): NodeMaterialConnectionPoint;
  67224. /**
  67225. * Gets the input angle
  67226. */
  67227. get angle(): NodeMaterialConnectionPoint;
  67228. /**
  67229. * Gets the output component
  67230. */
  67231. get output(): NodeMaterialConnectionPoint;
  67232. autoConfigure(material: NodeMaterial): void;
  67233. protected _buildBlock(state: NodeMaterialBuildState): this;
  67234. }
  67235. }
  67236. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67237. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67238. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67239. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67240. /**
  67241. * Block used to get the reflected vector from a direction and a normal
  67242. */
  67243. export class ReflectBlock extends NodeMaterialBlock {
  67244. /**
  67245. * Creates a new ReflectBlock
  67246. * @param name defines the block name
  67247. */
  67248. constructor(name: string);
  67249. /**
  67250. * Gets the current class name
  67251. * @returns the class name
  67252. */
  67253. getClassName(): string;
  67254. /**
  67255. * Gets the incident component
  67256. */
  67257. get incident(): NodeMaterialConnectionPoint;
  67258. /**
  67259. * Gets the normal component
  67260. */
  67261. get normal(): NodeMaterialConnectionPoint;
  67262. /**
  67263. * Gets the output component
  67264. */
  67265. get output(): NodeMaterialConnectionPoint;
  67266. protected _buildBlock(state: NodeMaterialBuildState): this;
  67267. }
  67268. }
  67269. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67270. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67271. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67272. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67273. /**
  67274. * Block used to get the refracted vector from a direction and a normal
  67275. */
  67276. export class RefractBlock extends NodeMaterialBlock {
  67277. /**
  67278. * Creates a new RefractBlock
  67279. * @param name defines the block name
  67280. */
  67281. constructor(name: string);
  67282. /**
  67283. * Gets the current class name
  67284. * @returns the class name
  67285. */
  67286. getClassName(): string;
  67287. /**
  67288. * Gets the incident component
  67289. */
  67290. get incident(): NodeMaterialConnectionPoint;
  67291. /**
  67292. * Gets the normal component
  67293. */
  67294. get normal(): NodeMaterialConnectionPoint;
  67295. /**
  67296. * Gets the index of refraction component
  67297. */
  67298. get ior(): NodeMaterialConnectionPoint;
  67299. /**
  67300. * Gets the output component
  67301. */
  67302. get output(): NodeMaterialConnectionPoint;
  67303. protected _buildBlock(state: NodeMaterialBuildState): this;
  67304. }
  67305. }
  67306. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67307. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67308. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67309. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67310. /**
  67311. * Block used to desaturate a color
  67312. */
  67313. export class DesaturateBlock extends NodeMaterialBlock {
  67314. /**
  67315. * Creates a new DesaturateBlock
  67316. * @param name defines the block name
  67317. */
  67318. constructor(name: string);
  67319. /**
  67320. * Gets the current class name
  67321. * @returns the class name
  67322. */
  67323. getClassName(): string;
  67324. /**
  67325. * Gets the color operand input component
  67326. */
  67327. get color(): NodeMaterialConnectionPoint;
  67328. /**
  67329. * Gets the level operand input component
  67330. */
  67331. get level(): NodeMaterialConnectionPoint;
  67332. /**
  67333. * Gets the output component
  67334. */
  67335. get output(): NodeMaterialConnectionPoint;
  67336. protected _buildBlock(state: NodeMaterialBuildState): this;
  67337. }
  67338. }
  67339. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67340. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67341. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67342. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67343. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67344. import { Nullable } from "babylonjs/types";
  67345. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67346. import { Scene } from "babylonjs/scene";
  67347. /**
  67348. * Block used to implement the ambient occlusion module of the PBR material
  67349. */
  67350. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67351. /**
  67352. * Create a new AmbientOcclusionBlock
  67353. * @param name defines the block name
  67354. */
  67355. constructor(name: string);
  67356. /**
  67357. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67358. */
  67359. useAmbientInGrayScale: boolean;
  67360. /**
  67361. * Initialize the block and prepare the context for build
  67362. * @param state defines the state that will be used for the build
  67363. */
  67364. initialize(state: NodeMaterialBuildState): void;
  67365. /**
  67366. * Gets the current class name
  67367. * @returns the class name
  67368. */
  67369. getClassName(): string;
  67370. /**
  67371. * Gets the texture input component
  67372. */
  67373. get texture(): NodeMaterialConnectionPoint;
  67374. /**
  67375. * Gets the texture intensity component
  67376. */
  67377. get intensity(): NodeMaterialConnectionPoint;
  67378. /**
  67379. * Gets the direct light intensity input component
  67380. */
  67381. get directLightIntensity(): NodeMaterialConnectionPoint;
  67382. /**
  67383. * Gets the ambient occlusion object output component
  67384. */
  67385. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67386. /**
  67387. * Gets the main code of the block (fragment side)
  67388. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67389. * @returns the shader code
  67390. */
  67391. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67392. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67393. protected _buildBlock(state: NodeMaterialBuildState): this;
  67394. protected _dumpPropertiesCode(): string;
  67395. serialize(): any;
  67396. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67397. }
  67398. }
  67399. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67400. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67401. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67402. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67403. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67404. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67405. import { Nullable } from "babylonjs/types";
  67406. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67407. import { Mesh } from "babylonjs/Meshes/mesh";
  67408. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67409. import { Effect } from "babylonjs/Materials/effect";
  67410. import { Scene } from "babylonjs/scene";
  67411. /**
  67412. * Block used to implement the reflection module of the PBR material
  67413. */
  67414. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67415. /** @hidden */
  67416. _defineLODReflectionAlpha: string;
  67417. /** @hidden */
  67418. _defineLinearSpecularReflection: string;
  67419. private _vEnvironmentIrradianceName;
  67420. /** @hidden */
  67421. _vReflectionMicrosurfaceInfosName: string;
  67422. /** @hidden */
  67423. _vReflectionInfosName: string;
  67424. /** @hidden */
  67425. _vReflectionFilteringInfoName: string;
  67426. private _scene;
  67427. /**
  67428. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67429. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67430. * It's less burden on the user side in the editor part.
  67431. */
  67432. /** @hidden */
  67433. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67434. /** @hidden */
  67435. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67436. /** @hidden */
  67437. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67438. /**
  67439. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67440. * diffuse part of the IBL.
  67441. */
  67442. useSphericalHarmonics: boolean;
  67443. /**
  67444. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67445. */
  67446. forceIrradianceInFragment: boolean;
  67447. /**
  67448. * Create a new ReflectionBlock
  67449. * @param name defines the block name
  67450. */
  67451. constructor(name: string);
  67452. /**
  67453. * Gets the current class name
  67454. * @returns the class name
  67455. */
  67456. getClassName(): string;
  67457. /**
  67458. * Gets the position input component
  67459. */
  67460. get position(): NodeMaterialConnectionPoint;
  67461. /**
  67462. * Gets the world position input component
  67463. */
  67464. get worldPosition(): NodeMaterialConnectionPoint;
  67465. /**
  67466. * Gets the world normal input component
  67467. */
  67468. get worldNormal(): NodeMaterialConnectionPoint;
  67469. /**
  67470. * Gets the world input component
  67471. */
  67472. get world(): NodeMaterialConnectionPoint;
  67473. /**
  67474. * Gets the camera (or eye) position component
  67475. */
  67476. get cameraPosition(): NodeMaterialConnectionPoint;
  67477. /**
  67478. * Gets the view input component
  67479. */
  67480. get view(): NodeMaterialConnectionPoint;
  67481. /**
  67482. * Gets the color input component
  67483. */
  67484. get color(): NodeMaterialConnectionPoint;
  67485. /**
  67486. * Gets the reflection object output component
  67487. */
  67488. get reflection(): NodeMaterialConnectionPoint;
  67489. /**
  67490. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67491. */
  67492. get hasTexture(): boolean;
  67493. /**
  67494. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67495. */
  67496. get reflectionColor(): string;
  67497. protected _getTexture(): Nullable<BaseTexture>;
  67498. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67499. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67500. /**
  67501. * Gets the code to inject in the vertex shader
  67502. * @param state current state of the node material building
  67503. * @returns the shader code
  67504. */
  67505. handleVertexSide(state: NodeMaterialBuildState): string;
  67506. /**
  67507. * Gets the main code of the block (fragment side)
  67508. * @param state current state of the node material building
  67509. * @param normalVarName name of the existing variable corresponding to the normal
  67510. * @returns the shader code
  67511. */
  67512. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67513. protected _buildBlock(state: NodeMaterialBuildState): this;
  67514. protected _dumpPropertiesCode(): string;
  67515. serialize(): any;
  67516. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67517. }
  67518. }
  67519. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67520. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67521. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67522. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67523. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67524. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67525. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67526. import { Scene } from "babylonjs/scene";
  67527. import { Nullable } from "babylonjs/types";
  67528. /**
  67529. * Block used to implement the sheen module of the PBR material
  67530. */
  67531. export class SheenBlock extends NodeMaterialBlock {
  67532. /**
  67533. * Create a new SheenBlock
  67534. * @param name defines the block name
  67535. */
  67536. constructor(name: string);
  67537. /**
  67538. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67539. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67540. * making it easier to setup and tweak the effect
  67541. */
  67542. albedoScaling: boolean;
  67543. /**
  67544. * Defines if the sheen is linked to the sheen color.
  67545. */
  67546. linkSheenWithAlbedo: boolean;
  67547. /**
  67548. * Initialize the block and prepare the context for build
  67549. * @param state defines the state that will be used for the build
  67550. */
  67551. initialize(state: NodeMaterialBuildState): void;
  67552. /**
  67553. * Gets the current class name
  67554. * @returns the class name
  67555. */
  67556. getClassName(): string;
  67557. /**
  67558. * Gets the intensity input component
  67559. */
  67560. get intensity(): NodeMaterialConnectionPoint;
  67561. /**
  67562. * Gets the color input component
  67563. */
  67564. get color(): NodeMaterialConnectionPoint;
  67565. /**
  67566. * Gets the roughness input component
  67567. */
  67568. get roughness(): NodeMaterialConnectionPoint;
  67569. /**
  67570. * Gets the sheen object output component
  67571. */
  67572. get sheen(): NodeMaterialConnectionPoint;
  67573. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67574. /**
  67575. * Gets the main code of the block (fragment side)
  67576. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67577. * @returns the shader code
  67578. */
  67579. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67580. protected _buildBlock(state: NodeMaterialBuildState): this;
  67581. protected _dumpPropertiesCode(): string;
  67582. serialize(): any;
  67583. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67584. }
  67585. }
  67586. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67587. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67588. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67589. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67590. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67592. import { Scene } from "babylonjs/scene";
  67593. import { Nullable } from "babylonjs/types";
  67594. import { Mesh } from "babylonjs/Meshes/mesh";
  67595. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67596. import { Effect } from "babylonjs/Materials/effect";
  67597. /**
  67598. * Block used to implement the reflectivity module of the PBR material
  67599. */
  67600. export class ReflectivityBlock extends NodeMaterialBlock {
  67601. private _metallicReflectanceColor;
  67602. private _metallicF0Factor;
  67603. /** @hidden */
  67604. _vMetallicReflectanceFactorsName: string;
  67605. /**
  67606. * The property below is set by the main PBR block prior to calling methods of this class.
  67607. */
  67608. /** @hidden */
  67609. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67610. /**
  67611. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67612. */
  67613. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67614. /**
  67615. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67616. */
  67617. useMetallnessFromMetallicTextureBlue: boolean;
  67618. /**
  67619. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67620. */
  67621. useRoughnessFromMetallicTextureAlpha: boolean;
  67622. /**
  67623. * Specifies if the metallic texture contains the roughness information in its green channel.
  67624. */
  67625. useRoughnessFromMetallicTextureGreen: boolean;
  67626. /**
  67627. * Create a new ReflectivityBlock
  67628. * @param name defines the block name
  67629. */
  67630. constructor(name: string);
  67631. /**
  67632. * Initialize the block and prepare the context for build
  67633. * @param state defines the state that will be used for the build
  67634. */
  67635. initialize(state: NodeMaterialBuildState): void;
  67636. /**
  67637. * Gets the current class name
  67638. * @returns the class name
  67639. */
  67640. getClassName(): string;
  67641. /**
  67642. * Gets the metallic input component
  67643. */
  67644. get metallic(): NodeMaterialConnectionPoint;
  67645. /**
  67646. * Gets the roughness input component
  67647. */
  67648. get roughness(): NodeMaterialConnectionPoint;
  67649. /**
  67650. * Gets the texture input component
  67651. */
  67652. get texture(): NodeMaterialConnectionPoint;
  67653. /**
  67654. * Gets the reflectivity object output component
  67655. */
  67656. get reflectivity(): NodeMaterialConnectionPoint;
  67657. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67658. /**
  67659. * Gets the main code of the block (fragment side)
  67660. * @param state current state of the node material building
  67661. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67662. * @returns the shader code
  67663. */
  67664. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67665. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67666. protected _buildBlock(state: NodeMaterialBuildState): this;
  67667. protected _dumpPropertiesCode(): string;
  67668. serialize(): any;
  67669. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67670. }
  67671. }
  67672. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67673. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67674. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67675. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67676. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67677. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67678. /**
  67679. * Block used to implement the anisotropy module of the PBR material
  67680. */
  67681. export class AnisotropyBlock extends NodeMaterialBlock {
  67682. /**
  67683. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67684. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67685. * It's less burden on the user side in the editor part.
  67686. */
  67687. /** @hidden */
  67688. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67689. /** @hidden */
  67690. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67691. /**
  67692. * Create a new AnisotropyBlock
  67693. * @param name defines the block name
  67694. */
  67695. constructor(name: string);
  67696. /**
  67697. * Initialize the block and prepare the context for build
  67698. * @param state defines the state that will be used for the build
  67699. */
  67700. initialize(state: NodeMaterialBuildState): void;
  67701. /**
  67702. * Gets the current class name
  67703. * @returns the class name
  67704. */
  67705. getClassName(): string;
  67706. /**
  67707. * Gets the intensity input component
  67708. */
  67709. get intensity(): NodeMaterialConnectionPoint;
  67710. /**
  67711. * Gets the direction input component
  67712. */
  67713. get direction(): NodeMaterialConnectionPoint;
  67714. /**
  67715. * Gets the texture input component
  67716. */
  67717. get texture(): NodeMaterialConnectionPoint;
  67718. /**
  67719. * Gets the uv input component
  67720. */
  67721. get uv(): NodeMaterialConnectionPoint;
  67722. /**
  67723. * Gets the worldTangent input component
  67724. */
  67725. get worldTangent(): NodeMaterialConnectionPoint;
  67726. /**
  67727. * Gets the anisotropy object output component
  67728. */
  67729. get anisotropy(): NodeMaterialConnectionPoint;
  67730. private _generateTBNSpace;
  67731. /**
  67732. * Gets the main code of the block (fragment side)
  67733. * @param state current state of the node material building
  67734. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67735. * @returns the shader code
  67736. */
  67737. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67738. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67739. protected _buildBlock(state: NodeMaterialBuildState): this;
  67740. }
  67741. }
  67742. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67743. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67744. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67745. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67746. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67747. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67748. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67749. import { Nullable } from "babylonjs/types";
  67750. import { Mesh } from "babylonjs/Meshes/mesh";
  67751. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67752. import { Effect } from "babylonjs/Materials/effect";
  67753. /**
  67754. * Block used to implement the clear coat module of the PBR material
  67755. */
  67756. export class ClearCoatBlock extends NodeMaterialBlock {
  67757. private _scene;
  67758. /**
  67759. * Create a new ClearCoatBlock
  67760. * @param name defines the block name
  67761. */
  67762. constructor(name: string);
  67763. /**
  67764. * Initialize the block and prepare the context for build
  67765. * @param state defines the state that will be used for the build
  67766. */
  67767. initialize(state: NodeMaterialBuildState): void;
  67768. /**
  67769. * Gets the current class name
  67770. * @returns the class name
  67771. */
  67772. getClassName(): string;
  67773. /**
  67774. * Gets the intensity input component
  67775. */
  67776. get intensity(): NodeMaterialConnectionPoint;
  67777. /**
  67778. * Gets the roughness input component
  67779. */
  67780. get roughness(): NodeMaterialConnectionPoint;
  67781. /**
  67782. * Gets the ior input component
  67783. */
  67784. get ior(): NodeMaterialConnectionPoint;
  67785. /**
  67786. * Gets the texture input component
  67787. */
  67788. get texture(): NodeMaterialConnectionPoint;
  67789. /**
  67790. * Gets the bump texture input component
  67791. */
  67792. get bumpTexture(): NodeMaterialConnectionPoint;
  67793. /**
  67794. * Gets the uv input component
  67795. */
  67796. get uv(): NodeMaterialConnectionPoint;
  67797. /**
  67798. * Gets the tint color input component
  67799. */
  67800. get tintColor(): NodeMaterialConnectionPoint;
  67801. /**
  67802. * Gets the tint "at distance" input component
  67803. */
  67804. get tintAtDistance(): NodeMaterialConnectionPoint;
  67805. /**
  67806. * Gets the tint thickness input component
  67807. */
  67808. get tintThickness(): NodeMaterialConnectionPoint;
  67809. /**
  67810. * Gets the world tangent input component
  67811. */
  67812. get worldTangent(): NodeMaterialConnectionPoint;
  67813. /**
  67814. * Gets the clear coat object output component
  67815. */
  67816. get clearcoat(): NodeMaterialConnectionPoint;
  67817. autoConfigure(material: NodeMaterial): void;
  67818. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67819. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67820. private _generateTBNSpace;
  67821. /**
  67822. * Gets the main code of the block (fragment side)
  67823. * @param state current state of the node material building
  67824. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67825. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67826. * @param worldPosVarName name of the variable holding the world position
  67827. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67828. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67829. * @param worldNormalVarName name of the variable holding the world normal
  67830. * @returns the shader code
  67831. */
  67832. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67833. protected _buildBlock(state: NodeMaterialBuildState): this;
  67834. }
  67835. }
  67836. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67837. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67839. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67840. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67841. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67842. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67843. import { Nullable } from "babylonjs/types";
  67844. /**
  67845. * Block used to implement the sub surface module of the PBR material
  67846. */
  67847. export class SubSurfaceBlock extends NodeMaterialBlock {
  67848. /**
  67849. * Create a new SubSurfaceBlock
  67850. * @param name defines the block name
  67851. */
  67852. constructor(name: string);
  67853. /**
  67854. * Stores the intensity of the different subsurface effects in the thickness texture.
  67855. * * the green channel is the translucency intensity.
  67856. * * the blue channel is the scattering intensity.
  67857. * * the alpha channel is the refraction intensity.
  67858. */
  67859. useMaskFromThicknessTexture: boolean;
  67860. /**
  67861. * Initialize the block and prepare the context for build
  67862. * @param state defines the state that will be used for the build
  67863. */
  67864. initialize(state: NodeMaterialBuildState): void;
  67865. /**
  67866. * Gets the current class name
  67867. * @returns the class name
  67868. */
  67869. getClassName(): string;
  67870. /**
  67871. * Gets the min thickness input component
  67872. */
  67873. get minThickness(): NodeMaterialConnectionPoint;
  67874. /**
  67875. * Gets the max thickness input component
  67876. */
  67877. get maxThickness(): NodeMaterialConnectionPoint;
  67878. /**
  67879. * Gets the thickness texture component
  67880. */
  67881. get thicknessTexture(): NodeMaterialConnectionPoint;
  67882. /**
  67883. * Gets the tint color input component
  67884. */
  67885. get tintColor(): NodeMaterialConnectionPoint;
  67886. /**
  67887. * Gets the translucency intensity input component
  67888. */
  67889. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67890. /**
  67891. * Gets the translucency diffusion distance input component
  67892. */
  67893. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67894. /**
  67895. * Gets the refraction object parameters
  67896. */
  67897. get refraction(): NodeMaterialConnectionPoint;
  67898. /**
  67899. * Gets the sub surface object output component
  67900. */
  67901. get subsurface(): NodeMaterialConnectionPoint;
  67902. autoConfigure(material: NodeMaterial): void;
  67903. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67904. /**
  67905. * Gets the main code of the block (fragment side)
  67906. * @param state current state of the node material building
  67907. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67908. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67909. * @param worldPosVarName name of the variable holding the world position
  67910. * @returns the shader code
  67911. */
  67912. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67913. protected _buildBlock(state: NodeMaterialBuildState): this;
  67914. }
  67915. }
  67916. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67917. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67918. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67919. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67920. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67921. import { Light } from "babylonjs/Lights/light";
  67922. import { Nullable } from "babylonjs/types";
  67923. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67924. import { Effect } from "babylonjs/Materials/effect";
  67925. import { Mesh } from "babylonjs/Meshes/mesh";
  67926. import { Scene } from "babylonjs/scene";
  67927. /**
  67928. * Block used to implement the PBR metallic/roughness model
  67929. */
  67930. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67931. /**
  67932. * Gets or sets the light associated with this block
  67933. */
  67934. light: Nullable<Light>;
  67935. private _lightId;
  67936. private _scene;
  67937. private _environmentBRDFTexture;
  67938. private _environmentBrdfSamplerName;
  67939. private _vNormalWName;
  67940. private _invertNormalName;
  67941. /**
  67942. * Create a new ReflectionBlock
  67943. * @param name defines the block name
  67944. */
  67945. constructor(name: string);
  67946. /**
  67947. * Intensity of the direct lights e.g. the four lights available in your scene.
  67948. * This impacts both the direct diffuse and specular highlights.
  67949. */
  67950. directIntensity: number;
  67951. /**
  67952. * Intensity of the environment e.g. how much the environment will light the object
  67953. * either through harmonics for rough material or through the refelction for shiny ones.
  67954. */
  67955. environmentIntensity: number;
  67956. /**
  67957. * This is a special control allowing the reduction of the specular highlights coming from the
  67958. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67959. */
  67960. specularIntensity: number;
  67961. /**
  67962. * Defines the falloff type used in this material.
  67963. * It by default is Physical.
  67964. */
  67965. lightFalloff: number;
  67966. /**
  67967. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67968. */
  67969. useAlphaFromAlbedoTexture: boolean;
  67970. /**
  67971. * Specifies that alpha test should be used
  67972. */
  67973. useAlphaTest: boolean;
  67974. /**
  67975. * Defines the alpha limits in alpha test mode.
  67976. */
  67977. alphaTestCutoff: number;
  67978. /**
  67979. * Specifies that alpha blending should be used
  67980. */
  67981. useAlphaBlending: boolean;
  67982. /**
  67983. * Defines if the alpha value should be determined via the rgb values.
  67984. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67985. */
  67986. opacityRGB: boolean;
  67987. /**
  67988. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67989. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67990. */
  67991. useRadianceOverAlpha: boolean;
  67992. /**
  67993. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67994. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67995. */
  67996. useSpecularOverAlpha: boolean;
  67997. /**
  67998. * Enables specular anti aliasing in the PBR shader.
  67999. * It will both interacts on the Geometry for analytical and IBL lighting.
  68000. * It also prefilter the roughness map based on the bump values.
  68001. */
  68002. enableSpecularAntiAliasing: boolean;
  68003. /**
  68004. * Enables realtime filtering on the texture.
  68005. */
  68006. realTimeFiltering: boolean;
  68007. /**
  68008. * Quality switch for realtime filtering
  68009. */
  68010. realTimeFilteringQuality: number;
  68011. /**
  68012. * Defines if the material uses energy conservation.
  68013. */
  68014. useEnergyConservation: boolean;
  68015. /**
  68016. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68017. * too much the area relying on ambient texture to define their ambient occlusion.
  68018. */
  68019. useRadianceOcclusion: boolean;
  68020. /**
  68021. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68022. * makes the reflect vector face the model (under horizon).
  68023. */
  68024. useHorizonOcclusion: boolean;
  68025. /**
  68026. * If set to true, no lighting calculations will be applied.
  68027. */
  68028. unlit: boolean;
  68029. /**
  68030. * Force normal to face away from face.
  68031. */
  68032. forceNormalForward: boolean;
  68033. /**
  68034. * Defines the material debug mode.
  68035. * It helps seeing only some components of the material while troubleshooting.
  68036. */
  68037. debugMode: number;
  68038. /**
  68039. * Specify from where on screen the debug mode should start.
  68040. * The value goes from -1 (full screen) to 1 (not visible)
  68041. * It helps with side by side comparison against the final render
  68042. * This defaults to 0
  68043. */
  68044. debugLimit: number;
  68045. /**
  68046. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68047. * You can use the factor to better multiply the final value.
  68048. */
  68049. debugFactor: number;
  68050. /**
  68051. * Initialize the block and prepare the context for build
  68052. * @param state defines the state that will be used for the build
  68053. */
  68054. initialize(state: NodeMaterialBuildState): void;
  68055. /**
  68056. * Gets the current class name
  68057. * @returns the class name
  68058. */
  68059. getClassName(): string;
  68060. /**
  68061. * Gets the world position input component
  68062. */
  68063. get worldPosition(): NodeMaterialConnectionPoint;
  68064. /**
  68065. * Gets the world normal input component
  68066. */
  68067. get worldNormal(): NodeMaterialConnectionPoint;
  68068. /**
  68069. * Gets the perturbed normal input component
  68070. */
  68071. get perturbedNormal(): NodeMaterialConnectionPoint;
  68072. /**
  68073. * Gets the camera position input component
  68074. */
  68075. get cameraPosition(): NodeMaterialConnectionPoint;
  68076. /**
  68077. * Gets the base color input component
  68078. */
  68079. get baseColor(): NodeMaterialConnectionPoint;
  68080. /**
  68081. * Gets the opacity texture input component
  68082. */
  68083. get opacityTexture(): NodeMaterialConnectionPoint;
  68084. /**
  68085. * Gets the ambient color input component
  68086. */
  68087. get ambientColor(): NodeMaterialConnectionPoint;
  68088. /**
  68089. * Gets the reflectivity object parameters
  68090. */
  68091. get reflectivity(): NodeMaterialConnectionPoint;
  68092. /**
  68093. * Gets the ambient occlusion object parameters
  68094. */
  68095. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68096. /**
  68097. * Gets the reflection object parameters
  68098. */
  68099. get reflection(): NodeMaterialConnectionPoint;
  68100. /**
  68101. * Gets the sheen object parameters
  68102. */
  68103. get sheen(): NodeMaterialConnectionPoint;
  68104. /**
  68105. * Gets the clear coat object parameters
  68106. */
  68107. get clearcoat(): NodeMaterialConnectionPoint;
  68108. /**
  68109. * Gets the sub surface object parameters
  68110. */
  68111. get subsurface(): NodeMaterialConnectionPoint;
  68112. /**
  68113. * Gets the anisotropy object parameters
  68114. */
  68115. get anisotropy(): NodeMaterialConnectionPoint;
  68116. /**
  68117. * Gets the ambient output component
  68118. */
  68119. get ambient(): NodeMaterialConnectionPoint;
  68120. /**
  68121. * Gets the diffuse output component
  68122. */
  68123. get diffuse(): NodeMaterialConnectionPoint;
  68124. /**
  68125. * Gets the specular output component
  68126. */
  68127. get specular(): NodeMaterialConnectionPoint;
  68128. /**
  68129. * Gets the sheen output component
  68130. */
  68131. get sheenDir(): NodeMaterialConnectionPoint;
  68132. /**
  68133. * Gets the clear coat output component
  68134. */
  68135. get clearcoatDir(): NodeMaterialConnectionPoint;
  68136. /**
  68137. * Gets the indirect diffuse output component
  68138. */
  68139. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68140. /**
  68141. * Gets the indirect specular output component
  68142. */
  68143. get specularIndirect(): NodeMaterialConnectionPoint;
  68144. /**
  68145. * Gets the indirect sheen output component
  68146. */
  68147. get sheenIndirect(): NodeMaterialConnectionPoint;
  68148. /**
  68149. * Gets the indirect clear coat output component
  68150. */
  68151. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68152. /**
  68153. * Gets the refraction output component
  68154. */
  68155. get refraction(): NodeMaterialConnectionPoint;
  68156. /**
  68157. * Gets the global lighting output component
  68158. */
  68159. get lighting(): NodeMaterialConnectionPoint;
  68160. /**
  68161. * Gets the shadow output component
  68162. */
  68163. get shadow(): NodeMaterialConnectionPoint;
  68164. /**
  68165. * Gets the alpha output component
  68166. */
  68167. get alpha(): NodeMaterialConnectionPoint;
  68168. autoConfigure(material: NodeMaterial): void;
  68169. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68170. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68171. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68172. private _injectVertexCode;
  68173. /**
  68174. * Gets the code corresponding to the albedo/opacity module
  68175. * @returns the shader code
  68176. */
  68177. getAlbedoOpacityCode(): string;
  68178. protected _buildBlock(state: NodeMaterialBuildState): this;
  68179. protected _dumpPropertiesCode(): string;
  68180. serialize(): any;
  68181. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68182. }
  68183. }
  68184. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68185. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68186. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68187. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68188. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68189. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68190. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68191. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68192. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68193. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68194. }
  68195. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68196. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68197. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68198. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68199. }
  68200. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68201. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68202. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68203. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68204. /**
  68205. * Block used to compute value of one parameter modulo another
  68206. */
  68207. export class ModBlock extends NodeMaterialBlock {
  68208. /**
  68209. * Creates a new ModBlock
  68210. * @param name defines the block name
  68211. */
  68212. constructor(name: string);
  68213. /**
  68214. * Gets the current class name
  68215. * @returns the class name
  68216. */
  68217. getClassName(): string;
  68218. /**
  68219. * Gets the left operand input component
  68220. */
  68221. get left(): NodeMaterialConnectionPoint;
  68222. /**
  68223. * Gets the right operand input component
  68224. */
  68225. get right(): NodeMaterialConnectionPoint;
  68226. /**
  68227. * Gets the output component
  68228. */
  68229. get output(): NodeMaterialConnectionPoint;
  68230. protected _buildBlock(state: NodeMaterialBuildState): this;
  68231. }
  68232. }
  68233. declare module "babylonjs/Materials/Node/Blocks/index" {
  68234. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68235. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68236. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68237. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68238. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68239. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68240. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68241. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68242. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68243. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68244. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68245. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68246. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68247. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68248. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68249. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68250. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68251. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68252. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68253. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68254. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68255. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68256. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68257. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68258. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68259. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68260. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68261. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68262. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68263. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68264. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68265. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68266. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68267. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68268. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68269. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68270. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68271. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68272. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68273. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68274. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68275. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68276. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68277. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68278. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68279. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68280. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68281. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68282. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68283. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68284. }
  68285. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68286. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68287. }
  68288. declare module "babylonjs/Materials/Node/index" {
  68289. export * from "babylonjs/Materials/Node/Enums/index";
  68290. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68291. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68292. export * from "babylonjs/Materials/Node/nodeMaterial";
  68293. export * from "babylonjs/Materials/Node/Blocks/index";
  68294. export * from "babylonjs/Materials/Node/Optimizers/index";
  68295. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68296. }
  68297. declare module "babylonjs/Materials/index" {
  68298. export * from "babylonjs/Materials/Background/index";
  68299. export * from "babylonjs/Materials/colorCurves";
  68300. export * from "babylonjs/Materials/iEffectFallbacks";
  68301. export * from "babylonjs/Materials/effectFallbacks";
  68302. export * from "babylonjs/Materials/effect";
  68303. export * from "babylonjs/Materials/fresnelParameters";
  68304. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68305. export * from "babylonjs/Materials/material";
  68306. export * from "babylonjs/Materials/materialDefines";
  68307. export * from "babylonjs/Materials/thinMaterialHelper";
  68308. export * from "babylonjs/Materials/materialHelper";
  68309. export * from "babylonjs/Materials/multiMaterial";
  68310. export * from "babylonjs/Materials/PBR/index";
  68311. export * from "babylonjs/Materials/pushMaterial";
  68312. export * from "babylonjs/Materials/shaderMaterial";
  68313. export * from "babylonjs/Materials/standardMaterial";
  68314. export * from "babylonjs/Materials/Textures/index";
  68315. export * from "babylonjs/Materials/uniformBuffer";
  68316. export * from "babylonjs/Materials/materialFlags";
  68317. export * from "babylonjs/Materials/Node/index";
  68318. export * from "babylonjs/Materials/effectRenderer";
  68319. export * from "babylonjs/Materials/shadowDepthWrapper";
  68320. }
  68321. declare module "babylonjs/Maths/index" {
  68322. export * from "babylonjs/Maths/math.scalar";
  68323. export * from "babylonjs/Maths/math";
  68324. export * from "babylonjs/Maths/sphericalPolynomial";
  68325. }
  68326. declare module "babylonjs/Misc/workerPool" {
  68327. import { IDisposable } from "babylonjs/scene";
  68328. /**
  68329. * Helper class to push actions to a pool of workers.
  68330. */
  68331. export class WorkerPool implements IDisposable {
  68332. private _workerInfos;
  68333. private _pendingActions;
  68334. /**
  68335. * Constructor
  68336. * @param workers Array of workers to use for actions
  68337. */
  68338. constructor(workers: Array<Worker>);
  68339. /**
  68340. * Terminates all workers and clears any pending actions.
  68341. */
  68342. dispose(): void;
  68343. /**
  68344. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68345. * pended until a worker has completed its action.
  68346. * @param action The action to perform. Call onComplete when the action is complete.
  68347. */
  68348. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68349. private _execute;
  68350. }
  68351. }
  68352. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68353. import { IDisposable } from "babylonjs/scene";
  68354. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68355. /**
  68356. * Configuration for Draco compression
  68357. */
  68358. export interface IDracoCompressionConfiguration {
  68359. /**
  68360. * Configuration for the decoder.
  68361. */
  68362. decoder: {
  68363. /**
  68364. * The url to the WebAssembly module.
  68365. */
  68366. wasmUrl?: string;
  68367. /**
  68368. * The url to the WebAssembly binary.
  68369. */
  68370. wasmBinaryUrl?: string;
  68371. /**
  68372. * The url to the fallback JavaScript module.
  68373. */
  68374. fallbackUrl?: string;
  68375. };
  68376. }
  68377. /**
  68378. * Draco compression (https://google.github.io/draco/)
  68379. *
  68380. * This class wraps the Draco module.
  68381. *
  68382. * **Encoder**
  68383. *
  68384. * The encoder is not currently implemented.
  68385. *
  68386. * **Decoder**
  68387. *
  68388. * 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.
  68389. *
  68390. * To update the configuration, use the following code:
  68391. * ```javascript
  68392. * DracoCompression.Configuration = {
  68393. * decoder: {
  68394. * wasmUrl: "<url to the WebAssembly library>",
  68395. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68396. * fallbackUrl: "<url to the fallback JavaScript library>",
  68397. * }
  68398. * };
  68399. * ```
  68400. *
  68401. * 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.
  68402. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68403. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68404. *
  68405. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68406. * ```javascript
  68407. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68408. * ```
  68409. *
  68410. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68411. */
  68412. export class DracoCompression implements IDisposable {
  68413. private _workerPoolPromise?;
  68414. private _decoderModulePromise?;
  68415. /**
  68416. * The configuration. Defaults to the following urls:
  68417. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68418. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68419. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68420. */
  68421. static Configuration: IDracoCompressionConfiguration;
  68422. /**
  68423. * Returns true if the decoder configuration is available.
  68424. */
  68425. static get DecoderAvailable(): boolean;
  68426. /**
  68427. * Default number of workers to create when creating the draco compression object.
  68428. */
  68429. static DefaultNumWorkers: number;
  68430. private static GetDefaultNumWorkers;
  68431. private static _Default;
  68432. /**
  68433. * Default instance for the draco compression object.
  68434. */
  68435. static get Default(): DracoCompression;
  68436. /**
  68437. * Constructor
  68438. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68439. */
  68440. constructor(numWorkers?: number);
  68441. /**
  68442. * Stop all async operations and release resources.
  68443. */
  68444. dispose(): void;
  68445. /**
  68446. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68447. * @returns a promise that resolves when ready
  68448. */
  68449. whenReadyAsync(): Promise<void>;
  68450. /**
  68451. * Decode Draco compressed mesh data to vertex data.
  68452. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68453. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68454. * @returns A promise that resolves with the decoded vertex data
  68455. */
  68456. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68457. [kind: string]: number;
  68458. }): Promise<VertexData>;
  68459. }
  68460. }
  68461. declare module "babylonjs/Meshes/Compression/index" {
  68462. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68463. }
  68464. declare module "babylonjs/Meshes/csg" {
  68465. import { Nullable } from "babylonjs/types";
  68466. import { Scene } from "babylonjs/scene";
  68467. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68468. import { Mesh } from "babylonjs/Meshes/mesh";
  68469. import { Material } from "babylonjs/Materials/material";
  68470. /**
  68471. * Class for building Constructive Solid Geometry
  68472. */
  68473. export class CSG {
  68474. private polygons;
  68475. /**
  68476. * The world matrix
  68477. */
  68478. matrix: Matrix;
  68479. /**
  68480. * Stores the position
  68481. */
  68482. position: Vector3;
  68483. /**
  68484. * Stores the rotation
  68485. */
  68486. rotation: Vector3;
  68487. /**
  68488. * Stores the rotation quaternion
  68489. */
  68490. rotationQuaternion: Nullable<Quaternion>;
  68491. /**
  68492. * Stores the scaling vector
  68493. */
  68494. scaling: Vector3;
  68495. /**
  68496. * Convert the Mesh to CSG
  68497. * @param mesh The Mesh to convert to CSG
  68498. * @returns A new CSG from the Mesh
  68499. */
  68500. static FromMesh(mesh: Mesh): CSG;
  68501. /**
  68502. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68503. * @param polygons Polygons used to construct a CSG solid
  68504. */
  68505. private static FromPolygons;
  68506. /**
  68507. * Clones, or makes a deep copy, of the CSG
  68508. * @returns A new CSG
  68509. */
  68510. clone(): CSG;
  68511. /**
  68512. * Unions this CSG with another CSG
  68513. * @param csg The CSG to union against this CSG
  68514. * @returns The unioned CSG
  68515. */
  68516. union(csg: CSG): CSG;
  68517. /**
  68518. * Unions this CSG with another CSG in place
  68519. * @param csg The CSG to union against this CSG
  68520. */
  68521. unionInPlace(csg: CSG): void;
  68522. /**
  68523. * Subtracts this CSG with another CSG
  68524. * @param csg The CSG to subtract against this CSG
  68525. * @returns A new CSG
  68526. */
  68527. subtract(csg: CSG): CSG;
  68528. /**
  68529. * Subtracts this CSG with another CSG in place
  68530. * @param csg The CSG to subtact against this CSG
  68531. */
  68532. subtractInPlace(csg: CSG): void;
  68533. /**
  68534. * Intersect this CSG with another CSG
  68535. * @param csg The CSG to intersect against this CSG
  68536. * @returns A new CSG
  68537. */
  68538. intersect(csg: CSG): CSG;
  68539. /**
  68540. * Intersects this CSG with another CSG in place
  68541. * @param csg The CSG to intersect against this CSG
  68542. */
  68543. intersectInPlace(csg: CSG): void;
  68544. /**
  68545. * Return a new CSG solid with solid and empty space switched. This solid is
  68546. * not modified.
  68547. * @returns A new CSG solid with solid and empty space switched
  68548. */
  68549. inverse(): CSG;
  68550. /**
  68551. * Inverses the CSG in place
  68552. */
  68553. inverseInPlace(): void;
  68554. /**
  68555. * This is used to keep meshes transformations so they can be restored
  68556. * when we build back a Babylon Mesh
  68557. * NB : All CSG operations are performed in world coordinates
  68558. * @param csg The CSG to copy the transform attributes from
  68559. * @returns This CSG
  68560. */
  68561. copyTransformAttributes(csg: CSG): CSG;
  68562. /**
  68563. * Build Raw mesh from CSG
  68564. * Coordinates here are in world space
  68565. * @param name The name of the mesh geometry
  68566. * @param scene The Scene
  68567. * @param keepSubMeshes Specifies if the submeshes should be kept
  68568. * @returns A new Mesh
  68569. */
  68570. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68571. /**
  68572. * Build Mesh from CSG taking material and transforms into account
  68573. * @param name The name of the Mesh
  68574. * @param material The material of the Mesh
  68575. * @param scene The Scene
  68576. * @param keepSubMeshes Specifies if submeshes should be kept
  68577. * @returns The new Mesh
  68578. */
  68579. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68580. }
  68581. }
  68582. declare module "babylonjs/Meshes/trailMesh" {
  68583. import { Mesh } from "babylonjs/Meshes/mesh";
  68584. import { Scene } from "babylonjs/scene";
  68585. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68586. /**
  68587. * Class used to create a trail following a mesh
  68588. */
  68589. export class TrailMesh extends Mesh {
  68590. private _generator;
  68591. private _autoStart;
  68592. private _running;
  68593. private _diameter;
  68594. private _length;
  68595. private _sectionPolygonPointsCount;
  68596. private _sectionVectors;
  68597. private _sectionNormalVectors;
  68598. private _beforeRenderObserver;
  68599. /**
  68600. * @constructor
  68601. * @param name The value used by scene.getMeshByName() to do a lookup.
  68602. * @param generator The mesh or transform node to generate a trail.
  68603. * @param scene The scene to add this mesh to.
  68604. * @param diameter Diameter of trailing mesh. Default is 1.
  68605. * @param length Length of trailing mesh. Default is 60.
  68606. * @param autoStart Automatically start trailing mesh. Default true.
  68607. */
  68608. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68609. /**
  68610. * "TrailMesh"
  68611. * @returns "TrailMesh"
  68612. */
  68613. getClassName(): string;
  68614. private _createMesh;
  68615. /**
  68616. * Start trailing mesh.
  68617. */
  68618. start(): void;
  68619. /**
  68620. * Stop trailing mesh.
  68621. */
  68622. stop(): void;
  68623. /**
  68624. * Update trailing mesh geometry.
  68625. */
  68626. update(): void;
  68627. /**
  68628. * Returns a new TrailMesh object.
  68629. * @param name is a string, the name given to the new mesh
  68630. * @param newGenerator use new generator object for cloned trail mesh
  68631. * @returns a new mesh
  68632. */
  68633. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68634. /**
  68635. * Serializes this trail mesh
  68636. * @param serializationObject object to write serialization to
  68637. */
  68638. serialize(serializationObject: any): void;
  68639. /**
  68640. * Parses a serialized trail mesh
  68641. * @param parsedMesh the serialized mesh
  68642. * @param scene the scene to create the trail mesh in
  68643. * @returns the created trail mesh
  68644. */
  68645. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68646. }
  68647. }
  68648. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68649. import { Nullable } from "babylonjs/types";
  68650. import { Scene } from "babylonjs/scene";
  68651. import { Vector4 } from "babylonjs/Maths/math.vector";
  68652. import { Color4 } from "babylonjs/Maths/math.color";
  68653. import { Mesh } from "babylonjs/Meshes/mesh";
  68654. /**
  68655. * Class containing static functions to help procedurally build meshes
  68656. */
  68657. export class TiledBoxBuilder {
  68658. /**
  68659. * Creates a box mesh
  68660. * 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)
  68661. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68662. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68663. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68664. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68665. * @param name defines the name of the mesh
  68666. * @param options defines the options used to create the mesh
  68667. * @param scene defines the hosting scene
  68668. * @returns the box mesh
  68669. */
  68670. static CreateTiledBox(name: string, options: {
  68671. pattern?: number;
  68672. width?: number;
  68673. height?: number;
  68674. depth?: number;
  68675. tileSize?: number;
  68676. tileWidth?: number;
  68677. tileHeight?: number;
  68678. alignHorizontal?: number;
  68679. alignVertical?: number;
  68680. faceUV?: Vector4[];
  68681. faceColors?: Color4[];
  68682. sideOrientation?: number;
  68683. updatable?: boolean;
  68684. }, scene?: Nullable<Scene>): Mesh;
  68685. }
  68686. }
  68687. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68688. import { Vector4 } from "babylonjs/Maths/math.vector";
  68689. import { Mesh } from "babylonjs/Meshes/mesh";
  68690. /**
  68691. * Class containing static functions to help procedurally build meshes
  68692. */
  68693. export class TorusKnotBuilder {
  68694. /**
  68695. * Creates a torus knot mesh
  68696. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68697. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68698. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68699. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68700. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68701. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68702. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68703. * @param name defines the name of the mesh
  68704. * @param options defines the options used to create the mesh
  68705. * @param scene defines the hosting scene
  68706. * @returns the torus knot mesh
  68707. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68708. */
  68709. static CreateTorusKnot(name: string, options: {
  68710. radius?: number;
  68711. tube?: number;
  68712. radialSegments?: number;
  68713. tubularSegments?: number;
  68714. p?: number;
  68715. q?: number;
  68716. updatable?: boolean;
  68717. sideOrientation?: number;
  68718. frontUVs?: Vector4;
  68719. backUVs?: Vector4;
  68720. }, scene: any): Mesh;
  68721. }
  68722. }
  68723. declare module "babylonjs/Meshes/polygonMesh" {
  68724. import { Scene } from "babylonjs/scene";
  68725. import { Vector2 } from "babylonjs/Maths/math.vector";
  68726. import { Mesh } from "babylonjs/Meshes/mesh";
  68727. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68728. import { Path2 } from "babylonjs/Maths/math.path";
  68729. /**
  68730. * Polygon
  68731. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68732. */
  68733. export class Polygon {
  68734. /**
  68735. * Creates a rectangle
  68736. * @param xmin bottom X coord
  68737. * @param ymin bottom Y coord
  68738. * @param xmax top X coord
  68739. * @param ymax top Y coord
  68740. * @returns points that make the resulting rectation
  68741. */
  68742. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68743. /**
  68744. * Creates a circle
  68745. * @param radius radius of circle
  68746. * @param cx scale in x
  68747. * @param cy scale in y
  68748. * @param numberOfSides number of sides that make up the circle
  68749. * @returns points that make the resulting circle
  68750. */
  68751. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68752. /**
  68753. * Creates a polygon from input string
  68754. * @param input Input polygon data
  68755. * @returns the parsed points
  68756. */
  68757. static Parse(input: string): Vector2[];
  68758. /**
  68759. * Starts building a polygon from x and y coordinates
  68760. * @param x x coordinate
  68761. * @param y y coordinate
  68762. * @returns the started path2
  68763. */
  68764. static StartingAt(x: number, y: number): Path2;
  68765. }
  68766. /**
  68767. * Builds a polygon
  68768. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68769. */
  68770. export class PolygonMeshBuilder {
  68771. private _points;
  68772. private _outlinepoints;
  68773. private _holes;
  68774. private _name;
  68775. private _scene;
  68776. private _epoints;
  68777. private _eholes;
  68778. private _addToepoint;
  68779. /**
  68780. * Babylon reference to the earcut plugin.
  68781. */
  68782. bjsEarcut: any;
  68783. /**
  68784. * Creates a PolygonMeshBuilder
  68785. * @param name name of the builder
  68786. * @param contours Path of the polygon
  68787. * @param scene scene to add to when creating the mesh
  68788. * @param earcutInjection can be used to inject your own earcut reference
  68789. */
  68790. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68791. /**
  68792. * Adds a whole within the polygon
  68793. * @param hole Array of points defining the hole
  68794. * @returns this
  68795. */
  68796. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68797. /**
  68798. * Creates the polygon
  68799. * @param updatable If the mesh should be updatable
  68800. * @param depth The depth of the mesh created
  68801. * @returns the created mesh
  68802. */
  68803. build(updatable?: boolean, depth?: number): Mesh;
  68804. /**
  68805. * Creates the polygon
  68806. * @param depth The depth of the mesh created
  68807. * @returns the created VertexData
  68808. */
  68809. buildVertexData(depth?: number): VertexData;
  68810. /**
  68811. * Adds a side to the polygon
  68812. * @param positions points that make the polygon
  68813. * @param normals normals of the polygon
  68814. * @param uvs uvs of the polygon
  68815. * @param indices indices of the polygon
  68816. * @param bounds bounds of the polygon
  68817. * @param points points of the polygon
  68818. * @param depth depth of the polygon
  68819. * @param flip flip of the polygon
  68820. */
  68821. private addSide;
  68822. }
  68823. }
  68824. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68825. import { Scene } from "babylonjs/scene";
  68826. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68827. import { Color4 } from "babylonjs/Maths/math.color";
  68828. import { Mesh } from "babylonjs/Meshes/mesh";
  68829. import { Nullable } from "babylonjs/types";
  68830. /**
  68831. * Class containing static functions to help procedurally build meshes
  68832. */
  68833. export class PolygonBuilder {
  68834. /**
  68835. * Creates a polygon mesh
  68836. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68837. * * 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
  68838. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68839. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68840. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68841. * * Remember you can only change the shape positions, not their number when updating a polygon
  68842. * @param name defines the name of the mesh
  68843. * @param options defines the options used to create the mesh
  68844. * @param scene defines the hosting scene
  68845. * @param earcutInjection can be used to inject your own earcut reference
  68846. * @returns the polygon mesh
  68847. */
  68848. static CreatePolygon(name: string, options: {
  68849. shape: Vector3[];
  68850. holes?: Vector3[][];
  68851. depth?: number;
  68852. faceUV?: Vector4[];
  68853. faceColors?: Color4[];
  68854. updatable?: boolean;
  68855. sideOrientation?: number;
  68856. frontUVs?: Vector4;
  68857. backUVs?: Vector4;
  68858. wrap?: boolean;
  68859. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68860. /**
  68861. * Creates an extruded polygon mesh, with depth in the Y direction.
  68862. * * 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)
  68863. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68864. * @param name defines the name of the mesh
  68865. * @param options defines the options used to create the mesh
  68866. * @param scene defines the hosting scene
  68867. * @param earcutInjection can be used to inject your own earcut reference
  68868. * @returns the polygon mesh
  68869. */
  68870. static ExtrudePolygon(name: string, options: {
  68871. shape: Vector3[];
  68872. holes?: Vector3[][];
  68873. depth?: number;
  68874. faceUV?: Vector4[];
  68875. faceColors?: Color4[];
  68876. updatable?: boolean;
  68877. sideOrientation?: number;
  68878. frontUVs?: Vector4;
  68879. backUVs?: Vector4;
  68880. wrap?: boolean;
  68881. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68882. }
  68883. }
  68884. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68885. import { Scene } from "babylonjs/scene";
  68886. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68887. import { Mesh } from "babylonjs/Meshes/mesh";
  68888. import { Nullable } from "babylonjs/types";
  68889. /**
  68890. * Class containing static functions to help procedurally build meshes
  68891. */
  68892. export class LatheBuilder {
  68893. /**
  68894. * Creates lathe mesh.
  68895. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68896. * * 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
  68897. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68898. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68899. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68900. * * 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
  68901. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68902. * * 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
  68903. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68904. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68905. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68906. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68907. * @param name defines the name of the mesh
  68908. * @param options defines the options used to create the mesh
  68909. * @param scene defines the hosting scene
  68910. * @returns the lathe mesh
  68911. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68912. */
  68913. static CreateLathe(name: string, options: {
  68914. shape: Vector3[];
  68915. radius?: number;
  68916. tessellation?: number;
  68917. clip?: number;
  68918. arc?: number;
  68919. closed?: boolean;
  68920. updatable?: boolean;
  68921. sideOrientation?: number;
  68922. frontUVs?: Vector4;
  68923. backUVs?: Vector4;
  68924. cap?: number;
  68925. invertUV?: boolean;
  68926. }, scene?: Nullable<Scene>): Mesh;
  68927. }
  68928. }
  68929. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68930. import { Nullable } from "babylonjs/types";
  68931. import { Scene } from "babylonjs/scene";
  68932. import { Vector4 } from "babylonjs/Maths/math.vector";
  68933. import { Mesh } from "babylonjs/Meshes/mesh";
  68934. /**
  68935. * Class containing static functions to help procedurally build meshes
  68936. */
  68937. export class TiledPlaneBuilder {
  68938. /**
  68939. * Creates a tiled plane mesh
  68940. * * The parameter `pattern` will, depending on value, do nothing or
  68941. * * * flip (reflect about central vertical) alternate tiles across and up
  68942. * * * flip every tile on alternate rows
  68943. * * * rotate (180 degs) alternate tiles across and up
  68944. * * * rotate every tile on alternate rows
  68945. * * * flip and rotate alternate tiles across and up
  68946. * * * flip and rotate every tile on alternate rows
  68947. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68948. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68949. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68950. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68951. * * 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)
  68952. * * 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)
  68953. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68954. * @param name defines the name of the mesh
  68955. * @param options defines the options used to create the mesh
  68956. * @param scene defines the hosting scene
  68957. * @returns the box mesh
  68958. */
  68959. static CreateTiledPlane(name: string, options: {
  68960. pattern?: number;
  68961. tileSize?: number;
  68962. tileWidth?: number;
  68963. tileHeight?: number;
  68964. size?: number;
  68965. width?: number;
  68966. height?: number;
  68967. alignHorizontal?: number;
  68968. alignVertical?: number;
  68969. sideOrientation?: number;
  68970. frontUVs?: Vector4;
  68971. backUVs?: Vector4;
  68972. updatable?: boolean;
  68973. }, scene?: Nullable<Scene>): Mesh;
  68974. }
  68975. }
  68976. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68977. import { Nullable } from "babylonjs/types";
  68978. import { Scene } from "babylonjs/scene";
  68979. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68980. import { Mesh } from "babylonjs/Meshes/mesh";
  68981. /**
  68982. * Class containing static functions to help procedurally build meshes
  68983. */
  68984. export class TubeBuilder {
  68985. /**
  68986. * Creates a tube mesh.
  68987. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68988. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68989. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68990. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68991. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68992. * * 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)
  68993. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68994. * * 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
  68995. * * 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
  68996. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68997. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68998. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68999. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69000. * @param name defines the name of the mesh
  69001. * @param options defines the options used to create the mesh
  69002. * @param scene defines the hosting scene
  69003. * @returns the tube mesh
  69004. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69005. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69006. */
  69007. static CreateTube(name: string, options: {
  69008. path: Vector3[];
  69009. radius?: number;
  69010. tessellation?: number;
  69011. radiusFunction?: {
  69012. (i: number, distance: number): number;
  69013. };
  69014. cap?: number;
  69015. arc?: number;
  69016. updatable?: boolean;
  69017. sideOrientation?: number;
  69018. frontUVs?: Vector4;
  69019. backUVs?: Vector4;
  69020. instance?: Mesh;
  69021. invertUV?: boolean;
  69022. }, scene?: Nullable<Scene>): Mesh;
  69023. }
  69024. }
  69025. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69026. import { Scene } from "babylonjs/scene";
  69027. import { Vector4 } from "babylonjs/Maths/math.vector";
  69028. import { Mesh } from "babylonjs/Meshes/mesh";
  69029. import { Nullable } from "babylonjs/types";
  69030. /**
  69031. * Class containing static functions to help procedurally build meshes
  69032. */
  69033. export class IcoSphereBuilder {
  69034. /**
  69035. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69036. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69037. * * 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`)
  69038. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69039. * * 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
  69040. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69041. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69042. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69043. * @param name defines the name of the mesh
  69044. * @param options defines the options used to create the mesh
  69045. * @param scene defines the hosting scene
  69046. * @returns the icosahedron mesh
  69047. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69048. */
  69049. static CreateIcoSphere(name: string, options: {
  69050. radius?: number;
  69051. radiusX?: number;
  69052. radiusY?: number;
  69053. radiusZ?: number;
  69054. flat?: boolean;
  69055. subdivisions?: number;
  69056. sideOrientation?: number;
  69057. frontUVs?: Vector4;
  69058. backUVs?: Vector4;
  69059. updatable?: boolean;
  69060. }, scene?: Nullable<Scene>): Mesh;
  69061. }
  69062. }
  69063. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69064. import { Vector3 } from "babylonjs/Maths/math.vector";
  69065. import { Mesh } from "babylonjs/Meshes/mesh";
  69066. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69067. /**
  69068. * Class containing static functions to help procedurally build meshes
  69069. */
  69070. export class DecalBuilder {
  69071. /**
  69072. * Creates a decal mesh.
  69073. * 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
  69074. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69075. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69076. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69077. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69078. * @param name defines the name of the mesh
  69079. * @param sourceMesh defines the mesh where the decal must be applied
  69080. * @param options defines the options used to create the mesh
  69081. * @param scene defines the hosting scene
  69082. * @returns the decal mesh
  69083. * @see https://doc.babylonjs.com/how_to/decals
  69084. */
  69085. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69086. position?: Vector3;
  69087. normal?: Vector3;
  69088. size?: Vector3;
  69089. angle?: number;
  69090. }): Mesh;
  69091. }
  69092. }
  69093. declare module "babylonjs/Meshes/meshBuilder" {
  69094. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69095. import { Nullable } from "babylonjs/types";
  69096. import { Scene } from "babylonjs/scene";
  69097. import { Mesh } from "babylonjs/Meshes/mesh";
  69098. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69099. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69100. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69101. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69102. import { Plane } from "babylonjs/Maths/math.plane";
  69103. /**
  69104. * Class containing static functions to help procedurally build meshes
  69105. */
  69106. export class MeshBuilder {
  69107. /**
  69108. * Creates a box mesh
  69109. * * The parameter `size` sets the size (float) of each box side (default 1)
  69110. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69111. * * 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)
  69112. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69113. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69114. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69115. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69116. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69117. * @param name defines the name of the mesh
  69118. * @param options defines the options used to create the mesh
  69119. * @param scene defines the hosting scene
  69120. * @returns the box mesh
  69121. */
  69122. static CreateBox(name: string, options: {
  69123. size?: number;
  69124. width?: number;
  69125. height?: number;
  69126. depth?: number;
  69127. faceUV?: Vector4[];
  69128. faceColors?: Color4[];
  69129. sideOrientation?: number;
  69130. frontUVs?: Vector4;
  69131. backUVs?: Vector4;
  69132. wrap?: boolean;
  69133. topBaseAt?: number;
  69134. bottomBaseAt?: number;
  69135. updatable?: boolean;
  69136. }, scene?: Nullable<Scene>): Mesh;
  69137. /**
  69138. * Creates a tiled box mesh
  69139. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69140. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69141. * @param name defines the name of the mesh
  69142. * @param options defines the options used to create the mesh
  69143. * @param scene defines the hosting scene
  69144. * @returns the tiled box mesh
  69145. */
  69146. static CreateTiledBox(name: string, options: {
  69147. pattern?: number;
  69148. size?: number;
  69149. width?: number;
  69150. height?: number;
  69151. depth: number;
  69152. tileSize?: number;
  69153. tileWidth?: number;
  69154. tileHeight?: number;
  69155. faceUV?: Vector4[];
  69156. faceColors?: Color4[];
  69157. alignHorizontal?: number;
  69158. alignVertical?: number;
  69159. sideOrientation?: number;
  69160. updatable?: boolean;
  69161. }, scene?: Nullable<Scene>): Mesh;
  69162. /**
  69163. * Creates a sphere mesh
  69164. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69165. * * 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`)
  69166. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69167. * * 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
  69168. * * 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)
  69169. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69170. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69171. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69172. * @param name defines the name of the mesh
  69173. * @param options defines the options used to create the mesh
  69174. * @param scene defines the hosting scene
  69175. * @returns the sphere mesh
  69176. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69177. */
  69178. static CreateSphere(name: string, options: {
  69179. segments?: number;
  69180. diameter?: number;
  69181. diameterX?: number;
  69182. diameterY?: number;
  69183. diameterZ?: number;
  69184. arc?: number;
  69185. slice?: number;
  69186. sideOrientation?: number;
  69187. frontUVs?: Vector4;
  69188. backUVs?: Vector4;
  69189. updatable?: boolean;
  69190. }, scene?: Nullable<Scene>): Mesh;
  69191. /**
  69192. * Creates a plane polygonal mesh. By default, this is a disc
  69193. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69194. * * 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
  69195. * * 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
  69196. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69197. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69198. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69199. * @param name defines the name of the mesh
  69200. * @param options defines the options used to create the mesh
  69201. * @param scene defines the hosting scene
  69202. * @returns the plane polygonal mesh
  69203. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69204. */
  69205. static CreateDisc(name: string, options: {
  69206. radius?: number;
  69207. tessellation?: number;
  69208. arc?: number;
  69209. updatable?: boolean;
  69210. sideOrientation?: number;
  69211. frontUVs?: Vector4;
  69212. backUVs?: Vector4;
  69213. }, scene?: Nullable<Scene>): Mesh;
  69214. /**
  69215. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69216. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69217. * * 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`)
  69218. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69219. * * 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
  69220. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69221. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69222. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69223. * @param name defines the name of the mesh
  69224. * @param options defines the options used to create the mesh
  69225. * @param scene defines the hosting scene
  69226. * @returns the icosahedron mesh
  69227. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69228. */
  69229. static CreateIcoSphere(name: string, options: {
  69230. radius?: number;
  69231. radiusX?: number;
  69232. radiusY?: number;
  69233. radiusZ?: number;
  69234. flat?: boolean;
  69235. subdivisions?: number;
  69236. sideOrientation?: number;
  69237. frontUVs?: Vector4;
  69238. backUVs?: Vector4;
  69239. updatable?: boolean;
  69240. }, scene?: Nullable<Scene>): Mesh;
  69241. /**
  69242. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69243. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69244. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69245. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69246. * * 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
  69247. * * 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
  69248. * * 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
  69249. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69250. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69251. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69252. * * 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
  69253. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69254. * * 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
  69255. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69256. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69257. * @param name defines the name of the mesh
  69258. * @param options defines the options used to create the mesh
  69259. * @param scene defines the hosting scene
  69260. * @returns the ribbon mesh
  69261. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69262. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69263. */
  69264. static CreateRibbon(name: string, options: {
  69265. pathArray: Vector3[][];
  69266. closeArray?: boolean;
  69267. closePath?: boolean;
  69268. offset?: number;
  69269. updatable?: boolean;
  69270. sideOrientation?: number;
  69271. frontUVs?: Vector4;
  69272. backUVs?: Vector4;
  69273. instance?: Mesh;
  69274. invertUV?: boolean;
  69275. uvs?: Vector2[];
  69276. colors?: Color4[];
  69277. }, scene?: Nullable<Scene>): Mesh;
  69278. /**
  69279. * Creates a cylinder or a cone mesh
  69280. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69281. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69282. * * 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.
  69283. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69284. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69285. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69286. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69287. * * 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).
  69288. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69289. * * 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).
  69290. * * 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
  69291. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69292. * * 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
  69293. * * 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.
  69294. * * If `enclose` is false, a ring surface is one element.
  69295. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69296. * * 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
  69297. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69298. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69299. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69300. * @param name defines the name of the mesh
  69301. * @param options defines the options used to create the mesh
  69302. * @param scene defines the hosting scene
  69303. * @returns the cylinder mesh
  69304. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69305. */
  69306. static CreateCylinder(name: string, options: {
  69307. height?: number;
  69308. diameterTop?: number;
  69309. diameterBottom?: number;
  69310. diameter?: number;
  69311. tessellation?: number;
  69312. subdivisions?: number;
  69313. arc?: number;
  69314. faceColors?: Color4[];
  69315. faceUV?: Vector4[];
  69316. updatable?: boolean;
  69317. hasRings?: boolean;
  69318. enclose?: boolean;
  69319. cap?: number;
  69320. sideOrientation?: number;
  69321. frontUVs?: Vector4;
  69322. backUVs?: Vector4;
  69323. }, scene?: Nullable<Scene>): Mesh;
  69324. /**
  69325. * Creates a torus mesh
  69326. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69327. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69328. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69329. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69330. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69331. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69332. * @param name defines the name of the mesh
  69333. * @param options defines the options used to create the mesh
  69334. * @param scene defines the hosting scene
  69335. * @returns the torus mesh
  69336. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69337. */
  69338. static CreateTorus(name: string, options: {
  69339. diameter?: number;
  69340. thickness?: number;
  69341. tessellation?: number;
  69342. updatable?: boolean;
  69343. sideOrientation?: number;
  69344. frontUVs?: Vector4;
  69345. backUVs?: Vector4;
  69346. }, scene?: Nullable<Scene>): Mesh;
  69347. /**
  69348. * Creates a torus knot mesh
  69349. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69350. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69351. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69352. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69353. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69354. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69356. * @param name defines the name of the mesh
  69357. * @param options defines the options used to create the mesh
  69358. * @param scene defines the hosting scene
  69359. * @returns the torus knot mesh
  69360. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69361. */
  69362. static CreateTorusKnot(name: string, options: {
  69363. radius?: number;
  69364. tube?: number;
  69365. radialSegments?: number;
  69366. tubularSegments?: number;
  69367. p?: number;
  69368. q?: number;
  69369. updatable?: boolean;
  69370. sideOrientation?: number;
  69371. frontUVs?: Vector4;
  69372. backUVs?: Vector4;
  69373. }, scene?: Nullable<Scene>): Mesh;
  69374. /**
  69375. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69376. * * 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
  69377. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69378. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69379. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69380. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69381. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69382. * * 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
  69383. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69384. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69385. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69386. * @param name defines the name of the new line system
  69387. * @param options defines the options used to create the line system
  69388. * @param scene defines the hosting scene
  69389. * @returns a new line system mesh
  69390. */
  69391. static CreateLineSystem(name: string, options: {
  69392. lines: Vector3[][];
  69393. updatable?: boolean;
  69394. instance?: Nullable<LinesMesh>;
  69395. colors?: Nullable<Color4[][]>;
  69396. useVertexAlpha?: boolean;
  69397. }, scene: Nullable<Scene>): LinesMesh;
  69398. /**
  69399. * Creates a line mesh
  69400. * 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
  69401. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69402. * * The parameter `points` is an array successive Vector3
  69403. * * 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
  69404. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69405. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69406. * * When updating an instance, remember that only point positions can change, not the number of points
  69407. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69408. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69409. * @param name defines the name of the new line system
  69410. * @param options defines the options used to create the line system
  69411. * @param scene defines the hosting scene
  69412. * @returns a new line mesh
  69413. */
  69414. static CreateLines(name: string, options: {
  69415. points: Vector3[];
  69416. updatable?: boolean;
  69417. instance?: Nullable<LinesMesh>;
  69418. colors?: Color4[];
  69419. useVertexAlpha?: boolean;
  69420. }, scene?: Nullable<Scene>): LinesMesh;
  69421. /**
  69422. * Creates a dashed line mesh
  69423. * * 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
  69424. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69425. * * The parameter `points` is an array successive Vector3
  69426. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69427. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69428. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69429. * * 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
  69430. * * When updating an instance, remember that only point positions can change, not the number of points
  69431. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69432. * @param name defines the name of the mesh
  69433. * @param options defines the options used to create the mesh
  69434. * @param scene defines the hosting scene
  69435. * @returns the dashed line mesh
  69436. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69437. */
  69438. static CreateDashedLines(name: string, options: {
  69439. points: Vector3[];
  69440. dashSize?: number;
  69441. gapSize?: number;
  69442. dashNb?: number;
  69443. updatable?: boolean;
  69444. instance?: LinesMesh;
  69445. }, scene?: Nullable<Scene>): LinesMesh;
  69446. /**
  69447. * 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.
  69448. * * 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.
  69449. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69450. * * 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.
  69451. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69452. * * 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
  69453. * * 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
  69454. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69455. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69456. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69457. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69458. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69459. * @param name defines the name of the mesh
  69460. * @param options defines the options used to create the mesh
  69461. * @param scene defines the hosting scene
  69462. * @returns the extruded shape mesh
  69463. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69464. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69465. */
  69466. static ExtrudeShape(name: string, options: {
  69467. shape: Vector3[];
  69468. path: Vector3[];
  69469. scale?: number;
  69470. rotation?: number;
  69471. cap?: number;
  69472. updatable?: boolean;
  69473. sideOrientation?: number;
  69474. frontUVs?: Vector4;
  69475. backUVs?: Vector4;
  69476. instance?: Mesh;
  69477. invertUV?: boolean;
  69478. }, scene?: Nullable<Scene>): Mesh;
  69479. /**
  69480. * Creates an custom extruded shape mesh.
  69481. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69482. * * 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.
  69483. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69484. * * 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
  69485. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69486. * * 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
  69487. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69488. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69489. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69490. * * 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
  69491. * * 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
  69492. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69493. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69494. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69495. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69496. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69497. * @param name defines the name of the mesh
  69498. * @param options defines the options used to create the mesh
  69499. * @param scene defines the hosting scene
  69500. * @returns the custom extruded shape mesh
  69501. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69502. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69503. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69504. */
  69505. static ExtrudeShapeCustom(name: string, options: {
  69506. shape: Vector3[];
  69507. path: Vector3[];
  69508. scaleFunction?: any;
  69509. rotationFunction?: any;
  69510. ribbonCloseArray?: boolean;
  69511. ribbonClosePath?: boolean;
  69512. cap?: number;
  69513. updatable?: boolean;
  69514. sideOrientation?: number;
  69515. frontUVs?: Vector4;
  69516. backUVs?: Vector4;
  69517. instance?: Mesh;
  69518. invertUV?: boolean;
  69519. }, scene?: Nullable<Scene>): Mesh;
  69520. /**
  69521. * Creates lathe mesh.
  69522. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69523. * * 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
  69524. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69525. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69526. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69527. * * 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
  69528. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69529. * * 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
  69530. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69531. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69532. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69533. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69534. * @param name defines the name of the mesh
  69535. * @param options defines the options used to create the mesh
  69536. * @param scene defines the hosting scene
  69537. * @returns the lathe mesh
  69538. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69539. */
  69540. static CreateLathe(name: string, options: {
  69541. shape: Vector3[];
  69542. radius?: number;
  69543. tessellation?: number;
  69544. clip?: number;
  69545. arc?: number;
  69546. closed?: boolean;
  69547. updatable?: boolean;
  69548. sideOrientation?: number;
  69549. frontUVs?: Vector4;
  69550. backUVs?: Vector4;
  69551. cap?: number;
  69552. invertUV?: boolean;
  69553. }, scene?: Nullable<Scene>): Mesh;
  69554. /**
  69555. * Creates a tiled plane mesh
  69556. * * You can set a limited pattern arrangement with the tiles
  69557. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69558. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69559. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69560. * @param name defines the name of the mesh
  69561. * @param options defines the options used to create the mesh
  69562. * @param scene defines the hosting scene
  69563. * @returns the plane mesh
  69564. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69565. */
  69566. static CreateTiledPlane(name: string, options: {
  69567. pattern?: number;
  69568. tileSize?: number;
  69569. tileWidth?: number;
  69570. tileHeight?: number;
  69571. size?: number;
  69572. width?: number;
  69573. height?: number;
  69574. alignHorizontal?: number;
  69575. alignVertical?: number;
  69576. sideOrientation?: number;
  69577. frontUVs?: Vector4;
  69578. backUVs?: Vector4;
  69579. updatable?: boolean;
  69580. }, scene?: Nullable<Scene>): Mesh;
  69581. /**
  69582. * Creates a plane mesh
  69583. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69584. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69585. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69586. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69587. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69588. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69589. * @param name defines the name of the mesh
  69590. * @param options defines the options used to create the mesh
  69591. * @param scene defines the hosting scene
  69592. * @returns the plane mesh
  69593. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69594. */
  69595. static CreatePlane(name: string, options: {
  69596. size?: number;
  69597. width?: number;
  69598. height?: number;
  69599. sideOrientation?: number;
  69600. frontUVs?: Vector4;
  69601. backUVs?: Vector4;
  69602. updatable?: boolean;
  69603. sourcePlane?: Plane;
  69604. }, scene?: Nullable<Scene>): Mesh;
  69605. /**
  69606. * Creates a ground mesh
  69607. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69608. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69609. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69610. * @param name defines the name of the mesh
  69611. * @param options defines the options used to create the mesh
  69612. * @param scene defines the hosting scene
  69613. * @returns the ground mesh
  69614. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69615. */
  69616. static CreateGround(name: string, options: {
  69617. width?: number;
  69618. height?: number;
  69619. subdivisions?: number;
  69620. subdivisionsX?: number;
  69621. subdivisionsY?: number;
  69622. updatable?: boolean;
  69623. }, scene?: Nullable<Scene>): Mesh;
  69624. /**
  69625. * Creates a tiled ground mesh
  69626. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69627. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69628. * * 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
  69629. * * 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
  69630. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69631. * @param name defines the name of the mesh
  69632. * @param options defines the options used to create the mesh
  69633. * @param scene defines the hosting scene
  69634. * @returns the tiled ground mesh
  69635. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69636. */
  69637. static CreateTiledGround(name: string, options: {
  69638. xmin: number;
  69639. zmin: number;
  69640. xmax: number;
  69641. zmax: number;
  69642. subdivisions?: {
  69643. w: number;
  69644. h: number;
  69645. };
  69646. precision?: {
  69647. w: number;
  69648. h: number;
  69649. };
  69650. updatable?: boolean;
  69651. }, scene?: Nullable<Scene>): Mesh;
  69652. /**
  69653. * Creates a ground mesh from a height map
  69654. * * The parameter `url` sets the URL of the height map image resource.
  69655. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69656. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69657. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69658. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69659. * * 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.
  69660. * * 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).
  69661. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69662. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69663. * @param name defines the name of the mesh
  69664. * @param url defines the url to the height map
  69665. * @param options defines the options used to create the mesh
  69666. * @param scene defines the hosting scene
  69667. * @returns the ground mesh
  69668. * @see https://doc.babylonjs.com/babylon101/height_map
  69669. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69670. */
  69671. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69672. width?: number;
  69673. height?: number;
  69674. subdivisions?: number;
  69675. minHeight?: number;
  69676. maxHeight?: number;
  69677. colorFilter?: Color3;
  69678. alphaFilter?: number;
  69679. updatable?: boolean;
  69680. onReady?: (mesh: GroundMesh) => void;
  69681. }, scene?: Nullable<Scene>): GroundMesh;
  69682. /**
  69683. * Creates a polygon mesh
  69684. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69685. * * 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
  69686. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69687. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69688. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69689. * * Remember you can only change the shape positions, not their number when updating a polygon
  69690. * @param name defines the name of the mesh
  69691. * @param options defines the options used to create the mesh
  69692. * @param scene defines the hosting scene
  69693. * @param earcutInjection can be used to inject your own earcut reference
  69694. * @returns the polygon mesh
  69695. */
  69696. static CreatePolygon(name: string, options: {
  69697. shape: Vector3[];
  69698. holes?: Vector3[][];
  69699. depth?: number;
  69700. faceUV?: Vector4[];
  69701. faceColors?: Color4[];
  69702. updatable?: boolean;
  69703. sideOrientation?: number;
  69704. frontUVs?: Vector4;
  69705. backUVs?: Vector4;
  69706. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69707. /**
  69708. * Creates an extruded polygon mesh, with depth in the Y direction.
  69709. * * 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)
  69710. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69711. * @param name defines the name of the mesh
  69712. * @param options defines the options used to create the mesh
  69713. * @param scene defines the hosting scene
  69714. * @param earcutInjection can be used to inject your own earcut reference
  69715. * @returns the polygon mesh
  69716. */
  69717. static ExtrudePolygon(name: string, options: {
  69718. shape: Vector3[];
  69719. holes?: Vector3[][];
  69720. depth?: number;
  69721. faceUV?: Vector4[];
  69722. faceColors?: Color4[];
  69723. updatable?: boolean;
  69724. sideOrientation?: number;
  69725. frontUVs?: Vector4;
  69726. backUVs?: Vector4;
  69727. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69728. /**
  69729. * Creates a tube mesh.
  69730. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69731. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69732. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69733. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69734. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69735. * * 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)
  69736. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69737. * * 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
  69738. * * 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
  69739. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69740. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69741. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69742. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69743. * @param name defines the name of the mesh
  69744. * @param options defines the options used to create the mesh
  69745. * @param scene defines the hosting scene
  69746. * @returns the tube mesh
  69747. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69748. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69749. */
  69750. static CreateTube(name: string, options: {
  69751. path: Vector3[];
  69752. radius?: number;
  69753. tessellation?: number;
  69754. radiusFunction?: {
  69755. (i: number, distance: number): number;
  69756. };
  69757. cap?: number;
  69758. arc?: number;
  69759. updatable?: boolean;
  69760. sideOrientation?: number;
  69761. frontUVs?: Vector4;
  69762. backUVs?: Vector4;
  69763. instance?: Mesh;
  69764. invertUV?: boolean;
  69765. }, scene?: Nullable<Scene>): Mesh;
  69766. /**
  69767. * Creates a polyhedron mesh
  69768. * * 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
  69769. * * The parameter `size` (positive float, default 1) sets the polygon size
  69770. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69771. * * 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`
  69772. * * 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
  69773. * * 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)`)
  69774. * * 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
  69775. * * 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
  69776. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69777. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69778. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69779. * @param name defines the name of the mesh
  69780. * @param options defines the options used to create the mesh
  69781. * @param scene defines the hosting scene
  69782. * @returns the polyhedron mesh
  69783. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69784. */
  69785. static CreatePolyhedron(name: string, options: {
  69786. type?: number;
  69787. size?: number;
  69788. sizeX?: number;
  69789. sizeY?: number;
  69790. sizeZ?: number;
  69791. custom?: any;
  69792. faceUV?: Vector4[];
  69793. faceColors?: Color4[];
  69794. flat?: boolean;
  69795. updatable?: boolean;
  69796. sideOrientation?: number;
  69797. frontUVs?: Vector4;
  69798. backUVs?: Vector4;
  69799. }, scene?: Nullable<Scene>): Mesh;
  69800. /**
  69801. * Creates a decal mesh.
  69802. * 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
  69803. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69804. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69805. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69806. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69807. * @param name defines the name of the mesh
  69808. * @param sourceMesh defines the mesh where the decal must be applied
  69809. * @param options defines the options used to create the mesh
  69810. * @param scene defines the hosting scene
  69811. * @returns the decal mesh
  69812. * @see https://doc.babylonjs.com/how_to/decals
  69813. */
  69814. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69815. position?: Vector3;
  69816. normal?: Vector3;
  69817. size?: Vector3;
  69818. angle?: number;
  69819. }): Mesh;
  69820. }
  69821. }
  69822. declare module "babylonjs/Meshes/meshSimplification" {
  69823. import { Mesh } from "babylonjs/Meshes/mesh";
  69824. /**
  69825. * A simplifier interface for future simplification implementations
  69826. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69827. */
  69828. export interface ISimplifier {
  69829. /**
  69830. * Simplification of a given mesh according to the given settings.
  69831. * Since this requires computation, it is assumed that the function runs async.
  69832. * @param settings The settings of the simplification, including quality and distance
  69833. * @param successCallback A callback that will be called after the mesh was simplified.
  69834. * @param errorCallback in case of an error, this callback will be called. optional.
  69835. */
  69836. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69837. }
  69838. /**
  69839. * Expected simplification settings.
  69840. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69841. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69842. */
  69843. export interface ISimplificationSettings {
  69844. /**
  69845. * Gets or sets the expected quality
  69846. */
  69847. quality: number;
  69848. /**
  69849. * Gets or sets the distance when this optimized version should be used
  69850. */
  69851. distance: number;
  69852. /**
  69853. * Gets an already optimized mesh
  69854. */
  69855. optimizeMesh?: boolean;
  69856. }
  69857. /**
  69858. * Class used to specify simplification options
  69859. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69860. */
  69861. export class SimplificationSettings implements ISimplificationSettings {
  69862. /** expected quality */
  69863. quality: number;
  69864. /** distance when this optimized version should be used */
  69865. distance: number;
  69866. /** already optimized mesh */
  69867. optimizeMesh?: boolean | undefined;
  69868. /**
  69869. * Creates a SimplificationSettings
  69870. * @param quality expected quality
  69871. * @param distance distance when this optimized version should be used
  69872. * @param optimizeMesh already optimized mesh
  69873. */
  69874. constructor(
  69875. /** expected quality */
  69876. quality: number,
  69877. /** distance when this optimized version should be used */
  69878. distance: number,
  69879. /** already optimized mesh */
  69880. optimizeMesh?: boolean | undefined);
  69881. }
  69882. /**
  69883. * Interface used to define a simplification task
  69884. */
  69885. export interface ISimplificationTask {
  69886. /**
  69887. * Array of settings
  69888. */
  69889. settings: Array<ISimplificationSettings>;
  69890. /**
  69891. * Simplification type
  69892. */
  69893. simplificationType: SimplificationType;
  69894. /**
  69895. * Mesh to simplify
  69896. */
  69897. mesh: Mesh;
  69898. /**
  69899. * Callback called on success
  69900. */
  69901. successCallback?: () => void;
  69902. /**
  69903. * Defines if parallel processing can be used
  69904. */
  69905. parallelProcessing: boolean;
  69906. }
  69907. /**
  69908. * Queue used to order the simplification tasks
  69909. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69910. */
  69911. export class SimplificationQueue {
  69912. private _simplificationArray;
  69913. /**
  69914. * Gets a boolean indicating that the process is still running
  69915. */
  69916. running: boolean;
  69917. /**
  69918. * Creates a new queue
  69919. */
  69920. constructor();
  69921. /**
  69922. * Adds a new simplification task
  69923. * @param task defines a task to add
  69924. */
  69925. addTask(task: ISimplificationTask): void;
  69926. /**
  69927. * Execute next task
  69928. */
  69929. executeNext(): void;
  69930. /**
  69931. * Execute a simplification task
  69932. * @param task defines the task to run
  69933. */
  69934. runSimplification(task: ISimplificationTask): void;
  69935. private getSimplifier;
  69936. }
  69937. /**
  69938. * The implemented types of simplification
  69939. * At the moment only Quadratic Error Decimation is implemented
  69940. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69941. */
  69942. export enum SimplificationType {
  69943. /** Quadratic error decimation */
  69944. QUADRATIC = 0
  69945. }
  69946. /**
  69947. * An implementation of the Quadratic Error simplification algorithm.
  69948. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69949. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69950. * @author RaananW
  69951. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69952. */
  69953. export class QuadraticErrorSimplification implements ISimplifier {
  69954. private _mesh;
  69955. private triangles;
  69956. private vertices;
  69957. private references;
  69958. private _reconstructedMesh;
  69959. /** Gets or sets the number pf sync interations */
  69960. syncIterations: number;
  69961. /** Gets or sets the aggressiveness of the simplifier */
  69962. aggressiveness: number;
  69963. /** Gets or sets the number of allowed iterations for decimation */
  69964. decimationIterations: number;
  69965. /** Gets or sets the espilon to use for bounding box computation */
  69966. boundingBoxEpsilon: number;
  69967. /**
  69968. * Creates a new QuadraticErrorSimplification
  69969. * @param _mesh defines the target mesh
  69970. */
  69971. constructor(_mesh: Mesh);
  69972. /**
  69973. * Simplification of a given mesh according to the given settings.
  69974. * Since this requires computation, it is assumed that the function runs async.
  69975. * @param settings The settings of the simplification, including quality and distance
  69976. * @param successCallback A callback that will be called after the mesh was simplified.
  69977. */
  69978. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69979. private runDecimation;
  69980. private initWithMesh;
  69981. private init;
  69982. private reconstructMesh;
  69983. private initDecimatedMesh;
  69984. private isFlipped;
  69985. private updateTriangles;
  69986. private identifyBorder;
  69987. private updateMesh;
  69988. private vertexError;
  69989. private calculateError;
  69990. }
  69991. }
  69992. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69993. import { Scene } from "babylonjs/scene";
  69994. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69995. import { ISceneComponent } from "babylonjs/sceneComponent";
  69996. module "babylonjs/scene" {
  69997. interface Scene {
  69998. /** @hidden (Backing field) */
  69999. _simplificationQueue: SimplificationQueue;
  70000. /**
  70001. * Gets or sets the simplification queue attached to the scene
  70002. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70003. */
  70004. simplificationQueue: SimplificationQueue;
  70005. }
  70006. }
  70007. module "babylonjs/Meshes/mesh" {
  70008. interface Mesh {
  70009. /**
  70010. * Simplify the mesh according to the given array of settings.
  70011. * Function will return immediately and will simplify async
  70012. * @param settings a collection of simplification settings
  70013. * @param parallelProcessing should all levels calculate parallel or one after the other
  70014. * @param simplificationType the type of simplification to run
  70015. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70016. * @returns the current mesh
  70017. */
  70018. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70019. }
  70020. }
  70021. /**
  70022. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70023. * created in a scene
  70024. */
  70025. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70026. /**
  70027. * The component name helpfull to identify the component in the list of scene components.
  70028. */
  70029. readonly name: string;
  70030. /**
  70031. * The scene the component belongs to.
  70032. */
  70033. scene: Scene;
  70034. /**
  70035. * Creates a new instance of the component for the given scene
  70036. * @param scene Defines the scene to register the component in
  70037. */
  70038. constructor(scene: Scene);
  70039. /**
  70040. * Registers the component in a given scene
  70041. */
  70042. register(): void;
  70043. /**
  70044. * Rebuilds the elements related to this component in case of
  70045. * context lost for instance.
  70046. */
  70047. rebuild(): void;
  70048. /**
  70049. * Disposes the component and the associated ressources
  70050. */
  70051. dispose(): void;
  70052. private _beforeCameraUpdate;
  70053. }
  70054. }
  70055. declare module "babylonjs/Meshes/Builders/index" {
  70056. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70057. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70058. export * from "babylonjs/Meshes/Builders/discBuilder";
  70059. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70060. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70061. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70062. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70063. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70064. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70065. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70066. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70067. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70068. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70069. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70070. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70071. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70072. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70073. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70074. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70075. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70076. }
  70077. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70078. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70079. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70080. import { Matrix } from "babylonjs/Maths/math.vector";
  70081. module "babylonjs/Meshes/mesh" {
  70082. interface Mesh {
  70083. /**
  70084. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70085. */
  70086. thinInstanceEnablePicking: boolean;
  70087. /**
  70088. * Creates a new thin instance
  70089. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70090. * @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
  70091. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70092. */
  70093. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70094. /**
  70095. * Adds the transformation (matrix) of the current mesh as a thin instance
  70096. * @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
  70097. * @returns the thin instance index number
  70098. */
  70099. thinInstanceAddSelf(refresh: boolean): number;
  70100. /**
  70101. * Registers a custom attribute to be used with thin instances
  70102. * @param kind name of the attribute
  70103. * @param stride size in floats of the attribute
  70104. */
  70105. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70106. /**
  70107. * Sets the matrix of a thin instance
  70108. * @param index index of the thin instance
  70109. * @param matrix matrix to set
  70110. * @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
  70111. */
  70112. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70113. /**
  70114. * Sets the value of a custom attribute for a thin instance
  70115. * @param kind name of the attribute
  70116. * @param index index of the thin instance
  70117. * @param value value to set
  70118. * @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
  70119. */
  70120. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70121. /**
  70122. * 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.
  70123. */
  70124. thinInstanceCount: number;
  70125. /**
  70126. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70127. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70128. * @param buffer buffer to set
  70129. * @param stride size in floats of each value of the buffer
  70130. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70131. */
  70132. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70133. /**
  70134. * Gets the list of world matrices
  70135. * @return an array containing all the world matrices from the thin instances
  70136. */
  70137. thinInstanceGetWorldMatrices(): Matrix[];
  70138. /**
  70139. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70140. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70141. */
  70142. thinInstanceBufferUpdated(kind: string): void;
  70143. /**
  70144. * Applies a partial update to a buffer directly on the GPU
  70145. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  70146. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70147. * @param data the data to set in the GPU buffer
  70148. * @param offset the offset in the GPU buffer where to update the data
  70149. */
  70150. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  70151. /**
  70152. * Refreshes the bounding info, taking into account all the thin instances defined
  70153. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70154. */
  70155. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70156. /** @hidden */
  70157. _thinInstanceInitializeUserStorage(): void;
  70158. /** @hidden */
  70159. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70160. /** @hidden */
  70161. _userThinInstanceBuffersStorage: {
  70162. data: {
  70163. [key: string]: Float32Array;
  70164. };
  70165. sizes: {
  70166. [key: string]: number;
  70167. };
  70168. vertexBuffers: {
  70169. [key: string]: Nullable<VertexBuffer>;
  70170. };
  70171. strides: {
  70172. [key: string]: number;
  70173. };
  70174. };
  70175. }
  70176. }
  70177. }
  70178. declare module "babylonjs/Meshes/index" {
  70179. export * from "babylonjs/Meshes/abstractMesh";
  70180. export * from "babylonjs/Meshes/buffer";
  70181. export * from "babylonjs/Meshes/Compression/index";
  70182. export * from "babylonjs/Meshes/csg";
  70183. export * from "babylonjs/Meshes/geometry";
  70184. export * from "babylonjs/Meshes/groundMesh";
  70185. export * from "babylonjs/Meshes/trailMesh";
  70186. export * from "babylonjs/Meshes/instancedMesh";
  70187. export * from "babylonjs/Meshes/linesMesh";
  70188. export * from "babylonjs/Meshes/mesh";
  70189. export * from "babylonjs/Meshes/mesh.vertexData";
  70190. export * from "babylonjs/Meshes/meshBuilder";
  70191. export * from "babylonjs/Meshes/meshSimplification";
  70192. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70193. export * from "babylonjs/Meshes/polygonMesh";
  70194. export * from "babylonjs/Meshes/subMesh";
  70195. export * from "babylonjs/Meshes/meshLODLevel";
  70196. export * from "babylonjs/Meshes/transformNode";
  70197. export * from "babylonjs/Meshes/Builders/index";
  70198. export * from "babylonjs/Meshes/dataBuffer";
  70199. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70200. import "babylonjs/Meshes/thinInstanceMesh";
  70201. export * from "babylonjs/Meshes/thinInstanceMesh";
  70202. }
  70203. declare module "babylonjs/Morph/index" {
  70204. export * from "babylonjs/Morph/morphTarget";
  70205. export * from "babylonjs/Morph/morphTargetManager";
  70206. }
  70207. declare module "babylonjs/Navigation/INavigationEngine" {
  70208. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70209. import { Vector3 } from "babylonjs/Maths/math";
  70210. import { Mesh } from "babylonjs/Meshes/mesh";
  70211. import { Scene } from "babylonjs/scene";
  70212. /**
  70213. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70214. */
  70215. export interface INavigationEnginePlugin {
  70216. /**
  70217. * plugin name
  70218. */
  70219. name: string;
  70220. /**
  70221. * Creates a navigation mesh
  70222. * @param meshes array of all the geometry used to compute the navigatio mesh
  70223. * @param parameters bunch of parameters used to filter geometry
  70224. */
  70225. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70226. /**
  70227. * Create a navigation mesh debug mesh
  70228. * @param scene is where the mesh will be added
  70229. * @returns debug display mesh
  70230. */
  70231. createDebugNavMesh(scene: Scene): Mesh;
  70232. /**
  70233. * Get a navigation mesh constrained position, closest to the parameter position
  70234. * @param position world position
  70235. * @returns the closest point to position constrained by the navigation mesh
  70236. */
  70237. getClosestPoint(position: Vector3): Vector3;
  70238. /**
  70239. * Get a navigation mesh constrained position, closest to the parameter position
  70240. * @param position world position
  70241. * @param result output the closest point to position constrained by the navigation mesh
  70242. */
  70243. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70244. /**
  70245. * Get a navigation mesh constrained position, within a particular radius
  70246. * @param position world position
  70247. * @param maxRadius the maximum distance to the constrained world position
  70248. * @returns the closest point to position constrained by the navigation mesh
  70249. */
  70250. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70251. /**
  70252. * Get a navigation mesh constrained position, within a particular radius
  70253. * @param position world position
  70254. * @param maxRadius the maximum distance to the constrained world position
  70255. * @param result output the closest point to position constrained by the navigation mesh
  70256. */
  70257. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70258. /**
  70259. * Compute the final position from a segment made of destination-position
  70260. * @param position world position
  70261. * @param destination world position
  70262. * @returns the resulting point along the navmesh
  70263. */
  70264. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70265. /**
  70266. * Compute the final position from a segment made of destination-position
  70267. * @param position world position
  70268. * @param destination world position
  70269. * @param result output the resulting point along the navmesh
  70270. */
  70271. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70272. /**
  70273. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70274. * @param start world position
  70275. * @param end world position
  70276. * @returns array containing world position composing the path
  70277. */
  70278. computePath(start: Vector3, end: Vector3): Vector3[];
  70279. /**
  70280. * If this plugin is supported
  70281. * @returns true if plugin is supported
  70282. */
  70283. isSupported(): boolean;
  70284. /**
  70285. * Create a new Crowd so you can add agents
  70286. * @param maxAgents the maximum agent count in the crowd
  70287. * @param maxAgentRadius the maximum radius an agent can have
  70288. * @param scene to attach the crowd to
  70289. * @returns the crowd you can add agents to
  70290. */
  70291. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70292. /**
  70293. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70294. * The queries will try to find a solution within those bounds
  70295. * default is (1,1,1)
  70296. * @param extent x,y,z value that define the extent around the queries point of reference
  70297. */
  70298. setDefaultQueryExtent(extent: Vector3): void;
  70299. /**
  70300. * Get the Bounding box extent specified by setDefaultQueryExtent
  70301. * @returns the box extent values
  70302. */
  70303. getDefaultQueryExtent(): Vector3;
  70304. /**
  70305. * build the navmesh from a previously saved state using getNavmeshData
  70306. * @param data the Uint8Array returned by getNavmeshData
  70307. */
  70308. buildFromNavmeshData(data: Uint8Array): void;
  70309. /**
  70310. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70311. * @returns data the Uint8Array that can be saved and reused
  70312. */
  70313. getNavmeshData(): Uint8Array;
  70314. /**
  70315. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70316. * @param result output the box extent values
  70317. */
  70318. getDefaultQueryExtentToRef(result: Vector3): void;
  70319. /**
  70320. * Release all resources
  70321. */
  70322. dispose(): void;
  70323. }
  70324. /**
  70325. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70326. */
  70327. export interface ICrowd {
  70328. /**
  70329. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70330. * You can attach anything to that node. The node position is updated in the scene update tick.
  70331. * @param pos world position that will be constrained by the navigation mesh
  70332. * @param parameters agent parameters
  70333. * @param transform hooked to the agent that will be update by the scene
  70334. * @returns agent index
  70335. */
  70336. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70337. /**
  70338. * Returns the agent position in world space
  70339. * @param index agent index returned by addAgent
  70340. * @returns world space position
  70341. */
  70342. getAgentPosition(index: number): Vector3;
  70343. /**
  70344. * Gets the agent position result in world space
  70345. * @param index agent index returned by addAgent
  70346. * @param result output world space position
  70347. */
  70348. getAgentPositionToRef(index: number, result: Vector3): void;
  70349. /**
  70350. * Gets the agent velocity in world space
  70351. * @param index agent index returned by addAgent
  70352. * @returns world space velocity
  70353. */
  70354. getAgentVelocity(index: number): Vector3;
  70355. /**
  70356. * Gets the agent velocity result in world space
  70357. * @param index agent index returned by addAgent
  70358. * @param result output world space velocity
  70359. */
  70360. getAgentVelocityToRef(index: number, result: Vector3): void;
  70361. /**
  70362. * remove a particular agent previously created
  70363. * @param index agent index returned by addAgent
  70364. */
  70365. removeAgent(index: number): void;
  70366. /**
  70367. * get the list of all agents attached to this crowd
  70368. * @returns list of agent indices
  70369. */
  70370. getAgents(): number[];
  70371. /**
  70372. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70373. * @param deltaTime in seconds
  70374. */
  70375. update(deltaTime: number): void;
  70376. /**
  70377. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70378. * @param index agent index returned by addAgent
  70379. * @param destination targeted world position
  70380. */
  70381. agentGoto(index: number, destination: Vector3): void;
  70382. /**
  70383. * Teleport the agent to a new position
  70384. * @param index agent index returned by addAgent
  70385. * @param destination targeted world position
  70386. */
  70387. agentTeleport(index: number, destination: Vector3): void;
  70388. /**
  70389. * Update agent parameters
  70390. * @param index agent index returned by addAgent
  70391. * @param parameters agent parameters
  70392. */
  70393. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70394. /**
  70395. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70396. * The queries will try to find a solution within those bounds
  70397. * default is (1,1,1)
  70398. * @param extent x,y,z value that define the extent around the queries point of reference
  70399. */
  70400. setDefaultQueryExtent(extent: Vector3): void;
  70401. /**
  70402. * Get the Bounding box extent specified by setDefaultQueryExtent
  70403. * @returns the box extent values
  70404. */
  70405. getDefaultQueryExtent(): Vector3;
  70406. /**
  70407. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70408. * @param result output the box extent values
  70409. */
  70410. getDefaultQueryExtentToRef(result: Vector3): void;
  70411. /**
  70412. * Release all resources
  70413. */
  70414. dispose(): void;
  70415. }
  70416. /**
  70417. * Configures an agent
  70418. */
  70419. export interface IAgentParameters {
  70420. /**
  70421. * Agent radius. [Limit: >= 0]
  70422. */
  70423. radius: number;
  70424. /**
  70425. * Agent height. [Limit: > 0]
  70426. */
  70427. height: number;
  70428. /**
  70429. * Maximum allowed acceleration. [Limit: >= 0]
  70430. */
  70431. maxAcceleration: number;
  70432. /**
  70433. * Maximum allowed speed. [Limit: >= 0]
  70434. */
  70435. maxSpeed: number;
  70436. /**
  70437. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70438. */
  70439. collisionQueryRange: number;
  70440. /**
  70441. * The path visibility optimization range. [Limit: > 0]
  70442. */
  70443. pathOptimizationRange: number;
  70444. /**
  70445. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70446. */
  70447. separationWeight: number;
  70448. }
  70449. /**
  70450. * Configures the navigation mesh creation
  70451. */
  70452. export interface INavMeshParameters {
  70453. /**
  70454. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70455. */
  70456. cs: number;
  70457. /**
  70458. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70459. */
  70460. ch: number;
  70461. /**
  70462. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70463. */
  70464. walkableSlopeAngle: number;
  70465. /**
  70466. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70467. * be considered walkable. [Limit: >= 3] [Units: vx]
  70468. */
  70469. walkableHeight: number;
  70470. /**
  70471. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70472. */
  70473. walkableClimb: number;
  70474. /**
  70475. * The distance to erode/shrink the walkable area of the heightfield away from
  70476. * obstructions. [Limit: >=0] [Units: vx]
  70477. */
  70478. walkableRadius: number;
  70479. /**
  70480. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70481. */
  70482. maxEdgeLen: number;
  70483. /**
  70484. * The maximum distance a simplfied contour's border edges should deviate
  70485. * the original raw contour. [Limit: >=0] [Units: vx]
  70486. */
  70487. maxSimplificationError: number;
  70488. /**
  70489. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70490. */
  70491. minRegionArea: number;
  70492. /**
  70493. * Any regions with a span count smaller than this value will, if possible,
  70494. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70495. */
  70496. mergeRegionArea: number;
  70497. /**
  70498. * The maximum number of vertices allowed for polygons generated during the
  70499. * contour to polygon conversion process. [Limit: >= 3]
  70500. */
  70501. maxVertsPerPoly: number;
  70502. /**
  70503. * Sets the sampling distance to use when generating the detail mesh.
  70504. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70505. */
  70506. detailSampleDist: number;
  70507. /**
  70508. * The maximum distance the detail mesh surface should deviate from heightfield
  70509. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70510. */
  70511. detailSampleMaxError: number;
  70512. }
  70513. }
  70514. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70515. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70516. import { Mesh } from "babylonjs/Meshes/mesh";
  70517. import { Scene } from "babylonjs/scene";
  70518. import { Vector3 } from "babylonjs/Maths/math";
  70519. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70520. /**
  70521. * RecastJS navigation plugin
  70522. */
  70523. export class RecastJSPlugin implements INavigationEnginePlugin {
  70524. /**
  70525. * Reference to the Recast library
  70526. */
  70527. bjsRECAST: any;
  70528. /**
  70529. * plugin name
  70530. */
  70531. name: string;
  70532. /**
  70533. * the first navmesh created. We might extend this to support multiple navmeshes
  70534. */
  70535. navMesh: any;
  70536. /**
  70537. * Initializes the recastJS plugin
  70538. * @param recastInjection can be used to inject your own recast reference
  70539. */
  70540. constructor(recastInjection?: any);
  70541. /**
  70542. * Creates a navigation mesh
  70543. * @param meshes array of all the geometry used to compute the navigatio mesh
  70544. * @param parameters bunch of parameters used to filter geometry
  70545. */
  70546. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70547. /**
  70548. * Create a navigation mesh debug mesh
  70549. * @param scene is where the mesh will be added
  70550. * @returns debug display mesh
  70551. */
  70552. createDebugNavMesh(scene: Scene): Mesh;
  70553. /**
  70554. * Get a navigation mesh constrained position, closest to the parameter position
  70555. * @param position world position
  70556. * @returns the closest point to position constrained by the navigation mesh
  70557. */
  70558. getClosestPoint(position: Vector3): Vector3;
  70559. /**
  70560. * Get a navigation mesh constrained position, closest to the parameter position
  70561. * @param position world position
  70562. * @param result output the closest point to position constrained by the navigation mesh
  70563. */
  70564. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70565. /**
  70566. * Get a navigation mesh constrained position, within a particular radius
  70567. * @param position world position
  70568. * @param maxRadius the maximum distance to the constrained world position
  70569. * @returns the closest point to position constrained by the navigation mesh
  70570. */
  70571. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70572. /**
  70573. * Get a navigation mesh constrained position, within a particular radius
  70574. * @param position world position
  70575. * @param maxRadius the maximum distance to the constrained world position
  70576. * @param result output the closest point to position constrained by the navigation mesh
  70577. */
  70578. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70579. /**
  70580. * Compute the final position from a segment made of destination-position
  70581. * @param position world position
  70582. * @param destination world position
  70583. * @returns the resulting point along the navmesh
  70584. */
  70585. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70586. /**
  70587. * Compute the final position from a segment made of destination-position
  70588. * @param position world position
  70589. * @param destination world position
  70590. * @param result output the resulting point along the navmesh
  70591. */
  70592. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70593. /**
  70594. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70595. * @param start world position
  70596. * @param end world position
  70597. * @returns array containing world position composing the path
  70598. */
  70599. computePath(start: Vector3, end: Vector3): Vector3[];
  70600. /**
  70601. * Create a new Crowd so you can add agents
  70602. * @param maxAgents the maximum agent count in the crowd
  70603. * @param maxAgentRadius the maximum radius an agent can have
  70604. * @param scene to attach the crowd to
  70605. * @returns the crowd you can add agents to
  70606. */
  70607. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70608. /**
  70609. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70610. * The queries will try to find a solution within those bounds
  70611. * default is (1,1,1)
  70612. * @param extent x,y,z value that define the extent around the queries point of reference
  70613. */
  70614. setDefaultQueryExtent(extent: Vector3): void;
  70615. /**
  70616. * Get the Bounding box extent specified by setDefaultQueryExtent
  70617. * @returns the box extent values
  70618. */
  70619. getDefaultQueryExtent(): Vector3;
  70620. /**
  70621. * build the navmesh from a previously saved state using getNavmeshData
  70622. * @param data the Uint8Array returned by getNavmeshData
  70623. */
  70624. buildFromNavmeshData(data: Uint8Array): void;
  70625. /**
  70626. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70627. * @returns data the Uint8Array that can be saved and reused
  70628. */
  70629. getNavmeshData(): Uint8Array;
  70630. /**
  70631. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70632. * @param result output the box extent values
  70633. */
  70634. getDefaultQueryExtentToRef(result: Vector3): void;
  70635. /**
  70636. * Disposes
  70637. */
  70638. dispose(): void;
  70639. /**
  70640. * If this plugin is supported
  70641. * @returns true if plugin is supported
  70642. */
  70643. isSupported(): boolean;
  70644. }
  70645. /**
  70646. * Recast detour crowd implementation
  70647. */
  70648. export class RecastJSCrowd implements ICrowd {
  70649. /**
  70650. * Recast/detour plugin
  70651. */
  70652. bjsRECASTPlugin: RecastJSPlugin;
  70653. /**
  70654. * Link to the detour crowd
  70655. */
  70656. recastCrowd: any;
  70657. /**
  70658. * One transform per agent
  70659. */
  70660. transforms: TransformNode[];
  70661. /**
  70662. * All agents created
  70663. */
  70664. agents: number[];
  70665. /**
  70666. * Link to the scene is kept to unregister the crowd from the scene
  70667. */
  70668. private _scene;
  70669. /**
  70670. * Observer for crowd updates
  70671. */
  70672. private _onBeforeAnimationsObserver;
  70673. /**
  70674. * Constructor
  70675. * @param plugin recastJS plugin
  70676. * @param maxAgents the maximum agent count in the crowd
  70677. * @param maxAgentRadius the maximum radius an agent can have
  70678. * @param scene to attach the crowd to
  70679. * @returns the crowd you can add agents to
  70680. */
  70681. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70682. /**
  70683. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70684. * You can attach anything to that node. The node position is updated in the scene update tick.
  70685. * @param pos world position that will be constrained by the navigation mesh
  70686. * @param parameters agent parameters
  70687. * @param transform hooked to the agent that will be update by the scene
  70688. * @returns agent index
  70689. */
  70690. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70691. /**
  70692. * Returns the agent position in world space
  70693. * @param index agent index returned by addAgent
  70694. * @returns world space position
  70695. */
  70696. getAgentPosition(index: number): Vector3;
  70697. /**
  70698. * Returns the agent position result in world space
  70699. * @param index agent index returned by addAgent
  70700. * @param result output world space position
  70701. */
  70702. getAgentPositionToRef(index: number, result: Vector3): void;
  70703. /**
  70704. * Returns the agent velocity in world space
  70705. * @param index agent index returned by addAgent
  70706. * @returns world space velocity
  70707. */
  70708. getAgentVelocity(index: number): Vector3;
  70709. /**
  70710. * Returns the agent velocity result in world space
  70711. * @param index agent index returned by addAgent
  70712. * @param result output world space velocity
  70713. */
  70714. getAgentVelocityToRef(index: number, result: Vector3): void;
  70715. /**
  70716. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70717. * @param index agent index returned by addAgent
  70718. * @param destination targeted world position
  70719. */
  70720. agentGoto(index: number, destination: Vector3): void;
  70721. /**
  70722. * Teleport the agent to a new position
  70723. * @param index agent index returned by addAgent
  70724. * @param destination targeted world position
  70725. */
  70726. agentTeleport(index: number, destination: Vector3): void;
  70727. /**
  70728. * Update agent parameters
  70729. * @param index agent index returned by addAgent
  70730. * @param parameters agent parameters
  70731. */
  70732. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70733. /**
  70734. * remove a particular agent previously created
  70735. * @param index agent index returned by addAgent
  70736. */
  70737. removeAgent(index: number): void;
  70738. /**
  70739. * get the list of all agents attached to this crowd
  70740. * @returns list of agent indices
  70741. */
  70742. getAgents(): number[];
  70743. /**
  70744. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70745. * @param deltaTime in seconds
  70746. */
  70747. update(deltaTime: number): void;
  70748. /**
  70749. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70750. * The queries will try to find a solution within those bounds
  70751. * default is (1,1,1)
  70752. * @param extent x,y,z value that define the extent around the queries point of reference
  70753. */
  70754. setDefaultQueryExtent(extent: Vector3): void;
  70755. /**
  70756. * Get the Bounding box extent specified by setDefaultQueryExtent
  70757. * @returns the box extent values
  70758. */
  70759. getDefaultQueryExtent(): Vector3;
  70760. /**
  70761. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70762. * @param result output the box extent values
  70763. */
  70764. getDefaultQueryExtentToRef(result: Vector3): void;
  70765. /**
  70766. * Release all resources
  70767. */
  70768. dispose(): void;
  70769. }
  70770. }
  70771. declare module "babylonjs/Navigation/Plugins/index" {
  70772. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70773. }
  70774. declare module "babylonjs/Navigation/index" {
  70775. export * from "babylonjs/Navigation/INavigationEngine";
  70776. export * from "babylonjs/Navigation/Plugins/index";
  70777. }
  70778. declare module "babylonjs/Offline/database" {
  70779. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70780. /**
  70781. * Class used to enable access to IndexedDB
  70782. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70783. */
  70784. export class Database implements IOfflineProvider {
  70785. private _callbackManifestChecked;
  70786. private _currentSceneUrl;
  70787. private _db;
  70788. private _enableSceneOffline;
  70789. private _enableTexturesOffline;
  70790. private _manifestVersionFound;
  70791. private _mustUpdateRessources;
  70792. private _hasReachedQuota;
  70793. private _isSupported;
  70794. private _idbFactory;
  70795. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70796. private static IsUASupportingBlobStorage;
  70797. /**
  70798. * Gets a boolean indicating if Database storate is enabled (off by default)
  70799. */
  70800. static IDBStorageEnabled: boolean;
  70801. /**
  70802. * Gets a boolean indicating if scene must be saved in the database
  70803. */
  70804. get enableSceneOffline(): boolean;
  70805. /**
  70806. * Gets a boolean indicating if textures must be saved in the database
  70807. */
  70808. get enableTexturesOffline(): boolean;
  70809. /**
  70810. * Creates a new Database
  70811. * @param urlToScene defines the url to load the scene
  70812. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70813. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70814. */
  70815. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70816. private static _ParseURL;
  70817. private static _ReturnFullUrlLocation;
  70818. private _checkManifestFile;
  70819. /**
  70820. * Open the database and make it available
  70821. * @param successCallback defines the callback to call on success
  70822. * @param errorCallback defines the callback to call on error
  70823. */
  70824. open(successCallback: () => void, errorCallback: () => void): void;
  70825. /**
  70826. * Loads an image from the database
  70827. * @param url defines the url to load from
  70828. * @param image defines the target DOM image
  70829. */
  70830. loadImage(url: string, image: HTMLImageElement): void;
  70831. private _loadImageFromDBAsync;
  70832. private _saveImageIntoDBAsync;
  70833. private _checkVersionFromDB;
  70834. private _loadVersionFromDBAsync;
  70835. private _saveVersionIntoDBAsync;
  70836. /**
  70837. * Loads a file from database
  70838. * @param url defines the URL to load from
  70839. * @param sceneLoaded defines a callback to call on success
  70840. * @param progressCallBack defines a callback to call when progress changed
  70841. * @param errorCallback defines a callback to call on error
  70842. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70843. */
  70844. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70845. private _loadFileAsync;
  70846. private _saveFileAsync;
  70847. /**
  70848. * Validates if xhr data is correct
  70849. * @param xhr defines the request to validate
  70850. * @param dataType defines the expected data type
  70851. * @returns true if data is correct
  70852. */
  70853. private static _ValidateXHRData;
  70854. }
  70855. }
  70856. declare module "babylonjs/Offline/index" {
  70857. export * from "babylonjs/Offline/database";
  70858. export * from "babylonjs/Offline/IOfflineProvider";
  70859. }
  70860. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70861. /** @hidden */
  70862. export var gpuUpdateParticlesPixelShader: {
  70863. name: string;
  70864. shader: string;
  70865. };
  70866. }
  70867. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70868. /** @hidden */
  70869. export var gpuUpdateParticlesVertexShader: {
  70870. name: string;
  70871. shader: string;
  70872. };
  70873. }
  70874. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70875. /** @hidden */
  70876. export var clipPlaneFragmentDeclaration2: {
  70877. name: string;
  70878. shader: string;
  70879. };
  70880. }
  70881. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70882. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70883. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70884. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70885. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70886. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70887. /** @hidden */
  70888. export var gpuRenderParticlesPixelShader: {
  70889. name: string;
  70890. shader: string;
  70891. };
  70892. }
  70893. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70894. /** @hidden */
  70895. export var clipPlaneVertexDeclaration2: {
  70896. name: string;
  70897. shader: string;
  70898. };
  70899. }
  70900. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70901. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70902. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70903. /** @hidden */
  70904. export var gpuRenderParticlesVertexShader: {
  70905. name: string;
  70906. shader: string;
  70907. };
  70908. }
  70909. declare module "babylonjs/Particles/gpuParticleSystem" {
  70910. import { Nullable } from "babylonjs/types";
  70911. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70912. import { Observable } from "babylonjs/Misc/observable";
  70913. import { Matrix } from "babylonjs/Maths/math.vector";
  70914. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70915. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70916. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70917. import { IDisposable } from "babylonjs/scene";
  70918. import { Effect } from "babylonjs/Materials/effect";
  70919. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70920. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70921. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70922. import { Scene } from "babylonjs/scene";
  70923. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70924. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70925. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70926. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70927. /**
  70928. * This represents a GPU particle system in Babylon
  70929. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70930. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70931. */
  70932. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70933. /**
  70934. * The layer mask we are rendering the particles through.
  70935. */
  70936. layerMask: number;
  70937. private _capacity;
  70938. private _activeCount;
  70939. private _currentActiveCount;
  70940. private _accumulatedCount;
  70941. private _renderEffect;
  70942. private _updateEffect;
  70943. private _buffer0;
  70944. private _buffer1;
  70945. private _spriteBuffer;
  70946. private _updateVAO;
  70947. private _renderVAO;
  70948. private _targetIndex;
  70949. private _sourceBuffer;
  70950. private _targetBuffer;
  70951. private _currentRenderId;
  70952. private _started;
  70953. private _stopped;
  70954. private _timeDelta;
  70955. private _randomTexture;
  70956. private _randomTexture2;
  70957. private _attributesStrideSize;
  70958. private _updateEffectOptions;
  70959. private _randomTextureSize;
  70960. private _actualFrame;
  70961. private _customEffect;
  70962. private readonly _rawTextureWidth;
  70963. /**
  70964. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70965. */
  70966. static get IsSupported(): boolean;
  70967. /**
  70968. * An event triggered when the system is disposed.
  70969. */
  70970. onDisposeObservable: Observable<IParticleSystem>;
  70971. /**
  70972. * Gets the maximum number of particles active at the same time.
  70973. * @returns The max number of active particles.
  70974. */
  70975. getCapacity(): number;
  70976. /**
  70977. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70978. * to override the particles.
  70979. */
  70980. forceDepthWrite: boolean;
  70981. /**
  70982. * Gets or set the number of active particles
  70983. */
  70984. get activeParticleCount(): number;
  70985. set activeParticleCount(value: number);
  70986. private _preWarmDone;
  70987. /**
  70988. * Specifies if the particles are updated in emitter local space or world space.
  70989. */
  70990. isLocal: boolean;
  70991. /** Gets or sets a matrix to use to compute projection */
  70992. defaultProjectionMatrix: Matrix;
  70993. /**
  70994. * Is this system ready to be used/rendered
  70995. * @return true if the system is ready
  70996. */
  70997. isReady(): boolean;
  70998. /**
  70999. * Gets if the system has been started. (Note: this will still be true after stop is called)
  71000. * @returns True if it has been started, otherwise false.
  71001. */
  71002. isStarted(): boolean;
  71003. /**
  71004. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71005. * @returns True if it has been stopped, otherwise false.
  71006. */
  71007. isStopped(): boolean;
  71008. /**
  71009. * Gets a boolean indicating that the system is stopping
  71010. * @returns true if the system is currently stopping
  71011. */
  71012. isStopping(): boolean;
  71013. /**
  71014. * Gets the number of particles active at the same time.
  71015. * @returns The number of active particles.
  71016. */
  71017. getActiveCount(): number;
  71018. /**
  71019. * Starts the particle system and begins to emit
  71020. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71021. */
  71022. start(delay?: number): void;
  71023. /**
  71024. * Stops the particle system.
  71025. */
  71026. stop(): void;
  71027. /**
  71028. * Remove all active particles
  71029. */
  71030. reset(): void;
  71031. /**
  71032. * Returns the string "GPUParticleSystem"
  71033. * @returns a string containing the class name
  71034. */
  71035. getClassName(): string;
  71036. /**
  71037. * Gets the custom effect used to render the particles
  71038. * @param blendMode Blend mode for which the effect should be retrieved
  71039. * @returns The effect
  71040. */
  71041. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71042. /**
  71043. * Sets the custom effect used to render the particles
  71044. * @param effect The effect to set
  71045. * @param blendMode Blend mode for which the effect should be set
  71046. */
  71047. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71048. /** @hidden */
  71049. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71050. /**
  71051. * Observable that will be called just before the particles are drawn
  71052. */
  71053. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71054. /**
  71055. * Gets the name of the particle vertex shader
  71056. */
  71057. get vertexShaderName(): string;
  71058. private _colorGradientsTexture;
  71059. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71060. /**
  71061. * Adds a new color gradient
  71062. * @param gradient defines the gradient to use (between 0 and 1)
  71063. * @param color1 defines the color to affect to the specified gradient
  71064. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71065. * @returns the current particle system
  71066. */
  71067. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71068. private _refreshColorGradient;
  71069. /** Force the system to rebuild all gradients that need to be resync */
  71070. forceRefreshGradients(): void;
  71071. /**
  71072. * Remove a specific color gradient
  71073. * @param gradient defines the gradient to remove
  71074. * @returns the current particle system
  71075. */
  71076. removeColorGradient(gradient: number): GPUParticleSystem;
  71077. private _angularSpeedGradientsTexture;
  71078. private _sizeGradientsTexture;
  71079. private _velocityGradientsTexture;
  71080. private _limitVelocityGradientsTexture;
  71081. private _dragGradientsTexture;
  71082. private _addFactorGradient;
  71083. /**
  71084. * Adds a new size gradient
  71085. * @param gradient defines the gradient to use (between 0 and 1)
  71086. * @param factor defines the size factor to affect to the specified gradient
  71087. * @returns the current particle system
  71088. */
  71089. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71090. /**
  71091. * Remove a specific size gradient
  71092. * @param gradient defines the gradient to remove
  71093. * @returns the current particle system
  71094. */
  71095. removeSizeGradient(gradient: number): GPUParticleSystem;
  71096. private _refreshFactorGradient;
  71097. /**
  71098. * Adds a new angular speed gradient
  71099. * @param gradient defines the gradient to use (between 0 and 1)
  71100. * @param factor defines the angular speed to affect to the specified gradient
  71101. * @returns the current particle system
  71102. */
  71103. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71104. /**
  71105. * Remove a specific angular speed gradient
  71106. * @param gradient defines the gradient to remove
  71107. * @returns the current particle system
  71108. */
  71109. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71110. /**
  71111. * Adds a new velocity gradient
  71112. * @param gradient defines the gradient to use (between 0 and 1)
  71113. * @param factor defines the velocity to affect to the specified gradient
  71114. * @returns the current particle system
  71115. */
  71116. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71117. /**
  71118. * Remove a specific velocity gradient
  71119. * @param gradient defines the gradient to remove
  71120. * @returns the current particle system
  71121. */
  71122. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71123. /**
  71124. * Adds a new limit velocity gradient
  71125. * @param gradient defines the gradient to use (between 0 and 1)
  71126. * @param factor defines the limit velocity value to affect to the specified gradient
  71127. * @returns the current particle system
  71128. */
  71129. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71130. /**
  71131. * Remove a specific limit velocity gradient
  71132. * @param gradient defines the gradient to remove
  71133. * @returns the current particle system
  71134. */
  71135. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71136. /**
  71137. * Adds a new drag gradient
  71138. * @param gradient defines the gradient to use (between 0 and 1)
  71139. * @param factor defines the drag value to affect to the specified gradient
  71140. * @returns the current particle system
  71141. */
  71142. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71143. /**
  71144. * Remove a specific drag gradient
  71145. * @param gradient defines the gradient to remove
  71146. * @returns the current particle system
  71147. */
  71148. removeDragGradient(gradient: number): GPUParticleSystem;
  71149. /**
  71150. * Not supported by GPUParticleSystem
  71151. * @param gradient defines the gradient to use (between 0 and 1)
  71152. * @param factor defines the emit rate value to affect to the specified gradient
  71153. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71154. * @returns the current particle system
  71155. */
  71156. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71157. /**
  71158. * Not supported by GPUParticleSystem
  71159. * @param gradient defines the gradient to remove
  71160. * @returns the current particle system
  71161. */
  71162. removeEmitRateGradient(gradient: number): IParticleSystem;
  71163. /**
  71164. * Not supported by GPUParticleSystem
  71165. * @param gradient defines the gradient to use (between 0 and 1)
  71166. * @param factor defines the start size value to affect to the specified gradient
  71167. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71168. * @returns the current particle system
  71169. */
  71170. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71171. /**
  71172. * Not supported by GPUParticleSystem
  71173. * @param gradient defines the gradient to remove
  71174. * @returns the current particle system
  71175. */
  71176. removeStartSizeGradient(gradient: number): IParticleSystem;
  71177. /**
  71178. * Not supported by GPUParticleSystem
  71179. * @param gradient defines the gradient to use (between 0 and 1)
  71180. * @param min defines the color remap minimal range
  71181. * @param max defines the color remap maximal range
  71182. * @returns the current particle system
  71183. */
  71184. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71185. /**
  71186. * Not supported by GPUParticleSystem
  71187. * @param gradient defines the gradient to remove
  71188. * @returns the current particle system
  71189. */
  71190. removeColorRemapGradient(): IParticleSystem;
  71191. /**
  71192. * Not supported by GPUParticleSystem
  71193. * @param gradient defines the gradient to use (between 0 and 1)
  71194. * @param min defines the alpha remap minimal range
  71195. * @param max defines the alpha remap maximal range
  71196. * @returns the current particle system
  71197. */
  71198. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71199. /**
  71200. * Not supported by GPUParticleSystem
  71201. * @param gradient defines the gradient to remove
  71202. * @returns the current particle system
  71203. */
  71204. removeAlphaRemapGradient(): IParticleSystem;
  71205. /**
  71206. * Not supported by GPUParticleSystem
  71207. * @param gradient defines the gradient to use (between 0 and 1)
  71208. * @param color defines the color to affect to the specified gradient
  71209. * @returns the current particle system
  71210. */
  71211. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71212. /**
  71213. * Not supported by GPUParticleSystem
  71214. * @param gradient defines the gradient to remove
  71215. * @returns the current particle system
  71216. */
  71217. removeRampGradient(): IParticleSystem;
  71218. /**
  71219. * Not supported by GPUParticleSystem
  71220. * @returns the list of ramp gradients
  71221. */
  71222. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71223. /**
  71224. * Not supported by GPUParticleSystem
  71225. * Gets or sets a boolean indicating that ramp gradients must be used
  71226. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71227. */
  71228. get useRampGradients(): boolean;
  71229. set useRampGradients(value: boolean);
  71230. /**
  71231. * Not supported by GPUParticleSystem
  71232. * @param gradient defines the gradient to use (between 0 and 1)
  71233. * @param factor defines the life time factor to affect to the specified gradient
  71234. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71235. * @returns the current particle system
  71236. */
  71237. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71238. /**
  71239. * Not supported by GPUParticleSystem
  71240. * @param gradient defines the gradient to remove
  71241. * @returns the current particle system
  71242. */
  71243. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71244. /**
  71245. * Instantiates a GPU particle system.
  71246. * 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.
  71247. * @param name The name of the particle system
  71248. * @param options The options used to create the system
  71249. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71250. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71251. * @param customEffect a custom effect used to change the way particles are rendered by default
  71252. */
  71253. constructor(name: string, options: Partial<{
  71254. capacity: number;
  71255. randomTextureSize: number;
  71256. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71257. protected _reset(): void;
  71258. private _createUpdateVAO;
  71259. private _createRenderVAO;
  71260. private _initialize;
  71261. /** @hidden */
  71262. _recreateUpdateEffect(): void;
  71263. private _getEffect;
  71264. /**
  71265. * Fill the defines array according to the current settings of the particle system
  71266. * @param defines Array to be updated
  71267. * @param blendMode blend mode to take into account when updating the array
  71268. */
  71269. fillDefines(defines: Array<string>, blendMode?: number): void;
  71270. /**
  71271. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71272. * @param uniforms Uniforms array to fill
  71273. * @param attributes Attributes array to fill
  71274. * @param samplers Samplers array to fill
  71275. */
  71276. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71277. /** @hidden */
  71278. _recreateRenderEffect(): Effect;
  71279. /**
  71280. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71281. * @param preWarm defines if we are in the pre-warmimg phase
  71282. */
  71283. animate(preWarm?: boolean): void;
  71284. private _createFactorGradientTexture;
  71285. private _createSizeGradientTexture;
  71286. private _createAngularSpeedGradientTexture;
  71287. private _createVelocityGradientTexture;
  71288. private _createLimitVelocityGradientTexture;
  71289. private _createDragGradientTexture;
  71290. private _createColorGradientTexture;
  71291. /**
  71292. * Renders the particle system in its current state
  71293. * @param preWarm defines if the system should only update the particles but not render them
  71294. * @returns the current number of particles
  71295. */
  71296. render(preWarm?: boolean): number;
  71297. /**
  71298. * Rebuilds the particle system
  71299. */
  71300. rebuild(): void;
  71301. private _releaseBuffers;
  71302. private _releaseVAOs;
  71303. /**
  71304. * Disposes the particle system and free the associated resources
  71305. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71306. */
  71307. dispose(disposeTexture?: boolean): void;
  71308. /**
  71309. * Clones the particle system.
  71310. * @param name The name of the cloned object
  71311. * @param newEmitter The new emitter to use
  71312. * @returns the cloned particle system
  71313. */
  71314. clone(name: string, newEmitter: any): GPUParticleSystem;
  71315. /**
  71316. * Serializes the particle system to a JSON object
  71317. * @param serializeTexture defines if the texture must be serialized as well
  71318. * @returns the JSON object
  71319. */
  71320. serialize(serializeTexture?: boolean): any;
  71321. /**
  71322. * Parses a JSON object to create a GPU particle system.
  71323. * @param parsedParticleSystem The JSON object to parse
  71324. * @param sceneOrEngine The scene or the engine to create the particle system in
  71325. * @param rootUrl The root url to use to load external dependencies like texture
  71326. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71327. * @returns the parsed GPU particle system
  71328. */
  71329. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71330. }
  71331. }
  71332. declare module "babylonjs/Particles/particleSystemSet" {
  71333. import { Nullable } from "babylonjs/types";
  71334. import { Color3 } from "babylonjs/Maths/math.color";
  71335. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71336. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71337. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71338. import { Scene, IDisposable } from "babylonjs/scene";
  71339. /**
  71340. * Represents a set of particle systems working together to create a specific effect
  71341. */
  71342. export class ParticleSystemSet implements IDisposable {
  71343. /**
  71344. * Gets or sets base Assets URL
  71345. */
  71346. static BaseAssetsUrl: string;
  71347. private _emitterCreationOptions;
  71348. private _emitterNode;
  71349. /**
  71350. * Gets the particle system list
  71351. */
  71352. systems: IParticleSystem[];
  71353. /**
  71354. * Gets the emitter node used with this set
  71355. */
  71356. get emitterNode(): Nullable<TransformNode>;
  71357. /**
  71358. * Creates a new emitter mesh as a sphere
  71359. * @param options defines the options used to create the sphere
  71360. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71361. * @param scene defines the hosting scene
  71362. */
  71363. setEmitterAsSphere(options: {
  71364. diameter: number;
  71365. segments: number;
  71366. color: Color3;
  71367. }, renderingGroupId: number, scene: Scene): void;
  71368. /**
  71369. * Starts all particle systems of the set
  71370. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71371. */
  71372. start(emitter?: AbstractMesh): void;
  71373. /**
  71374. * Release all associated resources
  71375. */
  71376. dispose(): void;
  71377. /**
  71378. * Serialize the set into a JSON compatible object
  71379. * @param serializeTexture defines if the texture must be serialized as well
  71380. * @returns a JSON compatible representation of the set
  71381. */
  71382. serialize(serializeTexture?: boolean): any;
  71383. /**
  71384. * Parse a new ParticleSystemSet from a serialized source
  71385. * @param data defines a JSON compatible representation of the set
  71386. * @param scene defines the hosting scene
  71387. * @param gpu defines if we want GPU particles or CPU particles
  71388. * @returns a new ParticleSystemSet
  71389. */
  71390. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71391. }
  71392. }
  71393. declare module "babylonjs/Particles/particleHelper" {
  71394. import { Nullable } from "babylonjs/types";
  71395. import { Scene } from "babylonjs/scene";
  71396. import { Vector3 } from "babylonjs/Maths/math.vector";
  71397. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71398. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71399. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71400. /**
  71401. * This class is made for on one-liner static method to help creating particle system set.
  71402. */
  71403. export class ParticleHelper {
  71404. /**
  71405. * Gets or sets base Assets URL
  71406. */
  71407. static BaseAssetsUrl: string;
  71408. /** Define the Url to load snippets */
  71409. static SnippetUrl: string;
  71410. /**
  71411. * Create a default particle system that you can tweak
  71412. * @param emitter defines the emitter to use
  71413. * @param capacity defines the system capacity (default is 500 particles)
  71414. * @param scene defines the hosting scene
  71415. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71416. * @returns the new Particle system
  71417. */
  71418. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71419. /**
  71420. * This is the main static method (one-liner) of this helper to create different particle systems
  71421. * @param type This string represents the type to the particle system to create
  71422. * @param scene The scene where the particle system should live
  71423. * @param gpu If the system will use gpu
  71424. * @returns the ParticleSystemSet created
  71425. */
  71426. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71427. /**
  71428. * Static function used to export a particle system to a ParticleSystemSet variable.
  71429. * Please note that the emitter shape is not exported
  71430. * @param systems defines the particle systems to export
  71431. * @returns the created particle system set
  71432. */
  71433. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71434. /**
  71435. * Creates a particle system from a snippet saved in a remote file
  71436. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71437. * @param url defines the url to load from
  71438. * @param scene defines the hosting scene
  71439. * @param gpu If the system will use gpu
  71440. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71441. * @returns a promise that will resolve to the new particle system
  71442. */
  71443. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71444. /**
  71445. * Creates a particle system from a snippet saved by the particle system editor
  71446. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71447. * @param scene defines the hosting scene
  71448. * @param gpu If the system will use gpu
  71449. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71450. * @returns a promise that will resolve to the new particle system
  71451. */
  71452. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71453. }
  71454. }
  71455. declare module "babylonjs/Particles/particleSystemComponent" {
  71456. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71457. import { Effect } from "babylonjs/Materials/effect";
  71458. import "babylonjs/Shaders/particles.vertex";
  71459. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71460. module "babylonjs/Engines/engine" {
  71461. interface Engine {
  71462. /**
  71463. * Create an effect to use with particle systems.
  71464. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71465. * the particle system for which you want to create a custom effect in the last parameter
  71466. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71467. * @param uniformsNames defines a list of attribute names
  71468. * @param samplers defines an array of string used to represent textures
  71469. * @param defines defines the string containing the defines to use to compile the shaders
  71470. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71471. * @param onCompiled defines a function to call when the effect creation is successful
  71472. * @param onError defines a function to call when the effect creation has failed
  71473. * @param particleSystem the particle system you want to create the effect for
  71474. * @returns the new Effect
  71475. */
  71476. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71477. }
  71478. }
  71479. module "babylonjs/Meshes/mesh" {
  71480. interface Mesh {
  71481. /**
  71482. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71483. * @returns an array of IParticleSystem
  71484. */
  71485. getEmittedParticleSystems(): IParticleSystem[];
  71486. /**
  71487. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71488. * @returns an array of IParticleSystem
  71489. */
  71490. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71491. }
  71492. }
  71493. }
  71494. declare module "babylonjs/Particles/pointsCloudSystem" {
  71495. import { Color4 } from "babylonjs/Maths/math";
  71496. import { Mesh } from "babylonjs/Meshes/mesh";
  71497. import { Scene, IDisposable } from "babylonjs/scene";
  71498. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71499. /** Defines the 4 color options */
  71500. export enum PointColor {
  71501. /** color value */
  71502. Color = 2,
  71503. /** uv value */
  71504. UV = 1,
  71505. /** random value */
  71506. Random = 0,
  71507. /** stated value */
  71508. Stated = 3
  71509. }
  71510. /**
  71511. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71512. * 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.
  71513. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71514. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71515. *
  71516. * Full documentation here : TO BE ENTERED
  71517. */
  71518. export class PointsCloudSystem implements IDisposable {
  71519. /**
  71520. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71521. * Example : var p = SPS.particles[i];
  71522. */
  71523. particles: CloudPoint[];
  71524. /**
  71525. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71526. */
  71527. nbParticles: number;
  71528. /**
  71529. * This a counter for your own usage. It's not set by any SPS functions.
  71530. */
  71531. counter: number;
  71532. /**
  71533. * The PCS name. This name is also given to the underlying mesh.
  71534. */
  71535. name: string;
  71536. /**
  71537. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71538. */
  71539. mesh: Mesh;
  71540. /**
  71541. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71542. * Please read :
  71543. */
  71544. vars: any;
  71545. /**
  71546. * @hidden
  71547. */
  71548. _size: number;
  71549. private _scene;
  71550. private _promises;
  71551. private _positions;
  71552. private _indices;
  71553. private _normals;
  71554. private _colors;
  71555. private _uvs;
  71556. private _indices32;
  71557. private _positions32;
  71558. private _colors32;
  71559. private _uvs32;
  71560. private _updatable;
  71561. private _isVisibilityBoxLocked;
  71562. private _alwaysVisible;
  71563. private _groups;
  71564. private _groupCounter;
  71565. private _computeParticleColor;
  71566. private _computeParticleTexture;
  71567. private _computeParticleRotation;
  71568. private _computeBoundingBox;
  71569. private _isReady;
  71570. /**
  71571. * Creates a PCS (Points Cloud System) object
  71572. * @param name (String) is the PCS name, this will be the underlying mesh name
  71573. * @param pointSize (number) is the size for each point
  71574. * @param scene (Scene) is the scene in which the PCS is added
  71575. * @param options defines the options of the PCS e.g.
  71576. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71577. */
  71578. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71579. updatable?: boolean;
  71580. });
  71581. /**
  71582. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71583. * If no points were added to the PCS, the returned mesh is just a single point.
  71584. * @returns a promise for the created mesh
  71585. */
  71586. buildMeshAsync(): Promise<Mesh>;
  71587. /**
  71588. * @hidden
  71589. */
  71590. private _buildMesh;
  71591. private _addParticle;
  71592. private _randomUnitVector;
  71593. private _getColorIndicesForCoord;
  71594. private _setPointsColorOrUV;
  71595. private _colorFromTexture;
  71596. private _calculateDensity;
  71597. /**
  71598. * Adds points to the PCS in random positions within a unit sphere
  71599. * @param nb (positive integer) the number of particles to be created from this model
  71600. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71601. * @returns the number of groups in the system
  71602. */
  71603. addPoints(nb: number, pointFunction?: any): number;
  71604. /**
  71605. * Adds points to the PCS from the surface of the model shape
  71606. * @param mesh is any Mesh object that will be used as a surface model for the points
  71607. * @param nb (positive integer) the number of particles to be created from this model
  71608. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71609. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71610. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71611. * @returns the number of groups in the system
  71612. */
  71613. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71614. /**
  71615. * Adds points to the PCS inside the model shape
  71616. * @param mesh is any Mesh object that will be used as a surface model for the points
  71617. * @param nb (positive integer) the number of particles to be created from this model
  71618. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71619. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71620. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71621. * @returns the number of groups in the system
  71622. */
  71623. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71624. /**
  71625. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71626. * This method calls `updateParticle()` for each particle of the SPS.
  71627. * For an animated SPS, it is usually called within the render loop.
  71628. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71629. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71630. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71631. * @returns the PCS.
  71632. */
  71633. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71634. /**
  71635. * Disposes the PCS.
  71636. */
  71637. dispose(): void;
  71638. /**
  71639. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71640. * doc :
  71641. * @returns the PCS.
  71642. */
  71643. refreshVisibleSize(): PointsCloudSystem;
  71644. /**
  71645. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71646. * @param size the size (float) of the visibility box
  71647. * note : this doesn't lock the PCS mesh bounding box.
  71648. * doc :
  71649. */
  71650. setVisibilityBox(size: number): void;
  71651. /**
  71652. * Gets whether the PCS is always visible or not
  71653. * doc :
  71654. */
  71655. get isAlwaysVisible(): boolean;
  71656. /**
  71657. * Sets the PCS as always visible or not
  71658. * doc :
  71659. */
  71660. set isAlwaysVisible(val: boolean);
  71661. /**
  71662. * Tells to `setParticles()` to compute the particle rotations or not
  71663. * Default value : false. The PCS is faster when it's set to false
  71664. * Note : particle rotations are only applied to parent particles
  71665. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71666. */
  71667. set computeParticleRotation(val: boolean);
  71668. /**
  71669. * Tells to `setParticles()` to compute the particle colors or not.
  71670. * Default value : true. The PCS is faster when it's set to false.
  71671. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71672. */
  71673. set computeParticleColor(val: boolean);
  71674. set computeParticleTexture(val: boolean);
  71675. /**
  71676. * Gets if `setParticles()` computes the particle colors or not.
  71677. * Default value : false. The PCS is faster when it's set to false.
  71678. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71679. */
  71680. get computeParticleColor(): boolean;
  71681. /**
  71682. * Gets if `setParticles()` computes the particle textures or not.
  71683. * Default value : false. The PCS is faster when it's set to false.
  71684. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71685. */
  71686. get computeParticleTexture(): boolean;
  71687. /**
  71688. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71689. */
  71690. set computeBoundingBox(val: boolean);
  71691. /**
  71692. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71693. */
  71694. get computeBoundingBox(): boolean;
  71695. /**
  71696. * This function does nothing. It may be overwritten to set all the particle first values.
  71697. * The PCS doesn't call this function, you may have to call it by your own.
  71698. * doc :
  71699. */
  71700. initParticles(): void;
  71701. /**
  71702. * This function does nothing. It may be overwritten to recycle a particle
  71703. * The PCS doesn't call this function, you can to call it
  71704. * doc :
  71705. * @param particle The particle to recycle
  71706. * @returns the recycled particle
  71707. */
  71708. recycleParticle(particle: CloudPoint): CloudPoint;
  71709. /**
  71710. * Updates a particle : this function should be overwritten by the user.
  71711. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71712. * doc :
  71713. * @example : just set a particle position or velocity and recycle conditions
  71714. * @param particle The particle to update
  71715. * @returns the updated particle
  71716. */
  71717. updateParticle(particle: CloudPoint): CloudPoint;
  71718. /**
  71719. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71720. * This does nothing and may be overwritten by the user.
  71721. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71722. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71723. * @param update the boolean update value actually passed to setParticles()
  71724. */
  71725. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71726. /**
  71727. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71728. * This will be passed three parameters.
  71729. * This does nothing and may be overwritten by the user.
  71730. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71731. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71732. * @param update the boolean update value actually passed to setParticles()
  71733. */
  71734. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71735. }
  71736. }
  71737. declare module "babylonjs/Particles/cloudPoint" {
  71738. import { Nullable } from "babylonjs/types";
  71739. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71740. import { Mesh } from "babylonjs/Meshes/mesh";
  71741. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71742. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71743. /**
  71744. * Represents one particle of a points cloud system.
  71745. */
  71746. export class CloudPoint {
  71747. /**
  71748. * particle global index
  71749. */
  71750. idx: number;
  71751. /**
  71752. * The color of the particle
  71753. */
  71754. color: Nullable<Color4>;
  71755. /**
  71756. * The world space position of the particle.
  71757. */
  71758. position: Vector3;
  71759. /**
  71760. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71761. */
  71762. rotation: Vector3;
  71763. /**
  71764. * The world space rotation quaternion of the particle.
  71765. */
  71766. rotationQuaternion: Nullable<Quaternion>;
  71767. /**
  71768. * The uv of the particle.
  71769. */
  71770. uv: Nullable<Vector2>;
  71771. /**
  71772. * The current speed of the particle.
  71773. */
  71774. velocity: Vector3;
  71775. /**
  71776. * The pivot point in the particle local space.
  71777. */
  71778. pivot: Vector3;
  71779. /**
  71780. * Must the particle be translated from its pivot point in its local space ?
  71781. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71782. * Default : false
  71783. */
  71784. translateFromPivot: boolean;
  71785. /**
  71786. * Index of this particle in the global "positions" array (Internal use)
  71787. * @hidden
  71788. */
  71789. _pos: number;
  71790. /**
  71791. * @hidden Index of this particle in the global "indices" array (Internal use)
  71792. */
  71793. _ind: number;
  71794. /**
  71795. * Group this particle belongs to
  71796. */
  71797. _group: PointsGroup;
  71798. /**
  71799. * Group id of this particle
  71800. */
  71801. groupId: number;
  71802. /**
  71803. * Index of the particle in its group id (Internal use)
  71804. */
  71805. idxInGroup: number;
  71806. /**
  71807. * @hidden Particle BoundingInfo object (Internal use)
  71808. */
  71809. _boundingInfo: BoundingInfo;
  71810. /**
  71811. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71812. */
  71813. _pcs: PointsCloudSystem;
  71814. /**
  71815. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71816. */
  71817. _stillInvisible: boolean;
  71818. /**
  71819. * @hidden Last computed particle rotation matrix
  71820. */
  71821. _rotationMatrix: number[];
  71822. /**
  71823. * Parent particle Id, if any.
  71824. * Default null.
  71825. */
  71826. parentId: Nullable<number>;
  71827. /**
  71828. * @hidden Internal global position in the PCS.
  71829. */
  71830. _globalPosition: Vector3;
  71831. /**
  71832. * Creates a Point Cloud object.
  71833. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71834. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71835. * @param group (PointsGroup) is the group the particle belongs to
  71836. * @param groupId (integer) is the group identifier in the PCS.
  71837. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71838. * @param pcs defines the PCS it is associated to
  71839. */
  71840. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71841. /**
  71842. * get point size
  71843. */
  71844. get size(): Vector3;
  71845. /**
  71846. * Set point size
  71847. */
  71848. set size(scale: Vector3);
  71849. /**
  71850. * Legacy support, changed quaternion to rotationQuaternion
  71851. */
  71852. get quaternion(): Nullable<Quaternion>;
  71853. /**
  71854. * Legacy support, changed quaternion to rotationQuaternion
  71855. */
  71856. set quaternion(q: Nullable<Quaternion>);
  71857. /**
  71858. * Returns a boolean. True if the particle intersects a mesh, else false
  71859. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71860. * @param target is the object (point or mesh) what the intersection is computed against
  71861. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71862. * @returns true if it intersects
  71863. */
  71864. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71865. /**
  71866. * get the rotation matrix of the particle
  71867. * @hidden
  71868. */
  71869. getRotationMatrix(m: Matrix): void;
  71870. }
  71871. /**
  71872. * Represents a group of points in a points cloud system
  71873. * * PCS internal tool, don't use it manually.
  71874. */
  71875. export class PointsGroup {
  71876. /**
  71877. * The group id
  71878. * @hidden
  71879. */
  71880. groupID: number;
  71881. /**
  71882. * image data for group (internal use)
  71883. * @hidden
  71884. */
  71885. _groupImageData: Nullable<ArrayBufferView>;
  71886. /**
  71887. * Image Width (internal use)
  71888. * @hidden
  71889. */
  71890. _groupImgWidth: number;
  71891. /**
  71892. * Image Height (internal use)
  71893. * @hidden
  71894. */
  71895. _groupImgHeight: number;
  71896. /**
  71897. * Custom position function (internal use)
  71898. * @hidden
  71899. */
  71900. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71901. /**
  71902. * density per facet for surface points
  71903. * @hidden
  71904. */
  71905. _groupDensity: number[];
  71906. /**
  71907. * Only when points are colored by texture carries pointer to texture list array
  71908. * @hidden
  71909. */
  71910. _textureNb: number;
  71911. /**
  71912. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71913. * PCS internal tool, don't use it manually.
  71914. * @hidden
  71915. */
  71916. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71917. }
  71918. }
  71919. declare module "babylonjs/Particles/index" {
  71920. export * from "babylonjs/Particles/baseParticleSystem";
  71921. export * from "babylonjs/Particles/EmitterTypes/index";
  71922. export * from "babylonjs/Particles/gpuParticleSystem";
  71923. export * from "babylonjs/Particles/IParticleSystem";
  71924. export * from "babylonjs/Particles/particle";
  71925. export * from "babylonjs/Particles/particleHelper";
  71926. export * from "babylonjs/Particles/particleSystem";
  71927. import "babylonjs/Particles/particleSystemComponent";
  71928. export * from "babylonjs/Particles/particleSystemComponent";
  71929. export * from "babylonjs/Particles/particleSystemSet";
  71930. export * from "babylonjs/Particles/solidParticle";
  71931. export * from "babylonjs/Particles/solidParticleSystem";
  71932. export * from "babylonjs/Particles/cloudPoint";
  71933. export * from "babylonjs/Particles/pointsCloudSystem";
  71934. export * from "babylonjs/Particles/subEmitter";
  71935. }
  71936. declare module "babylonjs/Physics/physicsEngineComponent" {
  71937. import { Nullable } from "babylonjs/types";
  71938. import { Observable, Observer } from "babylonjs/Misc/observable";
  71939. import { Vector3 } from "babylonjs/Maths/math.vector";
  71940. import { Mesh } from "babylonjs/Meshes/mesh";
  71941. import { ISceneComponent } from "babylonjs/sceneComponent";
  71942. import { Scene } from "babylonjs/scene";
  71943. import { Node } from "babylonjs/node";
  71944. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71945. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71946. module "babylonjs/scene" {
  71947. interface Scene {
  71948. /** @hidden (Backing field) */
  71949. _physicsEngine: Nullable<IPhysicsEngine>;
  71950. /** @hidden */
  71951. _physicsTimeAccumulator: number;
  71952. /**
  71953. * Gets the current physics engine
  71954. * @returns a IPhysicsEngine or null if none attached
  71955. */
  71956. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71957. /**
  71958. * Enables physics to the current scene
  71959. * @param gravity defines the scene's gravity for the physics engine
  71960. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71961. * @return a boolean indicating if the physics engine was initialized
  71962. */
  71963. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71964. /**
  71965. * Disables and disposes the physics engine associated with the scene
  71966. */
  71967. disablePhysicsEngine(): void;
  71968. /**
  71969. * Gets a boolean indicating if there is an active physics engine
  71970. * @returns a boolean indicating if there is an active physics engine
  71971. */
  71972. isPhysicsEnabled(): boolean;
  71973. /**
  71974. * Deletes a physics compound impostor
  71975. * @param compound defines the compound to delete
  71976. */
  71977. deleteCompoundImpostor(compound: any): void;
  71978. /**
  71979. * An event triggered when physic simulation is about to be run
  71980. */
  71981. onBeforePhysicsObservable: Observable<Scene>;
  71982. /**
  71983. * An event triggered when physic simulation has been done
  71984. */
  71985. onAfterPhysicsObservable: Observable<Scene>;
  71986. }
  71987. }
  71988. module "babylonjs/Meshes/abstractMesh" {
  71989. interface AbstractMesh {
  71990. /** @hidden */
  71991. _physicsImpostor: Nullable<PhysicsImpostor>;
  71992. /**
  71993. * Gets or sets impostor used for physic simulation
  71994. * @see https://doc.babylonjs.com/features/physics_engine
  71995. */
  71996. physicsImpostor: Nullable<PhysicsImpostor>;
  71997. /**
  71998. * Gets the current physics impostor
  71999. * @see https://doc.babylonjs.com/features/physics_engine
  72000. * @returns a physics impostor or null
  72001. */
  72002. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  72003. /** Apply a physic impulse to the mesh
  72004. * @param force defines the force to apply
  72005. * @param contactPoint defines where to apply the force
  72006. * @returns the current mesh
  72007. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72008. */
  72009. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72010. /**
  72011. * Creates a physic joint between two meshes
  72012. * @param otherMesh defines the other mesh to use
  72013. * @param pivot1 defines the pivot to use on this mesh
  72014. * @param pivot2 defines the pivot to use on the other mesh
  72015. * @param options defines additional options (can be plugin dependent)
  72016. * @returns the current mesh
  72017. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72018. */
  72019. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72020. /** @hidden */
  72021. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72022. }
  72023. }
  72024. /**
  72025. * Defines the physics engine scene component responsible to manage a physics engine
  72026. */
  72027. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72028. /**
  72029. * The component name helpful to identify the component in the list of scene components.
  72030. */
  72031. readonly name: string;
  72032. /**
  72033. * The scene the component belongs to.
  72034. */
  72035. scene: Scene;
  72036. /**
  72037. * Creates a new instance of the component for the given scene
  72038. * @param scene Defines the scene to register the component in
  72039. */
  72040. constructor(scene: Scene);
  72041. /**
  72042. * Registers the component in a given scene
  72043. */
  72044. register(): void;
  72045. /**
  72046. * Rebuilds the elements related to this component in case of
  72047. * context lost for instance.
  72048. */
  72049. rebuild(): void;
  72050. /**
  72051. * Disposes the component and the associated ressources
  72052. */
  72053. dispose(): void;
  72054. }
  72055. }
  72056. declare module "babylonjs/Physics/physicsHelper" {
  72057. import { Nullable } from "babylonjs/types";
  72058. import { Vector3 } from "babylonjs/Maths/math.vector";
  72059. import { Mesh } from "babylonjs/Meshes/mesh";
  72060. import { Scene } from "babylonjs/scene";
  72061. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72062. /**
  72063. * A helper for physics simulations
  72064. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72065. */
  72066. export class PhysicsHelper {
  72067. private _scene;
  72068. private _physicsEngine;
  72069. /**
  72070. * Initializes the Physics helper
  72071. * @param scene Babylon.js scene
  72072. */
  72073. constructor(scene: Scene);
  72074. /**
  72075. * Applies a radial explosion impulse
  72076. * @param origin the origin of the explosion
  72077. * @param radiusOrEventOptions the radius or the options of radial explosion
  72078. * @param strength the explosion strength
  72079. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72080. * @returns A physics radial explosion event, or null
  72081. */
  72082. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72083. /**
  72084. * Applies a radial explosion force
  72085. * @param origin the origin of the explosion
  72086. * @param radiusOrEventOptions the radius or the options of radial explosion
  72087. * @param strength the explosion strength
  72088. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72089. * @returns A physics radial explosion event, or null
  72090. */
  72091. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72092. /**
  72093. * Creates a gravitational field
  72094. * @param origin the origin of the explosion
  72095. * @param radiusOrEventOptions the radius or the options of radial explosion
  72096. * @param strength the explosion strength
  72097. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72098. * @returns A physics gravitational field event, or null
  72099. */
  72100. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72101. /**
  72102. * Creates a physics updraft event
  72103. * @param origin the origin of the updraft
  72104. * @param radiusOrEventOptions the radius or the options of the updraft
  72105. * @param strength the strength of the updraft
  72106. * @param height the height of the updraft
  72107. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72108. * @returns A physics updraft event, or null
  72109. */
  72110. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72111. /**
  72112. * Creates a physics vortex event
  72113. * @param origin the of the vortex
  72114. * @param radiusOrEventOptions the radius or the options of the vortex
  72115. * @param strength the strength of the vortex
  72116. * @param height the height of the vortex
  72117. * @returns a Physics vortex event, or null
  72118. * A physics vortex event or null
  72119. */
  72120. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72121. }
  72122. /**
  72123. * Represents a physics radial explosion event
  72124. */
  72125. class PhysicsRadialExplosionEvent {
  72126. private _scene;
  72127. private _options;
  72128. private _sphere;
  72129. private _dataFetched;
  72130. /**
  72131. * Initializes a radial explosioin event
  72132. * @param _scene BabylonJS scene
  72133. * @param _options The options for the vortex event
  72134. */
  72135. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72136. /**
  72137. * Returns the data related to the radial explosion event (sphere).
  72138. * @returns The radial explosion event data
  72139. */
  72140. getData(): PhysicsRadialExplosionEventData;
  72141. /**
  72142. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72143. * @param impostor A physics imposter
  72144. * @param origin the origin of the explosion
  72145. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72146. */
  72147. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72148. /**
  72149. * Triggers affecterd impostors callbacks
  72150. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72151. */
  72152. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72153. /**
  72154. * Disposes the sphere.
  72155. * @param force Specifies if the sphere should be disposed by force
  72156. */
  72157. dispose(force?: boolean): void;
  72158. /*** Helpers ***/
  72159. private _prepareSphere;
  72160. private _intersectsWithSphere;
  72161. }
  72162. /**
  72163. * Represents a gravitational field event
  72164. */
  72165. class PhysicsGravitationalFieldEvent {
  72166. private _physicsHelper;
  72167. private _scene;
  72168. private _origin;
  72169. private _options;
  72170. private _tickCallback;
  72171. private _sphere;
  72172. private _dataFetched;
  72173. /**
  72174. * Initializes the physics gravitational field event
  72175. * @param _physicsHelper A physics helper
  72176. * @param _scene BabylonJS scene
  72177. * @param _origin The origin position of the gravitational field event
  72178. * @param _options The options for the vortex event
  72179. */
  72180. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72181. /**
  72182. * Returns the data related to the gravitational field event (sphere).
  72183. * @returns A gravitational field event
  72184. */
  72185. getData(): PhysicsGravitationalFieldEventData;
  72186. /**
  72187. * Enables the gravitational field.
  72188. */
  72189. enable(): void;
  72190. /**
  72191. * Disables the gravitational field.
  72192. */
  72193. disable(): void;
  72194. /**
  72195. * Disposes the sphere.
  72196. * @param force The force to dispose from the gravitational field event
  72197. */
  72198. dispose(force?: boolean): void;
  72199. private _tick;
  72200. }
  72201. /**
  72202. * Represents a physics updraft event
  72203. */
  72204. class PhysicsUpdraftEvent {
  72205. private _scene;
  72206. private _origin;
  72207. private _options;
  72208. private _physicsEngine;
  72209. private _originTop;
  72210. private _originDirection;
  72211. private _tickCallback;
  72212. private _cylinder;
  72213. private _cylinderPosition;
  72214. private _dataFetched;
  72215. /**
  72216. * Initializes the physics updraft event
  72217. * @param _scene BabylonJS scene
  72218. * @param _origin The origin position of the updraft
  72219. * @param _options The options for the updraft event
  72220. */
  72221. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72222. /**
  72223. * Returns the data related to the updraft event (cylinder).
  72224. * @returns A physics updraft event
  72225. */
  72226. getData(): PhysicsUpdraftEventData;
  72227. /**
  72228. * Enables the updraft.
  72229. */
  72230. enable(): void;
  72231. /**
  72232. * Disables the updraft.
  72233. */
  72234. disable(): void;
  72235. /**
  72236. * Disposes the cylinder.
  72237. * @param force Specifies if the updraft should be disposed by force
  72238. */
  72239. dispose(force?: boolean): void;
  72240. private getImpostorHitData;
  72241. private _tick;
  72242. /*** Helpers ***/
  72243. private _prepareCylinder;
  72244. private _intersectsWithCylinder;
  72245. }
  72246. /**
  72247. * Represents a physics vortex event
  72248. */
  72249. class PhysicsVortexEvent {
  72250. private _scene;
  72251. private _origin;
  72252. private _options;
  72253. private _physicsEngine;
  72254. private _originTop;
  72255. private _tickCallback;
  72256. private _cylinder;
  72257. private _cylinderPosition;
  72258. private _dataFetched;
  72259. /**
  72260. * Initializes the physics vortex event
  72261. * @param _scene The BabylonJS scene
  72262. * @param _origin The origin position of the vortex
  72263. * @param _options The options for the vortex event
  72264. */
  72265. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72266. /**
  72267. * Returns the data related to the vortex event (cylinder).
  72268. * @returns The physics vortex event data
  72269. */
  72270. getData(): PhysicsVortexEventData;
  72271. /**
  72272. * Enables the vortex.
  72273. */
  72274. enable(): void;
  72275. /**
  72276. * Disables the cortex.
  72277. */
  72278. disable(): void;
  72279. /**
  72280. * Disposes the sphere.
  72281. * @param force
  72282. */
  72283. dispose(force?: boolean): void;
  72284. private getImpostorHitData;
  72285. private _tick;
  72286. /*** Helpers ***/
  72287. private _prepareCylinder;
  72288. private _intersectsWithCylinder;
  72289. }
  72290. /**
  72291. * Options fot the radial explosion event
  72292. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72293. */
  72294. export class PhysicsRadialExplosionEventOptions {
  72295. /**
  72296. * The radius of the sphere for the radial explosion.
  72297. */
  72298. radius: number;
  72299. /**
  72300. * The strenth of the explosion.
  72301. */
  72302. strength: number;
  72303. /**
  72304. * The strenght of the force in correspondence to the distance of the affected object
  72305. */
  72306. falloff: PhysicsRadialImpulseFalloff;
  72307. /**
  72308. * Sphere options for the radial explosion.
  72309. */
  72310. sphere: {
  72311. segments: number;
  72312. diameter: number;
  72313. };
  72314. /**
  72315. * Sphere options for the radial explosion.
  72316. */
  72317. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72318. }
  72319. /**
  72320. * Options fot the updraft event
  72321. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72322. */
  72323. export class PhysicsUpdraftEventOptions {
  72324. /**
  72325. * The radius of the cylinder for the vortex
  72326. */
  72327. radius: number;
  72328. /**
  72329. * The strenth of the updraft.
  72330. */
  72331. strength: number;
  72332. /**
  72333. * The height of the cylinder for the updraft.
  72334. */
  72335. height: number;
  72336. /**
  72337. * The mode for the the updraft.
  72338. */
  72339. updraftMode: PhysicsUpdraftMode;
  72340. }
  72341. /**
  72342. * Options fot the vortex event
  72343. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72344. */
  72345. export class PhysicsVortexEventOptions {
  72346. /**
  72347. * The radius of the cylinder for the vortex
  72348. */
  72349. radius: number;
  72350. /**
  72351. * The strenth of the vortex.
  72352. */
  72353. strength: number;
  72354. /**
  72355. * The height of the cylinder for the vortex.
  72356. */
  72357. height: number;
  72358. /**
  72359. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72360. */
  72361. centripetalForceThreshold: number;
  72362. /**
  72363. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72364. */
  72365. centripetalForceMultiplier: number;
  72366. /**
  72367. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72368. */
  72369. centrifugalForceMultiplier: number;
  72370. /**
  72371. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72372. */
  72373. updraftForceMultiplier: number;
  72374. }
  72375. /**
  72376. * The strenght of the force in correspondence to the distance of the affected object
  72377. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72378. */
  72379. export enum PhysicsRadialImpulseFalloff {
  72380. /** Defines that impulse is constant in strength across it's whole radius */
  72381. Constant = 0,
  72382. /** Defines that impulse gets weaker if it's further from the origin */
  72383. Linear = 1
  72384. }
  72385. /**
  72386. * The strength of the force in correspondence to the distance of the affected object
  72387. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72388. */
  72389. export enum PhysicsUpdraftMode {
  72390. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72391. Center = 0,
  72392. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72393. Perpendicular = 1
  72394. }
  72395. /**
  72396. * Interface for a physics hit data
  72397. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72398. */
  72399. export interface PhysicsHitData {
  72400. /**
  72401. * The force applied at the contact point
  72402. */
  72403. force: Vector3;
  72404. /**
  72405. * The contact point
  72406. */
  72407. contactPoint: Vector3;
  72408. /**
  72409. * The distance from the origin to the contact point
  72410. */
  72411. distanceFromOrigin: number;
  72412. }
  72413. /**
  72414. * Interface for radial explosion event data
  72415. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72416. */
  72417. export interface PhysicsRadialExplosionEventData {
  72418. /**
  72419. * A sphere used for the radial explosion event
  72420. */
  72421. sphere: Mesh;
  72422. }
  72423. /**
  72424. * Interface for gravitational field event data
  72425. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72426. */
  72427. export interface PhysicsGravitationalFieldEventData {
  72428. /**
  72429. * A sphere mesh used for the gravitational field event
  72430. */
  72431. sphere: Mesh;
  72432. }
  72433. /**
  72434. * Interface for updraft event data
  72435. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72436. */
  72437. export interface PhysicsUpdraftEventData {
  72438. /**
  72439. * A cylinder used for the updraft event
  72440. */
  72441. cylinder: Mesh;
  72442. }
  72443. /**
  72444. * Interface for vortex event data
  72445. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72446. */
  72447. export interface PhysicsVortexEventData {
  72448. /**
  72449. * A cylinder used for the vortex event
  72450. */
  72451. cylinder: Mesh;
  72452. }
  72453. /**
  72454. * Interface for an affected physics impostor
  72455. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72456. */
  72457. export interface PhysicsAffectedImpostorWithData {
  72458. /**
  72459. * The impostor affected by the effect
  72460. */
  72461. impostor: PhysicsImpostor;
  72462. /**
  72463. * The data about the hit/horce from the explosion
  72464. */
  72465. hitData: PhysicsHitData;
  72466. }
  72467. }
  72468. declare module "babylonjs/Physics/Plugins/index" {
  72469. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72470. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72471. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72472. }
  72473. declare module "babylonjs/Physics/index" {
  72474. export * from "babylonjs/Physics/IPhysicsEngine";
  72475. export * from "babylonjs/Physics/physicsEngine";
  72476. export * from "babylonjs/Physics/physicsEngineComponent";
  72477. export * from "babylonjs/Physics/physicsHelper";
  72478. export * from "babylonjs/Physics/physicsImpostor";
  72479. export * from "babylonjs/Physics/physicsJoint";
  72480. export * from "babylonjs/Physics/Plugins/index";
  72481. }
  72482. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72483. /** @hidden */
  72484. export var blackAndWhitePixelShader: {
  72485. name: string;
  72486. shader: string;
  72487. };
  72488. }
  72489. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72490. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72491. import { Camera } from "babylonjs/Cameras/camera";
  72492. import { Engine } from "babylonjs/Engines/engine";
  72493. import "babylonjs/Shaders/blackAndWhite.fragment";
  72494. import { Nullable } from "babylonjs/types";
  72495. import { Scene } from "babylonjs/scene";
  72496. /**
  72497. * Post process used to render in black and white
  72498. */
  72499. export class BlackAndWhitePostProcess extends PostProcess {
  72500. /**
  72501. * Linear about to convert he result to black and white (default: 1)
  72502. */
  72503. degree: number;
  72504. /**
  72505. * Gets a string identifying the name of the class
  72506. * @returns "BlackAndWhitePostProcess" string
  72507. */
  72508. getClassName(): string;
  72509. /**
  72510. * Creates a black and white post process
  72511. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72512. * @param name The name of the effect.
  72513. * @param options The required width/height ratio to downsize to before computing the render pass.
  72514. * @param camera The camera to apply the render pass to.
  72515. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72516. * @param engine The engine which the post process will be applied. (default: current engine)
  72517. * @param reusable If the post process can be reused on the same frame. (default: false)
  72518. */
  72519. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72520. /** @hidden */
  72521. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72522. }
  72523. }
  72524. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72525. import { Nullable } from "babylonjs/types";
  72526. import { Camera } from "babylonjs/Cameras/camera";
  72527. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72528. import { Engine } from "babylonjs/Engines/engine";
  72529. /**
  72530. * This represents a set of one or more post processes in Babylon.
  72531. * A post process can be used to apply a shader to a texture after it is rendered.
  72532. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72533. */
  72534. export class PostProcessRenderEffect {
  72535. private _postProcesses;
  72536. private _getPostProcesses;
  72537. private _singleInstance;
  72538. private _cameras;
  72539. private _indicesForCamera;
  72540. /**
  72541. * Name of the effect
  72542. * @hidden
  72543. */
  72544. _name: string;
  72545. /**
  72546. * Instantiates a post process render effect.
  72547. * A post process can be used to apply a shader to a texture after it is rendered.
  72548. * @param engine The engine the effect is tied to
  72549. * @param name The name of the effect
  72550. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72551. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72552. */
  72553. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72554. /**
  72555. * Checks if all the post processes in the effect are supported.
  72556. */
  72557. get isSupported(): boolean;
  72558. /**
  72559. * Updates the current state of the effect
  72560. * @hidden
  72561. */
  72562. _update(): void;
  72563. /**
  72564. * Attaches the effect on cameras
  72565. * @param cameras The camera to attach to.
  72566. * @hidden
  72567. */
  72568. _attachCameras(cameras: Camera): void;
  72569. /**
  72570. * Attaches the effect on cameras
  72571. * @param cameras The camera to attach to.
  72572. * @hidden
  72573. */
  72574. _attachCameras(cameras: Camera[]): void;
  72575. /**
  72576. * Detaches the effect on cameras
  72577. * @param cameras The camera to detatch from.
  72578. * @hidden
  72579. */
  72580. _detachCameras(cameras: Camera): void;
  72581. /**
  72582. * Detatches the effect on cameras
  72583. * @param cameras The camera to detatch from.
  72584. * @hidden
  72585. */
  72586. _detachCameras(cameras: Camera[]): void;
  72587. /**
  72588. * Enables the effect on given cameras
  72589. * @param cameras The camera to enable.
  72590. * @hidden
  72591. */
  72592. _enable(cameras: Camera): void;
  72593. /**
  72594. * Enables the effect on given cameras
  72595. * @param cameras The camera to enable.
  72596. * @hidden
  72597. */
  72598. _enable(cameras: Nullable<Camera[]>): void;
  72599. /**
  72600. * Disables the effect on the given cameras
  72601. * @param cameras The camera to disable.
  72602. * @hidden
  72603. */
  72604. _disable(cameras: Camera): void;
  72605. /**
  72606. * Disables the effect on the given cameras
  72607. * @param cameras The camera to disable.
  72608. * @hidden
  72609. */
  72610. _disable(cameras: Nullable<Camera[]>): void;
  72611. /**
  72612. * Gets a list of the post processes contained in the effect.
  72613. * @param camera The camera to get the post processes on.
  72614. * @returns The list of the post processes in the effect.
  72615. */
  72616. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72617. }
  72618. }
  72619. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72620. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72621. /** @hidden */
  72622. export var extractHighlightsPixelShader: {
  72623. name: string;
  72624. shader: string;
  72625. };
  72626. }
  72627. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72628. import { Nullable } from "babylonjs/types";
  72629. import { Camera } from "babylonjs/Cameras/camera";
  72630. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72631. import { Engine } from "babylonjs/Engines/engine";
  72632. import "babylonjs/Shaders/extractHighlights.fragment";
  72633. /**
  72634. * 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.
  72635. */
  72636. export class ExtractHighlightsPostProcess extends PostProcess {
  72637. /**
  72638. * The luminance threshold, pixels below this value will be set to black.
  72639. */
  72640. threshold: number;
  72641. /** @hidden */
  72642. _exposure: number;
  72643. /**
  72644. * Post process which has the input texture to be used when performing highlight extraction
  72645. * @hidden
  72646. */
  72647. _inputPostProcess: Nullable<PostProcess>;
  72648. /**
  72649. * Gets a string identifying the name of the class
  72650. * @returns "ExtractHighlightsPostProcess" string
  72651. */
  72652. getClassName(): string;
  72653. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72654. }
  72655. }
  72656. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72657. /** @hidden */
  72658. export var bloomMergePixelShader: {
  72659. name: string;
  72660. shader: string;
  72661. };
  72662. }
  72663. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72664. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72665. import { Nullable } from "babylonjs/types";
  72666. import { Engine } from "babylonjs/Engines/engine";
  72667. import { Camera } from "babylonjs/Cameras/camera";
  72668. import "babylonjs/Shaders/bloomMerge.fragment";
  72669. /**
  72670. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72671. */
  72672. export class BloomMergePostProcess extends PostProcess {
  72673. /** Weight of the bloom to be added to the original input. */
  72674. weight: number;
  72675. /**
  72676. * Gets a string identifying the name of the class
  72677. * @returns "BloomMergePostProcess" string
  72678. */
  72679. getClassName(): string;
  72680. /**
  72681. * Creates a new instance of @see BloomMergePostProcess
  72682. * @param name The name of the effect.
  72683. * @param originalFromInput Post process which's input will be used for the merge.
  72684. * @param blurred Blurred highlights post process which's output will be used.
  72685. * @param weight Weight of the bloom to be added to the original input.
  72686. * @param options The required width/height ratio to downsize to before computing the render pass.
  72687. * @param camera The camera to apply the render pass to.
  72688. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72689. * @param engine The engine which the post process will be applied. (default: current engine)
  72690. * @param reusable If the post process can be reused on the same frame. (default: false)
  72691. * @param textureType Type of textures used when performing the post process. (default: 0)
  72692. * @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)
  72693. */
  72694. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72695. /** Weight of the bloom to be added to the original input. */
  72696. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72697. }
  72698. }
  72699. declare module "babylonjs/PostProcesses/bloomEffect" {
  72700. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72701. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72702. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72703. import { Camera } from "babylonjs/Cameras/camera";
  72704. import { Scene } from "babylonjs/scene";
  72705. /**
  72706. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72707. */
  72708. export class BloomEffect extends PostProcessRenderEffect {
  72709. private bloomScale;
  72710. /**
  72711. * @hidden Internal
  72712. */
  72713. _effects: Array<PostProcess>;
  72714. /**
  72715. * @hidden Internal
  72716. */
  72717. _downscale: ExtractHighlightsPostProcess;
  72718. private _blurX;
  72719. private _blurY;
  72720. private _merge;
  72721. /**
  72722. * The luminance threshold to find bright areas of the image to bloom.
  72723. */
  72724. get threshold(): number;
  72725. set threshold(value: number);
  72726. /**
  72727. * The strength of the bloom.
  72728. */
  72729. get weight(): number;
  72730. set weight(value: number);
  72731. /**
  72732. * Specifies the size of the bloom blur kernel, relative to the final output size
  72733. */
  72734. get kernel(): number;
  72735. set kernel(value: number);
  72736. /**
  72737. * Creates a new instance of @see BloomEffect
  72738. * @param scene The scene the effect belongs to.
  72739. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72740. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72741. * @param bloomWeight The the strength of bloom.
  72742. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72743. * @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)
  72744. */
  72745. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72746. /**
  72747. * Disposes each of the internal effects for a given camera.
  72748. * @param camera The camera to dispose the effect on.
  72749. */
  72750. disposeEffects(camera: Camera): void;
  72751. /**
  72752. * @hidden Internal
  72753. */
  72754. _updateEffects(): void;
  72755. /**
  72756. * Internal
  72757. * @returns if all the contained post processes are ready.
  72758. * @hidden
  72759. */
  72760. _isReady(): boolean;
  72761. }
  72762. }
  72763. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72764. /** @hidden */
  72765. export var chromaticAberrationPixelShader: {
  72766. name: string;
  72767. shader: string;
  72768. };
  72769. }
  72770. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72771. import { Vector2 } from "babylonjs/Maths/math.vector";
  72772. import { Nullable } from "babylonjs/types";
  72773. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72774. import { Camera } from "babylonjs/Cameras/camera";
  72775. import { Engine } from "babylonjs/Engines/engine";
  72776. import "babylonjs/Shaders/chromaticAberration.fragment";
  72777. import { Scene } from "babylonjs/scene";
  72778. /**
  72779. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72780. */
  72781. export class ChromaticAberrationPostProcess extends PostProcess {
  72782. /**
  72783. * The amount of seperation of rgb channels (default: 30)
  72784. */
  72785. aberrationAmount: number;
  72786. /**
  72787. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72788. */
  72789. radialIntensity: number;
  72790. /**
  72791. * 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))
  72792. */
  72793. direction: Vector2;
  72794. /**
  72795. * 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))
  72796. */
  72797. centerPosition: Vector2;
  72798. /** The width of the screen to apply the effect on */
  72799. screenWidth: number;
  72800. /** The height of the screen to apply the effect on */
  72801. screenHeight: number;
  72802. /**
  72803. * Gets a string identifying the name of the class
  72804. * @returns "ChromaticAberrationPostProcess" string
  72805. */
  72806. getClassName(): string;
  72807. /**
  72808. * Creates a new instance ChromaticAberrationPostProcess
  72809. * @param name The name of the effect.
  72810. * @param screenWidth The width of the screen to apply the effect on.
  72811. * @param screenHeight The height of the screen to apply the effect on.
  72812. * @param options The required width/height ratio to downsize to before computing the render pass.
  72813. * @param camera The camera to apply the render pass to.
  72814. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72815. * @param engine The engine which the post process will be applied. (default: current engine)
  72816. * @param reusable If the post process can be reused on the same frame. (default: false)
  72817. * @param textureType Type of textures used when performing the post process. (default: 0)
  72818. * @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)
  72819. */
  72820. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72821. /** @hidden */
  72822. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72823. }
  72824. }
  72825. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72826. /** @hidden */
  72827. export var circleOfConfusionPixelShader: {
  72828. name: string;
  72829. shader: string;
  72830. };
  72831. }
  72832. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72833. import { Nullable } from "babylonjs/types";
  72834. import { Engine } from "babylonjs/Engines/engine";
  72835. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72836. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72837. import { Camera } from "babylonjs/Cameras/camera";
  72838. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72839. /**
  72840. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72841. */
  72842. export class CircleOfConfusionPostProcess extends PostProcess {
  72843. /**
  72844. * 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.
  72845. */
  72846. lensSize: number;
  72847. /**
  72848. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72849. */
  72850. fStop: number;
  72851. /**
  72852. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72853. */
  72854. focusDistance: number;
  72855. /**
  72856. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72857. */
  72858. focalLength: number;
  72859. /**
  72860. * Gets a string identifying the name of the class
  72861. * @returns "CircleOfConfusionPostProcess" string
  72862. */
  72863. getClassName(): string;
  72864. private _depthTexture;
  72865. /**
  72866. * Creates a new instance CircleOfConfusionPostProcess
  72867. * @param name The name of the effect.
  72868. * @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.
  72869. * @param options The required width/height ratio to downsize to before computing the render pass.
  72870. * @param camera The camera to apply the render pass to.
  72871. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72872. * @param engine The engine which the post process will be applied. (default: current engine)
  72873. * @param reusable If the post process can be reused on the same frame. (default: false)
  72874. * @param textureType Type of textures used when performing the post process. (default: 0)
  72875. * @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)
  72876. */
  72877. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72878. /**
  72879. * 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.
  72880. */
  72881. set depthTexture(value: RenderTargetTexture);
  72882. }
  72883. }
  72884. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72885. /** @hidden */
  72886. export var colorCorrectionPixelShader: {
  72887. name: string;
  72888. shader: string;
  72889. };
  72890. }
  72891. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72892. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72893. import { Engine } from "babylonjs/Engines/engine";
  72894. import { Camera } from "babylonjs/Cameras/camera";
  72895. import "babylonjs/Shaders/colorCorrection.fragment";
  72896. import { Nullable } from "babylonjs/types";
  72897. import { Scene } from "babylonjs/scene";
  72898. /**
  72899. *
  72900. * This post-process allows the modification of rendered colors by using
  72901. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72902. *
  72903. * The object needs to be provided an url to a texture containing the color
  72904. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72905. * Use an image editing software to tweak the LUT to match your needs.
  72906. *
  72907. * For an example of a color LUT, see here:
  72908. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72909. * For explanations on color grading, see here:
  72910. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72911. *
  72912. */
  72913. export class ColorCorrectionPostProcess extends PostProcess {
  72914. private _colorTableTexture;
  72915. /**
  72916. * Gets the color table url used to create the LUT texture
  72917. */
  72918. colorTableUrl: string;
  72919. /**
  72920. * Gets a string identifying the name of the class
  72921. * @returns "ColorCorrectionPostProcess" string
  72922. */
  72923. getClassName(): string;
  72924. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72925. /** @hidden */
  72926. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72927. }
  72928. }
  72929. declare module "babylonjs/Shaders/convolution.fragment" {
  72930. /** @hidden */
  72931. export var convolutionPixelShader: {
  72932. name: string;
  72933. shader: string;
  72934. };
  72935. }
  72936. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72937. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72938. import { Nullable } from "babylonjs/types";
  72939. import { Camera } from "babylonjs/Cameras/camera";
  72940. import { Engine } from "babylonjs/Engines/engine";
  72941. import "babylonjs/Shaders/convolution.fragment";
  72942. import { Scene } from "babylonjs/scene";
  72943. /**
  72944. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72945. * input texture to perform effects such as edge detection or sharpening
  72946. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72947. */
  72948. export class ConvolutionPostProcess extends PostProcess {
  72949. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72950. kernel: number[];
  72951. /**
  72952. * Gets a string identifying the name of the class
  72953. * @returns "ConvolutionPostProcess" string
  72954. */
  72955. getClassName(): string;
  72956. /**
  72957. * Creates a new instance ConvolutionPostProcess
  72958. * @param name The name of the effect.
  72959. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72960. * @param options The required width/height ratio to downsize to before computing the render pass.
  72961. * @param camera The camera to apply the render pass to.
  72962. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72963. * @param engine The engine which the post process will be applied. (default: current engine)
  72964. * @param reusable If the post process can be reused on the same frame. (default: false)
  72965. * @param textureType Type of textures used when performing the post process. (default: 0)
  72966. */
  72967. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72968. /** @hidden */
  72969. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72970. /**
  72971. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72972. */
  72973. static EdgeDetect0Kernel: number[];
  72974. /**
  72975. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72976. */
  72977. static EdgeDetect1Kernel: number[];
  72978. /**
  72979. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72980. */
  72981. static EdgeDetect2Kernel: number[];
  72982. /**
  72983. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72984. */
  72985. static SharpenKernel: number[];
  72986. /**
  72987. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72988. */
  72989. static EmbossKernel: number[];
  72990. /**
  72991. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72992. */
  72993. static GaussianKernel: number[];
  72994. }
  72995. }
  72996. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72997. import { Nullable } from "babylonjs/types";
  72998. import { Vector2 } from "babylonjs/Maths/math.vector";
  72999. import { Camera } from "babylonjs/Cameras/camera";
  73000. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73001. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73002. import { Engine } from "babylonjs/Engines/engine";
  73003. import { Scene } from "babylonjs/scene";
  73004. /**
  73005. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73006. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73007. * based on samples that have a large difference in distance than the center pixel.
  73008. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73009. */
  73010. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73011. /**
  73012. * The direction the blur should be applied
  73013. */
  73014. direction: Vector2;
  73015. /**
  73016. * Gets a string identifying the name of the class
  73017. * @returns "DepthOfFieldBlurPostProcess" string
  73018. */
  73019. getClassName(): string;
  73020. /**
  73021. * Creates a new instance CircleOfConfusionPostProcess
  73022. * @param name The name of the effect.
  73023. * @param scene The scene the effect belongs to.
  73024. * @param direction The direction the blur should be applied.
  73025. * @param kernel The size of the kernel used to blur.
  73026. * @param options The required width/height ratio to downsize to before computing the render pass.
  73027. * @param camera The camera to apply the render pass to.
  73028. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73029. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73030. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73031. * @param engine The engine which the post process will be applied. (default: current engine)
  73032. * @param reusable If the post process can be reused on the same frame. (default: false)
  73033. * @param textureType Type of textures used when performing the post process. (default: 0)
  73034. * @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)
  73035. */
  73036. 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);
  73037. }
  73038. }
  73039. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73040. /** @hidden */
  73041. export var depthOfFieldMergePixelShader: {
  73042. name: string;
  73043. shader: string;
  73044. };
  73045. }
  73046. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73047. import { Nullable } from "babylonjs/types";
  73048. import { Camera } from "babylonjs/Cameras/camera";
  73049. import { Effect } from "babylonjs/Materials/effect";
  73050. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73051. import { Engine } from "babylonjs/Engines/engine";
  73052. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73053. /**
  73054. * Options to be set when merging outputs from the default pipeline.
  73055. */
  73056. export class DepthOfFieldMergePostProcessOptions {
  73057. /**
  73058. * The original image to merge on top of
  73059. */
  73060. originalFromInput: PostProcess;
  73061. /**
  73062. * Parameters to perform the merge of the depth of field effect
  73063. */
  73064. depthOfField?: {
  73065. circleOfConfusion: PostProcess;
  73066. blurSteps: Array<PostProcess>;
  73067. };
  73068. /**
  73069. * Parameters to perform the merge of bloom effect
  73070. */
  73071. bloom?: {
  73072. blurred: PostProcess;
  73073. weight: number;
  73074. };
  73075. }
  73076. /**
  73077. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73078. */
  73079. export class DepthOfFieldMergePostProcess extends PostProcess {
  73080. private blurSteps;
  73081. /**
  73082. * Gets a string identifying the name of the class
  73083. * @returns "DepthOfFieldMergePostProcess" string
  73084. */
  73085. getClassName(): string;
  73086. /**
  73087. * Creates a new instance of DepthOfFieldMergePostProcess
  73088. * @param name The name of the effect.
  73089. * @param originalFromInput Post process which's input will be used for the merge.
  73090. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73091. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73092. * @param options The required width/height ratio to downsize to before computing the render pass.
  73093. * @param camera The camera to apply the render pass to.
  73094. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73095. * @param engine The engine which the post process will be applied. (default: current engine)
  73096. * @param reusable If the post process can be reused on the same frame. (default: false)
  73097. * @param textureType Type of textures used when performing the post process. (default: 0)
  73098. * @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)
  73099. */
  73100. 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);
  73101. /**
  73102. * Updates the effect with the current post process compile time values and recompiles the shader.
  73103. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73104. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73105. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73106. * @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
  73107. * @param onCompiled Called when the shader has been compiled.
  73108. * @param onError Called if there is an error when compiling a shader.
  73109. */
  73110. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73111. }
  73112. }
  73113. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73114. import { Nullable } from "babylonjs/types";
  73115. import { Camera } from "babylonjs/Cameras/camera";
  73116. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73117. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73118. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73119. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73120. import { Scene } from "babylonjs/scene";
  73121. /**
  73122. * Specifies the level of max blur that should be applied when using the depth of field effect
  73123. */
  73124. export enum DepthOfFieldEffectBlurLevel {
  73125. /**
  73126. * Subtle blur
  73127. */
  73128. Low = 0,
  73129. /**
  73130. * Medium blur
  73131. */
  73132. Medium = 1,
  73133. /**
  73134. * Large blur
  73135. */
  73136. High = 2
  73137. }
  73138. /**
  73139. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73140. */
  73141. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73142. private _circleOfConfusion;
  73143. /**
  73144. * @hidden Internal, blurs from high to low
  73145. */
  73146. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73147. private _depthOfFieldBlurY;
  73148. private _dofMerge;
  73149. /**
  73150. * @hidden Internal post processes in depth of field effect
  73151. */
  73152. _effects: Array<PostProcess>;
  73153. /**
  73154. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73155. */
  73156. set focalLength(value: number);
  73157. get focalLength(): number;
  73158. /**
  73159. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73160. */
  73161. set fStop(value: number);
  73162. get fStop(): number;
  73163. /**
  73164. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73165. */
  73166. set focusDistance(value: number);
  73167. get focusDistance(): number;
  73168. /**
  73169. * 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.
  73170. */
  73171. set lensSize(value: number);
  73172. get lensSize(): number;
  73173. /**
  73174. * Creates a new instance DepthOfFieldEffect
  73175. * @param scene The scene the effect belongs to.
  73176. * @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.
  73177. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73178. * @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)
  73179. */
  73180. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73181. /**
  73182. * Get the current class name of the current effet
  73183. * @returns "DepthOfFieldEffect"
  73184. */
  73185. getClassName(): string;
  73186. /**
  73187. * 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.
  73188. */
  73189. set depthTexture(value: RenderTargetTexture);
  73190. /**
  73191. * Disposes each of the internal effects for a given camera.
  73192. * @param camera The camera to dispose the effect on.
  73193. */
  73194. disposeEffects(camera: Camera): void;
  73195. /**
  73196. * @hidden Internal
  73197. */
  73198. _updateEffects(): void;
  73199. /**
  73200. * Internal
  73201. * @returns if all the contained post processes are ready.
  73202. * @hidden
  73203. */
  73204. _isReady(): boolean;
  73205. }
  73206. }
  73207. declare module "babylonjs/Shaders/displayPass.fragment" {
  73208. /** @hidden */
  73209. export var displayPassPixelShader: {
  73210. name: string;
  73211. shader: string;
  73212. };
  73213. }
  73214. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73215. import { Nullable } from "babylonjs/types";
  73216. import { Camera } from "babylonjs/Cameras/camera";
  73217. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73218. import { Engine } from "babylonjs/Engines/engine";
  73219. import "babylonjs/Shaders/displayPass.fragment";
  73220. import { Scene } from "babylonjs/scene";
  73221. /**
  73222. * DisplayPassPostProcess which produces an output the same as it's input
  73223. */
  73224. export class DisplayPassPostProcess extends PostProcess {
  73225. /**
  73226. * Gets a string identifying the name of the class
  73227. * @returns "DisplayPassPostProcess" string
  73228. */
  73229. getClassName(): string;
  73230. /**
  73231. * Creates the DisplayPassPostProcess
  73232. * @param name The name of the effect.
  73233. * @param options The required width/height ratio to downsize to before computing the render pass.
  73234. * @param camera The camera to apply the render pass to.
  73235. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73236. * @param engine The engine which the post process will be applied. (default: current engine)
  73237. * @param reusable If the post process can be reused on the same frame. (default: false)
  73238. */
  73239. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73240. /** @hidden */
  73241. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73242. }
  73243. }
  73244. declare module "babylonjs/Shaders/filter.fragment" {
  73245. /** @hidden */
  73246. export var filterPixelShader: {
  73247. name: string;
  73248. shader: string;
  73249. };
  73250. }
  73251. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73252. import { Nullable } from "babylonjs/types";
  73253. import { Matrix } from "babylonjs/Maths/math.vector";
  73254. import { Camera } from "babylonjs/Cameras/camera";
  73255. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73256. import { Engine } from "babylonjs/Engines/engine";
  73257. import "babylonjs/Shaders/filter.fragment";
  73258. import { Scene } from "babylonjs/scene";
  73259. /**
  73260. * Applies a kernel filter to the image
  73261. */
  73262. export class FilterPostProcess extends PostProcess {
  73263. /** The matrix to be applied to the image */
  73264. kernelMatrix: Matrix;
  73265. /**
  73266. * Gets a string identifying the name of the class
  73267. * @returns "FilterPostProcess" string
  73268. */
  73269. getClassName(): string;
  73270. /**
  73271. *
  73272. * @param name The name of the effect.
  73273. * @param kernelMatrix The matrix to be applied to the image
  73274. * @param options The required width/height ratio to downsize to before computing the render pass.
  73275. * @param camera The camera to apply the render pass to.
  73276. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73277. * @param engine The engine which the post process will be applied. (default: current engine)
  73278. * @param reusable If the post process can be reused on the same frame. (default: false)
  73279. */
  73280. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73281. /** @hidden */
  73282. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73283. }
  73284. }
  73285. declare module "babylonjs/Shaders/fxaa.fragment" {
  73286. /** @hidden */
  73287. export var fxaaPixelShader: {
  73288. name: string;
  73289. shader: string;
  73290. };
  73291. }
  73292. declare module "babylonjs/Shaders/fxaa.vertex" {
  73293. /** @hidden */
  73294. export var fxaaVertexShader: {
  73295. name: string;
  73296. shader: string;
  73297. };
  73298. }
  73299. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73300. import { Nullable } from "babylonjs/types";
  73301. import { Camera } from "babylonjs/Cameras/camera";
  73302. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73303. import { Engine } from "babylonjs/Engines/engine";
  73304. import "babylonjs/Shaders/fxaa.fragment";
  73305. import "babylonjs/Shaders/fxaa.vertex";
  73306. import { Scene } from "babylonjs/scene";
  73307. /**
  73308. * Fxaa post process
  73309. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73310. */
  73311. export class FxaaPostProcess extends PostProcess {
  73312. /**
  73313. * Gets a string identifying the name of the class
  73314. * @returns "FxaaPostProcess" string
  73315. */
  73316. getClassName(): string;
  73317. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73318. private _getDefines;
  73319. /** @hidden */
  73320. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73321. }
  73322. }
  73323. declare module "babylonjs/Shaders/grain.fragment" {
  73324. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73325. /** @hidden */
  73326. export var grainPixelShader: {
  73327. name: string;
  73328. shader: string;
  73329. };
  73330. }
  73331. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73332. import { Nullable } from "babylonjs/types";
  73333. import { Camera } from "babylonjs/Cameras/camera";
  73334. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73335. import { Engine } from "babylonjs/Engines/engine";
  73336. import "babylonjs/Shaders/grain.fragment";
  73337. import { Scene } from "babylonjs/scene";
  73338. /**
  73339. * The GrainPostProcess adds noise to the image at mid luminance levels
  73340. */
  73341. export class GrainPostProcess extends PostProcess {
  73342. /**
  73343. * The intensity of the grain added (default: 30)
  73344. */
  73345. intensity: number;
  73346. /**
  73347. * If the grain should be randomized on every frame
  73348. */
  73349. animated: boolean;
  73350. /**
  73351. * Gets a string identifying the name of the class
  73352. * @returns "GrainPostProcess" string
  73353. */
  73354. getClassName(): string;
  73355. /**
  73356. * Creates a new instance of @see GrainPostProcess
  73357. * @param name The name of the effect.
  73358. * @param options The required width/height ratio to downsize to before computing the render pass.
  73359. * @param camera The camera to apply the render pass to.
  73360. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73361. * @param engine The engine which the post process will be applied. (default: current engine)
  73362. * @param reusable If the post process can be reused on the same frame. (default: false)
  73363. * @param textureType Type of textures used when performing the post process. (default: 0)
  73364. * @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)
  73365. */
  73366. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73367. /** @hidden */
  73368. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73369. }
  73370. }
  73371. declare module "babylonjs/Shaders/highlights.fragment" {
  73372. /** @hidden */
  73373. export var highlightsPixelShader: {
  73374. name: string;
  73375. shader: string;
  73376. };
  73377. }
  73378. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73379. import { Nullable } from "babylonjs/types";
  73380. import { Camera } from "babylonjs/Cameras/camera";
  73381. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73382. import { Engine } from "babylonjs/Engines/engine";
  73383. import "babylonjs/Shaders/highlights.fragment";
  73384. /**
  73385. * Extracts highlights from the image
  73386. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73387. */
  73388. export class HighlightsPostProcess extends PostProcess {
  73389. /**
  73390. * Gets a string identifying the name of the class
  73391. * @returns "HighlightsPostProcess" string
  73392. */
  73393. getClassName(): string;
  73394. /**
  73395. * Extracts highlights from the image
  73396. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73397. * @param name The name of the effect.
  73398. * @param options The required width/height ratio to downsize to before computing the render pass.
  73399. * @param camera The camera to apply the render pass to.
  73400. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73401. * @param engine The engine which the post process will be applied. (default: current engine)
  73402. * @param reusable If the post process can be reused on the same frame. (default: false)
  73403. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73404. */
  73405. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73406. }
  73407. }
  73408. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73409. /** @hidden */
  73410. export var mrtFragmentDeclaration: {
  73411. name: string;
  73412. shader: string;
  73413. };
  73414. }
  73415. declare module "babylonjs/Shaders/geometry.fragment" {
  73416. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73417. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73418. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73419. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73420. /** @hidden */
  73421. export var geometryPixelShader: {
  73422. name: string;
  73423. shader: string;
  73424. };
  73425. }
  73426. declare module "babylonjs/Shaders/geometry.vertex" {
  73427. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73428. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73429. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73430. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73431. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73432. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73433. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73434. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73435. /** @hidden */
  73436. export var geometryVertexShader: {
  73437. name: string;
  73438. shader: string;
  73439. };
  73440. }
  73441. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73442. import { Matrix } from "babylonjs/Maths/math.vector";
  73443. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73444. import { Mesh } from "babylonjs/Meshes/mesh";
  73445. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73446. import { Effect } from "babylonjs/Materials/effect";
  73447. import { Scene } from "babylonjs/scene";
  73448. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73449. import "babylonjs/Shaders/geometry.fragment";
  73450. import "babylonjs/Shaders/geometry.vertex";
  73451. /** @hidden */
  73452. interface ISavedTransformationMatrix {
  73453. world: Matrix;
  73454. viewProjection: Matrix;
  73455. }
  73456. /**
  73457. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73458. */
  73459. export class GeometryBufferRenderer {
  73460. /**
  73461. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73462. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73463. */
  73464. static readonly POSITION_TEXTURE_TYPE: number;
  73465. /**
  73466. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73467. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73468. */
  73469. static readonly VELOCITY_TEXTURE_TYPE: number;
  73470. /**
  73471. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73472. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73473. */
  73474. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73475. /**
  73476. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73477. * in order to compute objects velocities when enableVelocity is set to "true"
  73478. * @hidden
  73479. */
  73480. _previousTransformationMatrices: {
  73481. [index: number]: ISavedTransformationMatrix;
  73482. };
  73483. /**
  73484. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73485. * in order to compute objects velocities when enableVelocity is set to "true"
  73486. * @hidden
  73487. */
  73488. _previousBonesTransformationMatrices: {
  73489. [index: number]: Float32Array;
  73490. };
  73491. /**
  73492. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73493. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73494. */
  73495. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73496. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73497. renderTransparentMeshes: boolean;
  73498. private _scene;
  73499. private _resizeObserver;
  73500. private _multiRenderTarget;
  73501. private _ratio;
  73502. private _enablePosition;
  73503. private _enableVelocity;
  73504. private _enableReflectivity;
  73505. private _positionIndex;
  73506. private _velocityIndex;
  73507. private _reflectivityIndex;
  73508. protected _effect: Effect;
  73509. protected _cachedDefines: string;
  73510. /**
  73511. * Set the render list (meshes to be rendered) used in the G buffer.
  73512. */
  73513. set renderList(meshes: Mesh[]);
  73514. /**
  73515. * Gets wether or not G buffer are supported by the running hardware.
  73516. * This requires draw buffer supports
  73517. */
  73518. get isSupported(): boolean;
  73519. /**
  73520. * Returns the index of the given texture type in the G-Buffer textures array
  73521. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73522. * @returns the index of the given texture type in the G-Buffer textures array
  73523. */
  73524. getTextureIndex(textureType: number): number;
  73525. /**
  73526. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73527. */
  73528. get enablePosition(): boolean;
  73529. /**
  73530. * Sets whether or not objects positions are enabled for the G buffer.
  73531. */
  73532. set enablePosition(enable: boolean);
  73533. /**
  73534. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73535. */
  73536. get enableVelocity(): boolean;
  73537. /**
  73538. * Sets wether or not objects velocities are enabled for the G buffer.
  73539. */
  73540. set enableVelocity(enable: boolean);
  73541. /**
  73542. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73543. */
  73544. get enableReflectivity(): boolean;
  73545. /**
  73546. * Sets wether or not objects roughness are enabled for the G buffer.
  73547. */
  73548. set enableReflectivity(enable: boolean);
  73549. /**
  73550. * Gets the scene associated with the buffer.
  73551. */
  73552. get scene(): Scene;
  73553. /**
  73554. * Gets the ratio used by the buffer during its creation.
  73555. * How big is the buffer related to the main canvas.
  73556. */
  73557. get ratio(): number;
  73558. /** @hidden */
  73559. static _SceneComponentInitialization: (scene: Scene) => void;
  73560. /**
  73561. * Creates a new G Buffer for the scene
  73562. * @param scene The scene the buffer belongs to
  73563. * @param ratio How big is the buffer related to the main canvas.
  73564. */
  73565. constructor(scene: Scene, ratio?: number);
  73566. /**
  73567. * Checks wether everything is ready to render a submesh to the G buffer.
  73568. * @param subMesh the submesh to check readiness for
  73569. * @param useInstances is the mesh drawn using instance or not
  73570. * @returns true if ready otherwise false
  73571. */
  73572. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73573. /**
  73574. * Gets the current underlying G Buffer.
  73575. * @returns the buffer
  73576. */
  73577. getGBuffer(): MultiRenderTarget;
  73578. /**
  73579. * Gets the number of samples used to render the buffer (anti aliasing).
  73580. */
  73581. get samples(): number;
  73582. /**
  73583. * Sets the number of samples used to render the buffer (anti aliasing).
  73584. */
  73585. set samples(value: number);
  73586. /**
  73587. * Disposes the renderer and frees up associated resources.
  73588. */
  73589. dispose(): void;
  73590. protected _createRenderTargets(): void;
  73591. private _copyBonesTransformationMatrices;
  73592. }
  73593. }
  73594. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73595. import { Nullable } from "babylonjs/types";
  73596. import { Scene } from "babylonjs/scene";
  73597. import { ISceneComponent } from "babylonjs/sceneComponent";
  73598. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73599. module "babylonjs/scene" {
  73600. interface Scene {
  73601. /** @hidden (Backing field) */
  73602. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73603. /**
  73604. * Gets or Sets the current geometry buffer associated to the scene.
  73605. */
  73606. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73607. /**
  73608. * Enables a GeometryBufferRender and associates it with the scene
  73609. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73610. * @returns the GeometryBufferRenderer
  73611. */
  73612. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73613. /**
  73614. * Disables the GeometryBufferRender associated with the scene
  73615. */
  73616. disableGeometryBufferRenderer(): void;
  73617. }
  73618. }
  73619. /**
  73620. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73621. * in several rendering techniques.
  73622. */
  73623. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73624. /**
  73625. * The component name helpful to identify the component in the list of scene components.
  73626. */
  73627. readonly name: string;
  73628. /**
  73629. * The scene the component belongs to.
  73630. */
  73631. scene: Scene;
  73632. /**
  73633. * Creates a new instance of the component for the given scene
  73634. * @param scene Defines the scene to register the component in
  73635. */
  73636. constructor(scene: Scene);
  73637. /**
  73638. * Registers the component in a given scene
  73639. */
  73640. register(): void;
  73641. /**
  73642. * Rebuilds the elements related to this component in case of
  73643. * context lost for instance.
  73644. */
  73645. rebuild(): void;
  73646. /**
  73647. * Disposes the component and the associated ressources
  73648. */
  73649. dispose(): void;
  73650. private _gatherRenderTargets;
  73651. }
  73652. }
  73653. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73654. /** @hidden */
  73655. export var motionBlurPixelShader: {
  73656. name: string;
  73657. shader: string;
  73658. };
  73659. }
  73660. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73661. import { Nullable } from "babylonjs/types";
  73662. import { Camera } from "babylonjs/Cameras/camera";
  73663. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73664. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73665. import "babylonjs/Animations/animatable";
  73666. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73667. import "babylonjs/Shaders/motionBlur.fragment";
  73668. import { Engine } from "babylonjs/Engines/engine";
  73669. import { Scene } from "babylonjs/scene";
  73670. /**
  73671. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73672. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73673. * As an example, all you have to do is to create the post-process:
  73674. * var mb = new BABYLON.MotionBlurPostProcess(
  73675. * 'mb', // The name of the effect.
  73676. * scene, // The scene containing the objects to blur according to their velocity.
  73677. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73678. * camera // The camera to apply the render pass to.
  73679. * );
  73680. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73681. */
  73682. export class MotionBlurPostProcess extends PostProcess {
  73683. /**
  73684. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73685. */
  73686. motionStrength: number;
  73687. /**
  73688. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73689. */
  73690. get motionBlurSamples(): number;
  73691. /**
  73692. * Sets the number of iterations to be used for motion blur quality
  73693. */
  73694. set motionBlurSamples(samples: number);
  73695. private _motionBlurSamples;
  73696. private _geometryBufferRenderer;
  73697. /**
  73698. * Gets a string identifying the name of the class
  73699. * @returns "MotionBlurPostProcess" string
  73700. */
  73701. getClassName(): string;
  73702. /**
  73703. * Creates a new instance MotionBlurPostProcess
  73704. * @param name The name of the effect.
  73705. * @param scene The scene containing the objects to blur according to their velocity.
  73706. * @param options The required width/height ratio to downsize to before computing the render pass.
  73707. * @param camera The camera to apply the render pass to.
  73708. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73709. * @param engine The engine which the post process will be applied. (default: current engine)
  73710. * @param reusable If the post process can be reused on the same frame. (default: false)
  73711. * @param textureType Type of textures used when performing the post process. (default: 0)
  73712. * @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)
  73713. */
  73714. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73715. /**
  73716. * Excludes the given skinned mesh from computing bones velocities.
  73717. * 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.
  73718. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73719. */
  73720. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73721. /**
  73722. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73723. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73724. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73725. */
  73726. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73727. /**
  73728. * Disposes the post process.
  73729. * @param camera The camera to dispose the post process on.
  73730. */
  73731. dispose(camera?: Camera): void;
  73732. /** @hidden */
  73733. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73734. }
  73735. }
  73736. declare module "babylonjs/Shaders/refraction.fragment" {
  73737. /** @hidden */
  73738. export var refractionPixelShader: {
  73739. name: string;
  73740. shader: string;
  73741. };
  73742. }
  73743. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73744. import { Color3 } from "babylonjs/Maths/math.color";
  73745. import { Camera } from "babylonjs/Cameras/camera";
  73746. import { Texture } from "babylonjs/Materials/Textures/texture";
  73747. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73748. import { Engine } from "babylonjs/Engines/engine";
  73749. import "babylonjs/Shaders/refraction.fragment";
  73750. import { Scene } from "babylonjs/scene";
  73751. /**
  73752. * Post process which applies a refractin texture
  73753. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73754. */
  73755. export class RefractionPostProcess extends PostProcess {
  73756. private _refTexture;
  73757. private _ownRefractionTexture;
  73758. /** the base color of the refraction (used to taint the rendering) */
  73759. color: Color3;
  73760. /** simulated refraction depth */
  73761. depth: number;
  73762. /** the coefficient of the base color (0 to remove base color tainting) */
  73763. colorLevel: number;
  73764. /** Gets the url used to load the refraction texture */
  73765. refractionTextureUrl: string;
  73766. /**
  73767. * Gets or sets the refraction texture
  73768. * Please note that you are responsible for disposing the texture if you set it manually
  73769. */
  73770. get refractionTexture(): Texture;
  73771. set refractionTexture(value: Texture);
  73772. /**
  73773. * Gets a string identifying the name of the class
  73774. * @returns "RefractionPostProcess" string
  73775. */
  73776. getClassName(): string;
  73777. /**
  73778. * Initializes the RefractionPostProcess
  73779. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73780. * @param name The name of the effect.
  73781. * @param refractionTextureUrl Url of the refraction texture to use
  73782. * @param color the base color of the refraction (used to taint the rendering)
  73783. * @param depth simulated refraction depth
  73784. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73785. * @param camera The camera to apply the render pass to.
  73786. * @param options The required width/height ratio to downsize to before computing the render pass.
  73787. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73788. * @param engine The engine which the post process will be applied. (default: current engine)
  73789. * @param reusable If the post process can be reused on the same frame. (default: false)
  73790. */
  73791. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73792. /**
  73793. * Disposes of the post process
  73794. * @param camera Camera to dispose post process on
  73795. */
  73796. dispose(camera: Camera): void;
  73797. /** @hidden */
  73798. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73799. }
  73800. }
  73801. declare module "babylonjs/Shaders/sharpen.fragment" {
  73802. /** @hidden */
  73803. export var sharpenPixelShader: {
  73804. name: string;
  73805. shader: string;
  73806. };
  73807. }
  73808. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73809. import { Nullable } from "babylonjs/types";
  73810. import { Camera } from "babylonjs/Cameras/camera";
  73811. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73812. import "babylonjs/Shaders/sharpen.fragment";
  73813. import { Engine } from "babylonjs/Engines/engine";
  73814. import { Scene } from "babylonjs/scene";
  73815. /**
  73816. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73817. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73818. */
  73819. export class SharpenPostProcess extends PostProcess {
  73820. /**
  73821. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73822. */
  73823. colorAmount: number;
  73824. /**
  73825. * How much sharpness should be applied (default: 0.3)
  73826. */
  73827. edgeAmount: number;
  73828. /**
  73829. * Gets a string identifying the name of the class
  73830. * @returns "SharpenPostProcess" string
  73831. */
  73832. getClassName(): string;
  73833. /**
  73834. * Creates a new instance ConvolutionPostProcess
  73835. * @param name The name of the effect.
  73836. * @param options The required width/height ratio to downsize to before computing the render pass.
  73837. * @param camera The camera to apply the render pass to.
  73838. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73839. * @param engine The engine which the post process will be applied. (default: current engine)
  73840. * @param reusable If the post process can be reused on the same frame. (default: false)
  73841. * @param textureType Type of textures used when performing the post process. (default: 0)
  73842. * @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)
  73843. */
  73844. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73845. /** @hidden */
  73846. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73847. }
  73848. }
  73849. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73850. import { Nullable } from "babylonjs/types";
  73851. import { Camera } from "babylonjs/Cameras/camera";
  73852. import { Engine } from "babylonjs/Engines/engine";
  73853. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73854. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73855. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73856. /**
  73857. * PostProcessRenderPipeline
  73858. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73859. */
  73860. export class PostProcessRenderPipeline {
  73861. private engine;
  73862. private _renderEffects;
  73863. private _renderEffectsForIsolatedPass;
  73864. /**
  73865. * List of inspectable custom properties (used by the Inspector)
  73866. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73867. */
  73868. inspectableCustomProperties: IInspectable[];
  73869. /**
  73870. * @hidden
  73871. */
  73872. protected _cameras: Camera[];
  73873. /** @hidden */
  73874. _name: string;
  73875. /**
  73876. * Gets pipeline name
  73877. */
  73878. get name(): string;
  73879. /** Gets the list of attached cameras */
  73880. get cameras(): Camera[];
  73881. /**
  73882. * Initializes a PostProcessRenderPipeline
  73883. * @param engine engine to add the pipeline to
  73884. * @param name name of the pipeline
  73885. */
  73886. constructor(engine: Engine, name: string);
  73887. /**
  73888. * Gets the class name
  73889. * @returns "PostProcessRenderPipeline"
  73890. */
  73891. getClassName(): string;
  73892. /**
  73893. * If all the render effects in the pipeline are supported
  73894. */
  73895. get isSupported(): boolean;
  73896. /**
  73897. * Adds an effect to the pipeline
  73898. * @param renderEffect the effect to add
  73899. */
  73900. addEffect(renderEffect: PostProcessRenderEffect): void;
  73901. /** @hidden */
  73902. _rebuild(): void;
  73903. /** @hidden */
  73904. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73905. /** @hidden */
  73906. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73907. /** @hidden */
  73908. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73909. /** @hidden */
  73910. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73911. /** @hidden */
  73912. _attachCameras(cameras: Camera, unique: boolean): void;
  73913. /** @hidden */
  73914. _attachCameras(cameras: Camera[], unique: boolean): void;
  73915. /** @hidden */
  73916. _detachCameras(cameras: Camera): void;
  73917. /** @hidden */
  73918. _detachCameras(cameras: Nullable<Camera[]>): void;
  73919. /** @hidden */
  73920. _update(): void;
  73921. /** @hidden */
  73922. _reset(): void;
  73923. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73924. /**
  73925. * Sets the required values to the prepass renderer.
  73926. * @param prePassRenderer defines the prepass renderer to setup.
  73927. * @returns true if the pre pass is needed.
  73928. */
  73929. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73930. /**
  73931. * Disposes of the pipeline
  73932. */
  73933. dispose(): void;
  73934. }
  73935. }
  73936. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73937. import { Camera } from "babylonjs/Cameras/camera";
  73938. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73939. /**
  73940. * PostProcessRenderPipelineManager class
  73941. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73942. */
  73943. export class PostProcessRenderPipelineManager {
  73944. private _renderPipelines;
  73945. /**
  73946. * Initializes a PostProcessRenderPipelineManager
  73947. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73948. */
  73949. constructor();
  73950. /**
  73951. * Gets the list of supported render pipelines
  73952. */
  73953. get supportedPipelines(): PostProcessRenderPipeline[];
  73954. /**
  73955. * Adds a pipeline to the manager
  73956. * @param renderPipeline The pipeline to add
  73957. */
  73958. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73959. /**
  73960. * Attaches a camera to the pipeline
  73961. * @param renderPipelineName The name of the pipeline to attach to
  73962. * @param cameras the camera to attach
  73963. * @param unique if the camera can be attached multiple times to the pipeline
  73964. */
  73965. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73966. /**
  73967. * Detaches a camera from the pipeline
  73968. * @param renderPipelineName The name of the pipeline to detach from
  73969. * @param cameras the camera to detach
  73970. */
  73971. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73972. /**
  73973. * Enables an effect by name on a pipeline
  73974. * @param renderPipelineName the name of the pipeline to enable the effect in
  73975. * @param renderEffectName the name of the effect to enable
  73976. * @param cameras the cameras that the effect should be enabled on
  73977. */
  73978. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73979. /**
  73980. * Disables an effect by name on a pipeline
  73981. * @param renderPipelineName the name of the pipeline to disable the effect in
  73982. * @param renderEffectName the name of the effect to disable
  73983. * @param cameras the cameras that the effect should be disabled on
  73984. */
  73985. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73986. /**
  73987. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73988. */
  73989. update(): void;
  73990. /** @hidden */
  73991. _rebuild(): void;
  73992. /**
  73993. * Disposes of the manager and pipelines
  73994. */
  73995. dispose(): void;
  73996. }
  73997. }
  73998. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73999. import { ISceneComponent } from "babylonjs/sceneComponent";
  74000. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74001. import { Scene } from "babylonjs/scene";
  74002. module "babylonjs/scene" {
  74003. interface Scene {
  74004. /** @hidden (Backing field) */
  74005. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74006. /**
  74007. * Gets the postprocess render pipeline manager
  74008. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74009. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74010. */
  74011. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74012. }
  74013. }
  74014. /**
  74015. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74016. */
  74017. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74018. /**
  74019. * The component name helpfull to identify the component in the list of scene components.
  74020. */
  74021. readonly name: string;
  74022. /**
  74023. * The scene the component belongs to.
  74024. */
  74025. scene: Scene;
  74026. /**
  74027. * Creates a new instance of the component for the given scene
  74028. * @param scene Defines the scene to register the component in
  74029. */
  74030. constructor(scene: Scene);
  74031. /**
  74032. * Registers the component in a given scene
  74033. */
  74034. register(): void;
  74035. /**
  74036. * Rebuilds the elements related to this component in case of
  74037. * context lost for instance.
  74038. */
  74039. rebuild(): void;
  74040. /**
  74041. * Disposes the component and the associated ressources
  74042. */
  74043. dispose(): void;
  74044. private _gatherRenderTargets;
  74045. }
  74046. }
  74047. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74048. import { Nullable } from "babylonjs/types";
  74049. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74050. import { Camera } from "babylonjs/Cameras/camera";
  74051. import { IDisposable } from "babylonjs/scene";
  74052. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74053. import { Scene } from "babylonjs/scene";
  74054. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74055. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74056. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74057. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74058. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74059. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74060. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74061. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74062. import { Animation } from "babylonjs/Animations/animation";
  74063. /**
  74064. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74065. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74066. */
  74067. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74068. private _scene;
  74069. private _camerasToBeAttached;
  74070. /**
  74071. * ID of the sharpen post process,
  74072. */
  74073. private readonly SharpenPostProcessId;
  74074. /**
  74075. * @ignore
  74076. * ID of the image processing post process;
  74077. */
  74078. readonly ImageProcessingPostProcessId: string;
  74079. /**
  74080. * @ignore
  74081. * ID of the Fast Approximate Anti-Aliasing post process;
  74082. */
  74083. readonly FxaaPostProcessId: string;
  74084. /**
  74085. * ID of the chromatic aberration post process,
  74086. */
  74087. private readonly ChromaticAberrationPostProcessId;
  74088. /**
  74089. * ID of the grain post process
  74090. */
  74091. private readonly GrainPostProcessId;
  74092. /**
  74093. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74094. */
  74095. sharpen: SharpenPostProcess;
  74096. private _sharpenEffect;
  74097. private bloom;
  74098. /**
  74099. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74100. */
  74101. depthOfField: DepthOfFieldEffect;
  74102. /**
  74103. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74104. */
  74105. fxaa: FxaaPostProcess;
  74106. /**
  74107. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74108. */
  74109. imageProcessing: ImageProcessingPostProcess;
  74110. /**
  74111. * Chromatic aberration post process which will shift rgb colors in the image
  74112. */
  74113. chromaticAberration: ChromaticAberrationPostProcess;
  74114. private _chromaticAberrationEffect;
  74115. /**
  74116. * Grain post process which add noise to the image
  74117. */
  74118. grain: GrainPostProcess;
  74119. private _grainEffect;
  74120. /**
  74121. * Glow post process which adds a glow to emissive areas of the image
  74122. */
  74123. private _glowLayer;
  74124. /**
  74125. * Animations which can be used to tweak settings over a period of time
  74126. */
  74127. animations: Animation[];
  74128. private _imageProcessingConfigurationObserver;
  74129. private _sharpenEnabled;
  74130. private _bloomEnabled;
  74131. private _depthOfFieldEnabled;
  74132. private _depthOfFieldBlurLevel;
  74133. private _fxaaEnabled;
  74134. private _imageProcessingEnabled;
  74135. private _defaultPipelineTextureType;
  74136. private _bloomScale;
  74137. private _chromaticAberrationEnabled;
  74138. private _grainEnabled;
  74139. private _buildAllowed;
  74140. /**
  74141. * Gets active scene
  74142. */
  74143. get scene(): Scene;
  74144. /**
  74145. * Enable or disable the sharpen process from the pipeline
  74146. */
  74147. set sharpenEnabled(enabled: boolean);
  74148. get sharpenEnabled(): boolean;
  74149. private _resizeObserver;
  74150. private _hardwareScaleLevel;
  74151. private _bloomKernel;
  74152. /**
  74153. * Specifies the size of the bloom blur kernel, relative to the final output size
  74154. */
  74155. get bloomKernel(): number;
  74156. set bloomKernel(value: number);
  74157. /**
  74158. * Specifies the weight of the bloom in the final rendering
  74159. */
  74160. private _bloomWeight;
  74161. /**
  74162. * Specifies the luma threshold for the area that will be blurred by the bloom
  74163. */
  74164. private _bloomThreshold;
  74165. private _hdr;
  74166. /**
  74167. * The strength of the bloom.
  74168. */
  74169. set bloomWeight(value: number);
  74170. get bloomWeight(): number;
  74171. /**
  74172. * The strength of the bloom.
  74173. */
  74174. set bloomThreshold(value: number);
  74175. get bloomThreshold(): number;
  74176. /**
  74177. * The scale of the bloom, lower value will provide better performance.
  74178. */
  74179. set bloomScale(value: number);
  74180. get bloomScale(): number;
  74181. /**
  74182. * Enable or disable the bloom from the pipeline
  74183. */
  74184. set bloomEnabled(enabled: boolean);
  74185. get bloomEnabled(): boolean;
  74186. private _rebuildBloom;
  74187. /**
  74188. * If the depth of field is enabled.
  74189. */
  74190. get depthOfFieldEnabled(): boolean;
  74191. set depthOfFieldEnabled(enabled: boolean);
  74192. /**
  74193. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74194. */
  74195. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74196. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74197. /**
  74198. * If the anti aliasing is enabled.
  74199. */
  74200. set fxaaEnabled(enabled: boolean);
  74201. get fxaaEnabled(): boolean;
  74202. private _samples;
  74203. /**
  74204. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74205. */
  74206. set samples(sampleCount: number);
  74207. get samples(): number;
  74208. /**
  74209. * If image processing is enabled.
  74210. */
  74211. set imageProcessingEnabled(enabled: boolean);
  74212. get imageProcessingEnabled(): boolean;
  74213. /**
  74214. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74215. */
  74216. set glowLayerEnabled(enabled: boolean);
  74217. get glowLayerEnabled(): boolean;
  74218. /**
  74219. * Gets the glow layer (or null if not defined)
  74220. */
  74221. get glowLayer(): Nullable<GlowLayer>;
  74222. /**
  74223. * Enable or disable the chromaticAberration process from the pipeline
  74224. */
  74225. set chromaticAberrationEnabled(enabled: boolean);
  74226. get chromaticAberrationEnabled(): boolean;
  74227. /**
  74228. * Enable or disable the grain process from the pipeline
  74229. */
  74230. set grainEnabled(enabled: boolean);
  74231. get grainEnabled(): boolean;
  74232. /**
  74233. * @constructor
  74234. * @param name - The rendering pipeline name (default: "")
  74235. * @param hdr - If high dynamic range textures should be used (default: true)
  74236. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74237. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74238. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74239. */
  74240. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74241. /**
  74242. * Get the class name
  74243. * @returns "DefaultRenderingPipeline"
  74244. */
  74245. getClassName(): string;
  74246. /**
  74247. * Force the compilation of the entire pipeline.
  74248. */
  74249. prepare(): void;
  74250. private _hasCleared;
  74251. private _prevPostProcess;
  74252. private _prevPrevPostProcess;
  74253. private _setAutoClearAndTextureSharing;
  74254. private _depthOfFieldSceneObserver;
  74255. private _buildPipeline;
  74256. private _disposePostProcesses;
  74257. /**
  74258. * Adds a camera to the pipeline
  74259. * @param camera the camera to be added
  74260. */
  74261. addCamera(camera: Camera): void;
  74262. /**
  74263. * Removes a camera from the pipeline
  74264. * @param camera the camera to remove
  74265. */
  74266. removeCamera(camera: Camera): void;
  74267. /**
  74268. * Dispose of the pipeline and stop all post processes
  74269. */
  74270. dispose(): void;
  74271. /**
  74272. * Serialize the rendering pipeline (Used when exporting)
  74273. * @returns the serialized object
  74274. */
  74275. serialize(): any;
  74276. /**
  74277. * Parse the serialized pipeline
  74278. * @param source Source pipeline.
  74279. * @param scene The scene to load the pipeline to.
  74280. * @param rootUrl The URL of the serialized pipeline.
  74281. * @returns An instantiated pipeline from the serialized object.
  74282. */
  74283. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74284. }
  74285. }
  74286. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74287. /** @hidden */
  74288. export var lensHighlightsPixelShader: {
  74289. name: string;
  74290. shader: string;
  74291. };
  74292. }
  74293. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74294. /** @hidden */
  74295. export var depthOfFieldPixelShader: {
  74296. name: string;
  74297. shader: string;
  74298. };
  74299. }
  74300. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74301. import { Camera } from "babylonjs/Cameras/camera";
  74302. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74303. import { Scene } from "babylonjs/scene";
  74304. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74305. import "babylonjs/Shaders/chromaticAberration.fragment";
  74306. import "babylonjs/Shaders/lensHighlights.fragment";
  74307. import "babylonjs/Shaders/depthOfField.fragment";
  74308. /**
  74309. * BABYLON.JS Chromatic Aberration GLSL Shader
  74310. * Author: Olivier Guyot
  74311. * Separates very slightly R, G and B colors on the edges of the screen
  74312. * Inspired by Francois Tarlier & Martins Upitis
  74313. */
  74314. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74315. /**
  74316. * @ignore
  74317. * The chromatic aberration PostProcess id in the pipeline
  74318. */
  74319. LensChromaticAberrationEffect: string;
  74320. /**
  74321. * @ignore
  74322. * The highlights enhancing PostProcess id in the pipeline
  74323. */
  74324. HighlightsEnhancingEffect: string;
  74325. /**
  74326. * @ignore
  74327. * The depth-of-field PostProcess id in the pipeline
  74328. */
  74329. LensDepthOfFieldEffect: string;
  74330. private _scene;
  74331. private _depthTexture;
  74332. private _grainTexture;
  74333. private _chromaticAberrationPostProcess;
  74334. private _highlightsPostProcess;
  74335. private _depthOfFieldPostProcess;
  74336. private _edgeBlur;
  74337. private _grainAmount;
  74338. private _chromaticAberration;
  74339. private _distortion;
  74340. private _highlightsGain;
  74341. private _highlightsThreshold;
  74342. private _dofDistance;
  74343. private _dofAperture;
  74344. private _dofDarken;
  74345. private _dofPentagon;
  74346. private _blurNoise;
  74347. /**
  74348. * @constructor
  74349. *
  74350. * Effect parameters are as follow:
  74351. * {
  74352. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74353. * edge_blur: number; // from 0 to x (1 for realism)
  74354. * distortion: number; // from 0 to x (1 for realism)
  74355. * grain_amount: number; // from 0 to 1
  74356. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74357. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74358. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74359. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74360. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74361. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74362. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74363. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74364. * }
  74365. * Note: if an effect parameter is unset, effect is disabled
  74366. *
  74367. * @param name The rendering pipeline name
  74368. * @param parameters - An object containing all parameters (see above)
  74369. * @param scene The scene linked to this pipeline
  74370. * @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)
  74371. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74372. */
  74373. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74374. /**
  74375. * Get the class name
  74376. * @returns "LensRenderingPipeline"
  74377. */
  74378. getClassName(): string;
  74379. /**
  74380. * Gets associated scene
  74381. */
  74382. get scene(): Scene;
  74383. /**
  74384. * Gets or sets the edge blur
  74385. */
  74386. get edgeBlur(): number;
  74387. set edgeBlur(value: number);
  74388. /**
  74389. * Gets or sets the grain amount
  74390. */
  74391. get grainAmount(): number;
  74392. set grainAmount(value: number);
  74393. /**
  74394. * Gets or sets the chromatic aberration amount
  74395. */
  74396. get chromaticAberration(): number;
  74397. set chromaticAberration(value: number);
  74398. /**
  74399. * Gets or sets the depth of field aperture
  74400. */
  74401. get dofAperture(): number;
  74402. set dofAperture(value: number);
  74403. /**
  74404. * Gets or sets the edge distortion
  74405. */
  74406. get edgeDistortion(): number;
  74407. set edgeDistortion(value: number);
  74408. /**
  74409. * Gets or sets the depth of field distortion
  74410. */
  74411. get dofDistortion(): number;
  74412. set dofDistortion(value: number);
  74413. /**
  74414. * Gets or sets the darken out of focus amount
  74415. */
  74416. get darkenOutOfFocus(): number;
  74417. set darkenOutOfFocus(value: number);
  74418. /**
  74419. * Gets or sets a boolean indicating if blur noise is enabled
  74420. */
  74421. get blurNoise(): boolean;
  74422. set blurNoise(value: boolean);
  74423. /**
  74424. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74425. */
  74426. get pentagonBokeh(): boolean;
  74427. set pentagonBokeh(value: boolean);
  74428. /**
  74429. * Gets or sets the highlight grain amount
  74430. */
  74431. get highlightsGain(): number;
  74432. set highlightsGain(value: number);
  74433. /**
  74434. * Gets or sets the highlight threshold
  74435. */
  74436. get highlightsThreshold(): number;
  74437. set highlightsThreshold(value: number);
  74438. /**
  74439. * Sets the amount of blur at the edges
  74440. * @param amount blur amount
  74441. */
  74442. setEdgeBlur(amount: number): void;
  74443. /**
  74444. * Sets edge blur to 0
  74445. */
  74446. disableEdgeBlur(): void;
  74447. /**
  74448. * Sets the amout of grain
  74449. * @param amount Amount of grain
  74450. */
  74451. setGrainAmount(amount: number): void;
  74452. /**
  74453. * Set grain amount to 0
  74454. */
  74455. disableGrain(): void;
  74456. /**
  74457. * Sets the chromatic aberration amount
  74458. * @param amount amount of chromatic aberration
  74459. */
  74460. setChromaticAberration(amount: number): void;
  74461. /**
  74462. * Sets chromatic aberration amount to 0
  74463. */
  74464. disableChromaticAberration(): void;
  74465. /**
  74466. * Sets the EdgeDistortion amount
  74467. * @param amount amount of EdgeDistortion
  74468. */
  74469. setEdgeDistortion(amount: number): void;
  74470. /**
  74471. * Sets edge distortion to 0
  74472. */
  74473. disableEdgeDistortion(): void;
  74474. /**
  74475. * Sets the FocusDistance amount
  74476. * @param amount amount of FocusDistance
  74477. */
  74478. setFocusDistance(amount: number): void;
  74479. /**
  74480. * Disables depth of field
  74481. */
  74482. disableDepthOfField(): void;
  74483. /**
  74484. * Sets the Aperture amount
  74485. * @param amount amount of Aperture
  74486. */
  74487. setAperture(amount: number): void;
  74488. /**
  74489. * Sets the DarkenOutOfFocus amount
  74490. * @param amount amount of DarkenOutOfFocus
  74491. */
  74492. setDarkenOutOfFocus(amount: number): void;
  74493. private _pentagonBokehIsEnabled;
  74494. /**
  74495. * Creates a pentagon bokeh effect
  74496. */
  74497. enablePentagonBokeh(): void;
  74498. /**
  74499. * Disables the pentagon bokeh effect
  74500. */
  74501. disablePentagonBokeh(): void;
  74502. /**
  74503. * Enables noise blur
  74504. */
  74505. enableNoiseBlur(): void;
  74506. /**
  74507. * Disables noise blur
  74508. */
  74509. disableNoiseBlur(): void;
  74510. /**
  74511. * Sets the HighlightsGain amount
  74512. * @param amount amount of HighlightsGain
  74513. */
  74514. setHighlightsGain(amount: number): void;
  74515. /**
  74516. * Sets the HighlightsThreshold amount
  74517. * @param amount amount of HighlightsThreshold
  74518. */
  74519. setHighlightsThreshold(amount: number): void;
  74520. /**
  74521. * Disables highlights
  74522. */
  74523. disableHighlights(): void;
  74524. /**
  74525. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74526. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74527. */
  74528. dispose(disableDepthRender?: boolean): void;
  74529. private _createChromaticAberrationPostProcess;
  74530. private _createHighlightsPostProcess;
  74531. private _createDepthOfFieldPostProcess;
  74532. private _createGrainTexture;
  74533. }
  74534. }
  74535. declare module "babylonjs/Shaders/ssao2.fragment" {
  74536. /** @hidden */
  74537. export var ssao2PixelShader: {
  74538. name: string;
  74539. shader: string;
  74540. };
  74541. }
  74542. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74543. /** @hidden */
  74544. export var ssaoCombinePixelShader: {
  74545. name: string;
  74546. shader: string;
  74547. };
  74548. }
  74549. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74550. import { Camera } from "babylonjs/Cameras/camera";
  74551. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74552. import { Scene } from "babylonjs/scene";
  74553. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74554. import "babylonjs/Shaders/ssao2.fragment";
  74555. import "babylonjs/Shaders/ssaoCombine.fragment";
  74556. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74557. /**
  74558. * Render pipeline to produce ssao effect
  74559. */
  74560. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74561. /**
  74562. * @ignore
  74563. * The PassPostProcess id in the pipeline that contains the original scene color
  74564. */
  74565. SSAOOriginalSceneColorEffect: string;
  74566. /**
  74567. * @ignore
  74568. * The SSAO PostProcess id in the pipeline
  74569. */
  74570. SSAORenderEffect: string;
  74571. /**
  74572. * @ignore
  74573. * The horizontal blur PostProcess id in the pipeline
  74574. */
  74575. SSAOBlurHRenderEffect: string;
  74576. /**
  74577. * @ignore
  74578. * The vertical blur PostProcess id in the pipeline
  74579. */
  74580. SSAOBlurVRenderEffect: string;
  74581. /**
  74582. * @ignore
  74583. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74584. */
  74585. SSAOCombineRenderEffect: string;
  74586. /**
  74587. * The output strength of the SSAO post-process. Default value is 1.0.
  74588. */
  74589. totalStrength: number;
  74590. /**
  74591. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74592. */
  74593. maxZ: number;
  74594. /**
  74595. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74596. */
  74597. minZAspect: number;
  74598. private _samples;
  74599. /**
  74600. * Number of samples used for the SSAO calculations. Default value is 8
  74601. */
  74602. set samples(n: number);
  74603. get samples(): number;
  74604. private _textureSamples;
  74605. /**
  74606. * Number of samples to use for antialiasing
  74607. */
  74608. set textureSamples(n: number);
  74609. get textureSamples(): number;
  74610. /**
  74611. * Force rendering the geometry through geometry buffer
  74612. */
  74613. private _forceGeometryBuffer;
  74614. /**
  74615. * Ratio object used for SSAO ratio and blur ratio
  74616. */
  74617. private _ratio;
  74618. /**
  74619. * Dynamically generated sphere sampler.
  74620. */
  74621. private _sampleSphere;
  74622. /**
  74623. * Blur filter offsets
  74624. */
  74625. private _samplerOffsets;
  74626. private _expensiveBlur;
  74627. /**
  74628. * If bilateral blur should be used
  74629. */
  74630. set expensiveBlur(b: boolean);
  74631. get expensiveBlur(): boolean;
  74632. /**
  74633. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74634. */
  74635. radius: number;
  74636. /**
  74637. * The base color of the SSAO post-process
  74638. * The final result is "base + ssao" between [0, 1]
  74639. */
  74640. base: number;
  74641. /**
  74642. * Support test.
  74643. */
  74644. static get IsSupported(): boolean;
  74645. private _scene;
  74646. private _randomTexture;
  74647. private _originalColorPostProcess;
  74648. private _ssaoPostProcess;
  74649. private _blurHPostProcess;
  74650. private _blurVPostProcess;
  74651. private _ssaoCombinePostProcess;
  74652. private _prePassRenderer;
  74653. /**
  74654. * Gets active scene
  74655. */
  74656. get scene(): Scene;
  74657. /**
  74658. * @constructor
  74659. * @param name The rendering pipeline name
  74660. * @param scene The scene linked to this pipeline
  74661. * @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 }
  74662. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74663. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74664. */
  74665. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74666. /**
  74667. * Get the class name
  74668. * @returns "SSAO2RenderingPipeline"
  74669. */
  74670. getClassName(): string;
  74671. /**
  74672. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74673. */
  74674. dispose(disableGeometryBufferRenderer?: boolean): void;
  74675. private _createBlurPostProcess;
  74676. /** @hidden */
  74677. _rebuild(): void;
  74678. private _bits;
  74679. private _radicalInverse_VdC;
  74680. private _hammersley;
  74681. private _hemisphereSample_uniform;
  74682. private _generateHemisphere;
  74683. private _getDefinesForSSAO;
  74684. private _createSSAOPostProcess;
  74685. private _createSSAOCombinePostProcess;
  74686. private _createRandomTexture;
  74687. /**
  74688. * Serialize the rendering pipeline (Used when exporting)
  74689. * @returns the serialized object
  74690. */
  74691. serialize(): any;
  74692. /**
  74693. * Parse the serialized pipeline
  74694. * @param source Source pipeline.
  74695. * @param scene The scene to load the pipeline to.
  74696. * @param rootUrl The URL of the serialized pipeline.
  74697. * @returns An instantiated pipeline from the serialized object.
  74698. */
  74699. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74700. /**
  74701. * Sets the required values to the prepass renderer.
  74702. * @param prePassRenderer defines the prepass renderer to setup
  74703. * @returns true if the pre pass is needed.
  74704. */
  74705. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74706. }
  74707. }
  74708. declare module "babylonjs/Shaders/ssao.fragment" {
  74709. /** @hidden */
  74710. export var ssaoPixelShader: {
  74711. name: string;
  74712. shader: string;
  74713. };
  74714. }
  74715. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74716. import { Camera } from "babylonjs/Cameras/camera";
  74717. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74718. import { Scene } from "babylonjs/scene";
  74719. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74720. import "babylonjs/Shaders/ssao.fragment";
  74721. import "babylonjs/Shaders/ssaoCombine.fragment";
  74722. /**
  74723. * Render pipeline to produce ssao effect
  74724. */
  74725. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74726. /**
  74727. * @ignore
  74728. * The PassPostProcess id in the pipeline that contains the original scene color
  74729. */
  74730. SSAOOriginalSceneColorEffect: string;
  74731. /**
  74732. * @ignore
  74733. * The SSAO PostProcess id in the pipeline
  74734. */
  74735. SSAORenderEffect: string;
  74736. /**
  74737. * @ignore
  74738. * The horizontal blur PostProcess id in the pipeline
  74739. */
  74740. SSAOBlurHRenderEffect: string;
  74741. /**
  74742. * @ignore
  74743. * The vertical blur PostProcess id in the pipeline
  74744. */
  74745. SSAOBlurVRenderEffect: string;
  74746. /**
  74747. * @ignore
  74748. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74749. */
  74750. SSAOCombineRenderEffect: string;
  74751. /**
  74752. * The output strength of the SSAO post-process. Default value is 1.0.
  74753. */
  74754. totalStrength: number;
  74755. /**
  74756. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74757. */
  74758. radius: number;
  74759. /**
  74760. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74761. * Must not be equal to fallOff and superior to fallOff.
  74762. * Default value is 0.0075
  74763. */
  74764. area: number;
  74765. /**
  74766. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74767. * Must not be equal to area and inferior to area.
  74768. * Default value is 0.000001
  74769. */
  74770. fallOff: number;
  74771. /**
  74772. * The base color of the SSAO post-process
  74773. * The final result is "base + ssao" between [0, 1]
  74774. */
  74775. base: number;
  74776. private _scene;
  74777. private _depthTexture;
  74778. private _randomTexture;
  74779. private _originalColorPostProcess;
  74780. private _ssaoPostProcess;
  74781. private _blurHPostProcess;
  74782. private _blurVPostProcess;
  74783. private _ssaoCombinePostProcess;
  74784. private _firstUpdate;
  74785. /**
  74786. * Gets active scene
  74787. */
  74788. get scene(): Scene;
  74789. /**
  74790. * @constructor
  74791. * @param name - The rendering pipeline name
  74792. * @param scene - The scene linked to this pipeline
  74793. * @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 }
  74794. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74795. */
  74796. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74797. /**
  74798. * Get the class name
  74799. * @returns "SSAORenderingPipeline"
  74800. */
  74801. getClassName(): string;
  74802. /**
  74803. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74804. */
  74805. dispose(disableDepthRender?: boolean): void;
  74806. private _createBlurPostProcess;
  74807. /** @hidden */
  74808. _rebuild(): void;
  74809. private _createSSAOPostProcess;
  74810. private _createSSAOCombinePostProcess;
  74811. private _createRandomTexture;
  74812. }
  74813. }
  74814. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74815. /** @hidden */
  74816. export var screenSpaceReflectionPixelShader: {
  74817. name: string;
  74818. shader: string;
  74819. };
  74820. }
  74821. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74822. import { Nullable } from "babylonjs/types";
  74823. import { Camera } from "babylonjs/Cameras/camera";
  74824. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74825. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74826. import { Engine } from "babylonjs/Engines/engine";
  74827. import { Scene } from "babylonjs/scene";
  74828. /**
  74829. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74830. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74831. */
  74832. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74833. /**
  74834. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74835. */
  74836. threshold: number;
  74837. /**
  74838. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74839. */
  74840. strength: number;
  74841. /**
  74842. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74843. */
  74844. reflectionSpecularFalloffExponent: number;
  74845. /**
  74846. * 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]
  74847. */
  74848. step: number;
  74849. /**
  74850. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74851. */
  74852. roughnessFactor: number;
  74853. private _geometryBufferRenderer;
  74854. private _enableSmoothReflections;
  74855. private _reflectionSamples;
  74856. private _smoothSteps;
  74857. /**
  74858. * Gets a string identifying the name of the class
  74859. * @returns "ScreenSpaceReflectionPostProcess" string
  74860. */
  74861. getClassName(): string;
  74862. /**
  74863. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74864. * @param name The name of the effect.
  74865. * @param scene The scene containing the objects to calculate reflections.
  74866. * @param options The required width/height ratio to downsize to before computing the render pass.
  74867. * @param camera The camera to apply the render pass to.
  74868. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74869. * @param engine The engine which the post process will be applied. (default: current engine)
  74870. * @param reusable If the post process can be reused on the same frame. (default: false)
  74871. * @param textureType Type of textures used when performing the post process. (default: 0)
  74872. * @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)
  74873. */
  74874. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74875. /**
  74876. * Gets wether or not smoothing reflections is enabled.
  74877. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74878. */
  74879. get enableSmoothReflections(): boolean;
  74880. /**
  74881. * Sets wether or not smoothing reflections is enabled.
  74882. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74883. */
  74884. set enableSmoothReflections(enabled: boolean);
  74885. /**
  74886. * Gets the number of samples taken while computing reflections. More samples count is high,
  74887. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74888. */
  74889. get reflectionSamples(): number;
  74890. /**
  74891. * Sets the number of samples taken while computing reflections. More samples count is high,
  74892. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74893. */
  74894. set reflectionSamples(samples: number);
  74895. /**
  74896. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74897. * more the post-process will require GPU power and can generate a drop in FPS.
  74898. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74899. */
  74900. get smoothSteps(): number;
  74901. set smoothSteps(steps: number);
  74902. private _updateEffectDefines;
  74903. /** @hidden */
  74904. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74905. }
  74906. }
  74907. declare module "babylonjs/Shaders/standard.fragment" {
  74908. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74909. /** @hidden */
  74910. export var standardPixelShader: {
  74911. name: string;
  74912. shader: string;
  74913. };
  74914. }
  74915. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74916. import { Nullable } from "babylonjs/types";
  74917. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74918. import { Camera } from "babylonjs/Cameras/camera";
  74919. import { Texture } from "babylonjs/Materials/Textures/texture";
  74920. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74921. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74922. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74923. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74924. import { IDisposable } from "babylonjs/scene";
  74925. import { SpotLight } from "babylonjs/Lights/spotLight";
  74926. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74927. import { Scene } from "babylonjs/scene";
  74928. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74929. import { Animation } from "babylonjs/Animations/animation";
  74930. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74931. import "babylonjs/Shaders/standard.fragment";
  74932. /**
  74933. * Standard rendering pipeline
  74934. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74935. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74936. */
  74937. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74938. /**
  74939. * Public members
  74940. */
  74941. /**
  74942. * Post-process which contains the original scene color before the pipeline applies all the effects
  74943. */
  74944. originalPostProcess: Nullable<PostProcess>;
  74945. /**
  74946. * Post-process used to down scale an image x4
  74947. */
  74948. downSampleX4PostProcess: Nullable<PostProcess>;
  74949. /**
  74950. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74951. */
  74952. brightPassPostProcess: Nullable<PostProcess>;
  74953. /**
  74954. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74955. */
  74956. blurHPostProcesses: PostProcess[];
  74957. /**
  74958. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74959. */
  74960. blurVPostProcesses: PostProcess[];
  74961. /**
  74962. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74963. */
  74964. textureAdderPostProcess: Nullable<PostProcess>;
  74965. /**
  74966. * Post-process used to create volumetric lighting effect
  74967. */
  74968. volumetricLightPostProcess: Nullable<PostProcess>;
  74969. /**
  74970. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74971. */
  74972. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74973. /**
  74974. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74975. */
  74976. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74977. /**
  74978. * Post-process used to merge the volumetric light effect and the real scene color
  74979. */
  74980. volumetricLightMergePostProces: Nullable<PostProcess>;
  74981. /**
  74982. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74983. */
  74984. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74985. /**
  74986. * Base post-process used to calculate the average luminance of the final image for HDR
  74987. */
  74988. luminancePostProcess: Nullable<PostProcess>;
  74989. /**
  74990. * Post-processes used to create down sample post-processes in order to get
  74991. * the average luminance of the final image for HDR
  74992. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74993. */
  74994. luminanceDownSamplePostProcesses: PostProcess[];
  74995. /**
  74996. * Post-process used to create a HDR effect (light adaptation)
  74997. */
  74998. hdrPostProcess: Nullable<PostProcess>;
  74999. /**
  75000. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  75001. */
  75002. textureAdderFinalPostProcess: Nullable<PostProcess>;
  75003. /**
  75004. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75005. */
  75006. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75007. /**
  75008. * Post-process used to merge the final HDR post-process and the real scene color
  75009. */
  75010. hdrFinalPostProcess: Nullable<PostProcess>;
  75011. /**
  75012. * Post-process used to create a lens flare effect
  75013. */
  75014. lensFlarePostProcess: Nullable<PostProcess>;
  75015. /**
  75016. * Post-process that merges the result of the lens flare post-process and the real scene color
  75017. */
  75018. lensFlareComposePostProcess: Nullable<PostProcess>;
  75019. /**
  75020. * Post-process used to create a motion blur effect
  75021. */
  75022. motionBlurPostProcess: Nullable<PostProcess>;
  75023. /**
  75024. * Post-process used to create a depth of field effect
  75025. */
  75026. depthOfFieldPostProcess: Nullable<PostProcess>;
  75027. /**
  75028. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75029. */
  75030. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75031. /**
  75032. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75033. */
  75034. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75035. /**
  75036. * Represents the brightness threshold in order to configure the illuminated surfaces
  75037. */
  75038. brightThreshold: number;
  75039. /**
  75040. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75041. */
  75042. blurWidth: number;
  75043. /**
  75044. * Sets if the blur for highlighted surfaces must be only horizontal
  75045. */
  75046. horizontalBlur: boolean;
  75047. /**
  75048. * Gets the overall exposure used by the pipeline
  75049. */
  75050. get exposure(): number;
  75051. /**
  75052. * Sets the overall exposure used by the pipeline
  75053. */
  75054. set exposure(value: number);
  75055. /**
  75056. * Texture used typically to simulate "dirty" on camera lens
  75057. */
  75058. lensTexture: Nullable<Texture>;
  75059. /**
  75060. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75061. */
  75062. volumetricLightCoefficient: number;
  75063. /**
  75064. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75065. */
  75066. volumetricLightPower: number;
  75067. /**
  75068. * Used the set the blur intensity to smooth the volumetric lights
  75069. */
  75070. volumetricLightBlurScale: number;
  75071. /**
  75072. * Light (spot or directional) used to generate the volumetric lights rays
  75073. * The source light must have a shadow generate so the pipeline can get its
  75074. * depth map
  75075. */
  75076. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75077. /**
  75078. * For eye adaptation, represents the minimum luminance the eye can see
  75079. */
  75080. hdrMinimumLuminance: number;
  75081. /**
  75082. * For eye adaptation, represents the decrease luminance speed
  75083. */
  75084. hdrDecreaseRate: number;
  75085. /**
  75086. * For eye adaptation, represents the increase luminance speed
  75087. */
  75088. hdrIncreaseRate: number;
  75089. /**
  75090. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75091. */
  75092. get hdrAutoExposure(): boolean;
  75093. /**
  75094. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75095. */
  75096. set hdrAutoExposure(value: boolean);
  75097. /**
  75098. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75099. */
  75100. lensColorTexture: Nullable<Texture>;
  75101. /**
  75102. * The overall strengh for the lens flare effect
  75103. */
  75104. lensFlareStrength: number;
  75105. /**
  75106. * Dispersion coefficient for lens flare ghosts
  75107. */
  75108. lensFlareGhostDispersal: number;
  75109. /**
  75110. * Main lens flare halo width
  75111. */
  75112. lensFlareHaloWidth: number;
  75113. /**
  75114. * Based on the lens distortion effect, defines how much the lens flare result
  75115. * is distorted
  75116. */
  75117. lensFlareDistortionStrength: number;
  75118. /**
  75119. * Configures the blur intensity used for for lens flare (halo)
  75120. */
  75121. lensFlareBlurWidth: number;
  75122. /**
  75123. * Lens star texture must be used to simulate rays on the flares and is available
  75124. * in the documentation
  75125. */
  75126. lensStarTexture: Nullable<Texture>;
  75127. /**
  75128. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75129. * flare effect by taking account of the dirt texture
  75130. */
  75131. lensFlareDirtTexture: Nullable<Texture>;
  75132. /**
  75133. * Represents the focal length for the depth of field effect
  75134. */
  75135. depthOfFieldDistance: number;
  75136. /**
  75137. * Represents the blur intensity for the blurred part of the depth of field effect
  75138. */
  75139. depthOfFieldBlurWidth: number;
  75140. /**
  75141. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75142. */
  75143. get motionStrength(): number;
  75144. /**
  75145. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75146. */
  75147. set motionStrength(strength: number);
  75148. /**
  75149. * Gets wether or not the motion blur post-process is object based or screen based.
  75150. */
  75151. get objectBasedMotionBlur(): boolean;
  75152. /**
  75153. * Sets wether or not the motion blur post-process should be object based or screen based
  75154. */
  75155. set objectBasedMotionBlur(value: boolean);
  75156. /**
  75157. * List of animations for the pipeline (IAnimatable implementation)
  75158. */
  75159. animations: Animation[];
  75160. /**
  75161. * Private members
  75162. */
  75163. private _scene;
  75164. private _currentDepthOfFieldSource;
  75165. private _basePostProcess;
  75166. private _fixedExposure;
  75167. private _currentExposure;
  75168. private _hdrAutoExposure;
  75169. private _hdrCurrentLuminance;
  75170. private _motionStrength;
  75171. private _isObjectBasedMotionBlur;
  75172. private _floatTextureType;
  75173. private _camerasToBeAttached;
  75174. private _ratio;
  75175. private _bloomEnabled;
  75176. private _depthOfFieldEnabled;
  75177. private _vlsEnabled;
  75178. private _lensFlareEnabled;
  75179. private _hdrEnabled;
  75180. private _motionBlurEnabled;
  75181. private _fxaaEnabled;
  75182. private _screenSpaceReflectionsEnabled;
  75183. private _motionBlurSamples;
  75184. private _volumetricLightStepsCount;
  75185. private _samples;
  75186. /**
  75187. * @ignore
  75188. * Specifies if the bloom pipeline is enabled
  75189. */
  75190. get BloomEnabled(): boolean;
  75191. set BloomEnabled(enabled: boolean);
  75192. /**
  75193. * @ignore
  75194. * Specifies if the depth of field pipeline is enabed
  75195. */
  75196. get DepthOfFieldEnabled(): boolean;
  75197. set DepthOfFieldEnabled(enabled: boolean);
  75198. /**
  75199. * @ignore
  75200. * Specifies if the lens flare pipeline is enabed
  75201. */
  75202. get LensFlareEnabled(): boolean;
  75203. set LensFlareEnabled(enabled: boolean);
  75204. /**
  75205. * @ignore
  75206. * Specifies if the HDR pipeline is enabled
  75207. */
  75208. get HDREnabled(): boolean;
  75209. set HDREnabled(enabled: boolean);
  75210. /**
  75211. * @ignore
  75212. * Specifies if the volumetric lights scattering effect is enabled
  75213. */
  75214. get VLSEnabled(): boolean;
  75215. set VLSEnabled(enabled: boolean);
  75216. /**
  75217. * @ignore
  75218. * Specifies if the motion blur effect is enabled
  75219. */
  75220. get MotionBlurEnabled(): boolean;
  75221. set MotionBlurEnabled(enabled: boolean);
  75222. /**
  75223. * Specifies if anti-aliasing is enabled
  75224. */
  75225. get fxaaEnabled(): boolean;
  75226. set fxaaEnabled(enabled: boolean);
  75227. /**
  75228. * Specifies if screen space reflections are enabled.
  75229. */
  75230. get screenSpaceReflectionsEnabled(): boolean;
  75231. set screenSpaceReflectionsEnabled(enabled: boolean);
  75232. /**
  75233. * Specifies the number of steps used to calculate the volumetric lights
  75234. * Typically in interval [50, 200]
  75235. */
  75236. get volumetricLightStepsCount(): number;
  75237. set volumetricLightStepsCount(count: number);
  75238. /**
  75239. * Specifies the number of samples used for the motion blur effect
  75240. * Typically in interval [16, 64]
  75241. */
  75242. get motionBlurSamples(): number;
  75243. set motionBlurSamples(samples: number);
  75244. /**
  75245. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75246. */
  75247. get samples(): number;
  75248. set samples(sampleCount: number);
  75249. /**
  75250. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75251. * @constructor
  75252. * @param name The rendering pipeline name
  75253. * @param scene The scene linked to this pipeline
  75254. * @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)
  75255. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75256. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75257. */
  75258. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75259. private _buildPipeline;
  75260. private _createDownSampleX4PostProcess;
  75261. private _createBrightPassPostProcess;
  75262. private _createBlurPostProcesses;
  75263. private _createTextureAdderPostProcess;
  75264. private _createVolumetricLightPostProcess;
  75265. private _createLuminancePostProcesses;
  75266. private _createHdrPostProcess;
  75267. private _createLensFlarePostProcess;
  75268. private _createDepthOfFieldPostProcess;
  75269. private _createMotionBlurPostProcess;
  75270. private _getDepthTexture;
  75271. private _disposePostProcesses;
  75272. /**
  75273. * Dispose of the pipeline and stop all post processes
  75274. */
  75275. dispose(): void;
  75276. /**
  75277. * Serialize the rendering pipeline (Used when exporting)
  75278. * @returns the serialized object
  75279. */
  75280. serialize(): any;
  75281. /**
  75282. * Parse the serialized pipeline
  75283. * @param source Source pipeline.
  75284. * @param scene The scene to load the pipeline to.
  75285. * @param rootUrl The URL of the serialized pipeline.
  75286. * @returns An instantiated pipeline from the serialized object.
  75287. */
  75288. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75289. /**
  75290. * Luminance steps
  75291. */
  75292. static LuminanceSteps: number;
  75293. }
  75294. }
  75295. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75296. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75297. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75298. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75299. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75300. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75301. }
  75302. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75303. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75304. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75305. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75306. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75307. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75308. }
  75309. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75310. /** @hidden */
  75311. export var stereoscopicInterlacePixelShader: {
  75312. name: string;
  75313. shader: string;
  75314. };
  75315. }
  75316. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75317. import { Camera } from "babylonjs/Cameras/camera";
  75318. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75319. import { Engine } from "babylonjs/Engines/engine";
  75320. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75321. /**
  75322. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75323. */
  75324. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75325. private _stepSize;
  75326. private _passedProcess;
  75327. /**
  75328. * Gets a string identifying the name of the class
  75329. * @returns "StereoscopicInterlacePostProcessI" string
  75330. */
  75331. getClassName(): string;
  75332. /**
  75333. * Initializes a StereoscopicInterlacePostProcessI
  75334. * @param name The name of the effect.
  75335. * @param rigCameras The rig cameras to be appled to the post process
  75336. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75337. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75338. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75339. * @param engine The engine which the post process will be applied. (default: current engine)
  75340. * @param reusable If the post process can be reused on the same frame. (default: false)
  75341. */
  75342. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75343. }
  75344. /**
  75345. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75346. */
  75347. export class StereoscopicInterlacePostProcess extends PostProcess {
  75348. private _stepSize;
  75349. private _passedProcess;
  75350. /**
  75351. * Gets a string identifying the name of the class
  75352. * @returns "StereoscopicInterlacePostProcess" string
  75353. */
  75354. getClassName(): string;
  75355. /**
  75356. * Initializes a StereoscopicInterlacePostProcess
  75357. * @param name The name of the effect.
  75358. * @param rigCameras The rig cameras to be appled to the post process
  75359. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75360. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75361. * @param engine The engine which the post process will be applied. (default: current engine)
  75362. * @param reusable If the post process can be reused on the same frame. (default: false)
  75363. */
  75364. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75365. }
  75366. }
  75367. declare module "babylonjs/Shaders/tonemap.fragment" {
  75368. /** @hidden */
  75369. export var tonemapPixelShader: {
  75370. name: string;
  75371. shader: string;
  75372. };
  75373. }
  75374. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75375. import { Camera } from "babylonjs/Cameras/camera";
  75376. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75377. import "babylonjs/Shaders/tonemap.fragment";
  75378. import { Engine } from "babylonjs/Engines/engine";
  75379. /** Defines operator used for tonemapping */
  75380. export enum TonemappingOperator {
  75381. /** Hable */
  75382. Hable = 0,
  75383. /** Reinhard */
  75384. Reinhard = 1,
  75385. /** HejiDawson */
  75386. HejiDawson = 2,
  75387. /** Photographic */
  75388. Photographic = 3
  75389. }
  75390. /**
  75391. * Defines a post process to apply tone mapping
  75392. */
  75393. export class TonemapPostProcess extends PostProcess {
  75394. private _operator;
  75395. /** Defines the required exposure adjustement */
  75396. exposureAdjustment: number;
  75397. /**
  75398. * Gets a string identifying the name of the class
  75399. * @returns "TonemapPostProcess" string
  75400. */
  75401. getClassName(): string;
  75402. /**
  75403. * Creates a new TonemapPostProcess
  75404. * @param name defines the name of the postprocess
  75405. * @param _operator defines the operator to use
  75406. * @param exposureAdjustment defines the required exposure adjustement
  75407. * @param camera defines the camera to use (can be null)
  75408. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75409. * @param engine defines the hosting engine (can be ignore if camera is set)
  75410. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75411. */
  75412. constructor(name: string, _operator: TonemappingOperator,
  75413. /** Defines the required exposure adjustement */
  75414. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75415. }
  75416. }
  75417. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75418. /** @hidden */
  75419. export var volumetricLightScatteringPixelShader: {
  75420. name: string;
  75421. shader: string;
  75422. };
  75423. }
  75424. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75425. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75426. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75427. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75428. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75429. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75430. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75431. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75432. /** @hidden */
  75433. export var volumetricLightScatteringPassVertexShader: {
  75434. name: string;
  75435. shader: string;
  75436. };
  75437. }
  75438. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75439. /** @hidden */
  75440. export var volumetricLightScatteringPassPixelShader: {
  75441. name: string;
  75442. shader: string;
  75443. };
  75444. }
  75445. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75446. import { Vector3 } from "babylonjs/Maths/math.vector";
  75447. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75448. import { Mesh } from "babylonjs/Meshes/mesh";
  75449. import { Camera } from "babylonjs/Cameras/camera";
  75450. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75451. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75452. import { Scene } from "babylonjs/scene";
  75453. import "babylonjs/Meshes/Builders/planeBuilder";
  75454. import "babylonjs/Shaders/depth.vertex";
  75455. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75456. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75457. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75458. import { Engine } from "babylonjs/Engines/engine";
  75459. /**
  75460. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75461. */
  75462. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75463. private _volumetricLightScatteringPass;
  75464. private _volumetricLightScatteringRTT;
  75465. private _viewPort;
  75466. private _screenCoordinates;
  75467. private _cachedDefines;
  75468. /**
  75469. * If not undefined, the mesh position is computed from the attached node position
  75470. */
  75471. attachedNode: {
  75472. position: Vector3;
  75473. };
  75474. /**
  75475. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75476. */
  75477. customMeshPosition: Vector3;
  75478. /**
  75479. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75480. */
  75481. useCustomMeshPosition: boolean;
  75482. /**
  75483. * If the post-process should inverse the light scattering direction
  75484. */
  75485. invert: boolean;
  75486. /**
  75487. * The internal mesh used by the post-process
  75488. */
  75489. mesh: Mesh;
  75490. /**
  75491. * @hidden
  75492. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75493. */
  75494. get useDiffuseColor(): boolean;
  75495. set useDiffuseColor(useDiffuseColor: boolean);
  75496. /**
  75497. * Array containing the excluded meshes not rendered in the internal pass
  75498. */
  75499. excludedMeshes: AbstractMesh[];
  75500. /**
  75501. * Controls the overall intensity of the post-process
  75502. */
  75503. exposure: number;
  75504. /**
  75505. * Dissipates each sample's contribution in range [0, 1]
  75506. */
  75507. decay: number;
  75508. /**
  75509. * Controls the overall intensity of each sample
  75510. */
  75511. weight: number;
  75512. /**
  75513. * Controls the density of each sample
  75514. */
  75515. density: number;
  75516. /**
  75517. * @constructor
  75518. * @param name The post-process name
  75519. * @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)
  75520. * @param camera The camera that the post-process will be attached to
  75521. * @param mesh The mesh used to create the light scattering
  75522. * @param samples The post-process quality, default 100
  75523. * @param samplingModeThe post-process filtering mode
  75524. * @param engine The babylon engine
  75525. * @param reusable If the post-process is reusable
  75526. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75527. */
  75528. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75529. /**
  75530. * Returns the string "VolumetricLightScatteringPostProcess"
  75531. * @returns "VolumetricLightScatteringPostProcess"
  75532. */
  75533. getClassName(): string;
  75534. private _isReady;
  75535. /**
  75536. * Sets the new light position for light scattering effect
  75537. * @param position The new custom light position
  75538. */
  75539. setCustomMeshPosition(position: Vector3): void;
  75540. /**
  75541. * Returns the light position for light scattering effect
  75542. * @return Vector3 The custom light position
  75543. */
  75544. getCustomMeshPosition(): Vector3;
  75545. /**
  75546. * Disposes the internal assets and detaches the post-process from the camera
  75547. */
  75548. dispose(camera: Camera): void;
  75549. /**
  75550. * Returns the render target texture used by the post-process
  75551. * @return the render target texture used by the post-process
  75552. */
  75553. getPass(): RenderTargetTexture;
  75554. private _meshExcluded;
  75555. private _createPass;
  75556. private _updateMeshScreenCoordinates;
  75557. /**
  75558. * Creates a default mesh for the Volumeric Light Scattering post-process
  75559. * @param name The mesh name
  75560. * @param scene The scene where to create the mesh
  75561. * @return the default mesh
  75562. */
  75563. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75564. }
  75565. }
  75566. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75567. /** @hidden */
  75568. export var screenSpaceCurvaturePixelShader: {
  75569. name: string;
  75570. shader: string;
  75571. };
  75572. }
  75573. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75574. import { Nullable } from "babylonjs/types";
  75575. import { Camera } from "babylonjs/Cameras/camera";
  75576. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75577. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75578. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75579. import { Engine } from "babylonjs/Engines/engine";
  75580. import { Scene } from "babylonjs/scene";
  75581. /**
  75582. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75583. */
  75584. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75585. /**
  75586. * Defines how much ridge the curvature effect displays.
  75587. */
  75588. ridge: number;
  75589. /**
  75590. * Defines how much valley the curvature effect displays.
  75591. */
  75592. valley: number;
  75593. private _geometryBufferRenderer;
  75594. /**
  75595. * Gets a string identifying the name of the class
  75596. * @returns "ScreenSpaceCurvaturePostProcess" string
  75597. */
  75598. getClassName(): string;
  75599. /**
  75600. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75601. * @param name The name of the effect.
  75602. * @param scene The scene containing the objects to blur according to their velocity.
  75603. * @param options The required width/height ratio to downsize to before computing the render pass.
  75604. * @param camera The camera to apply the render pass to.
  75605. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75606. * @param engine The engine which the post process will be applied. (default: current engine)
  75607. * @param reusable If the post process can be reused on the same frame. (default: false)
  75608. * @param textureType Type of textures used when performing the post process. (default: 0)
  75609. * @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)
  75610. */
  75611. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75612. /**
  75613. * Support test.
  75614. */
  75615. static get IsSupported(): boolean;
  75616. /** @hidden */
  75617. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75618. }
  75619. }
  75620. declare module "babylonjs/PostProcesses/index" {
  75621. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75622. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75623. export * from "babylonjs/PostProcesses/bloomEffect";
  75624. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75625. export * from "babylonjs/PostProcesses/blurPostProcess";
  75626. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75627. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75628. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75629. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75630. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75631. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75632. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75633. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75634. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75635. export * from "babylonjs/PostProcesses/filterPostProcess";
  75636. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75637. export * from "babylonjs/PostProcesses/grainPostProcess";
  75638. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75639. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75640. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75641. export * from "babylonjs/PostProcesses/passPostProcess";
  75642. export * from "babylonjs/PostProcesses/postProcess";
  75643. export * from "babylonjs/PostProcesses/postProcessManager";
  75644. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75645. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75646. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75647. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75648. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75649. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75650. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75651. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75652. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75653. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75654. }
  75655. declare module "babylonjs/Probes/index" {
  75656. export * from "babylonjs/Probes/reflectionProbe";
  75657. }
  75658. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75659. import { Scene } from "babylonjs/scene";
  75660. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75661. import { SmartArray } from "babylonjs/Misc/smartArray";
  75662. import { ISceneComponent } from "babylonjs/sceneComponent";
  75663. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75664. import "babylonjs/Meshes/Builders/boxBuilder";
  75665. import "babylonjs/Shaders/color.fragment";
  75666. import "babylonjs/Shaders/color.vertex";
  75667. import { Color3 } from "babylonjs/Maths/math.color";
  75668. import { Observable } from "babylonjs/Misc/observable";
  75669. module "babylonjs/scene" {
  75670. interface Scene {
  75671. /** @hidden (Backing field) */
  75672. _boundingBoxRenderer: BoundingBoxRenderer;
  75673. /** @hidden (Backing field) */
  75674. _forceShowBoundingBoxes: boolean;
  75675. /**
  75676. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75677. */
  75678. forceShowBoundingBoxes: boolean;
  75679. /**
  75680. * Gets the bounding box renderer associated with the scene
  75681. * @returns a BoundingBoxRenderer
  75682. */
  75683. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75684. }
  75685. }
  75686. module "babylonjs/Meshes/abstractMesh" {
  75687. interface AbstractMesh {
  75688. /** @hidden (Backing field) */
  75689. _showBoundingBox: boolean;
  75690. /**
  75691. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75692. */
  75693. showBoundingBox: boolean;
  75694. }
  75695. }
  75696. /**
  75697. * Component responsible of rendering the bounding box of the meshes in a scene.
  75698. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75699. */
  75700. export class BoundingBoxRenderer implements ISceneComponent {
  75701. /**
  75702. * The component name helpfull to identify the component in the list of scene components.
  75703. */
  75704. readonly name: string;
  75705. /**
  75706. * The scene the component belongs to.
  75707. */
  75708. scene: Scene;
  75709. /**
  75710. * Color of the bounding box lines placed in front of an object
  75711. */
  75712. frontColor: Color3;
  75713. /**
  75714. * Color of the bounding box lines placed behind an object
  75715. */
  75716. backColor: Color3;
  75717. /**
  75718. * Defines if the renderer should show the back lines or not
  75719. */
  75720. showBackLines: boolean;
  75721. /**
  75722. * Observable raised before rendering a bounding box
  75723. */
  75724. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75725. /**
  75726. * Observable raised after rendering a bounding box
  75727. */
  75728. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75729. /**
  75730. * @hidden
  75731. */
  75732. renderList: SmartArray<BoundingBox>;
  75733. private _colorShader;
  75734. private _vertexBuffers;
  75735. private _indexBuffer;
  75736. private _fillIndexBuffer;
  75737. private _fillIndexData;
  75738. /**
  75739. * Instantiates a new bounding box renderer in a scene.
  75740. * @param scene the scene the renderer renders in
  75741. */
  75742. constructor(scene: Scene);
  75743. /**
  75744. * Registers the component in a given scene
  75745. */
  75746. register(): void;
  75747. private _evaluateSubMesh;
  75748. private _activeMesh;
  75749. private _prepareRessources;
  75750. private _createIndexBuffer;
  75751. /**
  75752. * Rebuilds the elements related to this component in case of
  75753. * context lost for instance.
  75754. */
  75755. rebuild(): void;
  75756. /**
  75757. * @hidden
  75758. */
  75759. reset(): void;
  75760. /**
  75761. * Render the bounding boxes of a specific rendering group
  75762. * @param renderingGroupId defines the rendering group to render
  75763. */
  75764. render(renderingGroupId: number): void;
  75765. /**
  75766. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75767. * @param mesh Define the mesh to render the occlusion bounding box for
  75768. */
  75769. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75770. /**
  75771. * Dispose and release the resources attached to this renderer.
  75772. */
  75773. dispose(): void;
  75774. }
  75775. }
  75776. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75777. import { Nullable } from "babylonjs/types";
  75778. import { Scene } from "babylonjs/scene";
  75779. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75780. import { Camera } from "babylonjs/Cameras/camera";
  75781. import { ISceneComponent } from "babylonjs/sceneComponent";
  75782. module "babylonjs/scene" {
  75783. interface Scene {
  75784. /** @hidden (Backing field) */
  75785. _depthRenderer: {
  75786. [id: string]: DepthRenderer;
  75787. };
  75788. /**
  75789. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75790. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75791. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75792. * @returns the created depth renderer
  75793. */
  75794. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75795. /**
  75796. * Disables a depth renderer for a given camera
  75797. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75798. */
  75799. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75800. }
  75801. }
  75802. /**
  75803. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75804. * in several rendering techniques.
  75805. */
  75806. export class DepthRendererSceneComponent implements ISceneComponent {
  75807. /**
  75808. * The component name helpfull to identify the component in the list of scene components.
  75809. */
  75810. readonly name: string;
  75811. /**
  75812. * The scene the component belongs to.
  75813. */
  75814. scene: Scene;
  75815. /**
  75816. * Creates a new instance of the component for the given scene
  75817. * @param scene Defines the scene to register the component in
  75818. */
  75819. constructor(scene: Scene);
  75820. /**
  75821. * Registers the component in a given scene
  75822. */
  75823. register(): void;
  75824. /**
  75825. * Rebuilds the elements related to this component in case of
  75826. * context lost for instance.
  75827. */
  75828. rebuild(): void;
  75829. /**
  75830. * Disposes the component and the associated ressources
  75831. */
  75832. dispose(): void;
  75833. private _gatherRenderTargets;
  75834. private _gatherActiveCameraRenderTargets;
  75835. }
  75836. }
  75837. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75838. import { Nullable } from "babylonjs/types";
  75839. import { Scene } from "babylonjs/scene";
  75840. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75841. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75842. import { AbstractScene } from "babylonjs/abstractScene";
  75843. module "babylonjs/abstractScene" {
  75844. interface AbstractScene {
  75845. /** @hidden (Backing field) */
  75846. _prePassRenderer: Nullable<PrePassRenderer>;
  75847. /**
  75848. * Gets or Sets the current prepass renderer associated to the scene.
  75849. */
  75850. prePassRenderer: Nullable<PrePassRenderer>;
  75851. /**
  75852. * Enables the prepass and associates it with the scene
  75853. * @returns the PrePassRenderer
  75854. */
  75855. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75856. /**
  75857. * Disables the prepass associated with the scene
  75858. */
  75859. disablePrePassRenderer(): void;
  75860. }
  75861. }
  75862. /**
  75863. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75864. * in several rendering techniques.
  75865. */
  75866. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75867. /**
  75868. * The component name helpful to identify the component in the list of scene components.
  75869. */
  75870. readonly name: string;
  75871. /**
  75872. * The scene the component belongs to.
  75873. */
  75874. scene: Scene;
  75875. /**
  75876. * Creates a new instance of the component for the given scene
  75877. * @param scene Defines the scene to register the component in
  75878. */
  75879. constructor(scene: Scene);
  75880. /**
  75881. * Registers the component in a given scene
  75882. */
  75883. register(): void;
  75884. private _beforeCameraDraw;
  75885. private _afterCameraDraw;
  75886. private _beforeClearStage;
  75887. /**
  75888. * Serializes the component data to the specified json object
  75889. * @param serializationObject The object to serialize to
  75890. */
  75891. serialize(serializationObject: any): void;
  75892. /**
  75893. * Adds all the elements from the container to the scene
  75894. * @param container the container holding the elements
  75895. */
  75896. addFromContainer(container: AbstractScene): void;
  75897. /**
  75898. * Removes all the elements in the container from the scene
  75899. * @param container contains the elements to remove
  75900. * @param dispose if the removed element should be disposed (default: false)
  75901. */
  75902. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75903. /**
  75904. * Rebuilds the elements related to this component in case of
  75905. * context lost for instance.
  75906. */
  75907. rebuild(): void;
  75908. /**
  75909. * Disposes the component and the associated ressources
  75910. */
  75911. dispose(): void;
  75912. }
  75913. }
  75914. declare module "babylonjs/Shaders/outline.fragment" {
  75915. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75916. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75917. /** @hidden */
  75918. export var outlinePixelShader: {
  75919. name: string;
  75920. shader: string;
  75921. };
  75922. }
  75923. declare module "babylonjs/Shaders/outline.vertex" {
  75924. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75925. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75926. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75927. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75928. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75929. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75930. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75931. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75932. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75933. /** @hidden */
  75934. export var outlineVertexShader: {
  75935. name: string;
  75936. shader: string;
  75937. };
  75938. }
  75939. declare module "babylonjs/Rendering/outlineRenderer" {
  75940. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75941. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75942. import { Scene } from "babylonjs/scene";
  75943. import { ISceneComponent } from "babylonjs/sceneComponent";
  75944. import "babylonjs/Shaders/outline.fragment";
  75945. import "babylonjs/Shaders/outline.vertex";
  75946. module "babylonjs/scene" {
  75947. interface Scene {
  75948. /** @hidden */
  75949. _outlineRenderer: OutlineRenderer;
  75950. /**
  75951. * Gets the outline renderer associated with the scene
  75952. * @returns a OutlineRenderer
  75953. */
  75954. getOutlineRenderer(): OutlineRenderer;
  75955. }
  75956. }
  75957. module "babylonjs/Meshes/abstractMesh" {
  75958. interface AbstractMesh {
  75959. /** @hidden (Backing field) */
  75960. _renderOutline: boolean;
  75961. /**
  75962. * Gets or sets a boolean indicating if the outline must be rendered as well
  75963. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75964. */
  75965. renderOutline: boolean;
  75966. /** @hidden (Backing field) */
  75967. _renderOverlay: boolean;
  75968. /**
  75969. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75970. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75971. */
  75972. renderOverlay: boolean;
  75973. }
  75974. }
  75975. /**
  75976. * This class is responsible to draw bothe outline/overlay of meshes.
  75977. * It should not be used directly but through the available method on mesh.
  75978. */
  75979. export class OutlineRenderer implements ISceneComponent {
  75980. /**
  75981. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75982. */
  75983. private static _StencilReference;
  75984. /**
  75985. * The name of the component. Each component must have a unique name.
  75986. */
  75987. name: string;
  75988. /**
  75989. * The scene the component belongs to.
  75990. */
  75991. scene: Scene;
  75992. /**
  75993. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75994. */
  75995. zOffset: number;
  75996. private _engine;
  75997. private _effect;
  75998. private _cachedDefines;
  75999. private _savedDepthWrite;
  76000. /**
  76001. * Instantiates a new outline renderer. (There could be only one per scene).
  76002. * @param scene Defines the scene it belongs to
  76003. */
  76004. constructor(scene: Scene);
  76005. /**
  76006. * Register the component to one instance of a scene.
  76007. */
  76008. register(): void;
  76009. /**
  76010. * Rebuilds the elements related to this component in case of
  76011. * context lost for instance.
  76012. */
  76013. rebuild(): void;
  76014. /**
  76015. * Disposes the component and the associated ressources.
  76016. */
  76017. dispose(): void;
  76018. /**
  76019. * Renders the outline in the canvas.
  76020. * @param subMesh Defines the sumesh to render
  76021. * @param batch Defines the batch of meshes in case of instances
  76022. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76023. */
  76024. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76025. /**
  76026. * Returns whether or not the outline renderer is ready for a given submesh.
  76027. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76028. * @param subMesh Defines the submesh to check readyness for
  76029. * @param useInstances Defines wheter wee are trying to render instances or not
  76030. * @returns true if ready otherwise false
  76031. */
  76032. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76033. private _beforeRenderingMesh;
  76034. private _afterRenderingMesh;
  76035. }
  76036. }
  76037. declare module "babylonjs/Rendering/index" {
  76038. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76039. export * from "babylonjs/Rendering/depthRenderer";
  76040. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76041. export * from "babylonjs/Rendering/edgesRenderer";
  76042. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76043. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76044. export * from "babylonjs/Rendering/prePassRenderer";
  76045. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76046. export * from "babylonjs/Rendering/outlineRenderer";
  76047. export * from "babylonjs/Rendering/renderingGroup";
  76048. export * from "babylonjs/Rendering/renderingManager";
  76049. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76050. }
  76051. declare module "babylonjs/Sprites/ISprites" {
  76052. /**
  76053. * Defines the basic options interface of a Sprite Frame Source Size.
  76054. */
  76055. export interface ISpriteJSONSpriteSourceSize {
  76056. /**
  76057. * number of the original width of the Frame
  76058. */
  76059. w: number;
  76060. /**
  76061. * number of the original height of the Frame
  76062. */
  76063. h: number;
  76064. }
  76065. /**
  76066. * Defines the basic options interface of a Sprite Frame Data.
  76067. */
  76068. export interface ISpriteJSONSpriteFrameData {
  76069. /**
  76070. * number of the x offset of the Frame
  76071. */
  76072. x: number;
  76073. /**
  76074. * number of the y offset of the Frame
  76075. */
  76076. y: number;
  76077. /**
  76078. * number of the width of the Frame
  76079. */
  76080. w: number;
  76081. /**
  76082. * number of the height of the Frame
  76083. */
  76084. h: number;
  76085. }
  76086. /**
  76087. * Defines the basic options interface of a JSON Sprite.
  76088. */
  76089. export interface ISpriteJSONSprite {
  76090. /**
  76091. * string name of the Frame
  76092. */
  76093. filename: string;
  76094. /**
  76095. * ISpriteJSONSpriteFrame basic object of the frame data
  76096. */
  76097. frame: ISpriteJSONSpriteFrameData;
  76098. /**
  76099. * boolean to flag is the frame was rotated.
  76100. */
  76101. rotated: boolean;
  76102. /**
  76103. * boolean to flag is the frame was trimmed.
  76104. */
  76105. trimmed: boolean;
  76106. /**
  76107. * ISpriteJSONSpriteFrame basic object of the source data
  76108. */
  76109. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76110. /**
  76111. * ISpriteJSONSpriteFrame basic object of the source data
  76112. */
  76113. sourceSize: ISpriteJSONSpriteSourceSize;
  76114. }
  76115. /**
  76116. * Defines the basic options interface of a JSON atlas.
  76117. */
  76118. export interface ISpriteJSONAtlas {
  76119. /**
  76120. * Array of objects that contain the frame data.
  76121. */
  76122. frames: Array<ISpriteJSONSprite>;
  76123. /**
  76124. * object basic object containing the sprite meta data.
  76125. */
  76126. meta?: object;
  76127. }
  76128. }
  76129. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76130. /** @hidden */
  76131. export var spriteMapPixelShader: {
  76132. name: string;
  76133. shader: string;
  76134. };
  76135. }
  76136. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76137. /** @hidden */
  76138. export var spriteMapVertexShader: {
  76139. name: string;
  76140. shader: string;
  76141. };
  76142. }
  76143. declare module "babylonjs/Sprites/spriteMap" {
  76144. import { IDisposable, Scene } from "babylonjs/scene";
  76145. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76146. import { Texture } from "babylonjs/Materials/Textures/texture";
  76147. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76148. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76149. import "babylonjs/Meshes/Builders/planeBuilder";
  76150. import "babylonjs/Shaders/spriteMap.fragment";
  76151. import "babylonjs/Shaders/spriteMap.vertex";
  76152. /**
  76153. * Defines the basic options interface of a SpriteMap
  76154. */
  76155. export interface ISpriteMapOptions {
  76156. /**
  76157. * Vector2 of the number of cells in the grid.
  76158. */
  76159. stageSize?: Vector2;
  76160. /**
  76161. * Vector2 of the size of the output plane in World Units.
  76162. */
  76163. outputSize?: Vector2;
  76164. /**
  76165. * Vector3 of the position of the output plane in World Units.
  76166. */
  76167. outputPosition?: Vector3;
  76168. /**
  76169. * Vector3 of the rotation of the output plane.
  76170. */
  76171. outputRotation?: Vector3;
  76172. /**
  76173. * number of layers that the system will reserve in resources.
  76174. */
  76175. layerCount?: number;
  76176. /**
  76177. * number of max animation frames a single cell will reserve in resources.
  76178. */
  76179. maxAnimationFrames?: number;
  76180. /**
  76181. * number cell index of the base tile when the system compiles.
  76182. */
  76183. baseTile?: number;
  76184. /**
  76185. * boolean flip the sprite after its been repositioned by the framing data.
  76186. */
  76187. flipU?: boolean;
  76188. /**
  76189. * Vector3 scalar of the global RGB values of the SpriteMap.
  76190. */
  76191. colorMultiply?: Vector3;
  76192. }
  76193. /**
  76194. * Defines the IDisposable interface in order to be cleanable from resources.
  76195. */
  76196. export interface ISpriteMap extends IDisposable {
  76197. /**
  76198. * String name of the SpriteMap.
  76199. */
  76200. name: string;
  76201. /**
  76202. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76203. */
  76204. atlasJSON: ISpriteJSONAtlas;
  76205. /**
  76206. * Texture of the SpriteMap.
  76207. */
  76208. spriteSheet: Texture;
  76209. /**
  76210. * The parameters to initialize the SpriteMap with.
  76211. */
  76212. options: ISpriteMapOptions;
  76213. }
  76214. /**
  76215. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76216. */
  76217. export class SpriteMap implements ISpriteMap {
  76218. /** The Name of the spriteMap */
  76219. name: string;
  76220. /** The JSON file with the frame and meta data */
  76221. atlasJSON: ISpriteJSONAtlas;
  76222. /** The systems Sprite Sheet Texture */
  76223. spriteSheet: Texture;
  76224. /** Arguments passed with the Constructor */
  76225. options: ISpriteMapOptions;
  76226. /** Public Sprite Storage array, parsed from atlasJSON */
  76227. sprites: Array<ISpriteJSONSprite>;
  76228. /** Returns the Number of Sprites in the System */
  76229. get spriteCount(): number;
  76230. /** Returns the Position of Output Plane*/
  76231. get position(): Vector3;
  76232. /** Returns the Position of Output Plane*/
  76233. set position(v: Vector3);
  76234. /** Returns the Rotation of Output Plane*/
  76235. get rotation(): Vector3;
  76236. /** Returns the Rotation of Output Plane*/
  76237. set rotation(v: Vector3);
  76238. /** Sets the AnimationMap*/
  76239. get animationMap(): RawTexture;
  76240. /** Sets the AnimationMap*/
  76241. set animationMap(v: RawTexture);
  76242. /** Scene that the SpriteMap was created in */
  76243. private _scene;
  76244. /** Texture Buffer of Float32 that holds tile frame data*/
  76245. private _frameMap;
  76246. /** Texture Buffers of Float32 that holds tileMap data*/
  76247. private _tileMaps;
  76248. /** Texture Buffer of Float32 that holds Animation Data*/
  76249. private _animationMap;
  76250. /** Custom ShaderMaterial Central to the System*/
  76251. private _material;
  76252. /** Custom ShaderMaterial Central to the System*/
  76253. private _output;
  76254. /** Systems Time Ticker*/
  76255. private _time;
  76256. /**
  76257. * Creates a new SpriteMap
  76258. * @param name defines the SpriteMaps Name
  76259. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76260. * @param spriteSheet is the Texture that the Sprites are on.
  76261. * @param options a basic deployment configuration
  76262. * @param scene The Scene that the map is deployed on
  76263. */
  76264. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76265. /**
  76266. * Returns tileID location
  76267. * @returns Vector2 the cell position ID
  76268. */
  76269. getTileID(): Vector2;
  76270. /**
  76271. * Gets the UV location of the mouse over the SpriteMap.
  76272. * @returns Vector2 the UV position of the mouse interaction
  76273. */
  76274. getMousePosition(): Vector2;
  76275. /**
  76276. * Creates the "frame" texture Buffer
  76277. * -------------------------------------
  76278. * Structure of frames
  76279. * "filename": "Falling-Water-2.png",
  76280. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76281. * "rotated": true,
  76282. * "trimmed": true,
  76283. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76284. * "sourceSize": {"w":32,"h":32}
  76285. * @returns RawTexture of the frameMap
  76286. */
  76287. private _createFrameBuffer;
  76288. /**
  76289. * Creates the tileMap texture Buffer
  76290. * @param buffer normally and array of numbers, or a false to generate from scratch
  76291. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76292. * @returns RawTexture of the tileMap
  76293. */
  76294. private _createTileBuffer;
  76295. /**
  76296. * Modifies the data of the tileMaps
  76297. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76298. * @param pos is the iVector2 Coordinates of the Tile
  76299. * @param tile The SpriteIndex of the new Tile
  76300. */
  76301. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76302. /**
  76303. * Creates the animationMap texture Buffer
  76304. * @param buffer normally and array of numbers, or a false to generate from scratch
  76305. * @returns RawTexture of the animationMap
  76306. */
  76307. private _createTileAnimationBuffer;
  76308. /**
  76309. * Modifies the data of the animationMap
  76310. * @param cellID is the Index of the Sprite
  76311. * @param _frame is the target Animation frame
  76312. * @param toCell is the Target Index of the next frame of the animation
  76313. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76314. * @param speed is a global scalar of the time variable on the map.
  76315. */
  76316. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76317. /**
  76318. * Exports the .tilemaps file
  76319. */
  76320. saveTileMaps(): void;
  76321. /**
  76322. * Imports the .tilemaps file
  76323. * @param url of the .tilemaps file
  76324. */
  76325. loadTileMaps(url: string): void;
  76326. /**
  76327. * Release associated resources
  76328. */
  76329. dispose(): void;
  76330. }
  76331. }
  76332. declare module "babylonjs/Sprites/spritePackedManager" {
  76333. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76334. import { Scene } from "babylonjs/scene";
  76335. /**
  76336. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76337. * @see https://doc.babylonjs.com/babylon101/sprites
  76338. */
  76339. export class SpritePackedManager extends SpriteManager {
  76340. /** defines the packed manager's name */
  76341. name: string;
  76342. /**
  76343. * Creates a new sprite manager from a packed sprite sheet
  76344. * @param name defines the manager's name
  76345. * @param imgUrl defines the sprite sheet url
  76346. * @param capacity defines the maximum allowed number of sprites
  76347. * @param scene defines the hosting scene
  76348. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76349. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76350. * @param samplingMode defines the smapling mode to use with spritesheet
  76351. * @param fromPacked set to true; do not alter
  76352. */
  76353. constructor(
  76354. /** defines the packed manager's name */
  76355. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76356. }
  76357. }
  76358. declare module "babylonjs/Sprites/index" {
  76359. export * from "babylonjs/Sprites/sprite";
  76360. export * from "babylonjs/Sprites/ISprites";
  76361. export * from "babylonjs/Sprites/spriteManager";
  76362. export * from "babylonjs/Sprites/spriteMap";
  76363. export * from "babylonjs/Sprites/spritePackedManager";
  76364. export * from "babylonjs/Sprites/spriteSceneComponent";
  76365. }
  76366. declare module "babylonjs/States/index" {
  76367. export * from "babylonjs/States/alphaCullingState";
  76368. export * from "babylonjs/States/depthCullingState";
  76369. export * from "babylonjs/States/stencilState";
  76370. }
  76371. declare module "babylonjs/Misc/assetsManager" {
  76372. import { Scene } from "babylonjs/scene";
  76373. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76374. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76375. import { Skeleton } from "babylonjs/Bones/skeleton";
  76376. import { Observable } from "babylonjs/Misc/observable";
  76377. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76378. import { Texture } from "babylonjs/Materials/Textures/texture";
  76379. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76380. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76381. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76382. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76383. import { AssetContainer } from "babylonjs/assetContainer";
  76384. /**
  76385. * Defines the list of states available for a task inside a AssetsManager
  76386. */
  76387. export enum AssetTaskState {
  76388. /**
  76389. * Initialization
  76390. */
  76391. INIT = 0,
  76392. /**
  76393. * Running
  76394. */
  76395. RUNNING = 1,
  76396. /**
  76397. * Done
  76398. */
  76399. DONE = 2,
  76400. /**
  76401. * Error
  76402. */
  76403. ERROR = 3
  76404. }
  76405. /**
  76406. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76407. */
  76408. export abstract class AbstractAssetTask {
  76409. /**
  76410. * Task name
  76411. */ name: string;
  76412. /**
  76413. * Callback called when the task is successful
  76414. */
  76415. onSuccess: (task: any) => void;
  76416. /**
  76417. * Callback called when the task is not successful
  76418. */
  76419. onError: (task: any, message?: string, exception?: any) => void;
  76420. /**
  76421. * Creates a new AssetsManager
  76422. * @param name defines the name of the task
  76423. */
  76424. constructor(
  76425. /**
  76426. * Task name
  76427. */ name: string);
  76428. private _isCompleted;
  76429. private _taskState;
  76430. private _errorObject;
  76431. /**
  76432. * Get if the task is completed
  76433. */
  76434. get isCompleted(): boolean;
  76435. /**
  76436. * Gets the current state of the task
  76437. */
  76438. get taskState(): AssetTaskState;
  76439. /**
  76440. * Gets the current error object (if task is in error)
  76441. */
  76442. get errorObject(): {
  76443. message?: string;
  76444. exception?: any;
  76445. };
  76446. /**
  76447. * Internal only
  76448. * @hidden
  76449. */
  76450. _setErrorObject(message?: string, exception?: any): void;
  76451. /**
  76452. * Execute the current task
  76453. * @param scene defines the scene where you want your assets to be loaded
  76454. * @param onSuccess is a callback called when the task is successfully executed
  76455. * @param onError is a callback called if an error occurs
  76456. */
  76457. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76458. /**
  76459. * Execute the current task
  76460. * @param scene defines the scene where you want your assets to be loaded
  76461. * @param onSuccess is a callback called when the task is successfully executed
  76462. * @param onError is a callback called if an error occurs
  76463. */
  76464. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76465. /**
  76466. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76467. * This can be used with failed tasks that have the reason for failure fixed.
  76468. */
  76469. reset(): void;
  76470. private onErrorCallback;
  76471. private onDoneCallback;
  76472. }
  76473. /**
  76474. * Define the interface used by progress events raised during assets loading
  76475. */
  76476. export interface IAssetsProgressEvent {
  76477. /**
  76478. * Defines the number of remaining tasks to process
  76479. */
  76480. remainingCount: number;
  76481. /**
  76482. * Defines the total number of tasks
  76483. */
  76484. totalCount: number;
  76485. /**
  76486. * Defines the task that was just processed
  76487. */
  76488. task: AbstractAssetTask;
  76489. }
  76490. /**
  76491. * Class used to share progress information about assets loading
  76492. */
  76493. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76494. /**
  76495. * Defines the number of remaining tasks to process
  76496. */
  76497. remainingCount: number;
  76498. /**
  76499. * Defines the total number of tasks
  76500. */
  76501. totalCount: number;
  76502. /**
  76503. * Defines the task that was just processed
  76504. */
  76505. task: AbstractAssetTask;
  76506. /**
  76507. * Creates a AssetsProgressEvent
  76508. * @param remainingCount defines the number of remaining tasks to process
  76509. * @param totalCount defines the total number of tasks
  76510. * @param task defines the task that was just processed
  76511. */
  76512. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76513. }
  76514. /**
  76515. * Define a task used by AssetsManager to load assets into a container
  76516. */
  76517. export class ContainerAssetTask extends AbstractAssetTask {
  76518. /**
  76519. * Defines the name of the task
  76520. */
  76521. name: string;
  76522. /**
  76523. * Defines the list of mesh's names you want to load
  76524. */
  76525. meshesNames: any;
  76526. /**
  76527. * Defines the root url to use as a base to load your meshes and associated resources
  76528. */
  76529. rootUrl: string;
  76530. /**
  76531. * Defines the filename or File of the scene to load from
  76532. */
  76533. sceneFilename: string | File;
  76534. /**
  76535. * Get the loaded asset container
  76536. */
  76537. loadedContainer: AssetContainer;
  76538. /**
  76539. * Gets the list of loaded meshes
  76540. */
  76541. loadedMeshes: Array<AbstractMesh>;
  76542. /**
  76543. * Gets the list of loaded particle systems
  76544. */
  76545. loadedParticleSystems: Array<IParticleSystem>;
  76546. /**
  76547. * Gets the list of loaded skeletons
  76548. */
  76549. loadedSkeletons: Array<Skeleton>;
  76550. /**
  76551. * Gets the list of loaded animation groups
  76552. */
  76553. loadedAnimationGroups: Array<AnimationGroup>;
  76554. /**
  76555. * Callback called when the task is successful
  76556. */
  76557. onSuccess: (task: ContainerAssetTask) => void;
  76558. /**
  76559. * Callback called when the task is successful
  76560. */
  76561. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76562. /**
  76563. * Creates a new ContainerAssetTask
  76564. * @param name defines the name of the task
  76565. * @param meshesNames defines the list of mesh's names you want to load
  76566. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76567. * @param sceneFilename defines the filename or File of the scene to load from
  76568. */
  76569. constructor(
  76570. /**
  76571. * Defines the name of the task
  76572. */
  76573. name: string,
  76574. /**
  76575. * Defines the list of mesh's names you want to load
  76576. */
  76577. meshesNames: any,
  76578. /**
  76579. * Defines the root url to use as a base to load your meshes and associated resources
  76580. */
  76581. rootUrl: string,
  76582. /**
  76583. * Defines the filename or File of the scene to load from
  76584. */
  76585. sceneFilename: string | File);
  76586. /**
  76587. * Execute the current task
  76588. * @param scene defines the scene where you want your assets to be loaded
  76589. * @param onSuccess is a callback called when the task is successfully executed
  76590. * @param onError is a callback called if an error occurs
  76591. */
  76592. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76593. }
  76594. /**
  76595. * Define a task used by AssetsManager to load meshes
  76596. */
  76597. export class MeshAssetTask extends AbstractAssetTask {
  76598. /**
  76599. * Defines the name of the task
  76600. */
  76601. name: string;
  76602. /**
  76603. * Defines the list of mesh's names you want to load
  76604. */
  76605. meshesNames: any;
  76606. /**
  76607. * Defines the root url to use as a base to load your meshes and associated resources
  76608. */
  76609. rootUrl: string;
  76610. /**
  76611. * Defines the filename or File of the scene to load from
  76612. */
  76613. sceneFilename: string | File;
  76614. /**
  76615. * Gets the list of loaded meshes
  76616. */
  76617. loadedMeshes: Array<AbstractMesh>;
  76618. /**
  76619. * Gets the list of loaded particle systems
  76620. */
  76621. loadedParticleSystems: Array<IParticleSystem>;
  76622. /**
  76623. * Gets the list of loaded skeletons
  76624. */
  76625. loadedSkeletons: Array<Skeleton>;
  76626. /**
  76627. * Gets the list of loaded animation groups
  76628. */
  76629. loadedAnimationGroups: Array<AnimationGroup>;
  76630. /**
  76631. * Callback called when the task is successful
  76632. */
  76633. onSuccess: (task: MeshAssetTask) => void;
  76634. /**
  76635. * Callback called when the task is successful
  76636. */
  76637. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76638. /**
  76639. * Creates a new MeshAssetTask
  76640. * @param name defines the name of the task
  76641. * @param meshesNames defines the list of mesh's names you want to load
  76642. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76643. * @param sceneFilename defines the filename or File of the scene to load from
  76644. */
  76645. constructor(
  76646. /**
  76647. * Defines the name of the task
  76648. */
  76649. name: string,
  76650. /**
  76651. * Defines the list of mesh's names you want to load
  76652. */
  76653. meshesNames: any,
  76654. /**
  76655. * Defines the root url to use as a base to load your meshes and associated resources
  76656. */
  76657. rootUrl: string,
  76658. /**
  76659. * Defines the filename or File of the scene to load from
  76660. */
  76661. sceneFilename: string | File);
  76662. /**
  76663. * Execute the current task
  76664. * @param scene defines the scene where you want your assets to be loaded
  76665. * @param onSuccess is a callback called when the task is successfully executed
  76666. * @param onError is a callback called if an error occurs
  76667. */
  76668. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76669. }
  76670. /**
  76671. * Define a task used by AssetsManager to load text content
  76672. */
  76673. export class TextFileAssetTask extends AbstractAssetTask {
  76674. /**
  76675. * Defines the name of the task
  76676. */
  76677. name: string;
  76678. /**
  76679. * Defines the location of the file to load
  76680. */
  76681. url: string;
  76682. /**
  76683. * Gets the loaded text string
  76684. */
  76685. text: string;
  76686. /**
  76687. * Callback called when the task is successful
  76688. */
  76689. onSuccess: (task: TextFileAssetTask) => void;
  76690. /**
  76691. * Callback called when the task is successful
  76692. */
  76693. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76694. /**
  76695. * Creates a new TextFileAssetTask object
  76696. * @param name defines the name of the task
  76697. * @param url defines the location of the file to load
  76698. */
  76699. constructor(
  76700. /**
  76701. * Defines the name of the task
  76702. */
  76703. name: string,
  76704. /**
  76705. * Defines the location of the file to load
  76706. */
  76707. url: string);
  76708. /**
  76709. * Execute the current task
  76710. * @param scene defines the scene where you want your assets to be loaded
  76711. * @param onSuccess is a callback called when the task is successfully executed
  76712. * @param onError is a callback called if an error occurs
  76713. */
  76714. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76715. }
  76716. /**
  76717. * Define a task used by AssetsManager to load binary data
  76718. */
  76719. export class BinaryFileAssetTask extends AbstractAssetTask {
  76720. /**
  76721. * Defines the name of the task
  76722. */
  76723. name: string;
  76724. /**
  76725. * Defines the location of the file to load
  76726. */
  76727. url: string;
  76728. /**
  76729. * Gets the lodaded data (as an array buffer)
  76730. */
  76731. data: ArrayBuffer;
  76732. /**
  76733. * Callback called when the task is successful
  76734. */
  76735. onSuccess: (task: BinaryFileAssetTask) => void;
  76736. /**
  76737. * Callback called when the task is successful
  76738. */
  76739. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76740. /**
  76741. * Creates a new BinaryFileAssetTask object
  76742. * @param name defines the name of the new task
  76743. * @param url defines the location of the file to load
  76744. */
  76745. constructor(
  76746. /**
  76747. * Defines the name of the task
  76748. */
  76749. name: string,
  76750. /**
  76751. * Defines the location of the file to load
  76752. */
  76753. url: string);
  76754. /**
  76755. * Execute the current task
  76756. * @param scene defines the scene where you want your assets to be loaded
  76757. * @param onSuccess is a callback called when the task is successfully executed
  76758. * @param onError is a callback called if an error occurs
  76759. */
  76760. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76761. }
  76762. /**
  76763. * Define a task used by AssetsManager to load images
  76764. */
  76765. export class ImageAssetTask extends AbstractAssetTask {
  76766. /**
  76767. * Defines the name of the task
  76768. */
  76769. name: string;
  76770. /**
  76771. * Defines the location of the image to load
  76772. */
  76773. url: string;
  76774. /**
  76775. * Gets the loaded images
  76776. */
  76777. image: HTMLImageElement;
  76778. /**
  76779. * Callback called when the task is successful
  76780. */
  76781. onSuccess: (task: ImageAssetTask) => void;
  76782. /**
  76783. * Callback called when the task is successful
  76784. */
  76785. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76786. /**
  76787. * Creates a new ImageAssetTask
  76788. * @param name defines the name of the task
  76789. * @param url defines the location of the image to load
  76790. */
  76791. constructor(
  76792. /**
  76793. * Defines the name of the task
  76794. */
  76795. name: string,
  76796. /**
  76797. * Defines the location of the image to load
  76798. */
  76799. url: string);
  76800. /**
  76801. * Execute the current task
  76802. * @param scene defines the scene where you want your assets to be loaded
  76803. * @param onSuccess is a callback called when the task is successfully executed
  76804. * @param onError is a callback called if an error occurs
  76805. */
  76806. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76807. }
  76808. /**
  76809. * Defines the interface used by texture loading tasks
  76810. */
  76811. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76812. /**
  76813. * Gets the loaded texture
  76814. */
  76815. texture: TEX;
  76816. }
  76817. /**
  76818. * Define a task used by AssetsManager to load 2D textures
  76819. */
  76820. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76821. /**
  76822. * Defines the name of the task
  76823. */
  76824. name: string;
  76825. /**
  76826. * Defines the location of the file to load
  76827. */
  76828. url: string;
  76829. /**
  76830. * Defines if mipmap should not be generated (default is false)
  76831. */
  76832. noMipmap?: boolean | undefined;
  76833. /**
  76834. * Defines if texture must be inverted on Y axis (default is true)
  76835. */
  76836. invertY: boolean;
  76837. /**
  76838. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76839. */
  76840. samplingMode: number;
  76841. /**
  76842. * Gets the loaded texture
  76843. */
  76844. texture: Texture;
  76845. /**
  76846. * Callback called when the task is successful
  76847. */
  76848. onSuccess: (task: TextureAssetTask) => void;
  76849. /**
  76850. * Callback called when the task is successful
  76851. */
  76852. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76853. /**
  76854. * Creates a new TextureAssetTask object
  76855. * @param name defines the name of the task
  76856. * @param url defines the location of the file to load
  76857. * @param noMipmap defines if mipmap should not be generated (default is false)
  76858. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76859. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76860. */
  76861. constructor(
  76862. /**
  76863. * Defines the name of the task
  76864. */
  76865. name: string,
  76866. /**
  76867. * Defines the location of the file to load
  76868. */
  76869. url: string,
  76870. /**
  76871. * Defines if mipmap should not be generated (default is false)
  76872. */
  76873. noMipmap?: boolean | undefined,
  76874. /**
  76875. * Defines if texture must be inverted on Y axis (default is true)
  76876. */
  76877. invertY?: boolean,
  76878. /**
  76879. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76880. */
  76881. samplingMode?: number);
  76882. /**
  76883. * Execute the current task
  76884. * @param scene defines the scene where you want your assets to be loaded
  76885. * @param onSuccess is a callback called when the task is successfully executed
  76886. * @param onError is a callback called if an error occurs
  76887. */
  76888. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76889. }
  76890. /**
  76891. * Define a task used by AssetsManager to load cube textures
  76892. */
  76893. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76894. /**
  76895. * Defines the name of the task
  76896. */
  76897. name: string;
  76898. /**
  76899. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76900. */
  76901. url: string;
  76902. /**
  76903. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76904. */
  76905. extensions?: string[] | undefined;
  76906. /**
  76907. * Defines if mipmaps should not be generated (default is false)
  76908. */
  76909. noMipmap?: boolean | undefined;
  76910. /**
  76911. * Defines the explicit list of files (undefined by default)
  76912. */
  76913. files?: string[] | undefined;
  76914. /**
  76915. * Gets the loaded texture
  76916. */
  76917. texture: CubeTexture;
  76918. /**
  76919. * Callback called when the task is successful
  76920. */
  76921. onSuccess: (task: CubeTextureAssetTask) => void;
  76922. /**
  76923. * Callback called when the task is successful
  76924. */
  76925. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76926. /**
  76927. * Creates a new CubeTextureAssetTask
  76928. * @param name defines the name of the task
  76929. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76930. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76931. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76932. * @param files defines the explicit list of files (undefined by default)
  76933. */
  76934. constructor(
  76935. /**
  76936. * Defines the name of the task
  76937. */
  76938. name: string,
  76939. /**
  76940. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76941. */
  76942. url: string,
  76943. /**
  76944. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76945. */
  76946. extensions?: string[] | undefined,
  76947. /**
  76948. * Defines if mipmaps should not be generated (default is false)
  76949. */
  76950. noMipmap?: boolean | undefined,
  76951. /**
  76952. * Defines the explicit list of files (undefined by default)
  76953. */
  76954. files?: string[] | undefined);
  76955. /**
  76956. * Execute the current task
  76957. * @param scene defines the scene where you want your assets to be loaded
  76958. * @param onSuccess is a callback called when the task is successfully executed
  76959. * @param onError is a callback called if an error occurs
  76960. */
  76961. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76962. }
  76963. /**
  76964. * Define a task used by AssetsManager to load HDR cube textures
  76965. */
  76966. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76967. /**
  76968. * Defines the name of the task
  76969. */
  76970. name: string;
  76971. /**
  76972. * Defines the location of the file to load
  76973. */
  76974. url: string;
  76975. /**
  76976. * Defines the desired size (the more it increases the longer the generation will be)
  76977. */
  76978. size: number;
  76979. /**
  76980. * Defines if mipmaps should not be generated (default is false)
  76981. */
  76982. noMipmap: boolean;
  76983. /**
  76984. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76985. */
  76986. generateHarmonics: boolean;
  76987. /**
  76988. * 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)
  76989. */
  76990. gammaSpace: boolean;
  76991. /**
  76992. * Internal Use Only
  76993. */
  76994. reserved: boolean;
  76995. /**
  76996. * Gets the loaded texture
  76997. */
  76998. texture: HDRCubeTexture;
  76999. /**
  77000. * Callback called when the task is successful
  77001. */
  77002. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  77003. /**
  77004. * Callback called when the task is successful
  77005. */
  77006. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77007. /**
  77008. * Creates a new HDRCubeTextureAssetTask object
  77009. * @param name defines the name of the task
  77010. * @param url defines the location of the file to load
  77011. * @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.
  77012. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77013. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77014. * @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)
  77015. * @param reserved Internal use only
  77016. */
  77017. constructor(
  77018. /**
  77019. * Defines the name of the task
  77020. */
  77021. name: string,
  77022. /**
  77023. * Defines the location of the file to load
  77024. */
  77025. url: string,
  77026. /**
  77027. * Defines the desired size (the more it increases the longer the generation will be)
  77028. */
  77029. size: number,
  77030. /**
  77031. * Defines if mipmaps should not be generated (default is false)
  77032. */
  77033. noMipmap?: boolean,
  77034. /**
  77035. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77036. */
  77037. generateHarmonics?: boolean,
  77038. /**
  77039. * 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)
  77040. */
  77041. gammaSpace?: boolean,
  77042. /**
  77043. * Internal Use Only
  77044. */
  77045. reserved?: boolean);
  77046. /**
  77047. * Execute the current task
  77048. * @param scene defines the scene where you want your assets to be loaded
  77049. * @param onSuccess is a callback called when the task is successfully executed
  77050. * @param onError is a callback called if an error occurs
  77051. */
  77052. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77053. }
  77054. /**
  77055. * Define a task used by AssetsManager to load Equirectangular cube textures
  77056. */
  77057. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77058. /**
  77059. * Defines the name of the task
  77060. */
  77061. name: string;
  77062. /**
  77063. * Defines the location of the file to load
  77064. */
  77065. url: string;
  77066. /**
  77067. * Defines the desired size (the more it increases the longer the generation will be)
  77068. */
  77069. size: number;
  77070. /**
  77071. * Defines if mipmaps should not be generated (default is false)
  77072. */
  77073. noMipmap: boolean;
  77074. /**
  77075. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77076. * but the standard material would require them in Gamma space) (default is true)
  77077. */
  77078. gammaSpace: boolean;
  77079. /**
  77080. * Gets the loaded texture
  77081. */
  77082. texture: EquiRectangularCubeTexture;
  77083. /**
  77084. * Callback called when the task is successful
  77085. */
  77086. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77087. /**
  77088. * Callback called when the task is successful
  77089. */
  77090. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77091. /**
  77092. * Creates a new EquiRectangularCubeTextureAssetTask object
  77093. * @param name defines the name of the task
  77094. * @param url defines the location of the file to load
  77095. * @param size defines the desired size (the more it increases the longer the generation will be)
  77096. * If the size is omitted this implies you are using a preprocessed cubemap.
  77097. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77098. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77099. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77100. * (default is true)
  77101. */
  77102. constructor(
  77103. /**
  77104. * Defines the name of the task
  77105. */
  77106. name: string,
  77107. /**
  77108. * Defines the location of the file to load
  77109. */
  77110. url: string,
  77111. /**
  77112. * Defines the desired size (the more it increases the longer the generation will be)
  77113. */
  77114. size: number,
  77115. /**
  77116. * Defines if mipmaps should not be generated (default is false)
  77117. */
  77118. noMipmap?: boolean,
  77119. /**
  77120. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77121. * but the standard material would require them in Gamma space) (default is true)
  77122. */
  77123. gammaSpace?: boolean);
  77124. /**
  77125. * Execute the current task
  77126. * @param scene defines the scene where you want your assets to be loaded
  77127. * @param onSuccess is a callback called when the task is successfully executed
  77128. * @param onError is a callback called if an error occurs
  77129. */
  77130. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77131. }
  77132. /**
  77133. * This class can be used to easily import assets into a scene
  77134. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77135. */
  77136. export class AssetsManager {
  77137. private _scene;
  77138. private _isLoading;
  77139. protected _tasks: AbstractAssetTask[];
  77140. protected _waitingTasksCount: number;
  77141. protected _totalTasksCount: number;
  77142. /**
  77143. * Callback called when all tasks are processed
  77144. */
  77145. onFinish: (tasks: AbstractAssetTask[]) => void;
  77146. /**
  77147. * Callback called when a task is successful
  77148. */
  77149. onTaskSuccess: (task: AbstractAssetTask) => void;
  77150. /**
  77151. * Callback called when a task had an error
  77152. */
  77153. onTaskError: (task: AbstractAssetTask) => void;
  77154. /**
  77155. * Callback called when a task is done (whatever the result is)
  77156. */
  77157. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77158. /**
  77159. * Observable called when all tasks are processed
  77160. */
  77161. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77162. /**
  77163. * Observable called when a task had an error
  77164. */
  77165. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77166. /**
  77167. * Observable called when all tasks were executed
  77168. */
  77169. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77170. /**
  77171. * Observable called when a task is done (whatever the result is)
  77172. */
  77173. onProgressObservable: Observable<IAssetsProgressEvent>;
  77174. /**
  77175. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77176. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77177. */
  77178. useDefaultLoadingScreen: boolean;
  77179. /**
  77180. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77181. * when all assets have been downloaded.
  77182. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77183. */
  77184. autoHideLoadingUI: boolean;
  77185. /**
  77186. * Creates a new AssetsManager
  77187. * @param scene defines the scene to work on
  77188. */
  77189. constructor(scene: Scene);
  77190. /**
  77191. * Add a ContainerAssetTask to the list of active tasks
  77192. * @param taskName defines the name of the new task
  77193. * @param meshesNames defines the name of meshes to load
  77194. * @param rootUrl defines the root url to use to locate files
  77195. * @param sceneFilename defines the filename of the scene file
  77196. * @returns a new ContainerAssetTask object
  77197. */
  77198. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77199. /**
  77200. * Add a MeshAssetTask to the list of active tasks
  77201. * @param taskName defines the name of the new task
  77202. * @param meshesNames defines the name of meshes to load
  77203. * @param rootUrl defines the root url to use to locate files
  77204. * @param sceneFilename defines the filename of the scene file
  77205. * @returns a new MeshAssetTask object
  77206. */
  77207. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77208. /**
  77209. * Add a TextFileAssetTask to the list of active tasks
  77210. * @param taskName defines the name of the new task
  77211. * @param url defines the url of the file to load
  77212. * @returns a new TextFileAssetTask object
  77213. */
  77214. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77215. /**
  77216. * Add a BinaryFileAssetTask to the list of active tasks
  77217. * @param taskName defines the name of the new task
  77218. * @param url defines the url of the file to load
  77219. * @returns a new BinaryFileAssetTask object
  77220. */
  77221. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77222. /**
  77223. * Add a ImageAssetTask to the list of active tasks
  77224. * @param taskName defines the name of the new task
  77225. * @param url defines the url of the file to load
  77226. * @returns a new ImageAssetTask object
  77227. */
  77228. addImageTask(taskName: string, url: string): ImageAssetTask;
  77229. /**
  77230. * Add a TextureAssetTask to the list of active tasks
  77231. * @param taskName defines the name of the new task
  77232. * @param url defines the url of the file to load
  77233. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77234. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77235. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77236. * @returns a new TextureAssetTask object
  77237. */
  77238. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77239. /**
  77240. * Add a CubeTextureAssetTask to the list of active tasks
  77241. * @param taskName defines the name of the new task
  77242. * @param url defines the url of the file to load
  77243. * @param extensions defines the extension to use to load the cube map (can be null)
  77244. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77245. * @param files defines the list of files to load (can be null)
  77246. * @returns a new CubeTextureAssetTask object
  77247. */
  77248. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77249. /**
  77250. *
  77251. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77252. * @param taskName defines the name of the new task
  77253. * @param url defines the url of the file to load
  77254. * @param size defines the size you want for the cubemap (can be null)
  77255. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77256. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77257. * @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)
  77258. * @param reserved Internal use only
  77259. * @returns a new HDRCubeTextureAssetTask object
  77260. */
  77261. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77262. /**
  77263. *
  77264. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77265. * @param taskName defines the name of the new task
  77266. * @param url defines the url of the file to load
  77267. * @param size defines the size you want for the cubemap (can be null)
  77268. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77269. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77270. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77271. * @returns a new EquiRectangularCubeTextureAssetTask object
  77272. */
  77273. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77274. /**
  77275. * Remove a task from the assets manager.
  77276. * @param task the task to remove
  77277. */
  77278. removeTask(task: AbstractAssetTask): void;
  77279. private _decreaseWaitingTasksCount;
  77280. private _runTask;
  77281. /**
  77282. * Reset the AssetsManager and remove all tasks
  77283. * @return the current instance of the AssetsManager
  77284. */
  77285. reset(): AssetsManager;
  77286. /**
  77287. * Start the loading process
  77288. * @return the current instance of the AssetsManager
  77289. */
  77290. load(): AssetsManager;
  77291. /**
  77292. * Start the loading process as an async operation
  77293. * @return a promise returning the list of failed tasks
  77294. */
  77295. loadAsync(): Promise<void>;
  77296. }
  77297. }
  77298. declare module "babylonjs/Misc/deferred" {
  77299. /**
  77300. * Wrapper class for promise with external resolve and reject.
  77301. */
  77302. export class Deferred<T> {
  77303. /**
  77304. * The promise associated with this deferred object.
  77305. */
  77306. readonly promise: Promise<T>;
  77307. private _resolve;
  77308. private _reject;
  77309. /**
  77310. * The resolve method of the promise associated with this deferred object.
  77311. */
  77312. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77313. /**
  77314. * The reject method of the promise associated with this deferred object.
  77315. */
  77316. get reject(): (reason?: any) => void;
  77317. /**
  77318. * Constructor for this deferred object.
  77319. */
  77320. constructor();
  77321. }
  77322. }
  77323. declare module "babylonjs/Misc/meshExploder" {
  77324. import { Mesh } from "babylonjs/Meshes/mesh";
  77325. /**
  77326. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77327. */
  77328. export class MeshExploder {
  77329. private _centerMesh;
  77330. private _meshes;
  77331. private _meshesOrigins;
  77332. private _toCenterVectors;
  77333. private _scaledDirection;
  77334. private _newPosition;
  77335. private _centerPosition;
  77336. /**
  77337. * Explodes meshes from a center mesh.
  77338. * @param meshes The meshes to explode.
  77339. * @param centerMesh The mesh to be center of explosion.
  77340. */
  77341. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77342. private _setCenterMesh;
  77343. /**
  77344. * Get class name
  77345. * @returns "MeshExploder"
  77346. */
  77347. getClassName(): string;
  77348. /**
  77349. * "Exploded meshes"
  77350. * @returns Array of meshes with the centerMesh at index 0.
  77351. */
  77352. getMeshes(): Array<Mesh>;
  77353. /**
  77354. * Explodes meshes giving a specific direction
  77355. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77356. */
  77357. explode(direction?: number): void;
  77358. }
  77359. }
  77360. declare module "babylonjs/Misc/filesInput" {
  77361. import { Engine } from "babylonjs/Engines/engine";
  77362. import { Scene } from "babylonjs/scene";
  77363. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77364. import { Nullable } from "babylonjs/types";
  77365. /**
  77366. * Class used to help managing file picking and drag'n'drop
  77367. */
  77368. export class FilesInput {
  77369. /**
  77370. * List of files ready to be loaded
  77371. */
  77372. static get FilesToLoad(): {
  77373. [key: string]: File;
  77374. };
  77375. /**
  77376. * Callback called when a file is processed
  77377. */
  77378. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77379. private _engine;
  77380. private _currentScene;
  77381. private _sceneLoadedCallback;
  77382. private _progressCallback;
  77383. private _additionalRenderLoopLogicCallback;
  77384. private _textureLoadingCallback;
  77385. private _startingProcessingFilesCallback;
  77386. private _onReloadCallback;
  77387. private _errorCallback;
  77388. private _elementToMonitor;
  77389. private _sceneFileToLoad;
  77390. private _filesToLoad;
  77391. /**
  77392. * Creates a new FilesInput
  77393. * @param engine defines the rendering engine
  77394. * @param scene defines the hosting scene
  77395. * @param sceneLoadedCallback callback called when scene is loaded
  77396. * @param progressCallback callback called to track progress
  77397. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77398. * @param textureLoadingCallback callback called when a texture is loading
  77399. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77400. * @param onReloadCallback callback called when a reload is requested
  77401. * @param errorCallback callback call if an error occurs
  77402. */
  77403. 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>);
  77404. private _dragEnterHandler;
  77405. private _dragOverHandler;
  77406. private _dropHandler;
  77407. /**
  77408. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77409. * @param elementToMonitor defines the DOM element to track
  77410. */
  77411. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77412. /** Gets the current list of files to load */
  77413. get filesToLoad(): File[];
  77414. /**
  77415. * Release all associated resources
  77416. */
  77417. dispose(): void;
  77418. private renderFunction;
  77419. private drag;
  77420. private drop;
  77421. private _traverseFolder;
  77422. private _processFiles;
  77423. /**
  77424. * Load files from a drop event
  77425. * @param event defines the drop event to use as source
  77426. */
  77427. loadFiles(event: any): void;
  77428. private _processReload;
  77429. /**
  77430. * Reload the current scene from the loaded files
  77431. */
  77432. reload(): void;
  77433. }
  77434. }
  77435. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77436. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77437. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77438. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77439. }
  77440. declare module "babylonjs/Misc/sceneOptimizer" {
  77441. import { Scene, IDisposable } from "babylonjs/scene";
  77442. import { Observable } from "babylonjs/Misc/observable";
  77443. /**
  77444. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77445. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77446. */
  77447. export class SceneOptimization {
  77448. /**
  77449. * Defines the priority of this optimization (0 by default which means first in the list)
  77450. */
  77451. priority: number;
  77452. /**
  77453. * Gets a string describing the action executed by the current optimization
  77454. * @returns description string
  77455. */
  77456. getDescription(): string;
  77457. /**
  77458. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77459. * @param scene defines the current scene where to apply this optimization
  77460. * @param optimizer defines the current optimizer
  77461. * @returns true if everything that can be done was applied
  77462. */
  77463. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77464. /**
  77465. * Creates the SceneOptimization object
  77466. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77467. * @param desc defines the description associated with the optimization
  77468. */
  77469. constructor(
  77470. /**
  77471. * Defines the priority of this optimization (0 by default which means first in the list)
  77472. */
  77473. priority?: number);
  77474. }
  77475. /**
  77476. * Defines an optimization used to reduce the size of render target textures
  77477. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77478. */
  77479. export class TextureOptimization extends SceneOptimization {
  77480. /**
  77481. * Defines the priority of this optimization (0 by default which means first in the list)
  77482. */
  77483. priority: number;
  77484. /**
  77485. * 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
  77486. */
  77487. maximumSize: number;
  77488. /**
  77489. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77490. */
  77491. step: number;
  77492. /**
  77493. * Gets a string describing the action executed by the current optimization
  77494. * @returns description string
  77495. */
  77496. getDescription(): string;
  77497. /**
  77498. * Creates the TextureOptimization object
  77499. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77500. * @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
  77501. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77502. */
  77503. constructor(
  77504. /**
  77505. * Defines the priority of this optimization (0 by default which means first in the list)
  77506. */
  77507. priority?: number,
  77508. /**
  77509. * 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
  77510. */
  77511. maximumSize?: number,
  77512. /**
  77513. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77514. */
  77515. step?: number);
  77516. /**
  77517. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77518. * @param scene defines the current scene where to apply this optimization
  77519. * @param optimizer defines the current optimizer
  77520. * @returns true if everything that can be done was applied
  77521. */
  77522. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77523. }
  77524. /**
  77525. * Defines an optimization used to increase or decrease the rendering resolution
  77526. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77527. */
  77528. export class HardwareScalingOptimization extends SceneOptimization {
  77529. /**
  77530. * Defines the priority of this optimization (0 by default which means first in the list)
  77531. */
  77532. priority: number;
  77533. /**
  77534. * Defines the maximum scale to use (2 by default)
  77535. */
  77536. maximumScale: number;
  77537. /**
  77538. * Defines the step to use between two passes (0.5 by default)
  77539. */
  77540. step: number;
  77541. private _currentScale;
  77542. private _directionOffset;
  77543. /**
  77544. * Gets a string describing the action executed by the current optimization
  77545. * @return description string
  77546. */
  77547. getDescription(): string;
  77548. /**
  77549. * Creates the HardwareScalingOptimization object
  77550. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77551. * @param maximumScale defines the maximum scale to use (2 by default)
  77552. * @param step defines the step to use between two passes (0.5 by default)
  77553. */
  77554. constructor(
  77555. /**
  77556. * Defines the priority of this optimization (0 by default which means first in the list)
  77557. */
  77558. priority?: number,
  77559. /**
  77560. * Defines the maximum scale to use (2 by default)
  77561. */
  77562. maximumScale?: number,
  77563. /**
  77564. * Defines the step to use between two passes (0.5 by default)
  77565. */
  77566. step?: number);
  77567. /**
  77568. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77569. * @param scene defines the current scene where to apply this optimization
  77570. * @param optimizer defines the current optimizer
  77571. * @returns true if everything that can be done was applied
  77572. */
  77573. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77574. }
  77575. /**
  77576. * Defines an optimization used to remove shadows
  77577. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77578. */
  77579. export class ShadowsOptimization extends SceneOptimization {
  77580. /**
  77581. * Gets a string describing the action executed by the current optimization
  77582. * @return description string
  77583. */
  77584. getDescription(): string;
  77585. /**
  77586. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77587. * @param scene defines the current scene where to apply this optimization
  77588. * @param optimizer defines the current optimizer
  77589. * @returns true if everything that can be done was applied
  77590. */
  77591. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77592. }
  77593. /**
  77594. * Defines an optimization used to turn post-processes off
  77595. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77596. */
  77597. export class PostProcessesOptimization extends SceneOptimization {
  77598. /**
  77599. * Gets a string describing the action executed by the current optimization
  77600. * @return description string
  77601. */
  77602. getDescription(): string;
  77603. /**
  77604. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77605. * @param scene defines the current scene where to apply this optimization
  77606. * @param optimizer defines the current optimizer
  77607. * @returns true if everything that can be done was applied
  77608. */
  77609. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77610. }
  77611. /**
  77612. * Defines an optimization used to turn lens flares off
  77613. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77614. */
  77615. export class LensFlaresOptimization extends SceneOptimization {
  77616. /**
  77617. * Gets a string describing the action executed by the current optimization
  77618. * @return description string
  77619. */
  77620. getDescription(): string;
  77621. /**
  77622. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77623. * @param scene defines the current scene where to apply this optimization
  77624. * @param optimizer defines the current optimizer
  77625. * @returns true if everything that can be done was applied
  77626. */
  77627. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77628. }
  77629. /**
  77630. * Defines an optimization based on user defined callback.
  77631. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77632. */
  77633. export class CustomOptimization extends SceneOptimization {
  77634. /**
  77635. * Callback called to apply the custom optimization.
  77636. */
  77637. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77638. /**
  77639. * Callback called to get custom description
  77640. */
  77641. onGetDescription: () => string;
  77642. /**
  77643. * Gets a string describing the action executed by the current optimization
  77644. * @returns description string
  77645. */
  77646. getDescription(): string;
  77647. /**
  77648. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77649. * @param scene defines the current scene where to apply this optimization
  77650. * @param optimizer defines the current optimizer
  77651. * @returns true if everything that can be done was applied
  77652. */
  77653. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77654. }
  77655. /**
  77656. * Defines an optimization used to turn particles off
  77657. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77658. */
  77659. export class ParticlesOptimization extends SceneOptimization {
  77660. /**
  77661. * Gets a string describing the action executed by the current optimization
  77662. * @return description string
  77663. */
  77664. getDescription(): string;
  77665. /**
  77666. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77667. * @param scene defines the current scene where to apply this optimization
  77668. * @param optimizer defines the current optimizer
  77669. * @returns true if everything that can be done was applied
  77670. */
  77671. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77672. }
  77673. /**
  77674. * Defines an optimization used to turn render targets off
  77675. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77676. */
  77677. export class RenderTargetsOptimization extends SceneOptimization {
  77678. /**
  77679. * Gets a string describing the action executed by the current optimization
  77680. * @return description string
  77681. */
  77682. getDescription(): string;
  77683. /**
  77684. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77685. * @param scene defines the current scene where to apply this optimization
  77686. * @param optimizer defines the current optimizer
  77687. * @returns true if everything that can be done was applied
  77688. */
  77689. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77690. }
  77691. /**
  77692. * Defines an optimization used to merge meshes with compatible materials
  77693. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77694. */
  77695. export class MergeMeshesOptimization extends SceneOptimization {
  77696. private static _UpdateSelectionTree;
  77697. /**
  77698. * Gets or sets a boolean which defines if optimization octree has to be updated
  77699. */
  77700. static get UpdateSelectionTree(): boolean;
  77701. /**
  77702. * Gets or sets a boolean which defines if optimization octree has to be updated
  77703. */
  77704. static set UpdateSelectionTree(value: boolean);
  77705. /**
  77706. * Gets a string describing the action executed by the current optimization
  77707. * @return description string
  77708. */
  77709. getDescription(): string;
  77710. private _canBeMerged;
  77711. /**
  77712. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77713. * @param scene defines the current scene where to apply this optimization
  77714. * @param optimizer defines the current optimizer
  77715. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77716. * @returns true if everything that can be done was applied
  77717. */
  77718. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77719. }
  77720. /**
  77721. * Defines a list of options used by SceneOptimizer
  77722. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77723. */
  77724. export class SceneOptimizerOptions {
  77725. /**
  77726. * Defines the target frame rate to reach (60 by default)
  77727. */
  77728. targetFrameRate: number;
  77729. /**
  77730. * Defines the interval between two checkes (2000ms by default)
  77731. */
  77732. trackerDuration: number;
  77733. /**
  77734. * Gets the list of optimizations to apply
  77735. */
  77736. optimizations: SceneOptimization[];
  77737. /**
  77738. * Creates a new list of options used by SceneOptimizer
  77739. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77740. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77741. */
  77742. constructor(
  77743. /**
  77744. * Defines the target frame rate to reach (60 by default)
  77745. */
  77746. targetFrameRate?: number,
  77747. /**
  77748. * Defines the interval between two checkes (2000ms by default)
  77749. */
  77750. trackerDuration?: number);
  77751. /**
  77752. * Add a new optimization
  77753. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77754. * @returns the current SceneOptimizerOptions
  77755. */
  77756. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77757. /**
  77758. * Add a new custom optimization
  77759. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77760. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77761. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77762. * @returns the current SceneOptimizerOptions
  77763. */
  77764. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77765. /**
  77766. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77767. * @param targetFrameRate defines the target frame rate (60 by default)
  77768. * @returns a SceneOptimizerOptions object
  77769. */
  77770. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77771. /**
  77772. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77773. * @param targetFrameRate defines the target frame rate (60 by default)
  77774. * @returns a SceneOptimizerOptions object
  77775. */
  77776. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77777. /**
  77778. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77779. * @param targetFrameRate defines the target frame rate (60 by default)
  77780. * @returns a SceneOptimizerOptions object
  77781. */
  77782. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77783. }
  77784. /**
  77785. * Class used to run optimizations in order to reach a target frame rate
  77786. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77787. */
  77788. export class SceneOptimizer implements IDisposable {
  77789. private _isRunning;
  77790. private _options;
  77791. private _scene;
  77792. private _currentPriorityLevel;
  77793. private _targetFrameRate;
  77794. private _trackerDuration;
  77795. private _currentFrameRate;
  77796. private _sceneDisposeObserver;
  77797. private _improvementMode;
  77798. /**
  77799. * Defines an observable called when the optimizer reaches the target frame rate
  77800. */
  77801. onSuccessObservable: Observable<SceneOptimizer>;
  77802. /**
  77803. * Defines an observable called when the optimizer enables an optimization
  77804. */
  77805. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77806. /**
  77807. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77808. */
  77809. onFailureObservable: Observable<SceneOptimizer>;
  77810. /**
  77811. * Gets a boolean indicating if the optimizer is in improvement mode
  77812. */
  77813. get isInImprovementMode(): boolean;
  77814. /**
  77815. * Gets the current priority level (0 at start)
  77816. */
  77817. get currentPriorityLevel(): number;
  77818. /**
  77819. * Gets the current frame rate checked by the SceneOptimizer
  77820. */
  77821. get currentFrameRate(): number;
  77822. /**
  77823. * Gets or sets the current target frame rate (60 by default)
  77824. */
  77825. get targetFrameRate(): number;
  77826. /**
  77827. * Gets or sets the current target frame rate (60 by default)
  77828. */
  77829. set targetFrameRate(value: number);
  77830. /**
  77831. * Gets or sets the current interval between two checks (every 2000ms by default)
  77832. */
  77833. get trackerDuration(): number;
  77834. /**
  77835. * Gets or sets the current interval between two checks (every 2000ms by default)
  77836. */
  77837. set trackerDuration(value: number);
  77838. /**
  77839. * Gets the list of active optimizations
  77840. */
  77841. get optimizations(): SceneOptimization[];
  77842. /**
  77843. * Creates a new SceneOptimizer
  77844. * @param scene defines the scene to work on
  77845. * @param options defines the options to use with the SceneOptimizer
  77846. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77847. * @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)
  77848. */
  77849. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77850. /**
  77851. * Stops the current optimizer
  77852. */
  77853. stop(): void;
  77854. /**
  77855. * Reset the optimizer to initial step (current priority level = 0)
  77856. */
  77857. reset(): void;
  77858. /**
  77859. * Start the optimizer. By default it will try to reach a specific framerate
  77860. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77861. */
  77862. start(): void;
  77863. private _checkCurrentState;
  77864. /**
  77865. * Release all resources
  77866. */
  77867. dispose(): void;
  77868. /**
  77869. * Helper function to create a SceneOptimizer with one single line of code
  77870. * @param scene defines the scene to work on
  77871. * @param options defines the options to use with the SceneOptimizer
  77872. * @param onSuccess defines a callback to call on success
  77873. * @param onFailure defines a callback to call on failure
  77874. * @returns the new SceneOptimizer object
  77875. */
  77876. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77877. }
  77878. }
  77879. declare module "babylonjs/Misc/sceneSerializer" {
  77880. import { Scene } from "babylonjs/scene";
  77881. /**
  77882. * Class used to serialize a scene into a string
  77883. */
  77884. export class SceneSerializer {
  77885. /**
  77886. * Clear cache used by a previous serialization
  77887. */
  77888. static ClearCache(): void;
  77889. /**
  77890. * Serialize a scene into a JSON compatible object
  77891. * @param scene defines the scene to serialize
  77892. * @returns a JSON compatible object
  77893. */
  77894. static Serialize(scene: Scene): any;
  77895. /**
  77896. * Serialize a mesh into a JSON compatible object
  77897. * @param toSerialize defines the mesh to serialize
  77898. * @param withParents defines if parents must be serialized as well
  77899. * @param withChildren defines if children must be serialized as well
  77900. * @returns a JSON compatible object
  77901. */
  77902. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77903. }
  77904. }
  77905. declare module "babylonjs/Misc/textureTools" {
  77906. import { Texture } from "babylonjs/Materials/Textures/texture";
  77907. /**
  77908. * Class used to host texture specific utilities
  77909. */
  77910. export class TextureTools {
  77911. /**
  77912. * Uses the GPU to create a copy texture rescaled at a given size
  77913. * @param texture Texture to copy from
  77914. * @param width defines the desired width
  77915. * @param height defines the desired height
  77916. * @param useBilinearMode defines if bilinear mode has to be used
  77917. * @return the generated texture
  77918. */
  77919. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77920. }
  77921. }
  77922. declare module "babylonjs/Misc/videoRecorder" {
  77923. import { Nullable } from "babylonjs/types";
  77924. import { Engine } from "babylonjs/Engines/engine";
  77925. /**
  77926. * This represents the different options available for the video capture.
  77927. */
  77928. export interface VideoRecorderOptions {
  77929. /** Defines the mime type of the video. */
  77930. mimeType: string;
  77931. /** Defines the FPS the video should be recorded at. */
  77932. fps: number;
  77933. /** Defines the chunk size for the recording data. */
  77934. recordChunckSize: number;
  77935. /** The audio tracks to attach to the recording. */
  77936. audioTracks?: MediaStreamTrack[];
  77937. }
  77938. /**
  77939. * This can help with recording videos from BabylonJS.
  77940. * This is based on the available WebRTC functionalities of the browser.
  77941. *
  77942. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77943. */
  77944. export class VideoRecorder {
  77945. private static readonly _defaultOptions;
  77946. /**
  77947. * Returns whether or not the VideoRecorder is available in your browser.
  77948. * @param engine Defines the Babylon Engine.
  77949. * @returns true if supported otherwise false.
  77950. */
  77951. static IsSupported(engine: Engine): boolean;
  77952. private readonly _options;
  77953. private _canvas;
  77954. private _mediaRecorder;
  77955. private _recordedChunks;
  77956. private _fileName;
  77957. private _resolve;
  77958. private _reject;
  77959. /**
  77960. * True when a recording is already in progress.
  77961. */
  77962. get isRecording(): boolean;
  77963. /**
  77964. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77965. * @param engine Defines the BabylonJS Engine you wish to record.
  77966. * @param options Defines options that can be used to customize the capture.
  77967. */
  77968. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77969. /**
  77970. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77971. */
  77972. stopRecording(): void;
  77973. /**
  77974. * Starts recording the canvas for a max duration specified in parameters.
  77975. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77976. * If null no automatic download will start and you can rely on the promise to get the data back.
  77977. * @param maxDuration Defines the maximum recording time in seconds.
  77978. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77979. * @return A promise callback at the end of the recording with the video data in Blob.
  77980. */
  77981. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77982. /**
  77983. * Releases internal resources used during the recording.
  77984. */
  77985. dispose(): void;
  77986. private _handleDataAvailable;
  77987. private _handleError;
  77988. private _handleStop;
  77989. }
  77990. }
  77991. declare module "babylonjs/Misc/screenshotTools" {
  77992. import { Camera } from "babylonjs/Cameras/camera";
  77993. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77994. import { Engine } from "babylonjs/Engines/engine";
  77995. /**
  77996. * Class containing a set of static utilities functions for screenshots
  77997. */
  77998. export class ScreenshotTools {
  77999. /**
  78000. * Captures a screenshot of the current rendering
  78001. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78002. * @param engine defines the rendering engine
  78003. * @param camera defines the source camera
  78004. * @param size This parameter can be set to a single number or to an object with the
  78005. * following (optional) properties: precision, width, height. If a single number is passed,
  78006. * it will be used for both width and height. If an object is passed, the screenshot size
  78007. * will be derived from the parameters. The precision property is a multiplier allowing
  78008. * rendering at a higher or lower resolution
  78009. * @param successCallback defines the callback receives a single parameter which contains the
  78010. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78011. * src parameter of an <img> to display it
  78012. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78013. * Check your browser for supported MIME types
  78014. */
  78015. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78016. /**
  78017. * Captures a screenshot of the current rendering
  78018. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78019. * @param engine defines the rendering engine
  78020. * @param camera defines the source camera
  78021. * @param size This parameter can be set to a single number or to an object with the
  78022. * following (optional) properties: precision, width, height. If a single number is passed,
  78023. * it will be used for both width and height. If an object is passed, the screenshot size
  78024. * will be derived from the parameters. The precision property is a multiplier allowing
  78025. * rendering at a higher or lower resolution
  78026. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78027. * Check your browser for supported MIME types
  78028. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78029. * to the src parameter of an <img> to display it
  78030. */
  78031. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78032. /**
  78033. * Generates an image screenshot from the specified camera.
  78034. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78035. * @param engine The engine to use for rendering
  78036. * @param camera The camera to use for rendering
  78037. * @param size This parameter can be set to a single number or to an object with the
  78038. * following (optional) properties: precision, width, height. If a single number is passed,
  78039. * it will be used for both width and height. If an object is passed, the screenshot size
  78040. * will be derived from the parameters. The precision property is a multiplier allowing
  78041. * rendering at a higher or lower resolution
  78042. * @param successCallback The callback receives a single parameter which contains the
  78043. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78044. * src parameter of an <img> to display it
  78045. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78046. * Check your browser for supported MIME types
  78047. * @param samples Texture samples (default: 1)
  78048. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78049. * @param fileName A name for for the downloaded file.
  78050. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78051. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78052. */
  78053. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  78054. /**
  78055. * Generates an image screenshot from the specified camera.
  78056. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78057. * @param engine The engine to use for rendering
  78058. * @param camera The camera to use for rendering
  78059. * @param size This parameter can be set to a single number or to an object with the
  78060. * following (optional) properties: precision, width, height. If a single number is passed,
  78061. * it will be used for both width and height. If an object is passed, the screenshot size
  78062. * will be derived from the parameters. The precision property is a multiplier allowing
  78063. * rendering at a higher or lower resolution
  78064. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78065. * Check your browser for supported MIME types
  78066. * @param samples Texture samples (default: 1)
  78067. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78068. * @param fileName A name for for the downloaded file.
  78069. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78070. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78071. * to the src parameter of an <img> to display it
  78072. */
  78073. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78074. /**
  78075. * Gets height and width for screenshot size
  78076. * @private
  78077. */
  78078. private static _getScreenshotSize;
  78079. }
  78080. }
  78081. declare module "babylonjs/Misc/dataReader" {
  78082. /**
  78083. * Interface for a data buffer
  78084. */
  78085. export interface IDataBuffer {
  78086. /**
  78087. * Reads bytes from the data buffer.
  78088. * @param byteOffset The byte offset to read
  78089. * @param byteLength The byte length to read
  78090. * @returns A promise that resolves when the bytes are read
  78091. */
  78092. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78093. /**
  78094. * The byte length of the buffer.
  78095. */
  78096. readonly byteLength: number;
  78097. }
  78098. /**
  78099. * Utility class for reading from a data buffer
  78100. */
  78101. export class DataReader {
  78102. /**
  78103. * The data buffer associated with this data reader.
  78104. */
  78105. readonly buffer: IDataBuffer;
  78106. /**
  78107. * The current byte offset from the beginning of the data buffer.
  78108. */
  78109. byteOffset: number;
  78110. private _dataView;
  78111. private _dataByteOffset;
  78112. /**
  78113. * Constructor
  78114. * @param buffer The buffer to read
  78115. */
  78116. constructor(buffer: IDataBuffer);
  78117. /**
  78118. * Loads the given byte length.
  78119. * @param byteLength The byte length to load
  78120. * @returns A promise that resolves when the load is complete
  78121. */
  78122. loadAsync(byteLength: number): Promise<void>;
  78123. /**
  78124. * Read a unsigned 32-bit integer from the currently loaded data range.
  78125. * @returns The 32-bit integer read
  78126. */
  78127. readUint32(): number;
  78128. /**
  78129. * Read a byte array from the currently loaded data range.
  78130. * @param byteLength The byte length to read
  78131. * @returns The byte array read
  78132. */
  78133. readUint8Array(byteLength: number): Uint8Array;
  78134. /**
  78135. * Read a string from the currently loaded data range.
  78136. * @param byteLength The byte length to read
  78137. * @returns The string read
  78138. */
  78139. readString(byteLength: number): string;
  78140. /**
  78141. * Skips the given byte length the currently loaded data range.
  78142. * @param byteLength The byte length to skip
  78143. */
  78144. skipBytes(byteLength: number): void;
  78145. }
  78146. }
  78147. declare module "babylonjs/Misc/dataStorage" {
  78148. /**
  78149. * Class for storing data to local storage if available or in-memory storage otherwise
  78150. */
  78151. export class DataStorage {
  78152. private static _Storage;
  78153. private static _GetStorage;
  78154. /**
  78155. * Reads a string from the data storage
  78156. * @param key The key to read
  78157. * @param defaultValue The value if the key doesn't exist
  78158. * @returns The string value
  78159. */
  78160. static ReadString(key: string, defaultValue: string): string;
  78161. /**
  78162. * Writes a string to the data storage
  78163. * @param key The key to write
  78164. * @param value The value to write
  78165. */
  78166. static WriteString(key: string, value: string): void;
  78167. /**
  78168. * Reads a boolean from the data storage
  78169. * @param key The key to read
  78170. * @param defaultValue The value if the key doesn't exist
  78171. * @returns The boolean value
  78172. */
  78173. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78174. /**
  78175. * Writes a boolean to the data storage
  78176. * @param key The key to write
  78177. * @param value The value to write
  78178. */
  78179. static WriteBoolean(key: string, value: boolean): void;
  78180. /**
  78181. * Reads a number from the data storage
  78182. * @param key The key to read
  78183. * @param defaultValue The value if the key doesn't exist
  78184. * @returns The number value
  78185. */
  78186. static ReadNumber(key: string, defaultValue: number): number;
  78187. /**
  78188. * Writes a number to the data storage
  78189. * @param key The key to write
  78190. * @param value The value to write
  78191. */
  78192. static WriteNumber(key: string, value: number): void;
  78193. }
  78194. }
  78195. declare module "babylonjs/Misc/sceneRecorder" {
  78196. import { Scene } from "babylonjs/scene";
  78197. /**
  78198. * Class used to record delta files between 2 scene states
  78199. */
  78200. export class SceneRecorder {
  78201. private _trackedScene;
  78202. private _savedJSON;
  78203. /**
  78204. * Track a given scene. This means the current scene state will be considered the original state
  78205. * @param scene defines the scene to track
  78206. */
  78207. track(scene: Scene): void;
  78208. /**
  78209. * Get the delta between current state and original state
  78210. * @returns a string containing the delta
  78211. */
  78212. getDelta(): any;
  78213. private _compareArray;
  78214. private _compareObjects;
  78215. private _compareCollections;
  78216. private static GetShadowGeneratorById;
  78217. /**
  78218. * Apply a given delta to a given scene
  78219. * @param deltaJSON defines the JSON containing the delta
  78220. * @param scene defines the scene to apply the delta to
  78221. */
  78222. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78223. private static _ApplyPropertiesToEntity;
  78224. private static _ApplyDeltaForEntity;
  78225. }
  78226. }
  78227. declare module "babylonjs/Misc/index" {
  78228. export * from "babylonjs/Misc/andOrNotEvaluator";
  78229. export * from "babylonjs/Misc/assetsManager";
  78230. export * from "babylonjs/Misc/basis";
  78231. export * from "babylonjs/Misc/dds";
  78232. export * from "babylonjs/Misc/decorators";
  78233. export * from "babylonjs/Misc/deferred";
  78234. export * from "babylonjs/Misc/environmentTextureTools";
  78235. export * from "babylonjs/Misc/meshExploder";
  78236. export * from "babylonjs/Misc/filesInput";
  78237. export * from "babylonjs/Misc/HighDynamicRange/index";
  78238. export * from "babylonjs/Misc/khronosTextureContainer";
  78239. export * from "babylonjs/Misc/observable";
  78240. export * from "babylonjs/Misc/performanceMonitor";
  78241. export * from "babylonjs/Misc/promise";
  78242. export * from "babylonjs/Misc/sceneOptimizer";
  78243. export * from "babylonjs/Misc/sceneSerializer";
  78244. export * from "babylonjs/Misc/smartArray";
  78245. export * from "babylonjs/Misc/stringDictionary";
  78246. export * from "babylonjs/Misc/tags";
  78247. export * from "babylonjs/Misc/textureTools";
  78248. export * from "babylonjs/Misc/tga";
  78249. export * from "babylonjs/Misc/tools";
  78250. export * from "babylonjs/Misc/videoRecorder";
  78251. export * from "babylonjs/Misc/virtualJoystick";
  78252. export * from "babylonjs/Misc/workerPool";
  78253. export * from "babylonjs/Misc/logger";
  78254. export * from "babylonjs/Misc/typeStore";
  78255. export * from "babylonjs/Misc/filesInputStore";
  78256. export * from "babylonjs/Misc/deepCopier";
  78257. export * from "babylonjs/Misc/pivotTools";
  78258. export * from "babylonjs/Misc/precisionDate";
  78259. export * from "babylonjs/Misc/screenshotTools";
  78260. export * from "babylonjs/Misc/typeStore";
  78261. export * from "babylonjs/Misc/webRequest";
  78262. export * from "babylonjs/Misc/iInspectable";
  78263. export * from "babylonjs/Misc/brdfTextureTools";
  78264. export * from "babylonjs/Misc/rgbdTextureTools";
  78265. export * from "babylonjs/Misc/gradients";
  78266. export * from "babylonjs/Misc/perfCounter";
  78267. export * from "babylonjs/Misc/fileRequest";
  78268. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78269. export * from "babylonjs/Misc/retryStrategy";
  78270. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78271. export * from "babylonjs/Misc/canvasGenerator";
  78272. export * from "babylonjs/Misc/fileTools";
  78273. export * from "babylonjs/Misc/stringTools";
  78274. export * from "babylonjs/Misc/dataReader";
  78275. export * from "babylonjs/Misc/minMaxReducer";
  78276. export * from "babylonjs/Misc/depthReducer";
  78277. export * from "babylonjs/Misc/dataStorage";
  78278. export * from "babylonjs/Misc/sceneRecorder";
  78279. }
  78280. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78281. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78282. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78283. import { Observable } from "babylonjs/Misc/observable";
  78284. import { Matrix } from "babylonjs/Maths/math.vector";
  78285. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78286. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78287. /**
  78288. * An interface for all Hit test features
  78289. */
  78290. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78291. /**
  78292. * Triggered when new babylon (transformed) hit test results are available
  78293. */
  78294. onHitTestResultObservable: Observable<T[]>;
  78295. }
  78296. /**
  78297. * Options used for hit testing
  78298. */
  78299. export interface IWebXRLegacyHitTestOptions {
  78300. /**
  78301. * Only test when user interacted with the scene. Default - hit test every frame
  78302. */
  78303. testOnPointerDownOnly?: boolean;
  78304. /**
  78305. * The node to use to transform the local results to world coordinates
  78306. */
  78307. worldParentNode?: TransformNode;
  78308. }
  78309. /**
  78310. * Interface defining the babylon result of raycasting/hit-test
  78311. */
  78312. export interface IWebXRLegacyHitResult {
  78313. /**
  78314. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78315. */
  78316. transformationMatrix: Matrix;
  78317. /**
  78318. * The native hit test result
  78319. */
  78320. xrHitResult: XRHitResult | XRHitTestResult;
  78321. }
  78322. /**
  78323. * The currently-working hit-test module.
  78324. * Hit test (or Ray-casting) is used to interact with the real world.
  78325. * For further information read here - https://github.com/immersive-web/hit-test
  78326. */
  78327. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78328. /**
  78329. * options to use when constructing this feature
  78330. */
  78331. readonly options: IWebXRLegacyHitTestOptions;
  78332. private _direction;
  78333. private _mat;
  78334. private _onSelectEnabled;
  78335. private _origin;
  78336. /**
  78337. * The module's name
  78338. */
  78339. static readonly Name: string;
  78340. /**
  78341. * The (Babylon) version of this module.
  78342. * This is an integer representing the implementation version.
  78343. * This number does not correspond to the WebXR specs version
  78344. */
  78345. static readonly Version: number;
  78346. /**
  78347. * Populated with the last native XR Hit Results
  78348. */
  78349. lastNativeXRHitResults: XRHitResult[];
  78350. /**
  78351. * Triggered when new babylon (transformed) hit test results are available
  78352. */
  78353. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78354. /**
  78355. * Creates a new instance of the (legacy version) hit test feature
  78356. * @param _xrSessionManager an instance of WebXRSessionManager
  78357. * @param options options to use when constructing this feature
  78358. */
  78359. constructor(_xrSessionManager: WebXRSessionManager,
  78360. /**
  78361. * options to use when constructing this feature
  78362. */
  78363. options?: IWebXRLegacyHitTestOptions);
  78364. /**
  78365. * execute a hit test with an XR Ray
  78366. *
  78367. * @param xrSession a native xrSession that will execute this hit test
  78368. * @param xrRay the ray (position and direction) to use for ray-casting
  78369. * @param referenceSpace native XR reference space to use for the hit-test
  78370. * @param filter filter function that will filter the results
  78371. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78372. */
  78373. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78374. /**
  78375. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78376. * @param event the (select) event to use to select with
  78377. * @param referenceSpace the reference space to use for this hit test
  78378. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78379. */
  78380. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78381. /**
  78382. * attach this feature
  78383. * Will usually be called by the features manager
  78384. *
  78385. * @returns true if successful.
  78386. */
  78387. attach(): boolean;
  78388. /**
  78389. * detach this feature.
  78390. * Will usually be called by the features manager
  78391. *
  78392. * @returns true if successful.
  78393. */
  78394. detach(): boolean;
  78395. /**
  78396. * Dispose this feature and all of the resources attached
  78397. */
  78398. dispose(): void;
  78399. protected _onXRFrame(frame: XRFrame): void;
  78400. private _onHitTestResults;
  78401. private _onSelect;
  78402. }
  78403. }
  78404. declare module "babylonjs/XR/features/WebXRHitTest" {
  78405. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78406. import { Observable } from "babylonjs/Misc/observable";
  78407. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78408. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78409. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78410. /**
  78411. * Options used for hit testing (version 2)
  78412. */
  78413. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78414. /**
  78415. * Do not create a permanent hit test. Will usually be used when only
  78416. * transient inputs are needed.
  78417. */
  78418. disablePermanentHitTest?: boolean;
  78419. /**
  78420. * Enable transient (for example touch-based) hit test inspections
  78421. */
  78422. enableTransientHitTest?: boolean;
  78423. /**
  78424. * Offset ray for the permanent hit test
  78425. */
  78426. offsetRay?: Vector3;
  78427. /**
  78428. * Offset ray for the transient hit test
  78429. */
  78430. transientOffsetRay?: Vector3;
  78431. /**
  78432. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78433. */
  78434. useReferenceSpace?: boolean;
  78435. /**
  78436. * Override the default entity type(s) of the hit-test result
  78437. */
  78438. entityTypes?: XRHitTestTrackableType[];
  78439. }
  78440. /**
  78441. * Interface defining the babylon result of hit-test
  78442. */
  78443. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78444. /**
  78445. * The input source that generated this hit test (if transient)
  78446. */
  78447. inputSource?: XRInputSource;
  78448. /**
  78449. * Is this a transient hit test
  78450. */
  78451. isTransient?: boolean;
  78452. /**
  78453. * Position of the hit test result
  78454. */
  78455. position: Vector3;
  78456. /**
  78457. * Rotation of the hit test result
  78458. */
  78459. rotationQuaternion: Quaternion;
  78460. /**
  78461. * The native hit test result
  78462. */
  78463. xrHitResult: XRHitTestResult;
  78464. }
  78465. /**
  78466. * The currently-working hit-test module.
  78467. * Hit test (or Ray-casting) is used to interact with the real world.
  78468. * For further information read here - https://github.com/immersive-web/hit-test
  78469. *
  78470. * Tested on chrome (mobile) 80.
  78471. */
  78472. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78473. /**
  78474. * options to use when constructing this feature
  78475. */
  78476. readonly options: IWebXRHitTestOptions;
  78477. private _tmpMat;
  78478. private _tmpPos;
  78479. private _tmpQuat;
  78480. private _transientXrHitTestSource;
  78481. private _xrHitTestSource;
  78482. private initHitTestSource;
  78483. /**
  78484. * The module's name
  78485. */
  78486. static readonly Name: string;
  78487. /**
  78488. * The (Babylon) version of this module.
  78489. * This is an integer representing the implementation version.
  78490. * This number does not correspond to the WebXR specs version
  78491. */
  78492. static readonly Version: number;
  78493. /**
  78494. * When set to true, each hit test will have its own position/rotation objects
  78495. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78496. * the developers will clone them or copy them as they see fit.
  78497. */
  78498. autoCloneTransformation: boolean;
  78499. /**
  78500. * Triggered when new babylon (transformed) hit test results are available
  78501. */
  78502. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78503. /**
  78504. * Use this to temporarily pause hit test checks.
  78505. */
  78506. paused: boolean;
  78507. /**
  78508. * Creates a new instance of the hit test feature
  78509. * @param _xrSessionManager an instance of WebXRSessionManager
  78510. * @param options options to use when constructing this feature
  78511. */
  78512. constructor(_xrSessionManager: WebXRSessionManager,
  78513. /**
  78514. * options to use when constructing this feature
  78515. */
  78516. options?: IWebXRHitTestOptions);
  78517. /**
  78518. * attach this feature
  78519. * Will usually be called by the features manager
  78520. *
  78521. * @returns true if successful.
  78522. */
  78523. attach(): boolean;
  78524. /**
  78525. * detach this feature.
  78526. * Will usually be called by the features manager
  78527. *
  78528. * @returns true if successful.
  78529. */
  78530. detach(): boolean;
  78531. /**
  78532. * Dispose this feature and all of the resources attached
  78533. */
  78534. dispose(): void;
  78535. protected _onXRFrame(frame: XRFrame): void;
  78536. private _processWebXRHitTestResult;
  78537. }
  78538. }
  78539. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78540. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78541. import { Observable } from "babylonjs/Misc/observable";
  78542. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78543. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78544. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78545. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78546. /**
  78547. * Configuration options of the anchor system
  78548. */
  78549. export interface IWebXRAnchorSystemOptions {
  78550. /**
  78551. * a node that will be used to convert local to world coordinates
  78552. */
  78553. worldParentNode?: TransformNode;
  78554. /**
  78555. * If set to true a reference of the created anchors will be kept until the next session starts
  78556. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78557. */
  78558. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78559. }
  78560. /**
  78561. * A babylon container for an XR Anchor
  78562. */
  78563. export interface IWebXRAnchor {
  78564. /**
  78565. * A babylon-assigned ID for this anchor
  78566. */
  78567. id: number;
  78568. /**
  78569. * Transformation matrix to apply to an object attached to this anchor
  78570. */
  78571. transformationMatrix: Matrix;
  78572. /**
  78573. * The native anchor object
  78574. */
  78575. xrAnchor: XRAnchor;
  78576. /**
  78577. * if defined, this object will be constantly updated by the anchor's position and rotation
  78578. */
  78579. attachedNode?: TransformNode;
  78580. }
  78581. /**
  78582. * An implementation of the anchor system for WebXR.
  78583. * For further information see https://github.com/immersive-web/anchors/
  78584. */
  78585. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78586. private _options;
  78587. private _lastFrameDetected;
  78588. private _trackedAnchors;
  78589. private _referenceSpaceForFrameAnchors;
  78590. private _futureAnchors;
  78591. /**
  78592. * The module's name
  78593. */
  78594. static readonly Name: string;
  78595. /**
  78596. * The (Babylon) version of this module.
  78597. * This is an integer representing the implementation version.
  78598. * This number does not correspond to the WebXR specs version
  78599. */
  78600. static readonly Version: number;
  78601. /**
  78602. * Observers registered here will be executed when a new anchor was added to the session
  78603. */
  78604. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78605. /**
  78606. * Observers registered here will be executed when an anchor was removed from the session
  78607. */
  78608. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78609. /**
  78610. * Observers registered here will be executed when an existing anchor updates
  78611. * This can execute N times every frame
  78612. */
  78613. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78614. /**
  78615. * Set the reference space to use for anchor creation, when not using a hit test.
  78616. * Will default to the session's reference space if not defined
  78617. */
  78618. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78619. /**
  78620. * constructs a new anchor system
  78621. * @param _xrSessionManager an instance of WebXRSessionManager
  78622. * @param _options configuration object for this feature
  78623. */
  78624. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78625. private _tmpVector;
  78626. private _tmpQuaternion;
  78627. private _populateTmpTransformation;
  78628. /**
  78629. * Create a new anchor point using a hit test result at a specific point in the scene
  78630. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78631. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78632. *
  78633. * @param hitTestResult The hit test result to use for this anchor creation
  78634. * @param position an optional position offset for this anchor
  78635. * @param rotationQuaternion an optional rotation offset for this anchor
  78636. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78637. */
  78638. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78639. /**
  78640. * Add a new anchor at a specific position and rotation
  78641. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78642. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78643. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78644. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78645. *
  78646. * @param position the position in which to add an anchor
  78647. * @param rotationQuaternion an optional rotation for the anchor transformation
  78648. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78649. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78650. */
  78651. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78652. /**
  78653. * detach this feature.
  78654. * Will usually be called by the features manager
  78655. *
  78656. * @returns true if successful.
  78657. */
  78658. detach(): boolean;
  78659. /**
  78660. * Dispose this feature and all of the resources attached
  78661. */
  78662. dispose(): void;
  78663. protected _onXRFrame(frame: XRFrame): void;
  78664. /**
  78665. * avoiding using Array.find for global support.
  78666. * @param xrAnchor the plane to find in the array
  78667. */
  78668. private _findIndexInAnchorArray;
  78669. private _updateAnchorWithXRFrame;
  78670. private _createAnchorAtTransformation;
  78671. }
  78672. }
  78673. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78674. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78675. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78676. import { Observable } from "babylonjs/Misc/observable";
  78677. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78678. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78679. /**
  78680. * Options used in the plane detector module
  78681. */
  78682. export interface IWebXRPlaneDetectorOptions {
  78683. /**
  78684. * The node to use to transform the local results to world coordinates
  78685. */
  78686. worldParentNode?: TransformNode;
  78687. /**
  78688. * If set to true a reference of the created planes will be kept until the next session starts
  78689. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78690. */
  78691. doNotRemovePlanesOnSessionEnded?: boolean;
  78692. }
  78693. /**
  78694. * A babylon interface for a WebXR plane.
  78695. * A Plane is actually a polygon, built from N points in space
  78696. *
  78697. * Supported in chrome 79, not supported in canary 81 ATM
  78698. */
  78699. export interface IWebXRPlane {
  78700. /**
  78701. * a babylon-assigned ID for this polygon
  78702. */
  78703. id: number;
  78704. /**
  78705. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78706. */
  78707. polygonDefinition: Array<Vector3>;
  78708. /**
  78709. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78710. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78711. */
  78712. transformationMatrix: Matrix;
  78713. /**
  78714. * the native xr-plane object
  78715. */
  78716. xrPlane: XRPlane;
  78717. }
  78718. /**
  78719. * The plane detector is used to detect planes in the real world when in AR
  78720. * For more information see https://github.com/immersive-web/real-world-geometry/
  78721. */
  78722. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78723. private _options;
  78724. private _detectedPlanes;
  78725. private _enabled;
  78726. private _lastFrameDetected;
  78727. /**
  78728. * The module's name
  78729. */
  78730. static readonly Name: string;
  78731. /**
  78732. * The (Babylon) version of this module.
  78733. * This is an integer representing the implementation version.
  78734. * This number does not correspond to the WebXR specs version
  78735. */
  78736. static readonly Version: number;
  78737. /**
  78738. * Observers registered here will be executed when a new plane was added to the session
  78739. */
  78740. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78741. /**
  78742. * Observers registered here will be executed when a plane is no longer detected in the session
  78743. */
  78744. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78745. /**
  78746. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78747. * This can execute N times every frame
  78748. */
  78749. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78750. /**
  78751. * construct a new Plane Detector
  78752. * @param _xrSessionManager an instance of xr Session manager
  78753. * @param _options configuration to use when constructing this feature
  78754. */
  78755. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78756. /**
  78757. * detach this feature.
  78758. * Will usually be called by the features manager
  78759. *
  78760. * @returns true if successful.
  78761. */
  78762. detach(): boolean;
  78763. /**
  78764. * Dispose this feature and all of the resources attached
  78765. */
  78766. dispose(): void;
  78767. protected _onXRFrame(frame: XRFrame): void;
  78768. private _init;
  78769. private _updatePlaneWithXRPlane;
  78770. /**
  78771. * avoiding using Array.find for global support.
  78772. * @param xrPlane the plane to find in the array
  78773. */
  78774. private findIndexInPlaneArray;
  78775. }
  78776. }
  78777. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78778. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78779. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78780. import { Observable } from "babylonjs/Misc/observable";
  78781. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78782. /**
  78783. * Options interface for the background remover plugin
  78784. */
  78785. export interface IWebXRBackgroundRemoverOptions {
  78786. /**
  78787. * Further background meshes to disable when entering AR
  78788. */
  78789. backgroundMeshes?: AbstractMesh[];
  78790. /**
  78791. * flags to configure the removal of the environment helper.
  78792. * If not set, the entire background will be removed. If set, flags should be set as well.
  78793. */
  78794. environmentHelperRemovalFlags?: {
  78795. /**
  78796. * Should the skybox be removed (default false)
  78797. */
  78798. skyBox?: boolean;
  78799. /**
  78800. * Should the ground be removed (default false)
  78801. */
  78802. ground?: boolean;
  78803. };
  78804. /**
  78805. * don't disable the environment helper
  78806. */
  78807. ignoreEnvironmentHelper?: boolean;
  78808. }
  78809. /**
  78810. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78811. */
  78812. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78813. /**
  78814. * read-only options to be used in this module
  78815. */
  78816. readonly options: IWebXRBackgroundRemoverOptions;
  78817. /**
  78818. * The module's name
  78819. */
  78820. static readonly Name: string;
  78821. /**
  78822. * The (Babylon) version of this module.
  78823. * This is an integer representing the implementation version.
  78824. * This number does not correspond to the WebXR specs version
  78825. */
  78826. static readonly Version: number;
  78827. /**
  78828. * registered observers will be triggered when the background state changes
  78829. */
  78830. onBackgroundStateChangedObservable: Observable<boolean>;
  78831. /**
  78832. * constructs a new background remover module
  78833. * @param _xrSessionManager the session manager for this module
  78834. * @param options read-only options to be used in this module
  78835. */
  78836. constructor(_xrSessionManager: WebXRSessionManager,
  78837. /**
  78838. * read-only options to be used in this module
  78839. */
  78840. options?: IWebXRBackgroundRemoverOptions);
  78841. /**
  78842. * attach this feature
  78843. * Will usually be called by the features manager
  78844. *
  78845. * @returns true if successful.
  78846. */
  78847. attach(): boolean;
  78848. /**
  78849. * detach this feature.
  78850. * Will usually be called by the features manager
  78851. *
  78852. * @returns true if successful.
  78853. */
  78854. detach(): boolean;
  78855. /**
  78856. * Dispose this feature and all of the resources attached
  78857. */
  78858. dispose(): void;
  78859. protected _onXRFrame(_xrFrame: XRFrame): void;
  78860. private _setBackgroundState;
  78861. }
  78862. }
  78863. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78864. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78865. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78866. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78867. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78868. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78869. import { Nullable } from "babylonjs/types";
  78870. /**
  78871. * Options for the controller physics feature
  78872. */
  78873. export class IWebXRControllerPhysicsOptions {
  78874. /**
  78875. * Should the headset get its own impostor
  78876. */
  78877. enableHeadsetImpostor?: boolean;
  78878. /**
  78879. * Optional parameters for the headset impostor
  78880. */
  78881. headsetImpostorParams?: {
  78882. /**
  78883. * The type of impostor to create. Default is sphere
  78884. */
  78885. impostorType: number;
  78886. /**
  78887. * the size of the impostor. Defaults to 10cm
  78888. */
  78889. impostorSize?: number | {
  78890. width: number;
  78891. height: number;
  78892. depth: number;
  78893. };
  78894. /**
  78895. * Friction definitions
  78896. */
  78897. friction?: number;
  78898. /**
  78899. * Restitution
  78900. */
  78901. restitution?: number;
  78902. };
  78903. /**
  78904. * The physics properties of the future impostors
  78905. */
  78906. physicsProperties?: {
  78907. /**
  78908. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78909. * Note that this requires a physics engine that supports mesh impostors!
  78910. */
  78911. useControllerMesh?: boolean;
  78912. /**
  78913. * The type of impostor to create. Default is sphere
  78914. */
  78915. impostorType?: number;
  78916. /**
  78917. * the size of the impostor. Defaults to 10cm
  78918. */
  78919. impostorSize?: number | {
  78920. width: number;
  78921. height: number;
  78922. depth: number;
  78923. };
  78924. /**
  78925. * Friction definitions
  78926. */
  78927. friction?: number;
  78928. /**
  78929. * Restitution
  78930. */
  78931. restitution?: number;
  78932. };
  78933. /**
  78934. * the xr input to use with this pointer selection
  78935. */
  78936. xrInput: WebXRInput;
  78937. }
  78938. /**
  78939. * Add physics impostor to your webxr controllers,
  78940. * including naive calculation of their linear and angular velocity
  78941. */
  78942. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78943. private readonly _options;
  78944. private _attachController;
  78945. private _controllers;
  78946. private _debugMode;
  78947. private _delta;
  78948. private _headsetImpostor?;
  78949. private _headsetMesh?;
  78950. private _lastTimestamp;
  78951. private _tmpQuaternion;
  78952. private _tmpVector;
  78953. /**
  78954. * The module's name
  78955. */
  78956. static readonly Name: string;
  78957. /**
  78958. * The (Babylon) version of this module.
  78959. * This is an integer representing the implementation version.
  78960. * This number does not correspond to the webxr specs version
  78961. */
  78962. static readonly Version: number;
  78963. /**
  78964. * Construct a new Controller Physics Feature
  78965. * @param _xrSessionManager the corresponding xr session manager
  78966. * @param _options options to create this feature with
  78967. */
  78968. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78969. /**
  78970. * @hidden
  78971. * enable debugging - will show console outputs and the impostor mesh
  78972. */
  78973. _enablePhysicsDebug(): void;
  78974. /**
  78975. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78976. * @param xrController the controller to add
  78977. */
  78978. addController(xrController: WebXRInputSource): void;
  78979. /**
  78980. * attach this feature
  78981. * Will usually be called by the features manager
  78982. *
  78983. * @returns true if successful.
  78984. */
  78985. attach(): boolean;
  78986. /**
  78987. * detach this feature.
  78988. * Will usually be called by the features manager
  78989. *
  78990. * @returns true if successful.
  78991. */
  78992. detach(): boolean;
  78993. /**
  78994. * Get the headset impostor, if enabled
  78995. * @returns the impostor
  78996. */
  78997. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78998. /**
  78999. * Get the physics impostor of a specific controller.
  79000. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  79001. * @param controller the controller or the controller id of which to get the impostor
  79002. * @returns the impostor or null
  79003. */
  79004. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  79005. /**
  79006. * Update the physics properties provided in the constructor
  79007. * @param newProperties the new properties object
  79008. */
  79009. setPhysicsProperties(newProperties: {
  79010. impostorType?: number;
  79011. impostorSize?: number | {
  79012. width: number;
  79013. height: number;
  79014. depth: number;
  79015. };
  79016. friction?: number;
  79017. restitution?: number;
  79018. }): void;
  79019. protected _onXRFrame(_xrFrame: any): void;
  79020. private _detachController;
  79021. }
  79022. }
  79023. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79024. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79025. import { Observable } from "babylonjs/Misc/observable";
  79026. import { Vector3 } from "babylonjs/Maths/math.vector";
  79027. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79028. /**
  79029. * A babylon interface for a "WebXR" feature point.
  79030. * Represents the position and confidence value of a given feature point.
  79031. */
  79032. export interface IWebXRFeaturePoint {
  79033. /**
  79034. * Represents the position of the feature point in world space.
  79035. */
  79036. position: Vector3;
  79037. /**
  79038. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79039. */
  79040. confidenceValue: number;
  79041. }
  79042. /**
  79043. * The feature point system is used to detect feature points from real world geometry.
  79044. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79045. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79046. */
  79047. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79048. private _enabled;
  79049. private _featurePointCloud;
  79050. /**
  79051. * The module's name
  79052. */
  79053. static readonly Name: string;
  79054. /**
  79055. * The (Babylon) version of this module.
  79056. * This is an integer representing the implementation version.
  79057. * This number does not correspond to the WebXR specs version
  79058. */
  79059. static readonly Version: number;
  79060. /**
  79061. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79062. * Will notify the observers about which feature points have been added.
  79063. */
  79064. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79065. /**
  79066. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79067. * Will notify the observers about which feature points have been updated.
  79068. */
  79069. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79070. /**
  79071. * The current feature point cloud maintained across frames.
  79072. */
  79073. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79074. /**
  79075. * construct the feature point system
  79076. * @param _xrSessionManager an instance of xr Session manager
  79077. */
  79078. constructor(_xrSessionManager: WebXRSessionManager);
  79079. /**
  79080. * Detach this feature.
  79081. * Will usually be called by the features manager
  79082. *
  79083. * @returns true if successful.
  79084. */
  79085. detach(): boolean;
  79086. /**
  79087. * Dispose this feature and all of the resources attached
  79088. */
  79089. dispose(): void;
  79090. /**
  79091. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79092. */
  79093. protected _onXRFrame(frame: XRFrame): void;
  79094. /**
  79095. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79096. */
  79097. private _init;
  79098. }
  79099. }
  79100. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79101. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79102. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79103. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79104. import { Mesh } from "babylonjs/Meshes/mesh";
  79105. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79106. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79107. import { Nullable } from "babylonjs/types";
  79108. import { IDisposable } from "babylonjs/scene";
  79109. import { Observable } from "babylonjs/Misc/observable";
  79110. /**
  79111. * Configuration interface for the hand tracking feature
  79112. */
  79113. export interface IWebXRHandTrackingOptions {
  79114. /**
  79115. * The xrInput that will be used as source for new hands
  79116. */
  79117. xrInput: WebXRInput;
  79118. /**
  79119. * Configuration object for the joint meshes
  79120. */
  79121. jointMeshes?: {
  79122. /**
  79123. * Should the meshes created be invisible (defaults to false)
  79124. */
  79125. invisible?: boolean;
  79126. /**
  79127. * A source mesh to be used to create instances. Defaults to a sphere.
  79128. * This mesh will be the source for all other (25) meshes.
  79129. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79130. */
  79131. sourceMesh?: Mesh;
  79132. /**
  79133. * Should the source mesh stay visible. Defaults to false
  79134. */
  79135. keepOriginalVisible?: boolean;
  79136. /**
  79137. * Scale factor for all instances (defaults to 2)
  79138. */
  79139. scaleFactor?: number;
  79140. /**
  79141. * Should each instance have its own physics impostor
  79142. */
  79143. enablePhysics?: boolean;
  79144. /**
  79145. * If enabled, override default physics properties
  79146. */
  79147. physicsProps?: {
  79148. friction?: number;
  79149. restitution?: number;
  79150. impostorType?: number;
  79151. };
  79152. /**
  79153. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79154. */
  79155. handMesh?: AbstractMesh;
  79156. };
  79157. }
  79158. /**
  79159. * Parts of the hands divided to writs and finger names
  79160. */
  79161. export const enum HandPart {
  79162. /**
  79163. * HandPart - Wrist
  79164. */
  79165. WRIST = "wrist",
  79166. /**
  79167. * HandPart - The THumb
  79168. */
  79169. THUMB = "thumb",
  79170. /**
  79171. * HandPart - Index finger
  79172. */
  79173. INDEX = "index",
  79174. /**
  79175. * HandPart - Middle finger
  79176. */
  79177. MIDDLE = "middle",
  79178. /**
  79179. * HandPart - Ring finger
  79180. */
  79181. RING = "ring",
  79182. /**
  79183. * HandPart - Little finger
  79184. */
  79185. LITTLE = "little"
  79186. }
  79187. /**
  79188. * Representing a single hand (with its corresponding native XRHand object)
  79189. */
  79190. export class WebXRHand implements IDisposable {
  79191. /** the controller to which the hand correlates */
  79192. readonly xrController: WebXRInputSource;
  79193. /** the meshes to be used to track the hand joints */
  79194. readonly trackedMeshes: AbstractMesh[];
  79195. /**
  79196. * Hand-parts definition (key is HandPart)
  79197. */
  79198. static HandPartsDefinition: {
  79199. [key: string]: number[];
  79200. };
  79201. /**
  79202. * Populate the HandPartsDefinition object.
  79203. * This is called as a side effect since certain browsers don't have XRHand defined.
  79204. */
  79205. static _PopulateHandPartsDefinition(): void;
  79206. /**
  79207. * Construct a new hand object
  79208. * @param xrController the controller to which the hand correlates
  79209. * @param trackedMeshes the meshes to be used to track the hand joints
  79210. */
  79211. constructor(
  79212. /** the controller to which the hand correlates */
  79213. xrController: WebXRInputSource,
  79214. /** the meshes to be used to track the hand joints */
  79215. trackedMeshes: AbstractMesh[]);
  79216. /**
  79217. * Update this hand from the latest xr frame
  79218. * @param xrFrame xrFrame to update from
  79219. * @param referenceSpace The current viewer reference space
  79220. * @param scaleFactor optional scale factor for the meshes
  79221. */
  79222. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79223. /**
  79224. * Get meshes of part of the hand
  79225. * @param part the part of hand to get
  79226. * @returns An array of meshes that correlate to the hand part requested
  79227. */
  79228. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79229. /**
  79230. * Dispose this Hand object
  79231. */
  79232. dispose(): void;
  79233. }
  79234. /**
  79235. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79236. */
  79237. export class WebXRHandTracking extends WebXRAbstractFeature {
  79238. /**
  79239. * options to use when constructing this feature
  79240. */
  79241. readonly options: IWebXRHandTrackingOptions;
  79242. private static _idCounter;
  79243. /**
  79244. * The module's name
  79245. */
  79246. static readonly Name: string;
  79247. /**
  79248. * The (Babylon) version of this module.
  79249. * This is an integer representing the implementation version.
  79250. * This number does not correspond to the WebXR specs version
  79251. */
  79252. static readonly Version: number;
  79253. /**
  79254. * This observable will notify registered observers when a new hand object was added and initialized
  79255. */
  79256. onHandAddedObservable: Observable<WebXRHand>;
  79257. /**
  79258. * This observable will notify its observers right before the hand object is disposed
  79259. */
  79260. onHandRemovedObservable: Observable<WebXRHand>;
  79261. private _hands;
  79262. /**
  79263. * Creates a new instance of the hit test feature
  79264. * @param _xrSessionManager an instance of WebXRSessionManager
  79265. * @param options options to use when constructing this feature
  79266. */
  79267. constructor(_xrSessionManager: WebXRSessionManager,
  79268. /**
  79269. * options to use when constructing this feature
  79270. */
  79271. options: IWebXRHandTrackingOptions);
  79272. /**
  79273. * Check if the needed objects are defined.
  79274. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79275. */
  79276. isCompatible(): boolean;
  79277. /**
  79278. * attach this feature
  79279. * Will usually be called by the features manager
  79280. *
  79281. * @returns true if successful.
  79282. */
  79283. attach(): boolean;
  79284. /**
  79285. * detach this feature.
  79286. * Will usually be called by the features manager
  79287. *
  79288. * @returns true if successful.
  79289. */
  79290. detach(): boolean;
  79291. /**
  79292. * Dispose this feature and all of the resources attached
  79293. */
  79294. dispose(): void;
  79295. /**
  79296. * Get the hand object according to the controller id
  79297. * @param controllerId the controller id to which we want to get the hand
  79298. * @returns null if not found or the WebXRHand object if found
  79299. */
  79300. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79301. /**
  79302. * Get a hand object according to the requested handedness
  79303. * @param handedness the handedness to request
  79304. * @returns null if not found or the WebXRHand object if found
  79305. */
  79306. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79307. protected _onXRFrame(_xrFrame: XRFrame): void;
  79308. private _attachHand;
  79309. private _detachHand;
  79310. }
  79311. }
  79312. declare module "babylonjs/XR/features/index" {
  79313. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79314. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79315. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79316. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79317. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79318. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79319. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79320. export * from "babylonjs/XR/features/WebXRHitTest";
  79321. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79322. export * from "babylonjs/XR/features/WebXRHandTracking";
  79323. }
  79324. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79325. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79326. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79327. import { Scene } from "babylonjs/scene";
  79328. /**
  79329. * The motion controller class for all microsoft mixed reality controllers
  79330. */
  79331. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79332. protected readonly _mapping: {
  79333. defaultButton: {
  79334. valueNodeName: string;
  79335. unpressedNodeName: string;
  79336. pressedNodeName: string;
  79337. };
  79338. defaultAxis: {
  79339. valueNodeName: string;
  79340. minNodeName: string;
  79341. maxNodeName: string;
  79342. };
  79343. buttons: {
  79344. "xr-standard-trigger": {
  79345. rootNodeName: string;
  79346. componentProperty: string;
  79347. states: string[];
  79348. };
  79349. "xr-standard-squeeze": {
  79350. rootNodeName: string;
  79351. componentProperty: string;
  79352. states: string[];
  79353. };
  79354. "xr-standard-touchpad": {
  79355. rootNodeName: string;
  79356. labelAnchorNodeName: string;
  79357. touchPointNodeName: string;
  79358. };
  79359. "xr-standard-thumbstick": {
  79360. rootNodeName: string;
  79361. componentProperty: string;
  79362. states: string[];
  79363. };
  79364. };
  79365. axes: {
  79366. "xr-standard-touchpad": {
  79367. "x-axis": {
  79368. rootNodeName: string;
  79369. };
  79370. "y-axis": {
  79371. rootNodeName: string;
  79372. };
  79373. };
  79374. "xr-standard-thumbstick": {
  79375. "x-axis": {
  79376. rootNodeName: string;
  79377. };
  79378. "y-axis": {
  79379. rootNodeName: string;
  79380. };
  79381. };
  79382. };
  79383. };
  79384. /**
  79385. * The base url used to load the left and right controller models
  79386. */
  79387. static MODEL_BASE_URL: string;
  79388. /**
  79389. * The name of the left controller model file
  79390. */
  79391. static MODEL_LEFT_FILENAME: string;
  79392. /**
  79393. * The name of the right controller model file
  79394. */
  79395. static MODEL_RIGHT_FILENAME: string;
  79396. profileId: string;
  79397. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79398. protected _getFilenameAndPath(): {
  79399. filename: string;
  79400. path: string;
  79401. };
  79402. protected _getModelLoadingConstraints(): boolean;
  79403. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79404. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79405. protected _updateModel(): void;
  79406. }
  79407. }
  79408. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79409. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79411. import { Scene } from "babylonjs/scene";
  79412. /**
  79413. * The motion controller class for oculus touch (quest, rift).
  79414. * This class supports legacy mapping as well the standard xr mapping
  79415. */
  79416. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79417. private _forceLegacyControllers;
  79418. private _modelRootNode;
  79419. /**
  79420. * The base url used to load the left and right controller models
  79421. */
  79422. static MODEL_BASE_URL: string;
  79423. /**
  79424. * The name of the left controller model file
  79425. */
  79426. static MODEL_LEFT_FILENAME: string;
  79427. /**
  79428. * The name of the right controller model file
  79429. */
  79430. static MODEL_RIGHT_FILENAME: string;
  79431. /**
  79432. * Base Url for the Quest controller model.
  79433. */
  79434. static QUEST_MODEL_BASE_URL: string;
  79435. profileId: string;
  79436. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79437. protected _getFilenameAndPath(): {
  79438. filename: string;
  79439. path: string;
  79440. };
  79441. protected _getModelLoadingConstraints(): boolean;
  79442. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79443. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79444. protected _updateModel(): void;
  79445. /**
  79446. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79447. * between the touch and touch 2.
  79448. */
  79449. private _isQuest;
  79450. }
  79451. }
  79452. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79453. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79454. import { Scene } from "babylonjs/scene";
  79455. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79456. /**
  79457. * The motion controller class for the standard HTC-Vive controllers
  79458. */
  79459. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79460. private _modelRootNode;
  79461. /**
  79462. * The base url used to load the left and right controller models
  79463. */
  79464. static MODEL_BASE_URL: string;
  79465. /**
  79466. * File name for the controller model.
  79467. */
  79468. static MODEL_FILENAME: string;
  79469. profileId: string;
  79470. /**
  79471. * Create a new Vive motion controller object
  79472. * @param scene the scene to use to create this controller
  79473. * @param gamepadObject the corresponding gamepad object
  79474. * @param handedness the handedness of the controller
  79475. */
  79476. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79477. protected _getFilenameAndPath(): {
  79478. filename: string;
  79479. path: string;
  79480. };
  79481. protected _getModelLoadingConstraints(): boolean;
  79482. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79483. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79484. protected _updateModel(): void;
  79485. }
  79486. }
  79487. declare module "babylonjs/XR/motionController/index" {
  79488. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79489. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79490. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79491. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79492. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79493. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79494. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79495. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79496. }
  79497. declare module "babylonjs/XR/index" {
  79498. export * from "babylonjs/XR/webXRCamera";
  79499. export * from "babylonjs/XR/webXREnterExitUI";
  79500. export * from "babylonjs/XR/webXRExperienceHelper";
  79501. export * from "babylonjs/XR/webXRInput";
  79502. export * from "babylonjs/XR/webXRInputSource";
  79503. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79504. export * from "babylonjs/XR/webXRTypes";
  79505. export * from "babylonjs/XR/webXRSessionManager";
  79506. export * from "babylonjs/XR/webXRDefaultExperience";
  79507. export * from "babylonjs/XR/webXRFeaturesManager";
  79508. export * from "babylonjs/XR/features/index";
  79509. export * from "babylonjs/XR/motionController/index";
  79510. }
  79511. declare module "babylonjs/index" {
  79512. export * from "babylonjs/abstractScene";
  79513. export * from "babylonjs/Actions/index";
  79514. export * from "babylonjs/Animations/index";
  79515. export * from "babylonjs/assetContainer";
  79516. export * from "babylonjs/Audio/index";
  79517. export * from "babylonjs/Behaviors/index";
  79518. export * from "babylonjs/Bones/index";
  79519. export * from "babylonjs/Cameras/index";
  79520. export * from "babylonjs/Collisions/index";
  79521. export * from "babylonjs/Culling/index";
  79522. export * from "babylonjs/Debug/index";
  79523. export * from "babylonjs/DeviceInput/index";
  79524. export * from "babylonjs/Engines/index";
  79525. export * from "babylonjs/Events/index";
  79526. export * from "babylonjs/Gamepads/index";
  79527. export * from "babylonjs/Gizmos/index";
  79528. export * from "babylonjs/Helpers/index";
  79529. export * from "babylonjs/Instrumentation/index";
  79530. export * from "babylonjs/Layers/index";
  79531. export * from "babylonjs/LensFlares/index";
  79532. export * from "babylonjs/Lights/index";
  79533. export * from "babylonjs/Loading/index";
  79534. export * from "babylonjs/Materials/index";
  79535. export * from "babylonjs/Maths/index";
  79536. export * from "babylonjs/Meshes/index";
  79537. export * from "babylonjs/Morph/index";
  79538. export * from "babylonjs/Navigation/index";
  79539. export * from "babylonjs/node";
  79540. export * from "babylonjs/Offline/index";
  79541. export * from "babylonjs/Particles/index";
  79542. export * from "babylonjs/Physics/index";
  79543. export * from "babylonjs/PostProcesses/index";
  79544. export * from "babylonjs/Probes/index";
  79545. export * from "babylonjs/Rendering/index";
  79546. export * from "babylonjs/scene";
  79547. export * from "babylonjs/sceneComponent";
  79548. export * from "babylonjs/Sprites/index";
  79549. export * from "babylonjs/States/index";
  79550. export * from "babylonjs/Misc/index";
  79551. export * from "babylonjs/XR/index";
  79552. export * from "babylonjs/types";
  79553. }
  79554. declare module "babylonjs/Animations/pathCursor" {
  79555. import { Vector3 } from "babylonjs/Maths/math.vector";
  79556. import { Path2 } from "babylonjs/Maths/math.path";
  79557. /**
  79558. * A cursor which tracks a point on a path
  79559. */
  79560. export class PathCursor {
  79561. private path;
  79562. /**
  79563. * Stores path cursor callbacks for when an onchange event is triggered
  79564. */
  79565. private _onchange;
  79566. /**
  79567. * The value of the path cursor
  79568. */
  79569. value: number;
  79570. /**
  79571. * The animation array of the path cursor
  79572. */
  79573. animations: Animation[];
  79574. /**
  79575. * Initializes the path cursor
  79576. * @param path The path to track
  79577. */
  79578. constructor(path: Path2);
  79579. /**
  79580. * Gets the cursor point on the path
  79581. * @returns A point on the path cursor at the cursor location
  79582. */
  79583. getPoint(): Vector3;
  79584. /**
  79585. * Moves the cursor ahead by the step amount
  79586. * @param step The amount to move the cursor forward
  79587. * @returns This path cursor
  79588. */
  79589. moveAhead(step?: number): PathCursor;
  79590. /**
  79591. * Moves the cursor behind by the step amount
  79592. * @param step The amount to move the cursor back
  79593. * @returns This path cursor
  79594. */
  79595. moveBack(step?: number): PathCursor;
  79596. /**
  79597. * Moves the cursor by the step amount
  79598. * If the step amount is greater than one, an exception is thrown
  79599. * @param step The amount to move the cursor
  79600. * @returns This path cursor
  79601. */
  79602. move(step: number): PathCursor;
  79603. /**
  79604. * Ensures that the value is limited between zero and one
  79605. * @returns This path cursor
  79606. */
  79607. private ensureLimits;
  79608. /**
  79609. * Runs onchange callbacks on change (used by the animation engine)
  79610. * @returns This path cursor
  79611. */
  79612. private raiseOnChange;
  79613. /**
  79614. * Executes a function on change
  79615. * @param f A path cursor onchange callback
  79616. * @returns This path cursor
  79617. */
  79618. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79619. }
  79620. }
  79621. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79622. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79623. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79624. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79625. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79626. }
  79627. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79628. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79629. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79630. }
  79631. declare module "babylonjs/Engines/Processors/index" {
  79632. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79633. export * from "babylonjs/Engines/Processors/Expressions/index";
  79634. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79635. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79636. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79637. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79638. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79639. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79640. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79641. }
  79642. declare module "babylonjs/Legacy/legacy" {
  79643. import * as Babylon from "babylonjs/index";
  79644. export * from "babylonjs/index";
  79645. }
  79646. declare module "babylonjs/Shaders/blur.fragment" {
  79647. /** @hidden */
  79648. export var blurPixelShader: {
  79649. name: string;
  79650. shader: string;
  79651. };
  79652. }
  79653. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79654. /** @hidden */
  79655. export var pointCloudVertexDeclaration: {
  79656. name: string;
  79657. shader: string;
  79658. };
  79659. }
  79660. declare module "babylonjs" {
  79661. export * from "babylonjs/Legacy/legacy";
  79662. }
  79663. declare module BABYLON {
  79664. /** Alias type for value that can be null */
  79665. export type Nullable<T> = T | null;
  79666. /**
  79667. * Alias type for number that are floats
  79668. * @ignorenaming
  79669. */
  79670. export type float = number;
  79671. /**
  79672. * Alias type for number that are doubles.
  79673. * @ignorenaming
  79674. */
  79675. export type double = number;
  79676. /**
  79677. * Alias type for number that are integer
  79678. * @ignorenaming
  79679. */
  79680. export type int = number;
  79681. /** Alias type for number array or Float32Array */
  79682. export type FloatArray = number[] | Float32Array;
  79683. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79684. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79685. /**
  79686. * Alias for types that can be used by a Buffer or VertexBuffer.
  79687. */
  79688. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79689. /**
  79690. * Alias type for primitive types
  79691. * @ignorenaming
  79692. */
  79693. type Primitive = undefined | null | boolean | string | number | Function;
  79694. /**
  79695. * Type modifier to make all the properties of an object Readonly
  79696. */
  79697. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79698. /**
  79699. * Type modifier to make all the properties of an object Readonly recursively
  79700. */
  79701. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79702. /**
  79703. * Type modifier to make object properties readonly.
  79704. */
  79705. export type DeepImmutableObject<T> = {
  79706. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79707. };
  79708. /** @hidden */
  79709. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79710. }
  79711. }
  79712. declare module BABYLON {
  79713. /**
  79714. * A class serves as a medium between the observable and its observers
  79715. */
  79716. export class EventState {
  79717. /**
  79718. * Create a new EventState
  79719. * @param mask defines the mask associated with this state
  79720. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79721. * @param target defines the original target of the state
  79722. * @param currentTarget defines the current target of the state
  79723. */
  79724. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79725. /**
  79726. * Initialize the current event state
  79727. * @param mask defines the mask associated with this state
  79728. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79729. * @param target defines the original target of the state
  79730. * @param currentTarget defines the current target of the state
  79731. * @returns the current event state
  79732. */
  79733. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79734. /**
  79735. * An Observer can set this property to true to prevent subsequent observers of being notified
  79736. */
  79737. skipNextObservers: boolean;
  79738. /**
  79739. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79740. */
  79741. mask: number;
  79742. /**
  79743. * The object that originally notified the event
  79744. */
  79745. target?: any;
  79746. /**
  79747. * The current object in the bubbling phase
  79748. */
  79749. currentTarget?: any;
  79750. /**
  79751. * This will be populated with the return value of the last function that was executed.
  79752. * If it is the first function in the callback chain it will be the event data.
  79753. */
  79754. lastReturnValue?: any;
  79755. }
  79756. /**
  79757. * Represent an Observer registered to a given Observable object.
  79758. */
  79759. export class Observer<T> {
  79760. /**
  79761. * Defines the callback to call when the observer is notified
  79762. */
  79763. callback: (eventData: T, eventState: EventState) => void;
  79764. /**
  79765. * Defines the mask of the observer (used to filter notifications)
  79766. */
  79767. mask: number;
  79768. /**
  79769. * Defines the current scope used to restore the JS context
  79770. */
  79771. scope: any;
  79772. /** @hidden */
  79773. _willBeUnregistered: boolean;
  79774. /**
  79775. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79776. */
  79777. unregisterOnNextCall: boolean;
  79778. /**
  79779. * Creates a new observer
  79780. * @param callback defines the callback to call when the observer is notified
  79781. * @param mask defines the mask of the observer (used to filter notifications)
  79782. * @param scope defines the current scope used to restore the JS context
  79783. */
  79784. constructor(
  79785. /**
  79786. * Defines the callback to call when the observer is notified
  79787. */
  79788. callback: (eventData: T, eventState: EventState) => void,
  79789. /**
  79790. * Defines the mask of the observer (used to filter notifications)
  79791. */
  79792. mask: number,
  79793. /**
  79794. * Defines the current scope used to restore the JS context
  79795. */
  79796. scope?: any);
  79797. }
  79798. /**
  79799. * Represent a list of observers registered to multiple Observables object.
  79800. */
  79801. export class MultiObserver<T> {
  79802. private _observers;
  79803. private _observables;
  79804. /**
  79805. * Release associated resources
  79806. */
  79807. dispose(): void;
  79808. /**
  79809. * Raise a callback when one of the observable will notify
  79810. * @param observables defines a list of observables to watch
  79811. * @param callback defines the callback to call on notification
  79812. * @param mask defines the mask used to filter notifications
  79813. * @param scope defines the current scope used to restore the JS context
  79814. * @returns the new MultiObserver
  79815. */
  79816. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79817. }
  79818. /**
  79819. * The Observable class is a simple implementation of the Observable pattern.
  79820. *
  79821. * 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.
  79822. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79823. * 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).
  79824. * 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.
  79825. */
  79826. export class Observable<T> {
  79827. private _observers;
  79828. private _eventState;
  79829. private _onObserverAdded;
  79830. /**
  79831. * Gets the list of observers
  79832. */
  79833. get observers(): Array<Observer<T>>;
  79834. /**
  79835. * Creates a new observable
  79836. * @param onObserverAdded defines a callback to call when a new observer is added
  79837. */
  79838. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79839. /**
  79840. * Create a new Observer with the specified callback
  79841. * @param callback the callback that will be executed for that Observer
  79842. * @param mask the mask used to filter observers
  79843. * @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.
  79844. * @param scope optional scope for the callback to be called from
  79845. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79846. * @returns the new observer created for the callback
  79847. */
  79848. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79849. /**
  79850. * Create a new Observer with the specified callback and unregisters after the next notification
  79851. * @param callback the callback that will be executed for that Observer
  79852. * @returns the new observer created for the callback
  79853. */
  79854. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79855. /**
  79856. * Remove an Observer from the Observable object
  79857. * @param observer the instance of the Observer to remove
  79858. * @returns false if it doesn't belong to this Observable
  79859. */
  79860. remove(observer: Nullable<Observer<T>>): boolean;
  79861. /**
  79862. * Remove a callback from the Observable object
  79863. * @param callback the callback to remove
  79864. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79865. * @returns false if it doesn't belong to this Observable
  79866. */
  79867. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79868. private _deferUnregister;
  79869. private _remove;
  79870. /**
  79871. * Moves the observable to the top of the observer list making it get called first when notified
  79872. * @param observer the observer to move
  79873. */
  79874. makeObserverTopPriority(observer: Observer<T>): void;
  79875. /**
  79876. * Moves the observable to the bottom of the observer list making it get called last when notified
  79877. * @param observer the observer to move
  79878. */
  79879. makeObserverBottomPriority(observer: Observer<T>): void;
  79880. /**
  79881. * Notify all Observers by calling their respective callback with the given data
  79882. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79883. * @param eventData defines the data to send to all observers
  79884. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79885. * @param target defines the original target of the state
  79886. * @param currentTarget defines the current target of the state
  79887. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79888. */
  79889. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79890. /**
  79891. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79892. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79893. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79894. * and it is crucial that all callbacks will be executed.
  79895. * The order of the callbacks is kept, callbacks are not executed parallel.
  79896. *
  79897. * @param eventData The data to be sent to each callback
  79898. * @param mask is used to filter observers defaults to -1
  79899. * @param target defines the callback target (see EventState)
  79900. * @param currentTarget defines he current object in the bubbling phase
  79901. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79902. */
  79903. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79904. /**
  79905. * Notify a specific observer
  79906. * @param observer defines the observer to notify
  79907. * @param eventData defines the data to be sent to each callback
  79908. * @param mask is used to filter observers defaults to -1
  79909. */
  79910. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79911. /**
  79912. * Gets a boolean indicating if the observable has at least one observer
  79913. * @returns true is the Observable has at least one Observer registered
  79914. */
  79915. hasObservers(): boolean;
  79916. /**
  79917. * Clear the list of observers
  79918. */
  79919. clear(): void;
  79920. /**
  79921. * Clone the current observable
  79922. * @returns a new observable
  79923. */
  79924. clone(): Observable<T>;
  79925. /**
  79926. * Does this observable handles observer registered with a given mask
  79927. * @param mask defines the mask to be tested
  79928. * @return whether or not one observer registered with the given mask is handeled
  79929. **/
  79930. hasSpecificMask(mask?: number): boolean;
  79931. }
  79932. }
  79933. declare module BABYLON {
  79934. /**
  79935. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79936. * Babylon.js
  79937. */
  79938. export class DomManagement {
  79939. /**
  79940. * Checks if the window object exists
  79941. * @returns true if the window object exists
  79942. */
  79943. static IsWindowObjectExist(): boolean;
  79944. /**
  79945. * Checks if the navigator object exists
  79946. * @returns true if the navigator object exists
  79947. */
  79948. static IsNavigatorAvailable(): boolean;
  79949. /**
  79950. * Check if the document object exists
  79951. * @returns true if the document object exists
  79952. */
  79953. static IsDocumentAvailable(): boolean;
  79954. /**
  79955. * Extracts text content from a DOM element hierarchy
  79956. * @param element defines the root element
  79957. * @returns a string
  79958. */
  79959. static GetDOMTextContent(element: HTMLElement): string;
  79960. }
  79961. }
  79962. declare module BABYLON {
  79963. /**
  79964. * Logger used througouht the application to allow configuration of
  79965. * the log level required for the messages.
  79966. */
  79967. export class Logger {
  79968. /**
  79969. * No log
  79970. */
  79971. static readonly NoneLogLevel: number;
  79972. /**
  79973. * Only message logs
  79974. */
  79975. static readonly MessageLogLevel: number;
  79976. /**
  79977. * Only warning logs
  79978. */
  79979. static readonly WarningLogLevel: number;
  79980. /**
  79981. * Only error logs
  79982. */
  79983. static readonly ErrorLogLevel: number;
  79984. /**
  79985. * All logs
  79986. */
  79987. static readonly AllLogLevel: number;
  79988. private static _LogCache;
  79989. /**
  79990. * Gets a value indicating the number of loading errors
  79991. * @ignorenaming
  79992. */
  79993. static errorsCount: number;
  79994. /**
  79995. * Callback called when a new log is added
  79996. */
  79997. static OnNewCacheEntry: (entry: string) => void;
  79998. private static _AddLogEntry;
  79999. private static _FormatMessage;
  80000. private static _LogDisabled;
  80001. private static _LogEnabled;
  80002. private static _WarnDisabled;
  80003. private static _WarnEnabled;
  80004. private static _ErrorDisabled;
  80005. private static _ErrorEnabled;
  80006. /**
  80007. * Log a message to the console
  80008. */
  80009. static Log: (message: string) => void;
  80010. /**
  80011. * Write a warning message to the console
  80012. */
  80013. static Warn: (message: string) => void;
  80014. /**
  80015. * Write an error message to the console
  80016. */
  80017. static Error: (message: string) => void;
  80018. /**
  80019. * Gets current log cache (list of logs)
  80020. */
  80021. static get LogCache(): string;
  80022. /**
  80023. * Clears the log cache
  80024. */
  80025. static ClearLogCache(): void;
  80026. /**
  80027. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80028. */
  80029. static set LogLevels(level: number);
  80030. }
  80031. }
  80032. declare module BABYLON {
  80033. /** @hidden */
  80034. export class _TypeStore {
  80035. /** @hidden */
  80036. static RegisteredTypes: {
  80037. [key: string]: Object;
  80038. };
  80039. /** @hidden */
  80040. static GetClass(fqdn: string): any;
  80041. }
  80042. }
  80043. declare module BABYLON {
  80044. /**
  80045. * Helper to manipulate strings
  80046. */
  80047. export class StringTools {
  80048. /**
  80049. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80050. * @param str Source string
  80051. * @param suffix Suffix to search for in the source string
  80052. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80053. */
  80054. static EndsWith(str: string, suffix: string): boolean;
  80055. /**
  80056. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80057. * @param str Source string
  80058. * @param suffix Suffix to search for in the source string
  80059. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80060. */
  80061. static StartsWith(str: string, suffix: string): boolean;
  80062. /**
  80063. * Decodes a buffer into a string
  80064. * @param buffer The buffer to decode
  80065. * @returns The decoded string
  80066. */
  80067. static Decode(buffer: Uint8Array | Uint16Array): string;
  80068. /**
  80069. * Encode a buffer to a base64 string
  80070. * @param buffer defines the buffer to encode
  80071. * @returns the encoded string
  80072. */
  80073. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80074. /**
  80075. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80076. * @param num the number to convert and pad
  80077. * @param length the expected length of the string
  80078. * @returns the padded string
  80079. */
  80080. static PadNumber(num: number, length: number): string;
  80081. }
  80082. }
  80083. declare module BABYLON {
  80084. /**
  80085. * Class containing a set of static utilities functions for deep copy.
  80086. */
  80087. export class DeepCopier {
  80088. /**
  80089. * Tries to copy an object by duplicating every property
  80090. * @param source defines the source object
  80091. * @param destination defines the target object
  80092. * @param doNotCopyList defines a list of properties to avoid
  80093. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80094. */
  80095. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80096. }
  80097. }
  80098. declare module BABYLON {
  80099. /**
  80100. * Class containing a set of static utilities functions for precision date
  80101. */
  80102. export class PrecisionDate {
  80103. /**
  80104. * Gets either window.performance.now() if supported or Date.now() else
  80105. */
  80106. static get Now(): number;
  80107. }
  80108. }
  80109. declare module BABYLON {
  80110. /** @hidden */
  80111. export class _DevTools {
  80112. static WarnImport(name: string): string;
  80113. }
  80114. }
  80115. declare module BABYLON {
  80116. /**
  80117. * Interface used to define the mechanism to get data from the network
  80118. */
  80119. export interface IWebRequest {
  80120. /**
  80121. * Returns client's response url
  80122. */
  80123. responseURL: string;
  80124. /**
  80125. * Returns client's status
  80126. */
  80127. status: number;
  80128. /**
  80129. * Returns client's status as a text
  80130. */
  80131. statusText: string;
  80132. }
  80133. }
  80134. declare module BABYLON {
  80135. /**
  80136. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80137. */
  80138. export class WebRequest implements IWebRequest {
  80139. private _xhr;
  80140. /**
  80141. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80142. * i.e. when loading files, where the server/service expects an Authorization header
  80143. */
  80144. static CustomRequestHeaders: {
  80145. [key: string]: string;
  80146. };
  80147. /**
  80148. * Add callback functions in this array to update all the requests before they get sent to the network
  80149. */
  80150. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80151. private _injectCustomRequestHeaders;
  80152. /**
  80153. * Gets or sets a function to be called when loading progress changes
  80154. */
  80155. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80156. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80157. /**
  80158. * Returns client's state
  80159. */
  80160. get readyState(): number;
  80161. /**
  80162. * Returns client's status
  80163. */
  80164. get status(): number;
  80165. /**
  80166. * Returns client's status as a text
  80167. */
  80168. get statusText(): string;
  80169. /**
  80170. * Returns client's response
  80171. */
  80172. get response(): any;
  80173. /**
  80174. * Returns client's response url
  80175. */
  80176. get responseURL(): string;
  80177. /**
  80178. * Returns client's response as text
  80179. */
  80180. get responseText(): string;
  80181. /**
  80182. * Gets or sets the expected response type
  80183. */
  80184. get responseType(): XMLHttpRequestResponseType;
  80185. set responseType(value: XMLHttpRequestResponseType);
  80186. /** @hidden */
  80187. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80188. /** @hidden */
  80189. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80190. /**
  80191. * Cancels any network activity
  80192. */
  80193. abort(): void;
  80194. /**
  80195. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80196. * @param body defines an optional request body
  80197. */
  80198. send(body?: Document | BodyInit | null): void;
  80199. /**
  80200. * Sets the request method, request URL
  80201. * @param method defines the method to use (GET, POST, etc..)
  80202. * @param url defines the url to connect with
  80203. */
  80204. open(method: string, url: string): void;
  80205. /**
  80206. * Sets the value of a request header.
  80207. * @param name The name of the header whose value is to be set
  80208. * @param value The value to set as the body of the header
  80209. */
  80210. setRequestHeader(name: string, value: string): void;
  80211. /**
  80212. * Get the string containing the text of a particular header's value.
  80213. * @param name The name of the header
  80214. * @returns The string containing the text of the given header name
  80215. */
  80216. getResponseHeader(name: string): Nullable<string>;
  80217. }
  80218. }
  80219. declare module BABYLON {
  80220. /**
  80221. * File request interface
  80222. */
  80223. export interface IFileRequest {
  80224. /**
  80225. * Raised when the request is complete (success or error).
  80226. */
  80227. onCompleteObservable: Observable<IFileRequest>;
  80228. /**
  80229. * Aborts the request for a file.
  80230. */
  80231. abort: () => void;
  80232. }
  80233. }
  80234. declare module BABYLON {
  80235. /**
  80236. * Define options used to create a render target texture
  80237. */
  80238. export class RenderTargetCreationOptions {
  80239. /**
  80240. * Specifies is mipmaps must be generated
  80241. */
  80242. generateMipMaps?: boolean;
  80243. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80244. generateDepthBuffer?: boolean;
  80245. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80246. generateStencilBuffer?: boolean;
  80247. /** Defines texture type (int by default) */
  80248. type?: number;
  80249. /** Defines sampling mode (trilinear by default) */
  80250. samplingMode?: number;
  80251. /** Defines format (RGBA by default) */
  80252. format?: number;
  80253. }
  80254. }
  80255. declare module BABYLON {
  80256. /** Defines the cross module used constants to avoid circular dependncies */
  80257. export class Constants {
  80258. /** Defines that alpha blending is disabled */
  80259. static readonly ALPHA_DISABLE: number;
  80260. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80261. static readonly ALPHA_ADD: number;
  80262. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80263. static readonly ALPHA_COMBINE: number;
  80264. /** Defines that alpha blending is DEST - SRC * DEST */
  80265. static readonly ALPHA_SUBTRACT: number;
  80266. /** Defines that alpha blending is SRC * DEST */
  80267. static readonly ALPHA_MULTIPLY: number;
  80268. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80269. static readonly ALPHA_MAXIMIZED: number;
  80270. /** Defines that alpha blending is SRC + DEST */
  80271. static readonly ALPHA_ONEONE: number;
  80272. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80273. static readonly ALPHA_PREMULTIPLIED: number;
  80274. /**
  80275. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80276. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80277. */
  80278. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80279. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80280. static readonly ALPHA_INTERPOLATE: number;
  80281. /**
  80282. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80283. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80284. */
  80285. static readonly ALPHA_SCREENMODE: number;
  80286. /**
  80287. * Defines that alpha blending is SRC + DST
  80288. * Alpha will be set to SRC ALPHA + DST ALPHA
  80289. */
  80290. static readonly ALPHA_ONEONE_ONEONE: number;
  80291. /**
  80292. * Defines that alpha blending is SRC * DST ALPHA + DST
  80293. * Alpha will be set to 0
  80294. */
  80295. static readonly ALPHA_ALPHATOCOLOR: number;
  80296. /**
  80297. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80298. */
  80299. static readonly ALPHA_REVERSEONEMINUS: number;
  80300. /**
  80301. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80302. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80303. */
  80304. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80305. /**
  80306. * Defines that alpha blending is SRC + DST
  80307. * Alpha will be set to SRC ALPHA
  80308. */
  80309. static readonly ALPHA_ONEONE_ONEZERO: number;
  80310. /**
  80311. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80312. * Alpha will be set to DST ALPHA
  80313. */
  80314. static readonly ALPHA_EXCLUSION: number;
  80315. /** Defines that alpha blending equation a SUM */
  80316. static readonly ALPHA_EQUATION_ADD: number;
  80317. /** Defines that alpha blending equation a SUBSTRACTION */
  80318. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80319. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80320. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80321. /** Defines that alpha blending equation a MAX operation */
  80322. static readonly ALPHA_EQUATION_MAX: number;
  80323. /** Defines that alpha blending equation a MIN operation */
  80324. static readonly ALPHA_EQUATION_MIN: number;
  80325. /**
  80326. * Defines that alpha blending equation a DARKEN operation:
  80327. * It takes the min of the src and sums the alpha channels.
  80328. */
  80329. static readonly ALPHA_EQUATION_DARKEN: number;
  80330. /** Defines that the ressource is not delayed*/
  80331. static readonly DELAYLOADSTATE_NONE: number;
  80332. /** Defines that the ressource was successfully delay loaded */
  80333. static readonly DELAYLOADSTATE_LOADED: number;
  80334. /** Defines that the ressource is currently delay loading */
  80335. static readonly DELAYLOADSTATE_LOADING: number;
  80336. /** Defines that the ressource is delayed and has not started loading */
  80337. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80338. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80339. static readonly NEVER: number;
  80340. /** 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 */
  80341. static readonly ALWAYS: number;
  80342. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80343. static readonly LESS: number;
  80344. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80345. static readonly EQUAL: number;
  80346. /** 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 */
  80347. static readonly LEQUAL: number;
  80348. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80349. static readonly GREATER: number;
  80350. /** 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 */
  80351. static readonly GEQUAL: number;
  80352. /** 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 */
  80353. static readonly NOTEQUAL: number;
  80354. /** Passed to stencilOperation to specify that stencil value must be kept */
  80355. static readonly KEEP: number;
  80356. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80357. static readonly REPLACE: number;
  80358. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80359. static readonly INCR: number;
  80360. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80361. static readonly DECR: number;
  80362. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80363. static readonly INVERT: number;
  80364. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80365. static readonly INCR_WRAP: number;
  80366. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80367. static readonly DECR_WRAP: number;
  80368. /** Texture is not repeating outside of 0..1 UVs */
  80369. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80370. /** Texture is repeating outside of 0..1 UVs */
  80371. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80372. /** Texture is repeating and mirrored */
  80373. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80374. /** ALPHA */
  80375. static readonly TEXTUREFORMAT_ALPHA: number;
  80376. /** LUMINANCE */
  80377. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80378. /** LUMINANCE_ALPHA */
  80379. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80380. /** RGB */
  80381. static readonly TEXTUREFORMAT_RGB: number;
  80382. /** RGBA */
  80383. static readonly TEXTUREFORMAT_RGBA: number;
  80384. /** RED */
  80385. static readonly TEXTUREFORMAT_RED: number;
  80386. /** RED (2nd reference) */
  80387. static readonly TEXTUREFORMAT_R: number;
  80388. /** RG */
  80389. static readonly TEXTUREFORMAT_RG: number;
  80390. /** RED_INTEGER */
  80391. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80392. /** RED_INTEGER (2nd reference) */
  80393. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80394. /** RG_INTEGER */
  80395. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80396. /** RGB_INTEGER */
  80397. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80398. /** RGBA_INTEGER */
  80399. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80400. /** UNSIGNED_BYTE */
  80401. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80402. /** UNSIGNED_BYTE (2nd reference) */
  80403. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80404. /** FLOAT */
  80405. static readonly TEXTURETYPE_FLOAT: number;
  80406. /** HALF_FLOAT */
  80407. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80408. /** BYTE */
  80409. static readonly TEXTURETYPE_BYTE: number;
  80410. /** SHORT */
  80411. static readonly TEXTURETYPE_SHORT: number;
  80412. /** UNSIGNED_SHORT */
  80413. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80414. /** INT */
  80415. static readonly TEXTURETYPE_INT: number;
  80416. /** UNSIGNED_INT */
  80417. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80418. /** UNSIGNED_SHORT_4_4_4_4 */
  80419. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80420. /** UNSIGNED_SHORT_5_5_5_1 */
  80421. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80422. /** UNSIGNED_SHORT_5_6_5 */
  80423. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80424. /** UNSIGNED_INT_2_10_10_10_REV */
  80425. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80426. /** UNSIGNED_INT_24_8 */
  80427. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80428. /** UNSIGNED_INT_10F_11F_11F_REV */
  80429. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80430. /** UNSIGNED_INT_5_9_9_9_REV */
  80431. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80432. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80433. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80434. /** nearest is mag = nearest and min = nearest and no mip */
  80435. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80436. /** mag = nearest and min = nearest and mip = none */
  80437. static readonly TEXTURE_NEAREST_NEAREST: number;
  80438. /** Bilinear is mag = linear and min = linear and no mip */
  80439. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80440. /** mag = linear and min = linear and mip = none */
  80441. static readonly TEXTURE_LINEAR_LINEAR: number;
  80442. /** Trilinear is mag = linear and min = linear and mip = linear */
  80443. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80444. /** Trilinear is mag = linear and min = linear and mip = linear */
  80445. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80446. /** mag = nearest and min = nearest and mip = nearest */
  80447. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80448. /** mag = nearest and min = linear and mip = nearest */
  80449. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80450. /** mag = nearest and min = linear and mip = linear */
  80451. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80452. /** mag = nearest and min = linear and mip = none */
  80453. static readonly TEXTURE_NEAREST_LINEAR: number;
  80454. /** nearest is mag = nearest and min = nearest and mip = linear */
  80455. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80456. /** mag = linear and min = nearest and mip = nearest */
  80457. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80458. /** mag = linear and min = nearest and mip = linear */
  80459. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80460. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80461. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80462. /** mag = linear and min = nearest and mip = none */
  80463. static readonly TEXTURE_LINEAR_NEAREST: number;
  80464. /** Explicit coordinates mode */
  80465. static readonly TEXTURE_EXPLICIT_MODE: number;
  80466. /** Spherical coordinates mode */
  80467. static readonly TEXTURE_SPHERICAL_MODE: number;
  80468. /** Planar coordinates mode */
  80469. static readonly TEXTURE_PLANAR_MODE: number;
  80470. /** Cubic coordinates mode */
  80471. static readonly TEXTURE_CUBIC_MODE: number;
  80472. /** Projection coordinates mode */
  80473. static readonly TEXTURE_PROJECTION_MODE: number;
  80474. /** Skybox coordinates mode */
  80475. static readonly TEXTURE_SKYBOX_MODE: number;
  80476. /** Inverse Cubic coordinates mode */
  80477. static readonly TEXTURE_INVCUBIC_MODE: number;
  80478. /** Equirectangular coordinates mode */
  80479. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80480. /** Equirectangular Fixed coordinates mode */
  80481. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80482. /** Equirectangular Fixed Mirrored coordinates mode */
  80483. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80484. /** Offline (baking) quality for texture filtering */
  80485. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80486. /** High quality for texture filtering */
  80487. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80488. /** Medium quality for texture filtering */
  80489. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80490. /** Low quality for texture filtering */
  80491. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80492. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80493. static readonly SCALEMODE_FLOOR: number;
  80494. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80495. static readonly SCALEMODE_NEAREST: number;
  80496. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80497. static readonly SCALEMODE_CEILING: number;
  80498. /**
  80499. * The dirty texture flag value
  80500. */
  80501. static readonly MATERIAL_TextureDirtyFlag: number;
  80502. /**
  80503. * The dirty light flag value
  80504. */
  80505. static readonly MATERIAL_LightDirtyFlag: number;
  80506. /**
  80507. * The dirty fresnel flag value
  80508. */
  80509. static readonly MATERIAL_FresnelDirtyFlag: number;
  80510. /**
  80511. * The dirty attribute flag value
  80512. */
  80513. static readonly MATERIAL_AttributesDirtyFlag: number;
  80514. /**
  80515. * The dirty misc flag value
  80516. */
  80517. static readonly MATERIAL_MiscDirtyFlag: number;
  80518. /**
  80519. * The all dirty flag value
  80520. */
  80521. static readonly MATERIAL_AllDirtyFlag: number;
  80522. /**
  80523. * Returns the triangle fill mode
  80524. */
  80525. static readonly MATERIAL_TriangleFillMode: number;
  80526. /**
  80527. * Returns the wireframe mode
  80528. */
  80529. static readonly MATERIAL_WireFrameFillMode: number;
  80530. /**
  80531. * Returns the point fill mode
  80532. */
  80533. static readonly MATERIAL_PointFillMode: number;
  80534. /**
  80535. * Returns the point list draw mode
  80536. */
  80537. static readonly MATERIAL_PointListDrawMode: number;
  80538. /**
  80539. * Returns the line list draw mode
  80540. */
  80541. static readonly MATERIAL_LineListDrawMode: number;
  80542. /**
  80543. * Returns the line loop draw mode
  80544. */
  80545. static readonly MATERIAL_LineLoopDrawMode: number;
  80546. /**
  80547. * Returns the line strip draw mode
  80548. */
  80549. static readonly MATERIAL_LineStripDrawMode: number;
  80550. /**
  80551. * Returns the triangle strip draw mode
  80552. */
  80553. static readonly MATERIAL_TriangleStripDrawMode: number;
  80554. /**
  80555. * Returns the triangle fan draw mode
  80556. */
  80557. static readonly MATERIAL_TriangleFanDrawMode: number;
  80558. /**
  80559. * Stores the clock-wise side orientation
  80560. */
  80561. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80562. /**
  80563. * Stores the counter clock-wise side orientation
  80564. */
  80565. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80566. /**
  80567. * Nothing
  80568. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80569. */
  80570. static readonly ACTION_NothingTrigger: number;
  80571. /**
  80572. * On pick
  80573. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80574. */
  80575. static readonly ACTION_OnPickTrigger: number;
  80576. /**
  80577. * On left pick
  80578. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80579. */
  80580. static readonly ACTION_OnLeftPickTrigger: number;
  80581. /**
  80582. * On right pick
  80583. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80584. */
  80585. static readonly ACTION_OnRightPickTrigger: number;
  80586. /**
  80587. * On center pick
  80588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80589. */
  80590. static readonly ACTION_OnCenterPickTrigger: number;
  80591. /**
  80592. * On pick down
  80593. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80594. */
  80595. static readonly ACTION_OnPickDownTrigger: number;
  80596. /**
  80597. * On double pick
  80598. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80599. */
  80600. static readonly ACTION_OnDoublePickTrigger: number;
  80601. /**
  80602. * On pick up
  80603. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80604. */
  80605. static readonly ACTION_OnPickUpTrigger: number;
  80606. /**
  80607. * On pick out.
  80608. * This trigger will only be raised if you also declared a OnPickDown
  80609. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80610. */
  80611. static readonly ACTION_OnPickOutTrigger: number;
  80612. /**
  80613. * On long press
  80614. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80615. */
  80616. static readonly ACTION_OnLongPressTrigger: number;
  80617. /**
  80618. * On pointer over
  80619. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80620. */
  80621. static readonly ACTION_OnPointerOverTrigger: number;
  80622. /**
  80623. * On pointer out
  80624. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80625. */
  80626. static readonly ACTION_OnPointerOutTrigger: number;
  80627. /**
  80628. * On every frame
  80629. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80630. */
  80631. static readonly ACTION_OnEveryFrameTrigger: number;
  80632. /**
  80633. * On intersection enter
  80634. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80635. */
  80636. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80637. /**
  80638. * On intersection exit
  80639. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80640. */
  80641. static readonly ACTION_OnIntersectionExitTrigger: number;
  80642. /**
  80643. * On key down
  80644. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80645. */
  80646. static readonly ACTION_OnKeyDownTrigger: number;
  80647. /**
  80648. * On key up
  80649. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80650. */
  80651. static readonly ACTION_OnKeyUpTrigger: number;
  80652. /**
  80653. * Billboard mode will only apply to Y axis
  80654. */
  80655. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80656. /**
  80657. * Billboard mode will apply to all axes
  80658. */
  80659. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80660. /**
  80661. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80662. */
  80663. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80664. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80665. * Test order :
  80666. * Is the bounding sphere outside the frustum ?
  80667. * If not, are the bounding box vertices outside the frustum ?
  80668. * It not, then the cullable object is in the frustum.
  80669. */
  80670. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80671. /** Culling strategy : Bounding Sphere Only.
  80672. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80673. * It's also less accurate than the standard because some not visible objects can still be selected.
  80674. * Test : is the bounding sphere outside the frustum ?
  80675. * If not, then the cullable object is in the frustum.
  80676. */
  80677. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80678. /** Culling strategy : Optimistic Inclusion.
  80679. * This in an inclusion test first, then the standard exclusion test.
  80680. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80681. * 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.
  80682. * Anyway, it's as accurate as the standard strategy.
  80683. * Test :
  80684. * Is the cullable object bounding sphere center in the frustum ?
  80685. * If not, apply the default culling strategy.
  80686. */
  80687. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80688. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80689. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80690. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80691. * 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.
  80692. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80693. * Test :
  80694. * Is the cullable object bounding sphere center in the frustum ?
  80695. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80696. */
  80697. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80698. /**
  80699. * No logging while loading
  80700. */
  80701. static readonly SCENELOADER_NO_LOGGING: number;
  80702. /**
  80703. * Minimal logging while loading
  80704. */
  80705. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80706. /**
  80707. * Summary logging while loading
  80708. */
  80709. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80710. /**
  80711. * Detailled logging while loading
  80712. */
  80713. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80714. /**
  80715. * Prepass texture index for color
  80716. */
  80717. static readonly PREPASS_COLOR_INDEX: number;
  80718. /**
  80719. * Prepass texture index for irradiance
  80720. */
  80721. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80722. /**
  80723. * Prepass texture index for depth + normal
  80724. */
  80725. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80726. /**
  80727. * Prepass texture index for albedo
  80728. */
  80729. static readonly PREPASS_ALBEDO_INDEX: number;
  80730. }
  80731. }
  80732. declare module BABYLON {
  80733. /**
  80734. * This represents the required contract to create a new type of texture loader.
  80735. */
  80736. export interface IInternalTextureLoader {
  80737. /**
  80738. * Defines wether the loader supports cascade loading the different faces.
  80739. */
  80740. supportCascades: boolean;
  80741. /**
  80742. * This returns if the loader support the current file information.
  80743. * @param extension defines the file extension of the file being loaded
  80744. * @param mimeType defines the optional mime type of the file being loaded
  80745. * @returns true if the loader can load the specified file
  80746. */
  80747. canLoad(extension: string, mimeType?: string): boolean;
  80748. /**
  80749. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80750. * @param data contains the texture data
  80751. * @param texture defines the BabylonJS internal texture
  80752. * @param createPolynomials will be true if polynomials have been requested
  80753. * @param onLoad defines the callback to trigger once the texture is ready
  80754. * @param onError defines the callback to trigger in case of error
  80755. */
  80756. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80757. /**
  80758. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80759. * @param data contains the texture data
  80760. * @param texture defines the BabylonJS internal texture
  80761. * @param callback defines the method to call once ready to upload
  80762. */
  80763. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80764. }
  80765. }
  80766. declare module BABYLON {
  80767. /**
  80768. * Class used to store and describe the pipeline context associated with an effect
  80769. */
  80770. export interface IPipelineContext {
  80771. /**
  80772. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80773. */
  80774. isAsync: boolean;
  80775. /**
  80776. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80777. */
  80778. isReady: boolean;
  80779. /** @hidden */
  80780. _getVertexShaderCode(): string | null;
  80781. /** @hidden */
  80782. _getFragmentShaderCode(): string | null;
  80783. /** @hidden */
  80784. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80785. }
  80786. }
  80787. declare module BABYLON {
  80788. /**
  80789. * Class used to store gfx data (like WebGLBuffer)
  80790. */
  80791. export class DataBuffer {
  80792. /**
  80793. * Gets or sets the number of objects referencing this buffer
  80794. */
  80795. references: number;
  80796. /** Gets or sets the size of the underlying buffer */
  80797. capacity: number;
  80798. /**
  80799. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80800. */
  80801. is32Bits: boolean;
  80802. /**
  80803. * Gets the underlying buffer
  80804. */
  80805. get underlyingResource(): any;
  80806. }
  80807. }
  80808. declare module BABYLON {
  80809. /** @hidden */
  80810. export interface IShaderProcessor {
  80811. attributeProcessor?: (attribute: string) => string;
  80812. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80813. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80814. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80815. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80816. lineProcessor?: (line: string, isFragment: boolean) => string;
  80817. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80818. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80819. }
  80820. }
  80821. declare module BABYLON {
  80822. /** @hidden */
  80823. export interface ProcessingOptions {
  80824. defines: string[];
  80825. indexParameters: any;
  80826. isFragment: boolean;
  80827. shouldUseHighPrecisionShader: boolean;
  80828. supportsUniformBuffers: boolean;
  80829. shadersRepository: string;
  80830. includesShadersStore: {
  80831. [key: string]: string;
  80832. };
  80833. processor?: IShaderProcessor;
  80834. version: string;
  80835. platformName: string;
  80836. lookForClosingBracketForUniformBuffer?: boolean;
  80837. }
  80838. }
  80839. declare module BABYLON {
  80840. /** @hidden */
  80841. export class ShaderCodeNode {
  80842. line: string;
  80843. children: ShaderCodeNode[];
  80844. additionalDefineKey?: string;
  80845. additionalDefineValue?: string;
  80846. isValid(preprocessors: {
  80847. [key: string]: string;
  80848. }): boolean;
  80849. process(preprocessors: {
  80850. [key: string]: string;
  80851. }, options: ProcessingOptions): string;
  80852. }
  80853. }
  80854. declare module BABYLON {
  80855. /** @hidden */
  80856. export class ShaderCodeCursor {
  80857. private _lines;
  80858. lineIndex: number;
  80859. get currentLine(): string;
  80860. get canRead(): boolean;
  80861. set lines(value: string[]);
  80862. }
  80863. }
  80864. declare module BABYLON {
  80865. /** @hidden */
  80866. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80867. process(preprocessors: {
  80868. [key: string]: string;
  80869. }, options: ProcessingOptions): string;
  80870. }
  80871. }
  80872. declare module BABYLON {
  80873. /** @hidden */
  80874. export class ShaderDefineExpression {
  80875. isTrue(preprocessors: {
  80876. [key: string]: string;
  80877. }): boolean;
  80878. private static _OperatorPriority;
  80879. private static _Stack;
  80880. static postfixToInfix(postfix: string[]): string;
  80881. static infixToPostfix(infix: string): string[];
  80882. }
  80883. }
  80884. declare module BABYLON {
  80885. /** @hidden */
  80886. export class ShaderCodeTestNode extends ShaderCodeNode {
  80887. testExpression: ShaderDefineExpression;
  80888. isValid(preprocessors: {
  80889. [key: string]: string;
  80890. }): boolean;
  80891. }
  80892. }
  80893. declare module BABYLON {
  80894. /** @hidden */
  80895. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80896. define: string;
  80897. not: boolean;
  80898. constructor(define: string, not?: boolean);
  80899. isTrue(preprocessors: {
  80900. [key: string]: string;
  80901. }): boolean;
  80902. }
  80903. }
  80904. declare module BABYLON {
  80905. /** @hidden */
  80906. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80907. leftOperand: ShaderDefineExpression;
  80908. rightOperand: ShaderDefineExpression;
  80909. isTrue(preprocessors: {
  80910. [key: string]: string;
  80911. }): boolean;
  80912. }
  80913. }
  80914. declare module BABYLON {
  80915. /** @hidden */
  80916. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80917. leftOperand: ShaderDefineExpression;
  80918. rightOperand: ShaderDefineExpression;
  80919. isTrue(preprocessors: {
  80920. [key: string]: string;
  80921. }): boolean;
  80922. }
  80923. }
  80924. declare module BABYLON {
  80925. /** @hidden */
  80926. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80927. define: string;
  80928. operand: string;
  80929. testValue: string;
  80930. constructor(define: string, operand: string, testValue: string);
  80931. isTrue(preprocessors: {
  80932. [key: string]: string;
  80933. }): boolean;
  80934. }
  80935. }
  80936. declare module BABYLON {
  80937. /**
  80938. * Class used to enable access to offline support
  80939. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80940. */
  80941. export interface IOfflineProvider {
  80942. /**
  80943. * Gets a boolean indicating if scene must be saved in the database
  80944. */
  80945. enableSceneOffline: boolean;
  80946. /**
  80947. * Gets a boolean indicating if textures must be saved in the database
  80948. */
  80949. enableTexturesOffline: boolean;
  80950. /**
  80951. * Open the offline support and make it available
  80952. * @param successCallback defines the callback to call on success
  80953. * @param errorCallback defines the callback to call on error
  80954. */
  80955. open(successCallback: () => void, errorCallback: () => void): void;
  80956. /**
  80957. * Loads an image from the offline support
  80958. * @param url defines the url to load from
  80959. * @param image defines the target DOM image
  80960. */
  80961. loadImage(url: string, image: HTMLImageElement): void;
  80962. /**
  80963. * Loads a file from offline support
  80964. * @param url defines the URL to load from
  80965. * @param sceneLoaded defines a callback to call on success
  80966. * @param progressCallBack defines a callback to call when progress changed
  80967. * @param errorCallback defines a callback to call on error
  80968. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80969. */
  80970. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80971. }
  80972. }
  80973. declare module BABYLON {
  80974. /**
  80975. * Class used to help managing file picking and drag'n'drop
  80976. * File Storage
  80977. */
  80978. export class FilesInputStore {
  80979. /**
  80980. * List of files ready to be loaded
  80981. */
  80982. static FilesToLoad: {
  80983. [key: string]: File;
  80984. };
  80985. }
  80986. }
  80987. declare module BABYLON {
  80988. /**
  80989. * Class used to define a retry strategy when error happens while loading assets
  80990. */
  80991. export class RetryStrategy {
  80992. /**
  80993. * Function used to defines an exponential back off strategy
  80994. * @param maxRetries defines the maximum number of retries (3 by default)
  80995. * @param baseInterval defines the interval between retries
  80996. * @returns the strategy function to use
  80997. */
  80998. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80999. }
  81000. }
  81001. declare module BABYLON {
  81002. /**
  81003. * @ignore
  81004. * Application error to support additional information when loading a file
  81005. */
  81006. export abstract class BaseError extends Error {
  81007. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  81008. }
  81009. }
  81010. declare module BABYLON {
  81011. /** @ignore */
  81012. export class LoadFileError extends BaseError {
  81013. request?: WebRequest;
  81014. file?: File;
  81015. /**
  81016. * Creates a new LoadFileError
  81017. * @param message defines the message of the error
  81018. * @param request defines the optional web request
  81019. * @param file defines the optional file
  81020. */
  81021. constructor(message: string, object?: WebRequest | File);
  81022. }
  81023. /** @ignore */
  81024. export class RequestFileError extends BaseError {
  81025. request: WebRequest;
  81026. /**
  81027. * Creates a new LoadFileError
  81028. * @param message defines the message of the error
  81029. * @param request defines the optional web request
  81030. */
  81031. constructor(message: string, request: WebRequest);
  81032. }
  81033. /** @ignore */
  81034. export class ReadFileError extends BaseError {
  81035. file: File;
  81036. /**
  81037. * Creates a new ReadFileError
  81038. * @param message defines the message of the error
  81039. * @param file defines the optional file
  81040. */
  81041. constructor(message: string, file: File);
  81042. }
  81043. /**
  81044. * @hidden
  81045. */
  81046. export class FileTools {
  81047. /**
  81048. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81049. */
  81050. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81051. /**
  81052. * Gets or sets the base URL to use to load assets
  81053. */
  81054. static BaseUrl: string;
  81055. /**
  81056. * Default behaviour for cors in the application.
  81057. * It can be a string if the expected behavior is identical in the entire app.
  81058. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81059. */
  81060. static CorsBehavior: string | ((url: string | string[]) => string);
  81061. /**
  81062. * Gets or sets a function used to pre-process url before using them to load assets
  81063. */
  81064. static PreprocessUrl: (url: string) => string;
  81065. /**
  81066. * Removes unwanted characters from an url
  81067. * @param url defines the url to clean
  81068. * @returns the cleaned url
  81069. */
  81070. private static _CleanUrl;
  81071. /**
  81072. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81073. * @param url define the url we are trying
  81074. * @param element define the dom element where to configure the cors policy
  81075. */
  81076. static SetCorsBehavior(url: string | string[], element: {
  81077. crossOrigin: string | null;
  81078. }): void;
  81079. /**
  81080. * Loads an image as an HTMLImageElement.
  81081. * @param input url string, ArrayBuffer, or Blob to load
  81082. * @param onLoad callback called when the image successfully loads
  81083. * @param onError callback called when the image fails to load
  81084. * @param offlineProvider offline provider for caching
  81085. * @param mimeType optional mime type
  81086. * @returns the HTMLImageElement of the loaded image
  81087. */
  81088. 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>;
  81089. /**
  81090. * Reads a file from a File object
  81091. * @param file defines the file to load
  81092. * @param onSuccess defines the callback to call when data is loaded
  81093. * @param onProgress defines the callback to call during loading process
  81094. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81095. * @param onError defines the callback to call when an error occurs
  81096. * @returns a file request object
  81097. */
  81098. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81099. /**
  81100. * Loads a file from a url
  81101. * @param url url to load
  81102. * @param onSuccess callback called when the file successfully loads
  81103. * @param onProgress callback called while file is loading (if the server supports this mode)
  81104. * @param offlineProvider defines the offline provider for caching
  81105. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81106. * @param onError callback called when the file fails to load
  81107. * @returns a file request object
  81108. */
  81109. 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;
  81110. /**
  81111. * Loads a file
  81112. * @param url url to load
  81113. * @param onSuccess callback called when the file successfully loads
  81114. * @param onProgress callback called while file is loading (if the server supports this mode)
  81115. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81116. * @param onError callback called when the file fails to load
  81117. * @param onOpened callback called when the web request is opened
  81118. * @returns a file request object
  81119. */
  81120. 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;
  81121. /**
  81122. * Checks if the loaded document was accessed via `file:`-Protocol.
  81123. * @returns boolean
  81124. */
  81125. static IsFileURL(): boolean;
  81126. }
  81127. }
  81128. declare module BABYLON {
  81129. /** @hidden */
  81130. export class ShaderProcessor {
  81131. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81132. private static _ProcessPrecision;
  81133. private static _ExtractOperation;
  81134. private static _BuildSubExpression;
  81135. private static _BuildExpression;
  81136. private static _MoveCursorWithinIf;
  81137. private static _MoveCursor;
  81138. private static _EvaluatePreProcessors;
  81139. private static _PreparePreProcessors;
  81140. private static _ProcessShaderConversion;
  81141. private static _ProcessIncludes;
  81142. /**
  81143. * Loads a file from a url
  81144. * @param url url to load
  81145. * @param onSuccess callback called when the file successfully loads
  81146. * @param onProgress callback called while file is loading (if the server supports this mode)
  81147. * @param offlineProvider defines the offline provider for caching
  81148. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81149. * @param onError callback called when the file fails to load
  81150. * @returns a file request object
  81151. * @hidden
  81152. */
  81153. 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;
  81154. }
  81155. }
  81156. declare module BABYLON {
  81157. /**
  81158. * @hidden
  81159. */
  81160. export interface IColor4Like {
  81161. r: float;
  81162. g: float;
  81163. b: float;
  81164. a: float;
  81165. }
  81166. /**
  81167. * @hidden
  81168. */
  81169. export interface IColor3Like {
  81170. r: float;
  81171. g: float;
  81172. b: float;
  81173. }
  81174. /**
  81175. * @hidden
  81176. */
  81177. export interface IVector4Like {
  81178. x: float;
  81179. y: float;
  81180. z: float;
  81181. w: float;
  81182. }
  81183. /**
  81184. * @hidden
  81185. */
  81186. export interface IVector3Like {
  81187. x: float;
  81188. y: float;
  81189. z: float;
  81190. }
  81191. /**
  81192. * @hidden
  81193. */
  81194. export interface IVector2Like {
  81195. x: float;
  81196. y: float;
  81197. }
  81198. /**
  81199. * @hidden
  81200. */
  81201. export interface IMatrixLike {
  81202. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81203. updateFlag: int;
  81204. }
  81205. /**
  81206. * @hidden
  81207. */
  81208. export interface IViewportLike {
  81209. x: float;
  81210. y: float;
  81211. width: float;
  81212. height: float;
  81213. }
  81214. /**
  81215. * @hidden
  81216. */
  81217. export interface IPlaneLike {
  81218. normal: IVector3Like;
  81219. d: float;
  81220. normalize(): void;
  81221. }
  81222. }
  81223. declare module BABYLON {
  81224. /**
  81225. * Interface used to define common properties for effect fallbacks
  81226. */
  81227. export interface IEffectFallbacks {
  81228. /**
  81229. * Removes the defines that should be removed when falling back.
  81230. * @param currentDefines defines the current define statements for the shader.
  81231. * @param effect defines the current effect we try to compile
  81232. * @returns The resulting defines with defines of the current rank removed.
  81233. */
  81234. reduce(currentDefines: string, effect: Effect): string;
  81235. /**
  81236. * Removes the fallback from the bound mesh.
  81237. */
  81238. unBindMesh(): void;
  81239. /**
  81240. * Checks to see if more fallbacks are still availible.
  81241. */
  81242. hasMoreFallbacks: boolean;
  81243. }
  81244. }
  81245. declare module BABYLON {
  81246. /**
  81247. * Class used to evalaute queries containing `and` and `or` operators
  81248. */
  81249. export class AndOrNotEvaluator {
  81250. /**
  81251. * Evaluate a query
  81252. * @param query defines the query to evaluate
  81253. * @param evaluateCallback defines the callback used to filter result
  81254. * @returns true if the query matches
  81255. */
  81256. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81257. private static _HandleParenthesisContent;
  81258. private static _SimplifyNegation;
  81259. }
  81260. }
  81261. declare module BABYLON {
  81262. /**
  81263. * Class used to store custom tags
  81264. */
  81265. export class Tags {
  81266. /**
  81267. * Adds support for tags on the given object
  81268. * @param obj defines the object to use
  81269. */
  81270. static EnableFor(obj: any): void;
  81271. /**
  81272. * Removes tags support
  81273. * @param obj defines the object to use
  81274. */
  81275. static DisableFor(obj: any): void;
  81276. /**
  81277. * Gets a boolean indicating if the given object has tags
  81278. * @param obj defines the object to use
  81279. * @returns a boolean
  81280. */
  81281. static HasTags(obj: any): boolean;
  81282. /**
  81283. * Gets the tags available on a given object
  81284. * @param obj defines the object to use
  81285. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81286. * @returns the tags
  81287. */
  81288. static GetTags(obj: any, asString?: boolean): any;
  81289. /**
  81290. * Adds tags to an object
  81291. * @param obj defines the object to use
  81292. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81293. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81294. */
  81295. static AddTagsTo(obj: any, tagsString: string): void;
  81296. /**
  81297. * @hidden
  81298. */
  81299. static _AddTagTo(obj: any, tag: string): void;
  81300. /**
  81301. * Removes specific tags from a specific object
  81302. * @param obj defines the object to use
  81303. * @param tagsString defines the tags to remove
  81304. */
  81305. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81306. /**
  81307. * @hidden
  81308. */
  81309. static _RemoveTagFrom(obj: any, tag: string): void;
  81310. /**
  81311. * Defines if tags hosted on an object match a given query
  81312. * @param obj defines the object to use
  81313. * @param tagsQuery defines the tag query
  81314. * @returns a boolean
  81315. */
  81316. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81317. }
  81318. }
  81319. declare module BABYLON {
  81320. /**
  81321. * Scalar computation library
  81322. */
  81323. export class Scalar {
  81324. /**
  81325. * Two pi constants convenient for computation.
  81326. */
  81327. static TwoPi: number;
  81328. /**
  81329. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81330. * @param a number
  81331. * @param b number
  81332. * @param epsilon (default = 1.401298E-45)
  81333. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81334. */
  81335. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81336. /**
  81337. * Returns a string : the upper case translation of the number i to hexadecimal.
  81338. * @param i number
  81339. * @returns the upper case translation of the number i to hexadecimal.
  81340. */
  81341. static ToHex(i: number): string;
  81342. /**
  81343. * Returns -1 if value is negative and +1 is value is positive.
  81344. * @param value the value
  81345. * @returns the value itself if it's equal to zero.
  81346. */
  81347. static Sign(value: number): number;
  81348. /**
  81349. * Returns the value itself if it's between min and max.
  81350. * Returns min if the value is lower than min.
  81351. * Returns max if the value is greater than max.
  81352. * @param value the value to clmap
  81353. * @param min the min value to clamp to (default: 0)
  81354. * @param max the max value to clamp to (default: 1)
  81355. * @returns the clamped value
  81356. */
  81357. static Clamp(value: number, min?: number, max?: number): number;
  81358. /**
  81359. * the log2 of value.
  81360. * @param value the value to compute log2 of
  81361. * @returns the log2 of value.
  81362. */
  81363. static Log2(value: number): number;
  81364. /**
  81365. * Loops the value, so that it is never larger than length and never smaller than 0.
  81366. *
  81367. * This is similar to the modulo operator but it works with floating point numbers.
  81368. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81369. * With t = 5 and length = 2.5, the result would be 0.0.
  81370. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81371. * @param value the value
  81372. * @param length the length
  81373. * @returns the looped value
  81374. */
  81375. static Repeat(value: number, length: number): number;
  81376. /**
  81377. * Normalize the value between 0.0 and 1.0 using min and max values
  81378. * @param value value to normalize
  81379. * @param min max to normalize between
  81380. * @param max min to normalize between
  81381. * @returns the normalized value
  81382. */
  81383. static Normalize(value: number, min: number, max: number): number;
  81384. /**
  81385. * Denormalize the value from 0.0 and 1.0 using min and max values
  81386. * @param normalized value to denormalize
  81387. * @param min max to denormalize between
  81388. * @param max min to denormalize between
  81389. * @returns the denormalized value
  81390. */
  81391. static Denormalize(normalized: number, min: number, max: number): number;
  81392. /**
  81393. * Calculates the shortest difference between two given angles given in degrees.
  81394. * @param current current angle in degrees
  81395. * @param target target angle in degrees
  81396. * @returns the delta
  81397. */
  81398. static DeltaAngle(current: number, target: number): number;
  81399. /**
  81400. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81401. * @param tx value
  81402. * @param length length
  81403. * @returns The returned value will move back and forth between 0 and length
  81404. */
  81405. static PingPong(tx: number, length: number): number;
  81406. /**
  81407. * Interpolates between min and max with smoothing at the limits.
  81408. *
  81409. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81410. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81411. * @param from from
  81412. * @param to to
  81413. * @param tx value
  81414. * @returns the smooth stepped value
  81415. */
  81416. static SmoothStep(from: number, to: number, tx: number): number;
  81417. /**
  81418. * Moves a value current towards target.
  81419. *
  81420. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81421. * Negative values of maxDelta pushes the value away from target.
  81422. * @param current current value
  81423. * @param target target value
  81424. * @param maxDelta max distance to move
  81425. * @returns resulting value
  81426. */
  81427. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81428. /**
  81429. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81430. *
  81431. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81432. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81433. * @param current current value
  81434. * @param target target value
  81435. * @param maxDelta max distance to move
  81436. * @returns resulting angle
  81437. */
  81438. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81439. /**
  81440. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81441. * @param start start value
  81442. * @param end target value
  81443. * @param amount amount to lerp between
  81444. * @returns the lerped value
  81445. */
  81446. static Lerp(start: number, end: number, amount: number): number;
  81447. /**
  81448. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81449. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81450. * @param start start value
  81451. * @param end target value
  81452. * @param amount amount to lerp between
  81453. * @returns the lerped value
  81454. */
  81455. static LerpAngle(start: number, end: number, amount: number): number;
  81456. /**
  81457. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81458. * @param a start value
  81459. * @param b target value
  81460. * @param value value between a and b
  81461. * @returns the inverseLerp value
  81462. */
  81463. static InverseLerp(a: number, b: number, value: number): number;
  81464. /**
  81465. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81466. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81467. * @param value1 spline value
  81468. * @param tangent1 spline value
  81469. * @param value2 spline value
  81470. * @param tangent2 spline value
  81471. * @param amount input value
  81472. * @returns hermite result
  81473. */
  81474. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81475. /**
  81476. * Returns a random float number between and min and max values
  81477. * @param min min value of random
  81478. * @param max max value of random
  81479. * @returns random value
  81480. */
  81481. static RandomRange(min: number, max: number): number;
  81482. /**
  81483. * This function returns percentage of a number in a given range.
  81484. *
  81485. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81486. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81487. * @param number to convert to percentage
  81488. * @param min min range
  81489. * @param max max range
  81490. * @returns the percentage
  81491. */
  81492. static RangeToPercent(number: number, min: number, max: number): number;
  81493. /**
  81494. * This function returns number that corresponds to the percentage in a given range.
  81495. *
  81496. * PercentToRange(0.34,0,100) will return 34.
  81497. * @param percent to convert to number
  81498. * @param min min range
  81499. * @param max max range
  81500. * @returns the number
  81501. */
  81502. static PercentToRange(percent: number, min: number, max: number): number;
  81503. /**
  81504. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81505. * @param angle The angle to normalize in radian.
  81506. * @return The converted angle.
  81507. */
  81508. static NormalizeRadians(angle: number): number;
  81509. }
  81510. }
  81511. declare module BABYLON {
  81512. /**
  81513. * Constant used to convert a value to gamma space
  81514. * @ignorenaming
  81515. */
  81516. export const ToGammaSpace: number;
  81517. /**
  81518. * Constant used to convert a value to linear space
  81519. * @ignorenaming
  81520. */
  81521. export const ToLinearSpace = 2.2;
  81522. /**
  81523. * Constant used to define the minimal number value in Babylon.js
  81524. * @ignorenaming
  81525. */
  81526. let Epsilon: number;
  81527. }
  81528. declare module BABYLON {
  81529. /**
  81530. * Class used to represent a viewport on screen
  81531. */
  81532. export class Viewport {
  81533. /** viewport left coordinate */
  81534. x: number;
  81535. /** viewport top coordinate */
  81536. y: number;
  81537. /**viewport width */
  81538. width: number;
  81539. /** viewport height */
  81540. height: number;
  81541. /**
  81542. * Creates a Viewport object located at (x, y) and sized (width, height)
  81543. * @param x defines viewport left coordinate
  81544. * @param y defines viewport top coordinate
  81545. * @param width defines the viewport width
  81546. * @param height defines the viewport height
  81547. */
  81548. constructor(
  81549. /** viewport left coordinate */
  81550. x: number,
  81551. /** viewport top coordinate */
  81552. y: number,
  81553. /**viewport width */
  81554. width: number,
  81555. /** viewport height */
  81556. height: number);
  81557. /**
  81558. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81559. * @param renderWidth defines the rendering width
  81560. * @param renderHeight defines the rendering height
  81561. * @returns a new Viewport
  81562. */
  81563. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81564. /**
  81565. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81566. * @param renderWidth defines the rendering width
  81567. * @param renderHeight defines the rendering height
  81568. * @param ref defines the target viewport
  81569. * @returns the current viewport
  81570. */
  81571. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81572. /**
  81573. * Returns a new Viewport copied from the current one
  81574. * @returns a new Viewport
  81575. */
  81576. clone(): Viewport;
  81577. }
  81578. }
  81579. declare module BABYLON {
  81580. /**
  81581. * Class containing a set of static utilities functions for arrays.
  81582. */
  81583. export class ArrayTools {
  81584. /**
  81585. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81586. * @param size the number of element to construct and put in the array
  81587. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81588. * @returns a new array filled with new objects
  81589. */
  81590. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81591. }
  81592. }
  81593. declare module BABYLON {
  81594. /**
  81595. * Represents a plane by the equation ax + by + cz + d = 0
  81596. */
  81597. export class Plane {
  81598. private static _TmpMatrix;
  81599. /**
  81600. * Normal of the plane (a,b,c)
  81601. */
  81602. normal: Vector3;
  81603. /**
  81604. * d component of the plane
  81605. */
  81606. d: number;
  81607. /**
  81608. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81609. * @param a a component of the plane
  81610. * @param b b component of the plane
  81611. * @param c c component of the plane
  81612. * @param d d component of the plane
  81613. */
  81614. constructor(a: number, b: number, c: number, d: number);
  81615. /**
  81616. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81617. */
  81618. asArray(): number[];
  81619. /**
  81620. * @returns a new plane copied from the current Plane.
  81621. */
  81622. clone(): Plane;
  81623. /**
  81624. * @returns the string "Plane".
  81625. */
  81626. getClassName(): string;
  81627. /**
  81628. * @returns the Plane hash code.
  81629. */
  81630. getHashCode(): number;
  81631. /**
  81632. * Normalize the current Plane in place.
  81633. * @returns the updated Plane.
  81634. */
  81635. normalize(): Plane;
  81636. /**
  81637. * Applies a transformation the plane and returns the result
  81638. * @param transformation the transformation matrix to be applied to the plane
  81639. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81640. */
  81641. transform(transformation: DeepImmutable<Matrix>): Plane;
  81642. /**
  81643. * Compute the dot product between the point and the plane normal
  81644. * @param point point to calculate the dot product with
  81645. * @returns the dot product (float) of the point coordinates and the plane normal.
  81646. */
  81647. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81648. /**
  81649. * Updates the current Plane from the plane defined by the three given points.
  81650. * @param point1 one of the points used to contruct the plane
  81651. * @param point2 one of the points used to contruct the plane
  81652. * @param point3 one of the points used to contruct the plane
  81653. * @returns the updated Plane.
  81654. */
  81655. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81656. /**
  81657. * Checks if the plane is facing a given direction
  81658. * @param direction the direction to check if the plane is facing
  81659. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81660. * @returns True is the vector "direction" is the same side than the plane normal.
  81661. */
  81662. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81663. /**
  81664. * Calculates the distance to a point
  81665. * @param point point to calculate distance to
  81666. * @returns the signed distance (float) from the given point to the Plane.
  81667. */
  81668. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81669. /**
  81670. * Creates a plane from an array
  81671. * @param array the array to create a plane from
  81672. * @returns a new Plane from the given array.
  81673. */
  81674. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81675. /**
  81676. * Creates a plane from three points
  81677. * @param point1 point used to create the plane
  81678. * @param point2 point used to create the plane
  81679. * @param point3 point used to create the plane
  81680. * @returns a new Plane defined by the three given points.
  81681. */
  81682. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81683. /**
  81684. * Creates a plane from an origin point and a normal
  81685. * @param origin origin of the plane to be constructed
  81686. * @param normal normal of the plane to be constructed
  81687. * @returns a new Plane the normal vector to this plane at the given origin point.
  81688. * Note : the vector "normal" is updated because normalized.
  81689. */
  81690. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81691. /**
  81692. * Calculates the distance from a plane and a point
  81693. * @param origin origin of the plane to be constructed
  81694. * @param normal normal of the plane to be constructed
  81695. * @param point point to calculate distance to
  81696. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81697. */
  81698. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81699. }
  81700. }
  81701. declare module BABYLON {
  81702. /** @hidden */
  81703. export class PerformanceConfigurator {
  81704. /** @hidden */
  81705. static MatrixUse64Bits: boolean;
  81706. /** @hidden */
  81707. static MatrixTrackPrecisionChange: boolean;
  81708. /** @hidden */
  81709. static MatrixCurrentType: any;
  81710. /** @hidden */
  81711. static MatrixTrackedMatrices: Array<any> | null;
  81712. /** @hidden */
  81713. static SetMatrixPrecision(use64bits: boolean): void;
  81714. }
  81715. }
  81716. declare module BABYLON {
  81717. /**
  81718. * Class representing a vector containing 2 coordinates
  81719. */
  81720. export class Vector2 {
  81721. /** defines the first coordinate */
  81722. x: number;
  81723. /** defines the second coordinate */
  81724. y: number;
  81725. /**
  81726. * Creates a new Vector2 from the given x and y coordinates
  81727. * @param x defines the first coordinate
  81728. * @param y defines the second coordinate
  81729. */
  81730. constructor(
  81731. /** defines the first coordinate */
  81732. x?: number,
  81733. /** defines the second coordinate */
  81734. y?: number);
  81735. /**
  81736. * Gets a string with the Vector2 coordinates
  81737. * @returns a string with the Vector2 coordinates
  81738. */
  81739. toString(): string;
  81740. /**
  81741. * Gets class name
  81742. * @returns the string "Vector2"
  81743. */
  81744. getClassName(): string;
  81745. /**
  81746. * Gets current vector hash code
  81747. * @returns the Vector2 hash code as a number
  81748. */
  81749. getHashCode(): number;
  81750. /**
  81751. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81752. * @param array defines the source array
  81753. * @param index defines the offset in source array
  81754. * @returns the current Vector2
  81755. */
  81756. toArray(array: FloatArray, index?: number): Vector2;
  81757. /**
  81758. * Update the current vector from an array
  81759. * @param array defines the destination array
  81760. * @param index defines the offset in the destination array
  81761. * @returns the current Vector3
  81762. */
  81763. fromArray(array: FloatArray, index?: number): Vector2;
  81764. /**
  81765. * Copy the current vector to an array
  81766. * @returns a new array with 2 elements: the Vector2 coordinates.
  81767. */
  81768. asArray(): number[];
  81769. /**
  81770. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81771. * @param source defines the source Vector2
  81772. * @returns the current updated Vector2
  81773. */
  81774. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81775. /**
  81776. * Sets the Vector2 coordinates with the given floats
  81777. * @param x defines the first coordinate
  81778. * @param y defines the second coordinate
  81779. * @returns the current updated Vector2
  81780. */
  81781. copyFromFloats(x: number, y: number): Vector2;
  81782. /**
  81783. * Sets the Vector2 coordinates with the given floats
  81784. * @param x defines the first coordinate
  81785. * @param y defines the second coordinate
  81786. * @returns the current updated Vector2
  81787. */
  81788. set(x: number, y: number): Vector2;
  81789. /**
  81790. * Add another vector with the current one
  81791. * @param otherVector defines the other vector
  81792. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81793. */
  81794. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81795. /**
  81796. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81797. * @param otherVector defines the other vector
  81798. * @param result defines the target vector
  81799. * @returns the unmodified current Vector2
  81800. */
  81801. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81802. /**
  81803. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81804. * @param otherVector defines the other vector
  81805. * @returns the current updated Vector2
  81806. */
  81807. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81808. /**
  81809. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81810. * @param otherVector defines the other vector
  81811. * @returns a new Vector2
  81812. */
  81813. addVector3(otherVector: Vector3): Vector2;
  81814. /**
  81815. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81816. * @param otherVector defines the other vector
  81817. * @returns a new Vector2
  81818. */
  81819. subtract(otherVector: Vector2): Vector2;
  81820. /**
  81821. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81822. * @param otherVector defines the other vector
  81823. * @param result defines the target vector
  81824. * @returns the unmodified current Vector2
  81825. */
  81826. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81827. /**
  81828. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81829. * @param otherVector defines the other vector
  81830. * @returns the current updated Vector2
  81831. */
  81832. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81833. /**
  81834. * Multiplies in place the current Vector2 coordinates by the given ones
  81835. * @param otherVector defines the other vector
  81836. * @returns the current updated Vector2
  81837. */
  81838. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81839. /**
  81840. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81841. * @param otherVector defines the other vector
  81842. * @returns a new Vector2
  81843. */
  81844. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81845. /**
  81846. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81847. * @param otherVector defines the other vector
  81848. * @param result defines the target vector
  81849. * @returns the unmodified current Vector2
  81850. */
  81851. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81852. /**
  81853. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81854. * @param x defines the first coordinate
  81855. * @param y defines the second coordinate
  81856. * @returns a new Vector2
  81857. */
  81858. multiplyByFloats(x: number, y: number): Vector2;
  81859. /**
  81860. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81861. * @param otherVector defines the other vector
  81862. * @returns a new Vector2
  81863. */
  81864. divide(otherVector: Vector2): Vector2;
  81865. /**
  81866. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81867. * @param otherVector defines the other vector
  81868. * @param result defines the target vector
  81869. * @returns the unmodified current Vector2
  81870. */
  81871. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81872. /**
  81873. * Divides the current Vector2 coordinates by the given ones
  81874. * @param otherVector defines the other vector
  81875. * @returns the current updated Vector2
  81876. */
  81877. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81878. /**
  81879. * Gets a new Vector2 with current Vector2 negated coordinates
  81880. * @returns a new Vector2
  81881. */
  81882. negate(): Vector2;
  81883. /**
  81884. * Negate this vector in place
  81885. * @returns this
  81886. */
  81887. negateInPlace(): Vector2;
  81888. /**
  81889. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81890. * @param result defines the Vector3 object where to store the result
  81891. * @returns the current Vector2
  81892. */
  81893. negateToRef(result: Vector2): Vector2;
  81894. /**
  81895. * Multiply the Vector2 coordinates by scale
  81896. * @param scale defines the scaling factor
  81897. * @returns the current updated Vector2
  81898. */
  81899. scaleInPlace(scale: number): Vector2;
  81900. /**
  81901. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81902. * @param scale defines the scaling factor
  81903. * @returns a new Vector2
  81904. */
  81905. scale(scale: number): Vector2;
  81906. /**
  81907. * Scale the current Vector2 values by a factor to a given Vector2
  81908. * @param scale defines the scale factor
  81909. * @param result defines the Vector2 object where to store the result
  81910. * @returns the unmodified current Vector2
  81911. */
  81912. scaleToRef(scale: number, result: Vector2): Vector2;
  81913. /**
  81914. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81915. * @param scale defines the scale factor
  81916. * @param result defines the Vector2 object where to store the result
  81917. * @returns the unmodified current Vector2
  81918. */
  81919. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81920. /**
  81921. * Gets a boolean if two vectors are equals
  81922. * @param otherVector defines the other vector
  81923. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81924. */
  81925. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81926. /**
  81927. * Gets a boolean if two vectors are equals (using an epsilon value)
  81928. * @param otherVector defines the other vector
  81929. * @param epsilon defines the minimal distance to consider equality
  81930. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81931. */
  81932. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81933. /**
  81934. * Gets a new Vector2 from current Vector2 floored values
  81935. * @returns a new Vector2
  81936. */
  81937. floor(): Vector2;
  81938. /**
  81939. * Gets a new Vector2 from current Vector2 floored values
  81940. * @returns a new Vector2
  81941. */
  81942. fract(): Vector2;
  81943. /**
  81944. * Gets the length of the vector
  81945. * @returns the vector length (float)
  81946. */
  81947. length(): number;
  81948. /**
  81949. * Gets the vector squared length
  81950. * @returns the vector squared length (float)
  81951. */
  81952. lengthSquared(): number;
  81953. /**
  81954. * Normalize the vector
  81955. * @returns the current updated Vector2
  81956. */
  81957. normalize(): Vector2;
  81958. /**
  81959. * Gets a new Vector2 copied from the Vector2
  81960. * @returns a new Vector2
  81961. */
  81962. clone(): Vector2;
  81963. /**
  81964. * Gets a new Vector2(0, 0)
  81965. * @returns a new Vector2
  81966. */
  81967. static Zero(): Vector2;
  81968. /**
  81969. * Gets a new Vector2(1, 1)
  81970. * @returns a new Vector2
  81971. */
  81972. static One(): Vector2;
  81973. /**
  81974. * Gets a new Vector2 set from the given index element of the given array
  81975. * @param array defines the data source
  81976. * @param offset defines the offset in the data source
  81977. * @returns a new Vector2
  81978. */
  81979. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81980. /**
  81981. * Sets "result" from the given index element of the given array
  81982. * @param array defines the data source
  81983. * @param offset defines the offset in the data source
  81984. * @param result defines the target vector
  81985. */
  81986. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81987. /**
  81988. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81989. * @param value1 defines 1st point of control
  81990. * @param value2 defines 2nd point of control
  81991. * @param value3 defines 3rd point of control
  81992. * @param value4 defines 4th point of control
  81993. * @param amount defines the interpolation factor
  81994. * @returns a new Vector2
  81995. */
  81996. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81997. /**
  81998. * 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".
  81999. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  82000. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  82001. * @param value defines the value to clamp
  82002. * @param min defines the lower limit
  82003. * @param max defines the upper limit
  82004. * @returns a new Vector2
  82005. */
  82006. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  82007. /**
  82008. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  82009. * @param value1 defines the 1st control point
  82010. * @param tangent1 defines the outgoing tangent
  82011. * @param value2 defines the 2nd control point
  82012. * @param tangent2 defines the incoming tangent
  82013. * @param amount defines the interpolation factor
  82014. * @returns a new Vector2
  82015. */
  82016. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82017. /**
  82018. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82019. * @param start defines the start vector
  82020. * @param end defines the end vector
  82021. * @param amount defines the interpolation factor
  82022. * @returns a new Vector2
  82023. */
  82024. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82025. /**
  82026. * Gets the dot product of the vector "left" and the vector "right"
  82027. * @param left defines first vector
  82028. * @param right defines second vector
  82029. * @returns the dot product (float)
  82030. */
  82031. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82032. /**
  82033. * Returns a new Vector2 equal to the normalized given vector
  82034. * @param vector defines the vector to normalize
  82035. * @returns a new Vector2
  82036. */
  82037. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82038. /**
  82039. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82040. * @param left defines 1st vector
  82041. * @param right defines 2nd vector
  82042. * @returns a new Vector2
  82043. */
  82044. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82045. /**
  82046. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82047. * @param left defines 1st vector
  82048. * @param right defines 2nd vector
  82049. * @returns a new Vector2
  82050. */
  82051. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82052. /**
  82053. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82054. * @param vector defines the vector to transform
  82055. * @param transformation defines the matrix to apply
  82056. * @returns a new Vector2
  82057. */
  82058. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82059. /**
  82060. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82061. * @param vector defines the vector to transform
  82062. * @param transformation defines the matrix to apply
  82063. * @param result defines the target vector
  82064. */
  82065. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82066. /**
  82067. * Determines if a given vector is included in a triangle
  82068. * @param p defines the vector to test
  82069. * @param p0 defines 1st triangle point
  82070. * @param p1 defines 2nd triangle point
  82071. * @param p2 defines 3rd triangle point
  82072. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82073. */
  82074. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82075. /**
  82076. * Gets the distance between the vectors "value1" and "value2"
  82077. * @param value1 defines first vector
  82078. * @param value2 defines second vector
  82079. * @returns the distance between vectors
  82080. */
  82081. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82082. /**
  82083. * Returns the squared distance between the vectors "value1" and "value2"
  82084. * @param value1 defines first vector
  82085. * @param value2 defines second vector
  82086. * @returns the squared distance between vectors
  82087. */
  82088. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82089. /**
  82090. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82091. * @param value1 defines first vector
  82092. * @param value2 defines second vector
  82093. * @returns a new Vector2
  82094. */
  82095. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82096. /**
  82097. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82098. * @param p defines the middle point
  82099. * @param segA defines one point of the segment
  82100. * @param segB defines the other point of the segment
  82101. * @returns the shortest distance
  82102. */
  82103. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82104. }
  82105. /**
  82106. * Class used to store (x,y,z) vector representation
  82107. * A Vector3 is the main object used in 3D geometry
  82108. * It can represent etiher the coordinates of a point the space, either a direction
  82109. * Reminder: js uses a left handed forward facing system
  82110. */
  82111. export class Vector3 {
  82112. private static _UpReadOnly;
  82113. private static _ZeroReadOnly;
  82114. /** @hidden */
  82115. _x: number;
  82116. /** @hidden */
  82117. _y: number;
  82118. /** @hidden */
  82119. _z: number;
  82120. /** @hidden */
  82121. _isDirty: boolean;
  82122. /** Gets or sets the x coordinate */
  82123. get x(): number;
  82124. set x(value: number);
  82125. /** Gets or sets the y coordinate */
  82126. get y(): number;
  82127. set y(value: number);
  82128. /** Gets or sets the z coordinate */
  82129. get z(): number;
  82130. set z(value: number);
  82131. /**
  82132. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82133. * @param x defines the first coordinates (on X axis)
  82134. * @param y defines the second coordinates (on Y axis)
  82135. * @param z defines the third coordinates (on Z axis)
  82136. */
  82137. constructor(x?: number, y?: number, z?: number);
  82138. /**
  82139. * Creates a string representation of the Vector3
  82140. * @returns a string with the Vector3 coordinates.
  82141. */
  82142. toString(): string;
  82143. /**
  82144. * Gets the class name
  82145. * @returns the string "Vector3"
  82146. */
  82147. getClassName(): string;
  82148. /**
  82149. * Creates the Vector3 hash code
  82150. * @returns a number which tends to be unique between Vector3 instances
  82151. */
  82152. getHashCode(): number;
  82153. /**
  82154. * Creates an array containing three elements : the coordinates of the Vector3
  82155. * @returns a new array of numbers
  82156. */
  82157. asArray(): number[];
  82158. /**
  82159. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82160. * @param array defines the destination array
  82161. * @param index defines the offset in the destination array
  82162. * @returns the current Vector3
  82163. */
  82164. toArray(array: FloatArray, index?: number): Vector3;
  82165. /**
  82166. * Update the current vector from an array
  82167. * @param array defines the destination array
  82168. * @param index defines the offset in the destination array
  82169. * @returns the current Vector3
  82170. */
  82171. fromArray(array: FloatArray, index?: number): Vector3;
  82172. /**
  82173. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82174. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82175. */
  82176. toQuaternion(): Quaternion;
  82177. /**
  82178. * Adds the given vector to the current Vector3
  82179. * @param otherVector defines the second operand
  82180. * @returns the current updated Vector3
  82181. */
  82182. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82183. /**
  82184. * Adds the given coordinates to the current Vector3
  82185. * @param x defines the x coordinate of the operand
  82186. * @param y defines the y coordinate of the operand
  82187. * @param z defines the z coordinate of the operand
  82188. * @returns the current updated Vector3
  82189. */
  82190. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82191. /**
  82192. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82193. * @param otherVector defines the second operand
  82194. * @returns the resulting Vector3
  82195. */
  82196. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82197. /**
  82198. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82199. * @param otherVector defines the second operand
  82200. * @param result defines the Vector3 object where to store the result
  82201. * @returns the current Vector3
  82202. */
  82203. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82204. /**
  82205. * Subtract the given vector from the current Vector3
  82206. * @param otherVector defines the second operand
  82207. * @returns the current updated Vector3
  82208. */
  82209. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82210. /**
  82211. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82212. * @param otherVector defines the second operand
  82213. * @returns the resulting Vector3
  82214. */
  82215. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82216. /**
  82217. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82218. * @param otherVector defines the second operand
  82219. * @param result defines the Vector3 object where to store the result
  82220. * @returns the current Vector3
  82221. */
  82222. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82223. /**
  82224. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82225. * @param x defines the x coordinate of the operand
  82226. * @param y defines the y coordinate of the operand
  82227. * @param z defines the z coordinate of the operand
  82228. * @returns the resulting Vector3
  82229. */
  82230. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82231. /**
  82232. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82233. * @param x defines the x coordinate of the operand
  82234. * @param y defines the y coordinate of the operand
  82235. * @param z defines the z coordinate of the operand
  82236. * @param result defines the Vector3 object where to store the result
  82237. * @returns the current Vector3
  82238. */
  82239. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82240. /**
  82241. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82242. * @returns a new Vector3
  82243. */
  82244. negate(): Vector3;
  82245. /**
  82246. * Negate this vector in place
  82247. * @returns this
  82248. */
  82249. negateInPlace(): Vector3;
  82250. /**
  82251. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82252. * @param result defines the Vector3 object where to store the result
  82253. * @returns the current Vector3
  82254. */
  82255. negateToRef(result: Vector3): Vector3;
  82256. /**
  82257. * Multiplies the Vector3 coordinates by the float "scale"
  82258. * @param scale defines the multiplier factor
  82259. * @returns the current updated Vector3
  82260. */
  82261. scaleInPlace(scale: number): Vector3;
  82262. /**
  82263. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82264. * @param scale defines the multiplier factor
  82265. * @returns a new Vector3
  82266. */
  82267. scale(scale: number): Vector3;
  82268. /**
  82269. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82270. * @param scale defines the multiplier factor
  82271. * @param result defines the Vector3 object where to store the result
  82272. * @returns the current Vector3
  82273. */
  82274. scaleToRef(scale: number, result: Vector3): Vector3;
  82275. /**
  82276. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82277. * @param scale defines the scale factor
  82278. * @param result defines the Vector3 object where to store the result
  82279. * @returns the unmodified current Vector3
  82280. */
  82281. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82282. /**
  82283. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82284. * @param origin defines the origin of the projection ray
  82285. * @param plane defines the plane to project to
  82286. * @returns the projected vector3
  82287. */
  82288. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82289. /**
  82290. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82291. * @param origin defines the origin of the projection ray
  82292. * @param plane defines the plane to project to
  82293. * @param result defines the Vector3 where to store the result
  82294. */
  82295. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82296. /**
  82297. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82298. * @param otherVector defines the second operand
  82299. * @returns true if both vectors are equals
  82300. */
  82301. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82302. /**
  82303. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82304. * @param otherVector defines the second operand
  82305. * @param epsilon defines the minimal distance to define values as equals
  82306. * @returns true if both vectors are distant less than epsilon
  82307. */
  82308. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82309. /**
  82310. * Returns true if the current Vector3 coordinates equals the given floats
  82311. * @param x defines the x coordinate of the operand
  82312. * @param y defines the y coordinate of the operand
  82313. * @param z defines the z coordinate of the operand
  82314. * @returns true if both vectors are equals
  82315. */
  82316. equalsToFloats(x: number, y: number, z: number): boolean;
  82317. /**
  82318. * Multiplies the current Vector3 coordinates by the given ones
  82319. * @param otherVector defines the second operand
  82320. * @returns the current updated Vector3
  82321. */
  82322. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82323. /**
  82324. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82325. * @param otherVector defines the second operand
  82326. * @returns the new Vector3
  82327. */
  82328. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82329. /**
  82330. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82331. * @param otherVector defines the second operand
  82332. * @param result defines the Vector3 object where to store the result
  82333. * @returns the current Vector3
  82334. */
  82335. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82336. /**
  82337. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82338. * @param x defines the x coordinate of the operand
  82339. * @param y defines the y coordinate of the operand
  82340. * @param z defines the z coordinate of the operand
  82341. * @returns the new Vector3
  82342. */
  82343. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82344. /**
  82345. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82346. * @param otherVector defines the second operand
  82347. * @returns the new Vector3
  82348. */
  82349. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82350. /**
  82351. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82352. * @param otherVector defines the second operand
  82353. * @param result defines the Vector3 object where to store the result
  82354. * @returns the current Vector3
  82355. */
  82356. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82357. /**
  82358. * Divides the current Vector3 coordinates by the given ones.
  82359. * @param otherVector defines the second operand
  82360. * @returns the current updated Vector3
  82361. */
  82362. divideInPlace(otherVector: Vector3): Vector3;
  82363. /**
  82364. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82365. * @param other defines the second operand
  82366. * @returns the current updated Vector3
  82367. */
  82368. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82369. /**
  82370. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82371. * @param other defines the second operand
  82372. * @returns the current updated Vector3
  82373. */
  82374. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82375. /**
  82376. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82377. * @param x defines the x coordinate of the operand
  82378. * @param y defines the y coordinate of the operand
  82379. * @param z defines the z coordinate of the operand
  82380. * @returns the current updated Vector3
  82381. */
  82382. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82383. /**
  82384. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82385. * @param x defines the x coordinate of the operand
  82386. * @param y defines the y coordinate of the operand
  82387. * @param z defines the z coordinate of the operand
  82388. * @returns the current updated Vector3
  82389. */
  82390. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82391. /**
  82392. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82393. * Check if is non uniform within a certain amount of decimal places to account for this
  82394. * @param epsilon the amount the values can differ
  82395. * @returns if the the vector is non uniform to a certain number of decimal places
  82396. */
  82397. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82398. /**
  82399. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82400. */
  82401. get isNonUniform(): boolean;
  82402. /**
  82403. * Gets a new Vector3 from current Vector3 floored values
  82404. * @returns a new Vector3
  82405. */
  82406. floor(): Vector3;
  82407. /**
  82408. * Gets a new Vector3 from current Vector3 floored values
  82409. * @returns a new Vector3
  82410. */
  82411. fract(): Vector3;
  82412. /**
  82413. * Gets the length of the Vector3
  82414. * @returns the length of the Vector3
  82415. */
  82416. length(): number;
  82417. /**
  82418. * Gets the squared length of the Vector3
  82419. * @returns squared length of the Vector3
  82420. */
  82421. lengthSquared(): number;
  82422. /**
  82423. * Normalize the current Vector3.
  82424. * Please note that this is an in place operation.
  82425. * @returns the current updated Vector3
  82426. */
  82427. normalize(): Vector3;
  82428. /**
  82429. * Reorders the x y z properties of the vector in place
  82430. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82431. * @returns the current updated vector
  82432. */
  82433. reorderInPlace(order: string): this;
  82434. /**
  82435. * Rotates the vector around 0,0,0 by a quaternion
  82436. * @param quaternion the rotation quaternion
  82437. * @param result vector to store the result
  82438. * @returns the resulting vector
  82439. */
  82440. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82441. /**
  82442. * Rotates a vector around a given point
  82443. * @param quaternion the rotation quaternion
  82444. * @param point the point to rotate around
  82445. * @param result vector to store the result
  82446. * @returns the resulting vector
  82447. */
  82448. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82449. /**
  82450. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82451. * The cross product is then orthogonal to both current and "other"
  82452. * @param other defines the right operand
  82453. * @returns the cross product
  82454. */
  82455. cross(other: Vector3): Vector3;
  82456. /**
  82457. * Normalize the current Vector3 with the given input length.
  82458. * Please note that this is an in place operation.
  82459. * @param len the length of the vector
  82460. * @returns the current updated Vector3
  82461. */
  82462. normalizeFromLength(len: number): Vector3;
  82463. /**
  82464. * Normalize the current Vector3 to a new vector
  82465. * @returns the new Vector3
  82466. */
  82467. normalizeToNew(): Vector3;
  82468. /**
  82469. * Normalize the current Vector3 to the reference
  82470. * @param reference define the Vector3 to update
  82471. * @returns the updated Vector3
  82472. */
  82473. normalizeToRef(reference: Vector3): Vector3;
  82474. /**
  82475. * Creates a new Vector3 copied from the current Vector3
  82476. * @returns the new Vector3
  82477. */
  82478. clone(): Vector3;
  82479. /**
  82480. * Copies the given vector coordinates to the current Vector3 ones
  82481. * @param source defines the source Vector3
  82482. * @returns the current updated Vector3
  82483. */
  82484. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82485. /**
  82486. * Copies the given floats to the current Vector3 coordinates
  82487. * @param x defines the x coordinate of the operand
  82488. * @param y defines the y coordinate of the operand
  82489. * @param z defines the z coordinate of the operand
  82490. * @returns the current updated Vector3
  82491. */
  82492. copyFromFloats(x: number, y: number, z: number): Vector3;
  82493. /**
  82494. * Copies the given floats to the current Vector3 coordinates
  82495. * @param x defines the x coordinate of the operand
  82496. * @param y defines the y coordinate of the operand
  82497. * @param z defines the z coordinate of the operand
  82498. * @returns the current updated Vector3
  82499. */
  82500. set(x: number, y: number, z: number): Vector3;
  82501. /**
  82502. * Copies the given float to the current Vector3 coordinates
  82503. * @param v defines the x, y and z coordinates of the operand
  82504. * @returns the current updated Vector3
  82505. */
  82506. setAll(v: number): Vector3;
  82507. /**
  82508. * Get the clip factor between two vectors
  82509. * @param vector0 defines the first operand
  82510. * @param vector1 defines the second operand
  82511. * @param axis defines the axis to use
  82512. * @param size defines the size along the axis
  82513. * @returns the clip factor
  82514. */
  82515. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82516. /**
  82517. * Get angle between two vectors
  82518. * @param vector0 angle between vector0 and vector1
  82519. * @param vector1 angle between vector0 and vector1
  82520. * @param normal direction of the normal
  82521. * @return the angle between vector0 and vector1
  82522. */
  82523. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82524. /**
  82525. * Returns a new Vector3 set from the index "offset" of the given array
  82526. * @param array defines the source array
  82527. * @param offset defines the offset in the source array
  82528. * @returns the new Vector3
  82529. */
  82530. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82531. /**
  82532. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82533. * @param array defines the source array
  82534. * @param offset defines the offset in the source array
  82535. * @returns the new Vector3
  82536. * @deprecated Please use FromArray instead.
  82537. */
  82538. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82539. /**
  82540. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82541. * @param array defines the source array
  82542. * @param offset defines the offset in the source array
  82543. * @param result defines the Vector3 where to store the result
  82544. */
  82545. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82546. /**
  82547. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82548. * @param array defines the source array
  82549. * @param offset defines the offset in the source array
  82550. * @param result defines the Vector3 where to store the result
  82551. * @deprecated Please use FromArrayToRef instead.
  82552. */
  82553. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82554. /**
  82555. * Sets the given vector "result" with the given floats.
  82556. * @param x defines the x coordinate of the source
  82557. * @param y defines the y coordinate of the source
  82558. * @param z defines the z coordinate of the source
  82559. * @param result defines the Vector3 where to store the result
  82560. */
  82561. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82562. /**
  82563. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82564. * @returns a new empty Vector3
  82565. */
  82566. static Zero(): Vector3;
  82567. /**
  82568. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82569. * @returns a new unit Vector3
  82570. */
  82571. static One(): Vector3;
  82572. /**
  82573. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82574. * @returns a new up Vector3
  82575. */
  82576. static Up(): Vector3;
  82577. /**
  82578. * Gets a up Vector3 that must not be updated
  82579. */
  82580. static get UpReadOnly(): DeepImmutable<Vector3>;
  82581. /**
  82582. * Gets a zero Vector3 that must not be updated
  82583. */
  82584. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82585. /**
  82586. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82587. * @returns a new down Vector3
  82588. */
  82589. static Down(): Vector3;
  82590. /**
  82591. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82592. * @param rightHandedSystem is the scene right-handed (negative z)
  82593. * @returns a new forward Vector3
  82594. */
  82595. static Forward(rightHandedSystem?: boolean): Vector3;
  82596. /**
  82597. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82598. * @param rightHandedSystem is the scene right-handed (negative-z)
  82599. * @returns a new forward Vector3
  82600. */
  82601. static Backward(rightHandedSystem?: boolean): Vector3;
  82602. /**
  82603. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82604. * @returns a new right Vector3
  82605. */
  82606. static Right(): Vector3;
  82607. /**
  82608. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82609. * @returns a new left Vector3
  82610. */
  82611. static Left(): Vector3;
  82612. /**
  82613. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82614. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82615. * @param vector defines the Vector3 to transform
  82616. * @param transformation defines the transformation matrix
  82617. * @returns the transformed Vector3
  82618. */
  82619. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82620. /**
  82621. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82622. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82623. * @param vector defines the Vector3 to transform
  82624. * @param transformation defines the transformation matrix
  82625. * @param result defines the Vector3 where to store the result
  82626. */
  82627. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82628. /**
  82629. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82630. * This method computes tranformed coordinates only, not transformed direction vectors
  82631. * @param x define the x coordinate of the source vector
  82632. * @param y define the y coordinate of the source vector
  82633. * @param z define the z coordinate of the source vector
  82634. * @param transformation defines the transformation matrix
  82635. * @param result defines the Vector3 where to store the result
  82636. */
  82637. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82638. /**
  82639. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82640. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82641. * @param vector defines the Vector3 to transform
  82642. * @param transformation defines the transformation matrix
  82643. * @returns the new Vector3
  82644. */
  82645. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82646. /**
  82647. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82648. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82649. * @param vector defines the Vector3 to transform
  82650. * @param transformation defines the transformation matrix
  82651. * @param result defines the Vector3 where to store the result
  82652. */
  82653. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82654. /**
  82655. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82656. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82657. * @param x define the x coordinate of the source vector
  82658. * @param y define the y coordinate of the source vector
  82659. * @param z define the z coordinate of the source vector
  82660. * @param transformation defines the transformation matrix
  82661. * @param result defines the Vector3 where to store the result
  82662. */
  82663. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82664. /**
  82665. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82666. * @param value1 defines the first control point
  82667. * @param value2 defines the second control point
  82668. * @param value3 defines the third control point
  82669. * @param value4 defines the fourth control point
  82670. * @param amount defines the amount on the spline to use
  82671. * @returns the new Vector3
  82672. */
  82673. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82674. /**
  82675. * 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"
  82676. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82677. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82678. * @param value defines the current value
  82679. * @param min defines the lower range value
  82680. * @param max defines the upper range value
  82681. * @returns the new Vector3
  82682. */
  82683. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82684. /**
  82685. * 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"
  82686. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82687. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82688. * @param value defines the current value
  82689. * @param min defines the lower range value
  82690. * @param max defines the upper range value
  82691. * @param result defines the Vector3 where to store the result
  82692. */
  82693. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82694. /**
  82695. * Checks if a given vector is inside a specific range
  82696. * @param v defines the vector to test
  82697. * @param min defines the minimum range
  82698. * @param max defines the maximum range
  82699. */
  82700. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82701. /**
  82702. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82703. * @param value1 defines the first control point
  82704. * @param tangent1 defines the first tangent vector
  82705. * @param value2 defines the second control point
  82706. * @param tangent2 defines the second tangent vector
  82707. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82708. * @returns the new Vector3
  82709. */
  82710. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82711. /**
  82712. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82713. * @param start defines the start value
  82714. * @param end defines the end value
  82715. * @param amount max defines amount between both (between 0 and 1)
  82716. * @returns the new Vector3
  82717. */
  82718. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82719. /**
  82720. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82721. * @param start defines the start value
  82722. * @param end defines the end value
  82723. * @param amount max defines amount between both (between 0 and 1)
  82724. * @param result defines the Vector3 where to store the result
  82725. */
  82726. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82727. /**
  82728. * Returns the dot product (float) between the vectors "left" and "right"
  82729. * @param left defines the left operand
  82730. * @param right defines the right operand
  82731. * @returns the dot product
  82732. */
  82733. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82734. /**
  82735. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82736. * The cross product is then orthogonal to both "left" and "right"
  82737. * @param left defines the left operand
  82738. * @param right defines the right operand
  82739. * @returns the cross product
  82740. */
  82741. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82742. /**
  82743. * Sets the given vector "result" with the cross product of "left" and "right"
  82744. * The cross product is then orthogonal to both "left" and "right"
  82745. * @param left defines the left operand
  82746. * @param right defines the right operand
  82747. * @param result defines the Vector3 where to store the result
  82748. */
  82749. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82750. /**
  82751. * Returns a new Vector3 as the normalization of the given vector
  82752. * @param vector defines the Vector3 to normalize
  82753. * @returns the new Vector3
  82754. */
  82755. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82756. /**
  82757. * Sets the given vector "result" with the normalization of the given first vector
  82758. * @param vector defines the Vector3 to normalize
  82759. * @param result defines the Vector3 where to store the result
  82760. */
  82761. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82762. /**
  82763. * Project a Vector3 onto screen space
  82764. * @param vector defines the Vector3 to project
  82765. * @param world defines the world matrix to use
  82766. * @param transform defines the transform (view x projection) matrix to use
  82767. * @param viewport defines the screen viewport to use
  82768. * @returns the new Vector3
  82769. */
  82770. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82771. /** @hidden */
  82772. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82773. /**
  82774. * Unproject from screen space to object space
  82775. * @param source defines the screen space Vector3 to use
  82776. * @param viewportWidth defines the current width of the viewport
  82777. * @param viewportHeight defines the current height of the viewport
  82778. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82779. * @param transform defines the transform (view x projection) matrix to use
  82780. * @returns the new Vector3
  82781. */
  82782. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82783. /**
  82784. * Unproject from screen space to object space
  82785. * @param source defines the screen space Vector3 to use
  82786. * @param viewportWidth defines the current width of the viewport
  82787. * @param viewportHeight defines the current height of the viewport
  82788. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82789. * @param view defines the view matrix to use
  82790. * @param projection defines the projection matrix to use
  82791. * @returns the new Vector3
  82792. */
  82793. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82794. /**
  82795. * Unproject from screen space to object space
  82796. * @param source defines the screen space Vector3 to use
  82797. * @param viewportWidth defines the current width of the viewport
  82798. * @param viewportHeight defines the current height of the viewport
  82799. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82800. * @param view defines the view matrix to use
  82801. * @param projection defines the projection matrix to use
  82802. * @param result defines the Vector3 where to store the result
  82803. */
  82804. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82805. /**
  82806. * Unproject from screen space to object space
  82807. * @param sourceX defines the screen space x coordinate to use
  82808. * @param sourceY defines the screen space y coordinate to use
  82809. * @param sourceZ defines the screen space z coordinate to use
  82810. * @param viewportWidth defines the current width of the viewport
  82811. * @param viewportHeight defines the current height of the viewport
  82812. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82813. * @param view defines the view matrix to use
  82814. * @param projection defines the projection matrix to use
  82815. * @param result defines the Vector3 where to store the result
  82816. */
  82817. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82818. /**
  82819. * Gets the minimal coordinate values between two Vector3
  82820. * @param left defines the first operand
  82821. * @param right defines the second operand
  82822. * @returns the new Vector3
  82823. */
  82824. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82825. /**
  82826. * Gets the maximal coordinate values between two Vector3
  82827. * @param left defines the first operand
  82828. * @param right defines the second operand
  82829. * @returns the new Vector3
  82830. */
  82831. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82832. /**
  82833. * Returns the distance between the vectors "value1" and "value2"
  82834. * @param value1 defines the first operand
  82835. * @param value2 defines the second operand
  82836. * @returns the distance
  82837. */
  82838. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82839. /**
  82840. * Returns the squared distance between the vectors "value1" and "value2"
  82841. * @param value1 defines the first operand
  82842. * @param value2 defines the second operand
  82843. * @returns the squared distance
  82844. */
  82845. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82846. /**
  82847. * Returns a new Vector3 located at the center between "value1" and "value2"
  82848. * @param value1 defines the first operand
  82849. * @param value2 defines the second operand
  82850. * @returns the new Vector3
  82851. */
  82852. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82853. /**
  82854. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82855. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82856. * to something in order to rotate it from its local system to the given target system
  82857. * Note: axis1, axis2 and axis3 are normalized during this operation
  82858. * @param axis1 defines the first axis
  82859. * @param axis2 defines the second axis
  82860. * @param axis3 defines the third axis
  82861. * @returns a new Vector3
  82862. */
  82863. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82864. /**
  82865. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82866. * @param axis1 defines the first axis
  82867. * @param axis2 defines the second axis
  82868. * @param axis3 defines the third axis
  82869. * @param ref defines the Vector3 where to store the result
  82870. */
  82871. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82872. }
  82873. /**
  82874. * Vector4 class created for EulerAngle class conversion to Quaternion
  82875. */
  82876. export class Vector4 {
  82877. /** x value of the vector */
  82878. x: number;
  82879. /** y value of the vector */
  82880. y: number;
  82881. /** z value of the vector */
  82882. z: number;
  82883. /** w value of the vector */
  82884. w: number;
  82885. /**
  82886. * Creates a Vector4 object from the given floats.
  82887. * @param x x value of the vector
  82888. * @param y y value of the vector
  82889. * @param z z value of the vector
  82890. * @param w w value of the vector
  82891. */
  82892. constructor(
  82893. /** x value of the vector */
  82894. x: number,
  82895. /** y value of the vector */
  82896. y: number,
  82897. /** z value of the vector */
  82898. z: number,
  82899. /** w value of the vector */
  82900. w: number);
  82901. /**
  82902. * Returns the string with the Vector4 coordinates.
  82903. * @returns a string containing all the vector values
  82904. */
  82905. toString(): string;
  82906. /**
  82907. * Returns the string "Vector4".
  82908. * @returns "Vector4"
  82909. */
  82910. getClassName(): string;
  82911. /**
  82912. * Returns the Vector4 hash code.
  82913. * @returns a unique hash code
  82914. */
  82915. getHashCode(): number;
  82916. /**
  82917. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82918. * @returns the resulting array
  82919. */
  82920. asArray(): number[];
  82921. /**
  82922. * Populates the given array from the given index with the Vector4 coordinates.
  82923. * @param array array to populate
  82924. * @param index index of the array to start at (default: 0)
  82925. * @returns the Vector4.
  82926. */
  82927. toArray(array: FloatArray, index?: number): Vector4;
  82928. /**
  82929. * Update the current vector from an array
  82930. * @param array defines the destination array
  82931. * @param index defines the offset in the destination array
  82932. * @returns the current Vector3
  82933. */
  82934. fromArray(array: FloatArray, index?: number): Vector4;
  82935. /**
  82936. * Adds the given vector to the current Vector4.
  82937. * @param otherVector the vector to add
  82938. * @returns the updated Vector4.
  82939. */
  82940. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82941. /**
  82942. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82943. * @param otherVector the vector to add
  82944. * @returns the resulting vector
  82945. */
  82946. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82947. /**
  82948. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82949. * @param otherVector the vector to add
  82950. * @param result the vector to store the result
  82951. * @returns the current Vector4.
  82952. */
  82953. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82954. /**
  82955. * Subtract in place the given vector from the current Vector4.
  82956. * @param otherVector the vector to subtract
  82957. * @returns the updated Vector4.
  82958. */
  82959. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82960. /**
  82961. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82962. * @param otherVector the vector to add
  82963. * @returns the new vector with the result
  82964. */
  82965. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82966. /**
  82967. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82968. * @param otherVector the vector to subtract
  82969. * @param result the vector to store the result
  82970. * @returns the current Vector4.
  82971. */
  82972. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82973. /**
  82974. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82975. */
  82976. /**
  82977. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82978. * @param x value to subtract
  82979. * @param y value to subtract
  82980. * @param z value to subtract
  82981. * @param w value to subtract
  82982. * @returns new vector containing the result
  82983. */
  82984. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82985. /**
  82986. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82987. * @param x value to subtract
  82988. * @param y value to subtract
  82989. * @param z value to subtract
  82990. * @param w value to subtract
  82991. * @param result the vector to store the result in
  82992. * @returns the current Vector4.
  82993. */
  82994. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82995. /**
  82996. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82997. * @returns a new vector with the negated values
  82998. */
  82999. negate(): Vector4;
  83000. /**
  83001. * Negate this vector in place
  83002. * @returns this
  83003. */
  83004. negateInPlace(): Vector4;
  83005. /**
  83006. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  83007. * @param result defines the Vector3 object where to store the result
  83008. * @returns the current Vector4
  83009. */
  83010. negateToRef(result: Vector4): Vector4;
  83011. /**
  83012. * Multiplies the current Vector4 coordinates by scale (float).
  83013. * @param scale the number to scale with
  83014. * @returns the updated Vector4.
  83015. */
  83016. scaleInPlace(scale: number): Vector4;
  83017. /**
  83018. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83019. * @param scale the number to scale with
  83020. * @returns a new vector with the result
  83021. */
  83022. scale(scale: number): Vector4;
  83023. /**
  83024. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83025. * @param scale the number to scale with
  83026. * @param result a vector to store the result in
  83027. * @returns the current Vector4.
  83028. */
  83029. scaleToRef(scale: number, result: Vector4): Vector4;
  83030. /**
  83031. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83032. * @param scale defines the scale factor
  83033. * @param result defines the Vector4 object where to store the result
  83034. * @returns the unmodified current Vector4
  83035. */
  83036. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83037. /**
  83038. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83039. * @param otherVector the vector to compare against
  83040. * @returns true if they are equal
  83041. */
  83042. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83043. /**
  83044. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83045. * @param otherVector vector to compare against
  83046. * @param epsilon (Default: very small number)
  83047. * @returns true if they are equal
  83048. */
  83049. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83050. /**
  83051. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83052. * @param x x value to compare against
  83053. * @param y y value to compare against
  83054. * @param z z value to compare against
  83055. * @param w w value to compare against
  83056. * @returns true if equal
  83057. */
  83058. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83059. /**
  83060. * Multiplies in place the current Vector4 by the given one.
  83061. * @param otherVector vector to multiple with
  83062. * @returns the updated Vector4.
  83063. */
  83064. multiplyInPlace(otherVector: Vector4): Vector4;
  83065. /**
  83066. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83067. * @param otherVector vector to multiple with
  83068. * @returns resulting new vector
  83069. */
  83070. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83071. /**
  83072. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83073. * @param otherVector vector to multiple with
  83074. * @param result vector to store the result
  83075. * @returns the current Vector4.
  83076. */
  83077. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83078. /**
  83079. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83080. * @param x x value multiply with
  83081. * @param y y value multiply with
  83082. * @param z z value multiply with
  83083. * @param w w value multiply with
  83084. * @returns resulting new vector
  83085. */
  83086. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83087. /**
  83088. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83089. * @param otherVector vector to devide with
  83090. * @returns resulting new vector
  83091. */
  83092. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83093. /**
  83094. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83095. * @param otherVector vector to devide with
  83096. * @param result vector to store the result
  83097. * @returns the current Vector4.
  83098. */
  83099. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83100. /**
  83101. * Divides the current Vector3 coordinates by the given ones.
  83102. * @param otherVector vector to devide with
  83103. * @returns the updated Vector3.
  83104. */
  83105. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83106. /**
  83107. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83108. * @param other defines the second operand
  83109. * @returns the current updated Vector4
  83110. */
  83111. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83112. /**
  83113. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83114. * @param other defines the second operand
  83115. * @returns the current updated Vector4
  83116. */
  83117. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83118. /**
  83119. * Gets a new Vector4 from current Vector4 floored values
  83120. * @returns a new Vector4
  83121. */
  83122. floor(): Vector4;
  83123. /**
  83124. * Gets a new Vector4 from current Vector3 floored values
  83125. * @returns a new Vector4
  83126. */
  83127. fract(): Vector4;
  83128. /**
  83129. * Returns the Vector4 length (float).
  83130. * @returns the length
  83131. */
  83132. length(): number;
  83133. /**
  83134. * Returns the Vector4 squared length (float).
  83135. * @returns the length squared
  83136. */
  83137. lengthSquared(): number;
  83138. /**
  83139. * Normalizes in place the Vector4.
  83140. * @returns the updated Vector4.
  83141. */
  83142. normalize(): Vector4;
  83143. /**
  83144. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83145. * @returns this converted to a new vector3
  83146. */
  83147. toVector3(): Vector3;
  83148. /**
  83149. * Returns a new Vector4 copied from the current one.
  83150. * @returns the new cloned vector
  83151. */
  83152. clone(): Vector4;
  83153. /**
  83154. * Updates the current Vector4 with the given one coordinates.
  83155. * @param source the source vector to copy from
  83156. * @returns the updated Vector4.
  83157. */
  83158. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83159. /**
  83160. * Updates the current Vector4 coordinates with the given floats.
  83161. * @param x float to copy from
  83162. * @param y float to copy from
  83163. * @param z float to copy from
  83164. * @param w float to copy from
  83165. * @returns the updated Vector4.
  83166. */
  83167. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83168. /**
  83169. * Updates the current Vector4 coordinates with the given floats.
  83170. * @param x float to set from
  83171. * @param y float to set from
  83172. * @param z float to set from
  83173. * @param w float to set from
  83174. * @returns the updated Vector4.
  83175. */
  83176. set(x: number, y: number, z: number, w: number): Vector4;
  83177. /**
  83178. * Copies the given float to the current Vector3 coordinates
  83179. * @param v defines the x, y, z and w coordinates of the operand
  83180. * @returns the current updated Vector3
  83181. */
  83182. setAll(v: number): Vector4;
  83183. /**
  83184. * Returns a new Vector4 set from the starting index of the given array.
  83185. * @param array the array to pull values from
  83186. * @param offset the offset into the array to start at
  83187. * @returns the new vector
  83188. */
  83189. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83190. /**
  83191. * Updates the given vector "result" from the starting index of the given array.
  83192. * @param array the array to pull values from
  83193. * @param offset the offset into the array to start at
  83194. * @param result the vector to store the result in
  83195. */
  83196. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83197. /**
  83198. * Updates the given vector "result" from the starting index of the given Float32Array.
  83199. * @param array the array to pull values from
  83200. * @param offset the offset into the array to start at
  83201. * @param result the vector to store the result in
  83202. */
  83203. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83204. /**
  83205. * Updates the given vector "result" coordinates from the given floats.
  83206. * @param x float to set from
  83207. * @param y float to set from
  83208. * @param z float to set from
  83209. * @param w float to set from
  83210. * @param result the vector to the floats in
  83211. */
  83212. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83213. /**
  83214. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83215. * @returns the new vector
  83216. */
  83217. static Zero(): Vector4;
  83218. /**
  83219. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83220. * @returns the new vector
  83221. */
  83222. static One(): Vector4;
  83223. /**
  83224. * Returns a new normalized Vector4 from the given one.
  83225. * @param vector the vector to normalize
  83226. * @returns the vector
  83227. */
  83228. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83229. /**
  83230. * Updates the given vector "result" from the normalization of the given one.
  83231. * @param vector the vector to normalize
  83232. * @param result the vector to store the result in
  83233. */
  83234. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83235. /**
  83236. * Returns a vector with the minimum values from the left and right vectors
  83237. * @param left left vector to minimize
  83238. * @param right right vector to minimize
  83239. * @returns a new vector with the minimum of the left and right vector values
  83240. */
  83241. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83242. /**
  83243. * Returns a vector with the maximum values from the left and right vectors
  83244. * @param left left vector to maximize
  83245. * @param right right vector to maximize
  83246. * @returns a new vector with the maximum of the left and right vector values
  83247. */
  83248. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83249. /**
  83250. * Returns the distance (float) between the vectors "value1" and "value2".
  83251. * @param value1 value to calulate the distance between
  83252. * @param value2 value to calulate the distance between
  83253. * @return the distance between the two vectors
  83254. */
  83255. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83256. /**
  83257. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83258. * @param value1 value to calulate the distance between
  83259. * @param value2 value to calulate the distance between
  83260. * @return the distance between the two vectors squared
  83261. */
  83262. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83263. /**
  83264. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83265. * @param value1 value to calulate the center between
  83266. * @param value2 value to calulate the center between
  83267. * @return the center between the two vectors
  83268. */
  83269. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83270. /**
  83271. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83272. * This methods computes transformed normalized direction vectors only.
  83273. * @param vector the vector to transform
  83274. * @param transformation the transformation matrix to apply
  83275. * @returns the new vector
  83276. */
  83277. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83278. /**
  83279. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83280. * This methods computes transformed normalized direction vectors only.
  83281. * @param vector the vector to transform
  83282. * @param transformation the transformation matrix to apply
  83283. * @param result the vector to store the result in
  83284. */
  83285. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83286. /**
  83287. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83288. * This methods computes transformed normalized direction vectors only.
  83289. * @param x value to transform
  83290. * @param y value to transform
  83291. * @param z value to transform
  83292. * @param w value to transform
  83293. * @param transformation the transformation matrix to apply
  83294. * @param result the vector to store the results in
  83295. */
  83296. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83297. /**
  83298. * Creates a new Vector4 from a Vector3
  83299. * @param source defines the source data
  83300. * @param w defines the 4th component (default is 0)
  83301. * @returns a new Vector4
  83302. */
  83303. static FromVector3(source: Vector3, w?: number): Vector4;
  83304. }
  83305. /**
  83306. * Class used to store quaternion data
  83307. * @see https://en.wikipedia.org/wiki/Quaternion
  83308. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83309. */
  83310. export class Quaternion {
  83311. /** @hidden */
  83312. _x: number;
  83313. /** @hidden */
  83314. _y: number;
  83315. /** @hidden */
  83316. _z: number;
  83317. /** @hidden */
  83318. _w: number;
  83319. /** @hidden */
  83320. _isDirty: boolean;
  83321. /** Gets or sets the x coordinate */
  83322. get x(): number;
  83323. set x(value: number);
  83324. /** Gets or sets the y coordinate */
  83325. get y(): number;
  83326. set y(value: number);
  83327. /** Gets or sets the z coordinate */
  83328. get z(): number;
  83329. set z(value: number);
  83330. /** Gets or sets the w coordinate */
  83331. get w(): number;
  83332. set w(value: number);
  83333. /**
  83334. * Creates a new Quaternion from the given floats
  83335. * @param x defines the first component (0 by default)
  83336. * @param y defines the second component (0 by default)
  83337. * @param z defines the third component (0 by default)
  83338. * @param w defines the fourth component (1.0 by default)
  83339. */
  83340. constructor(x?: number, y?: number, z?: number, w?: number);
  83341. /**
  83342. * Gets a string representation for the current quaternion
  83343. * @returns a string with the Quaternion coordinates
  83344. */
  83345. toString(): string;
  83346. /**
  83347. * Gets the class name of the quaternion
  83348. * @returns the string "Quaternion"
  83349. */
  83350. getClassName(): string;
  83351. /**
  83352. * Gets a hash code for this quaternion
  83353. * @returns the quaternion hash code
  83354. */
  83355. getHashCode(): number;
  83356. /**
  83357. * Copy the quaternion to an array
  83358. * @returns a new array populated with 4 elements from the quaternion coordinates
  83359. */
  83360. asArray(): number[];
  83361. /**
  83362. * Check if two quaternions are equals
  83363. * @param otherQuaternion defines the second operand
  83364. * @return true if the current quaternion and the given one coordinates are strictly equals
  83365. */
  83366. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83367. /**
  83368. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83369. * @param otherQuaternion defines the other quaternion
  83370. * @param epsilon defines the minimal distance to consider equality
  83371. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83372. */
  83373. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83374. /**
  83375. * Clone the current quaternion
  83376. * @returns a new quaternion copied from the current one
  83377. */
  83378. clone(): Quaternion;
  83379. /**
  83380. * Copy a quaternion to the current one
  83381. * @param other defines the other quaternion
  83382. * @returns the updated current quaternion
  83383. */
  83384. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83385. /**
  83386. * Updates the current quaternion with the given float coordinates
  83387. * @param x defines the x coordinate
  83388. * @param y defines the y coordinate
  83389. * @param z defines the z coordinate
  83390. * @param w defines the w coordinate
  83391. * @returns the updated current quaternion
  83392. */
  83393. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83394. /**
  83395. * Updates the current quaternion from the given float coordinates
  83396. * @param x defines the x coordinate
  83397. * @param y defines the y coordinate
  83398. * @param z defines the z coordinate
  83399. * @param w defines the w coordinate
  83400. * @returns the updated current quaternion
  83401. */
  83402. set(x: number, y: number, z: number, w: number): Quaternion;
  83403. /**
  83404. * Adds two quaternions
  83405. * @param other defines the second operand
  83406. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83407. */
  83408. add(other: DeepImmutable<Quaternion>): Quaternion;
  83409. /**
  83410. * Add a quaternion to the current one
  83411. * @param other defines the quaternion to add
  83412. * @returns the current quaternion
  83413. */
  83414. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83415. /**
  83416. * Subtract two quaternions
  83417. * @param other defines the second operand
  83418. * @returns a new quaternion as the subtraction result of the given one from the current one
  83419. */
  83420. subtract(other: Quaternion): Quaternion;
  83421. /**
  83422. * Multiplies the current quaternion by a scale factor
  83423. * @param value defines the scale factor
  83424. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83425. */
  83426. scale(value: number): Quaternion;
  83427. /**
  83428. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83429. * @param scale defines the scale factor
  83430. * @param result defines the Quaternion object where to store the result
  83431. * @returns the unmodified current quaternion
  83432. */
  83433. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83434. /**
  83435. * Multiplies in place the current quaternion by a scale factor
  83436. * @param value defines the scale factor
  83437. * @returns the current modified quaternion
  83438. */
  83439. scaleInPlace(value: number): Quaternion;
  83440. /**
  83441. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83442. * @param scale defines the scale factor
  83443. * @param result defines the Quaternion object where to store the result
  83444. * @returns the unmodified current quaternion
  83445. */
  83446. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83447. /**
  83448. * Multiplies two quaternions
  83449. * @param q1 defines the second operand
  83450. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83451. */
  83452. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83453. /**
  83454. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83455. * @param q1 defines the second operand
  83456. * @param result defines the target quaternion
  83457. * @returns the current quaternion
  83458. */
  83459. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83460. /**
  83461. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83462. * @param q1 defines the second operand
  83463. * @returns the currentupdated quaternion
  83464. */
  83465. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83466. /**
  83467. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83468. * @param ref defines the target quaternion
  83469. * @returns the current quaternion
  83470. */
  83471. conjugateToRef(ref: Quaternion): Quaternion;
  83472. /**
  83473. * Conjugates in place (1-q) the current quaternion
  83474. * @returns the current updated quaternion
  83475. */
  83476. conjugateInPlace(): Quaternion;
  83477. /**
  83478. * Conjugates in place (1-q) the current quaternion
  83479. * @returns a new quaternion
  83480. */
  83481. conjugate(): Quaternion;
  83482. /**
  83483. * Gets length of current quaternion
  83484. * @returns the quaternion length (float)
  83485. */
  83486. length(): number;
  83487. /**
  83488. * Normalize in place the current quaternion
  83489. * @returns the current updated quaternion
  83490. */
  83491. normalize(): Quaternion;
  83492. /**
  83493. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83494. * @param order is a reserved parameter and is ignore for now
  83495. * @returns a new Vector3 containing the Euler angles
  83496. */
  83497. toEulerAngles(order?: string): Vector3;
  83498. /**
  83499. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83500. * @param result defines the vector which will be filled with the Euler angles
  83501. * @param order is a reserved parameter and is ignore for now
  83502. * @returns the current unchanged quaternion
  83503. */
  83504. toEulerAnglesToRef(result: Vector3): Quaternion;
  83505. /**
  83506. * Updates the given rotation matrix with the current quaternion values
  83507. * @param result defines the target matrix
  83508. * @returns the current unchanged quaternion
  83509. */
  83510. toRotationMatrix(result: Matrix): Quaternion;
  83511. /**
  83512. * Updates the current quaternion from the given rotation matrix values
  83513. * @param matrix defines the source matrix
  83514. * @returns the current updated quaternion
  83515. */
  83516. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83517. /**
  83518. * Creates a new quaternion from a rotation matrix
  83519. * @param matrix defines the source matrix
  83520. * @returns a new quaternion created from the given rotation matrix values
  83521. */
  83522. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83523. /**
  83524. * Updates the given quaternion with the given rotation matrix values
  83525. * @param matrix defines the source matrix
  83526. * @param result defines the target quaternion
  83527. */
  83528. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83529. /**
  83530. * Returns the dot product (float) between the quaternions "left" and "right"
  83531. * @param left defines the left operand
  83532. * @param right defines the right operand
  83533. * @returns the dot product
  83534. */
  83535. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83536. /**
  83537. * Checks if the two quaternions are close to each other
  83538. * @param quat0 defines the first quaternion to check
  83539. * @param quat1 defines the second quaternion to check
  83540. * @returns true if the two quaternions are close to each other
  83541. */
  83542. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83543. /**
  83544. * Creates an empty quaternion
  83545. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83546. */
  83547. static Zero(): Quaternion;
  83548. /**
  83549. * Inverse a given quaternion
  83550. * @param q defines the source quaternion
  83551. * @returns a new quaternion as the inverted current quaternion
  83552. */
  83553. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83554. /**
  83555. * Inverse a given quaternion
  83556. * @param q defines the source quaternion
  83557. * @param result the quaternion the result will be stored in
  83558. * @returns the result quaternion
  83559. */
  83560. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83561. /**
  83562. * Creates an identity quaternion
  83563. * @returns the identity quaternion
  83564. */
  83565. static Identity(): Quaternion;
  83566. /**
  83567. * Gets a boolean indicating if the given quaternion is identity
  83568. * @param quaternion defines the quaternion to check
  83569. * @returns true if the quaternion is identity
  83570. */
  83571. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83572. /**
  83573. * Creates a quaternion from a rotation around an axis
  83574. * @param axis defines the axis to use
  83575. * @param angle defines the angle to use
  83576. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83577. */
  83578. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83579. /**
  83580. * Creates a rotation around an axis and stores it into the given quaternion
  83581. * @param axis defines the axis to use
  83582. * @param angle defines the angle to use
  83583. * @param result defines the target quaternion
  83584. * @returns the target quaternion
  83585. */
  83586. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83587. /**
  83588. * Creates a new quaternion from data stored into an array
  83589. * @param array defines the data source
  83590. * @param offset defines the offset in the source array where the data starts
  83591. * @returns a new quaternion
  83592. */
  83593. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83594. /**
  83595. * Updates the given quaternion "result" from the starting index of the given array.
  83596. * @param array the array to pull values from
  83597. * @param offset the offset into the array to start at
  83598. * @param result the quaternion to store the result in
  83599. */
  83600. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83601. /**
  83602. * Create a quaternion from Euler rotation angles
  83603. * @param x Pitch
  83604. * @param y Yaw
  83605. * @param z Roll
  83606. * @returns the new Quaternion
  83607. */
  83608. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83609. /**
  83610. * Updates a quaternion from Euler rotation angles
  83611. * @param x Pitch
  83612. * @param y Yaw
  83613. * @param z Roll
  83614. * @param result the quaternion to store the result
  83615. * @returns the updated quaternion
  83616. */
  83617. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83618. /**
  83619. * Create a quaternion from Euler rotation vector
  83620. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83621. * @returns the new Quaternion
  83622. */
  83623. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83624. /**
  83625. * Updates a quaternion from Euler rotation vector
  83626. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83627. * @param result the quaternion to store the result
  83628. * @returns the updated quaternion
  83629. */
  83630. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83631. /**
  83632. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83633. * @param yaw defines the rotation around Y axis
  83634. * @param pitch defines the rotation around X axis
  83635. * @param roll defines the rotation around Z axis
  83636. * @returns the new quaternion
  83637. */
  83638. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83639. /**
  83640. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83641. * @param yaw defines the rotation around Y axis
  83642. * @param pitch defines the rotation around X axis
  83643. * @param roll defines the rotation around Z axis
  83644. * @param result defines the target quaternion
  83645. */
  83646. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83647. /**
  83648. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83649. * @param alpha defines the rotation around first axis
  83650. * @param beta defines the rotation around second axis
  83651. * @param gamma defines the rotation around third axis
  83652. * @returns the new quaternion
  83653. */
  83654. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83655. /**
  83656. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83657. * @param alpha defines the rotation around first axis
  83658. * @param beta defines the rotation around second axis
  83659. * @param gamma defines the rotation around third axis
  83660. * @param result defines the target quaternion
  83661. */
  83662. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83663. /**
  83664. * 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)
  83665. * @param axis1 defines the first axis
  83666. * @param axis2 defines the second axis
  83667. * @param axis3 defines the third axis
  83668. * @returns the new quaternion
  83669. */
  83670. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83671. /**
  83672. * 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
  83673. * @param axis1 defines the first axis
  83674. * @param axis2 defines the second axis
  83675. * @param axis3 defines the third axis
  83676. * @param ref defines the target quaternion
  83677. */
  83678. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83679. /**
  83680. * Interpolates between two quaternions
  83681. * @param left defines first quaternion
  83682. * @param right defines second quaternion
  83683. * @param amount defines the gradient to use
  83684. * @returns the new interpolated quaternion
  83685. */
  83686. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83687. /**
  83688. * Interpolates between two quaternions and stores it into a target quaternion
  83689. * @param left defines first quaternion
  83690. * @param right defines second quaternion
  83691. * @param amount defines the gradient to use
  83692. * @param result defines the target quaternion
  83693. */
  83694. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83695. /**
  83696. * Interpolate between two quaternions using Hermite interpolation
  83697. * @param value1 defines first quaternion
  83698. * @param tangent1 defines the incoming tangent
  83699. * @param value2 defines second quaternion
  83700. * @param tangent2 defines the outgoing tangent
  83701. * @param amount defines the target quaternion
  83702. * @returns the new interpolated quaternion
  83703. */
  83704. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83705. }
  83706. /**
  83707. * Class used to store matrix data (4x4)
  83708. */
  83709. export class Matrix {
  83710. /**
  83711. * Gets the precision of matrix computations
  83712. */
  83713. static get Use64Bits(): boolean;
  83714. private static _updateFlagSeed;
  83715. private static _identityReadOnly;
  83716. private _isIdentity;
  83717. private _isIdentityDirty;
  83718. private _isIdentity3x2;
  83719. private _isIdentity3x2Dirty;
  83720. /**
  83721. * Gets the update flag of the matrix which is an unique number for the matrix.
  83722. * It will be incremented every time the matrix data change.
  83723. * You can use it to speed the comparison between two versions of the same matrix.
  83724. */
  83725. updateFlag: number;
  83726. private readonly _m;
  83727. /**
  83728. * Gets the internal data of the matrix
  83729. */
  83730. get m(): DeepImmutable<Float32Array | Array<number>>;
  83731. /** @hidden */
  83732. _markAsUpdated(): void;
  83733. /** @hidden */
  83734. private _updateIdentityStatus;
  83735. /**
  83736. * Creates an empty matrix (filled with zeros)
  83737. */
  83738. constructor();
  83739. /**
  83740. * Check if the current matrix is identity
  83741. * @returns true is the matrix is the identity matrix
  83742. */
  83743. isIdentity(): boolean;
  83744. /**
  83745. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83746. * @returns true is the matrix is the identity matrix
  83747. */
  83748. isIdentityAs3x2(): boolean;
  83749. /**
  83750. * Gets the determinant of the matrix
  83751. * @returns the matrix determinant
  83752. */
  83753. determinant(): number;
  83754. /**
  83755. * Returns the matrix as a Float32Array or Array<number>
  83756. * @returns the matrix underlying array
  83757. */
  83758. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83759. /**
  83760. * Returns the matrix as a Float32Array or Array<number>
  83761. * @returns the matrix underlying array.
  83762. */
  83763. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83764. /**
  83765. * Inverts the current matrix in place
  83766. * @returns the current inverted matrix
  83767. */
  83768. invert(): Matrix;
  83769. /**
  83770. * Sets all the matrix elements to zero
  83771. * @returns the current matrix
  83772. */
  83773. reset(): Matrix;
  83774. /**
  83775. * Adds the current matrix with a second one
  83776. * @param other defines the matrix to add
  83777. * @returns a new matrix as the addition of the current matrix and the given one
  83778. */
  83779. add(other: DeepImmutable<Matrix>): Matrix;
  83780. /**
  83781. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83782. * @param other defines the matrix to add
  83783. * @param result defines the target matrix
  83784. * @returns the current matrix
  83785. */
  83786. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83787. /**
  83788. * Adds in place the given matrix to the current matrix
  83789. * @param other defines the second operand
  83790. * @returns the current updated matrix
  83791. */
  83792. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83793. /**
  83794. * Sets the given matrix to the current inverted Matrix
  83795. * @param other defines the target matrix
  83796. * @returns the unmodified current matrix
  83797. */
  83798. invertToRef(other: Matrix): Matrix;
  83799. /**
  83800. * add a value at the specified position in the current Matrix
  83801. * @param index the index of the value within the matrix. between 0 and 15.
  83802. * @param value the value to be added
  83803. * @returns the current updated matrix
  83804. */
  83805. addAtIndex(index: number, value: number): Matrix;
  83806. /**
  83807. * mutiply the specified position in the current Matrix by a value
  83808. * @param index the index of the value within the matrix. between 0 and 15.
  83809. * @param value the value to be added
  83810. * @returns the current updated matrix
  83811. */
  83812. multiplyAtIndex(index: number, value: number): Matrix;
  83813. /**
  83814. * Inserts the translation vector (using 3 floats) in the current matrix
  83815. * @param x defines the 1st component of the translation
  83816. * @param y defines the 2nd component of the translation
  83817. * @param z defines the 3rd component of the translation
  83818. * @returns the current updated matrix
  83819. */
  83820. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83821. /**
  83822. * Adds the translation vector (using 3 floats) in the current matrix
  83823. * @param x defines the 1st component of the translation
  83824. * @param y defines the 2nd component of the translation
  83825. * @param z defines the 3rd component of the translation
  83826. * @returns the current updated matrix
  83827. */
  83828. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83829. /**
  83830. * Inserts the translation vector in the current matrix
  83831. * @param vector3 defines the translation to insert
  83832. * @returns the current updated matrix
  83833. */
  83834. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83835. /**
  83836. * Gets the translation value of the current matrix
  83837. * @returns a new Vector3 as the extracted translation from the matrix
  83838. */
  83839. getTranslation(): Vector3;
  83840. /**
  83841. * Fill a Vector3 with the extracted translation from the matrix
  83842. * @param result defines the Vector3 where to store the translation
  83843. * @returns the current matrix
  83844. */
  83845. getTranslationToRef(result: Vector3): Matrix;
  83846. /**
  83847. * Remove rotation and scaling part from the matrix
  83848. * @returns the updated matrix
  83849. */
  83850. removeRotationAndScaling(): Matrix;
  83851. /**
  83852. * Multiply two matrices
  83853. * @param other defines the second operand
  83854. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83855. */
  83856. multiply(other: DeepImmutable<Matrix>): Matrix;
  83857. /**
  83858. * Copy the current matrix from the given one
  83859. * @param other defines the source matrix
  83860. * @returns the current updated matrix
  83861. */
  83862. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83863. /**
  83864. * Populates the given array from the starting index with the current matrix values
  83865. * @param array defines the target array
  83866. * @param offset defines the offset in the target array where to start storing values
  83867. * @returns the current matrix
  83868. */
  83869. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83870. /**
  83871. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83872. * @param other defines the second operand
  83873. * @param result defines the matrix where to store the multiplication
  83874. * @returns the current matrix
  83875. */
  83876. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83877. /**
  83878. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83879. * @param other defines the second operand
  83880. * @param result defines the array where to store the multiplication
  83881. * @param offset defines the offset in the target array where to start storing values
  83882. * @returns the current matrix
  83883. */
  83884. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83885. /**
  83886. * Check equality between this matrix and a second one
  83887. * @param value defines the second matrix to compare
  83888. * @returns true is the current matrix and the given one values are strictly equal
  83889. */
  83890. equals(value: DeepImmutable<Matrix>): boolean;
  83891. /**
  83892. * Clone the current matrix
  83893. * @returns a new matrix from the current matrix
  83894. */
  83895. clone(): Matrix;
  83896. /**
  83897. * Returns the name of the current matrix class
  83898. * @returns the string "Matrix"
  83899. */
  83900. getClassName(): string;
  83901. /**
  83902. * Gets the hash code of the current matrix
  83903. * @returns the hash code
  83904. */
  83905. getHashCode(): number;
  83906. /**
  83907. * Decomposes the current Matrix into a translation, rotation and scaling components
  83908. * @param scale defines the scale vector3 given as a reference to update
  83909. * @param rotation defines the rotation quaternion given as a reference to update
  83910. * @param translation defines the translation vector3 given as a reference to update
  83911. * @returns true if operation was successful
  83912. */
  83913. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83914. /**
  83915. * Gets specific row of the matrix
  83916. * @param index defines the number of the row to get
  83917. * @returns the index-th row of the current matrix as a new Vector4
  83918. */
  83919. getRow(index: number): Nullable<Vector4>;
  83920. /**
  83921. * Sets the index-th row of the current matrix to the vector4 values
  83922. * @param index defines the number of the row to set
  83923. * @param row defines the target vector4
  83924. * @returns the updated current matrix
  83925. */
  83926. setRow(index: number, row: Vector4): Matrix;
  83927. /**
  83928. * Compute the transpose of the matrix
  83929. * @returns the new transposed matrix
  83930. */
  83931. transpose(): Matrix;
  83932. /**
  83933. * Compute the transpose of the matrix and store it in a given matrix
  83934. * @param result defines the target matrix
  83935. * @returns the current matrix
  83936. */
  83937. transposeToRef(result: Matrix): Matrix;
  83938. /**
  83939. * Sets the index-th row of the current matrix with the given 4 x float values
  83940. * @param index defines the row index
  83941. * @param x defines the x component to set
  83942. * @param y defines the y component to set
  83943. * @param z defines the z component to set
  83944. * @param w defines the w component to set
  83945. * @returns the updated current matrix
  83946. */
  83947. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83948. /**
  83949. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83950. * @param scale defines the scale factor
  83951. * @returns a new matrix
  83952. */
  83953. scale(scale: number): Matrix;
  83954. /**
  83955. * Scale the current matrix values by a factor to a given result matrix
  83956. * @param scale defines the scale factor
  83957. * @param result defines the matrix to store the result
  83958. * @returns the current matrix
  83959. */
  83960. scaleToRef(scale: number, result: Matrix): Matrix;
  83961. /**
  83962. * Scale the current matrix values by a factor and add the result to a given matrix
  83963. * @param scale defines the scale factor
  83964. * @param result defines the Matrix to store the result
  83965. * @returns the current matrix
  83966. */
  83967. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83968. /**
  83969. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83970. * @param ref matrix to store the result
  83971. */
  83972. toNormalMatrix(ref: Matrix): void;
  83973. /**
  83974. * Gets only rotation part of the current matrix
  83975. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83976. */
  83977. getRotationMatrix(): Matrix;
  83978. /**
  83979. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83980. * @param result defines the target matrix to store data to
  83981. * @returns the current matrix
  83982. */
  83983. getRotationMatrixToRef(result: Matrix): Matrix;
  83984. /**
  83985. * Toggles model matrix from being right handed to left handed in place and vice versa
  83986. */
  83987. toggleModelMatrixHandInPlace(): void;
  83988. /**
  83989. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83990. */
  83991. toggleProjectionMatrixHandInPlace(): void;
  83992. /**
  83993. * Creates a matrix from an array
  83994. * @param array defines the source array
  83995. * @param offset defines an offset in the source array
  83996. * @returns a new Matrix set from the starting index of the given array
  83997. */
  83998. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83999. /**
  84000. * Copy the content of an array into a given matrix
  84001. * @param array defines the source array
  84002. * @param offset defines an offset in the source array
  84003. * @param result defines the target matrix
  84004. */
  84005. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  84006. /**
  84007. * Stores an array into a matrix after having multiplied each component by a given factor
  84008. * @param array defines the source array
  84009. * @param offset defines the offset in the source array
  84010. * @param scale defines the scaling factor
  84011. * @param result defines the target matrix
  84012. */
  84013. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84014. /**
  84015. * Gets an identity matrix that must not be updated
  84016. */
  84017. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84018. /**
  84019. * Stores a list of values (16) inside a given matrix
  84020. * @param initialM11 defines 1st value of 1st row
  84021. * @param initialM12 defines 2nd value of 1st row
  84022. * @param initialM13 defines 3rd value of 1st row
  84023. * @param initialM14 defines 4th value of 1st row
  84024. * @param initialM21 defines 1st value of 2nd row
  84025. * @param initialM22 defines 2nd value of 2nd row
  84026. * @param initialM23 defines 3rd value of 2nd row
  84027. * @param initialM24 defines 4th value of 2nd row
  84028. * @param initialM31 defines 1st value of 3rd row
  84029. * @param initialM32 defines 2nd value of 3rd row
  84030. * @param initialM33 defines 3rd value of 3rd row
  84031. * @param initialM34 defines 4th value of 3rd row
  84032. * @param initialM41 defines 1st value of 4th row
  84033. * @param initialM42 defines 2nd value of 4th row
  84034. * @param initialM43 defines 3rd value of 4th row
  84035. * @param initialM44 defines 4th value of 4th row
  84036. * @param result defines the target matrix
  84037. */
  84038. 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;
  84039. /**
  84040. * Creates new matrix from a list of values (16)
  84041. * @param initialM11 defines 1st value of 1st row
  84042. * @param initialM12 defines 2nd value of 1st row
  84043. * @param initialM13 defines 3rd value of 1st row
  84044. * @param initialM14 defines 4th value of 1st row
  84045. * @param initialM21 defines 1st value of 2nd row
  84046. * @param initialM22 defines 2nd value of 2nd row
  84047. * @param initialM23 defines 3rd value of 2nd row
  84048. * @param initialM24 defines 4th value of 2nd row
  84049. * @param initialM31 defines 1st value of 3rd row
  84050. * @param initialM32 defines 2nd value of 3rd row
  84051. * @param initialM33 defines 3rd value of 3rd row
  84052. * @param initialM34 defines 4th value of 3rd row
  84053. * @param initialM41 defines 1st value of 4th row
  84054. * @param initialM42 defines 2nd value of 4th row
  84055. * @param initialM43 defines 3rd value of 4th row
  84056. * @param initialM44 defines 4th value of 4th row
  84057. * @returns the new matrix
  84058. */
  84059. 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;
  84060. /**
  84061. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84062. * @param scale defines the scale vector3
  84063. * @param rotation defines the rotation quaternion
  84064. * @param translation defines the translation vector3
  84065. * @returns a new matrix
  84066. */
  84067. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84068. /**
  84069. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84070. * @param scale defines the scale vector3
  84071. * @param rotation defines the rotation quaternion
  84072. * @param translation defines the translation vector3
  84073. * @param result defines the target matrix
  84074. */
  84075. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84076. /**
  84077. * Creates a new identity matrix
  84078. * @returns a new identity matrix
  84079. */
  84080. static Identity(): Matrix;
  84081. /**
  84082. * Creates a new identity matrix and stores the result in a given matrix
  84083. * @param result defines the target matrix
  84084. */
  84085. static IdentityToRef(result: Matrix): void;
  84086. /**
  84087. * Creates a new zero matrix
  84088. * @returns a new zero matrix
  84089. */
  84090. static Zero(): Matrix;
  84091. /**
  84092. * Creates a new rotation matrix for "angle" radians around the X axis
  84093. * @param angle defines the angle (in radians) to use
  84094. * @return the new matrix
  84095. */
  84096. static RotationX(angle: number): Matrix;
  84097. /**
  84098. * Creates a new matrix as the invert of a given matrix
  84099. * @param source defines the source matrix
  84100. * @returns the new matrix
  84101. */
  84102. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84103. /**
  84104. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84105. * @param angle defines the angle (in radians) to use
  84106. * @param result defines the target matrix
  84107. */
  84108. static RotationXToRef(angle: number, result: Matrix): void;
  84109. /**
  84110. * Creates a new rotation matrix for "angle" radians around the Y axis
  84111. * @param angle defines the angle (in radians) to use
  84112. * @return the new matrix
  84113. */
  84114. static RotationY(angle: number): Matrix;
  84115. /**
  84116. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84117. * @param angle defines the angle (in radians) to use
  84118. * @param result defines the target matrix
  84119. */
  84120. static RotationYToRef(angle: number, result: Matrix): void;
  84121. /**
  84122. * Creates a new rotation matrix for "angle" radians around the Z axis
  84123. * @param angle defines the angle (in radians) to use
  84124. * @return the new matrix
  84125. */
  84126. static RotationZ(angle: number): Matrix;
  84127. /**
  84128. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84129. * @param angle defines the angle (in radians) to use
  84130. * @param result defines the target matrix
  84131. */
  84132. static RotationZToRef(angle: number, result: Matrix): void;
  84133. /**
  84134. * Creates a new rotation matrix for "angle" radians around the given axis
  84135. * @param axis defines the axis to use
  84136. * @param angle defines the angle (in radians) to use
  84137. * @return the new matrix
  84138. */
  84139. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84140. /**
  84141. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84142. * @param axis defines the axis to use
  84143. * @param angle defines the angle (in radians) to use
  84144. * @param result defines the target matrix
  84145. */
  84146. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84147. /**
  84148. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84149. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84150. * @param from defines the vector to align
  84151. * @param to defines the vector to align to
  84152. * @param result defines the target matrix
  84153. */
  84154. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84155. /**
  84156. * Creates a rotation matrix
  84157. * @param yaw defines the yaw angle in radians (Y axis)
  84158. * @param pitch defines the pitch angle in radians (X axis)
  84159. * @param roll defines the roll angle in radians (Z axis)
  84160. * @returns the new rotation matrix
  84161. */
  84162. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84163. /**
  84164. * Creates a rotation matrix and stores it in a given matrix
  84165. * @param yaw defines the yaw angle in radians (Y axis)
  84166. * @param pitch defines the pitch angle in radians (X axis)
  84167. * @param roll defines the roll angle in radians (Z axis)
  84168. * @param result defines the target matrix
  84169. */
  84170. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84171. /**
  84172. * Creates a scaling matrix
  84173. * @param x defines the scale factor on X axis
  84174. * @param y defines the scale factor on Y axis
  84175. * @param z defines the scale factor on Z axis
  84176. * @returns the new matrix
  84177. */
  84178. static Scaling(x: number, y: number, z: number): Matrix;
  84179. /**
  84180. * Creates a scaling matrix and stores it in a given matrix
  84181. * @param x defines the scale factor on X axis
  84182. * @param y defines the scale factor on Y axis
  84183. * @param z defines the scale factor on Z axis
  84184. * @param result defines the target matrix
  84185. */
  84186. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84187. /**
  84188. * Creates a translation matrix
  84189. * @param x defines the translation on X axis
  84190. * @param y defines the translation on Y axis
  84191. * @param z defines the translationon Z axis
  84192. * @returns the new matrix
  84193. */
  84194. static Translation(x: number, y: number, z: number): Matrix;
  84195. /**
  84196. * Creates a translation matrix and stores it in a given matrix
  84197. * @param x defines the translation on X axis
  84198. * @param y defines the translation on Y axis
  84199. * @param z defines the translationon Z axis
  84200. * @param result defines the target matrix
  84201. */
  84202. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84203. /**
  84204. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84205. * @param startValue defines the start value
  84206. * @param endValue defines the end value
  84207. * @param gradient defines the gradient factor
  84208. * @returns the new matrix
  84209. */
  84210. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84211. /**
  84212. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84213. * @param startValue defines the start value
  84214. * @param endValue defines the end value
  84215. * @param gradient defines the gradient factor
  84216. * @param result defines the Matrix object where to store data
  84217. */
  84218. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84219. /**
  84220. * Builds a new matrix whose values are computed by:
  84221. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84222. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84223. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84224. * @param startValue defines the first matrix
  84225. * @param endValue defines the second matrix
  84226. * @param gradient defines the gradient between the two matrices
  84227. * @returns the new matrix
  84228. */
  84229. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84230. /**
  84231. * Update a matrix to values which are computed by:
  84232. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84233. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84234. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84235. * @param startValue defines the first matrix
  84236. * @param endValue defines the second matrix
  84237. * @param gradient defines the gradient between the two matrices
  84238. * @param result defines the target matrix
  84239. */
  84240. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84241. /**
  84242. * 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"
  84243. * This function works in left handed mode
  84244. * @param eye defines the final position of the entity
  84245. * @param target defines where the entity should look at
  84246. * @param up defines the up vector for the entity
  84247. * @returns the new matrix
  84248. */
  84249. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84250. /**
  84251. * 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".
  84252. * This function works in left handed mode
  84253. * @param eye defines the final position of the entity
  84254. * @param target defines where the entity should look at
  84255. * @param up defines the up vector for the entity
  84256. * @param result defines the target matrix
  84257. */
  84258. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84259. /**
  84260. * 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"
  84261. * This function works in right handed mode
  84262. * @param eye defines the final position of the entity
  84263. * @param target defines where the entity should look at
  84264. * @param up defines the up vector for the entity
  84265. * @returns the new matrix
  84266. */
  84267. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84268. /**
  84269. * 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".
  84270. * This function works in right handed mode
  84271. * @param eye defines the final position of the entity
  84272. * @param target defines where the entity should look at
  84273. * @param up defines the up vector for the entity
  84274. * @param result defines the target matrix
  84275. */
  84276. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84277. /**
  84278. * Create a left-handed orthographic projection matrix
  84279. * @param width defines the viewport width
  84280. * @param height defines the viewport height
  84281. * @param znear defines the near clip plane
  84282. * @param zfar defines the far clip plane
  84283. * @returns a new matrix as a left-handed orthographic projection matrix
  84284. */
  84285. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84286. /**
  84287. * Store a left-handed orthographic projection to a given matrix
  84288. * @param width defines the viewport width
  84289. * @param height defines the viewport height
  84290. * @param znear defines the near clip plane
  84291. * @param zfar defines the far clip plane
  84292. * @param result defines the target matrix
  84293. */
  84294. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84295. /**
  84296. * Create a left-handed orthographic projection matrix
  84297. * @param left defines the viewport left coordinate
  84298. * @param right defines the viewport right coordinate
  84299. * @param bottom defines the viewport bottom coordinate
  84300. * @param top defines the viewport top coordinate
  84301. * @param znear defines the near clip plane
  84302. * @param zfar defines the far clip plane
  84303. * @returns a new matrix as a left-handed orthographic projection matrix
  84304. */
  84305. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84306. /**
  84307. * Stores a left-handed orthographic projection into a given matrix
  84308. * @param left defines the viewport left coordinate
  84309. * @param right defines the viewport right coordinate
  84310. * @param bottom defines the viewport bottom coordinate
  84311. * @param top defines the viewport top coordinate
  84312. * @param znear defines the near clip plane
  84313. * @param zfar defines the far clip plane
  84314. * @param result defines the target matrix
  84315. */
  84316. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84317. /**
  84318. * Creates a right-handed orthographic projection matrix
  84319. * @param left defines the viewport left coordinate
  84320. * @param right defines the viewport right coordinate
  84321. * @param bottom defines the viewport bottom coordinate
  84322. * @param top defines the viewport top coordinate
  84323. * @param znear defines the near clip plane
  84324. * @param zfar defines the far clip plane
  84325. * @returns a new matrix as a right-handed orthographic projection matrix
  84326. */
  84327. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84328. /**
  84329. * Stores a right-handed orthographic projection into a given matrix
  84330. * @param left defines the viewport left coordinate
  84331. * @param right defines the viewport right coordinate
  84332. * @param bottom defines the viewport bottom coordinate
  84333. * @param top defines the viewport top coordinate
  84334. * @param znear defines the near clip plane
  84335. * @param zfar defines the far clip plane
  84336. * @param result defines the target matrix
  84337. */
  84338. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84339. /**
  84340. * Creates a left-handed perspective projection matrix
  84341. * @param width defines the viewport width
  84342. * @param height defines the viewport height
  84343. * @param znear defines the near clip plane
  84344. * @param zfar defines the far clip plane
  84345. * @returns a new matrix as a left-handed perspective projection matrix
  84346. */
  84347. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84348. /**
  84349. * Creates a left-handed perspective projection matrix
  84350. * @param fov defines the horizontal field of view
  84351. * @param aspect defines the aspect ratio
  84352. * @param znear defines the near clip plane
  84353. * @param zfar defines the far clip plane
  84354. * @returns a new matrix as a left-handed perspective projection matrix
  84355. */
  84356. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84357. /**
  84358. * Stores a left-handed perspective projection into a given matrix
  84359. * @param fov defines the horizontal field of view
  84360. * @param aspect defines the aspect ratio
  84361. * @param znear defines the near clip plane
  84362. * @param zfar defines the far clip plane
  84363. * @param result defines the target matrix
  84364. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84365. */
  84366. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84367. /**
  84368. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84369. * @param fov defines the horizontal field of view
  84370. * @param aspect defines the aspect ratio
  84371. * @param znear defines the near clip plane
  84372. * @param zfar not used as infinity is used as far clip
  84373. * @param result defines the target matrix
  84374. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84375. */
  84376. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84377. /**
  84378. * Creates a right-handed perspective projection matrix
  84379. * @param fov defines the horizontal field of view
  84380. * @param aspect defines the aspect ratio
  84381. * @param znear defines the near clip plane
  84382. * @param zfar defines the far clip plane
  84383. * @returns a new matrix as a right-handed perspective projection matrix
  84384. */
  84385. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84386. /**
  84387. * Stores a right-handed perspective projection into a given matrix
  84388. * @param fov defines the horizontal field of view
  84389. * @param aspect defines the aspect ratio
  84390. * @param znear defines the near clip plane
  84391. * @param zfar defines the far clip plane
  84392. * @param result defines the target matrix
  84393. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84394. */
  84395. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84396. /**
  84397. * Stores a right-handed perspective projection into a given matrix
  84398. * @param fov defines the horizontal field of view
  84399. * @param aspect defines the aspect ratio
  84400. * @param znear defines the near clip plane
  84401. * @param zfar not used as infinity is used as far clip
  84402. * @param result defines the target matrix
  84403. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84404. */
  84405. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84406. /**
  84407. * Stores a perspective projection for WebVR info a given matrix
  84408. * @param fov defines the field of view
  84409. * @param znear defines the near clip plane
  84410. * @param zfar defines the far clip plane
  84411. * @param result defines the target matrix
  84412. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84413. */
  84414. static PerspectiveFovWebVRToRef(fov: {
  84415. upDegrees: number;
  84416. downDegrees: number;
  84417. leftDegrees: number;
  84418. rightDegrees: number;
  84419. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84420. /**
  84421. * Computes a complete transformation matrix
  84422. * @param viewport defines the viewport to use
  84423. * @param world defines the world matrix
  84424. * @param view defines the view matrix
  84425. * @param projection defines the projection matrix
  84426. * @param zmin defines the near clip plane
  84427. * @param zmax defines the far clip plane
  84428. * @returns the transformation matrix
  84429. */
  84430. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84431. /**
  84432. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84433. * @param matrix defines the matrix to use
  84434. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84435. */
  84436. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84437. /**
  84438. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84439. * @param matrix defines the matrix to use
  84440. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84441. */
  84442. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84443. /**
  84444. * Compute the transpose of a given matrix
  84445. * @param matrix defines the matrix to transpose
  84446. * @returns the new matrix
  84447. */
  84448. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84449. /**
  84450. * Compute the transpose of a matrix and store it in a target matrix
  84451. * @param matrix defines the matrix to transpose
  84452. * @param result defines the target matrix
  84453. */
  84454. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84455. /**
  84456. * Computes a reflection matrix from a plane
  84457. * @param plane defines the reflection plane
  84458. * @returns a new matrix
  84459. */
  84460. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84461. /**
  84462. * Computes a reflection matrix from a plane
  84463. * @param plane defines the reflection plane
  84464. * @param result defines the target matrix
  84465. */
  84466. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84467. /**
  84468. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84469. * @param xaxis defines the value of the 1st axis
  84470. * @param yaxis defines the value of the 2nd axis
  84471. * @param zaxis defines the value of the 3rd axis
  84472. * @param result defines the target matrix
  84473. */
  84474. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84475. /**
  84476. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84477. * @param quat defines the quaternion to use
  84478. * @param result defines the target matrix
  84479. */
  84480. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84481. }
  84482. /**
  84483. * @hidden
  84484. */
  84485. export class TmpVectors {
  84486. static Vector2: Vector2[];
  84487. static Vector3: Vector3[];
  84488. static Vector4: Vector4[];
  84489. static Quaternion: Quaternion[];
  84490. static Matrix: Matrix[];
  84491. }
  84492. }
  84493. declare module BABYLON {
  84494. /**
  84495. * Defines potential orientation for back face culling
  84496. */
  84497. export enum Orientation {
  84498. /**
  84499. * Clockwise
  84500. */
  84501. CW = 0,
  84502. /** Counter clockwise */
  84503. CCW = 1
  84504. }
  84505. /** Class used to represent a Bezier curve */
  84506. export class BezierCurve {
  84507. /**
  84508. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84509. * @param t defines the time
  84510. * @param x1 defines the left coordinate on X axis
  84511. * @param y1 defines the left coordinate on Y axis
  84512. * @param x2 defines the right coordinate on X axis
  84513. * @param y2 defines the right coordinate on Y axis
  84514. * @returns the interpolated value
  84515. */
  84516. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84517. }
  84518. /**
  84519. * Defines angle representation
  84520. */
  84521. export class Angle {
  84522. private _radians;
  84523. /**
  84524. * Creates an Angle object of "radians" radians (float).
  84525. * @param radians the angle in radians
  84526. */
  84527. constructor(radians: number);
  84528. /**
  84529. * Get value in degrees
  84530. * @returns the Angle value in degrees (float)
  84531. */
  84532. degrees(): number;
  84533. /**
  84534. * Get value in radians
  84535. * @returns the Angle value in radians (float)
  84536. */
  84537. radians(): number;
  84538. /**
  84539. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84540. * @param a defines first point as the origin
  84541. * @param b defines point
  84542. * @returns a new Angle
  84543. */
  84544. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84545. /**
  84546. * Gets a new Angle object from the given float in radians
  84547. * @param radians defines the angle value in radians
  84548. * @returns a new Angle
  84549. */
  84550. static FromRadians(radians: number): Angle;
  84551. /**
  84552. * Gets a new Angle object from the given float in degrees
  84553. * @param degrees defines the angle value in degrees
  84554. * @returns a new Angle
  84555. */
  84556. static FromDegrees(degrees: number): Angle;
  84557. }
  84558. /**
  84559. * This represents an arc in a 2d space.
  84560. */
  84561. export class Arc2 {
  84562. /** Defines the start point of the arc */
  84563. startPoint: Vector2;
  84564. /** Defines the mid point of the arc */
  84565. midPoint: Vector2;
  84566. /** Defines the end point of the arc */
  84567. endPoint: Vector2;
  84568. /**
  84569. * Defines the center point of the arc.
  84570. */
  84571. centerPoint: Vector2;
  84572. /**
  84573. * Defines the radius of the arc.
  84574. */
  84575. radius: number;
  84576. /**
  84577. * Defines the angle of the arc (from mid point to end point).
  84578. */
  84579. angle: Angle;
  84580. /**
  84581. * Defines the start angle of the arc (from start point to middle point).
  84582. */
  84583. startAngle: Angle;
  84584. /**
  84585. * Defines the orientation of the arc (clock wise/counter clock wise).
  84586. */
  84587. orientation: Orientation;
  84588. /**
  84589. * Creates an Arc object from the three given points : start, middle and end.
  84590. * @param startPoint Defines the start point of the arc
  84591. * @param midPoint Defines the midlle point of the arc
  84592. * @param endPoint Defines the end point of the arc
  84593. */
  84594. constructor(
  84595. /** Defines the start point of the arc */
  84596. startPoint: Vector2,
  84597. /** Defines the mid point of the arc */
  84598. midPoint: Vector2,
  84599. /** Defines the end point of the arc */
  84600. endPoint: Vector2);
  84601. }
  84602. /**
  84603. * Represents a 2D path made up of multiple 2D points
  84604. */
  84605. export class Path2 {
  84606. private _points;
  84607. private _length;
  84608. /**
  84609. * If the path start and end point are the same
  84610. */
  84611. closed: boolean;
  84612. /**
  84613. * Creates a Path2 object from the starting 2D coordinates x and y.
  84614. * @param x the starting points x value
  84615. * @param y the starting points y value
  84616. */
  84617. constructor(x: number, y: number);
  84618. /**
  84619. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84620. * @param x the added points x value
  84621. * @param y the added points y value
  84622. * @returns the updated Path2.
  84623. */
  84624. addLineTo(x: number, y: number): Path2;
  84625. /**
  84626. * 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.
  84627. * @param midX middle point x value
  84628. * @param midY middle point y value
  84629. * @param endX end point x value
  84630. * @param endY end point y value
  84631. * @param numberOfSegments (default: 36)
  84632. * @returns the updated Path2.
  84633. */
  84634. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84635. /**
  84636. * Closes the Path2.
  84637. * @returns the Path2.
  84638. */
  84639. close(): Path2;
  84640. /**
  84641. * Gets the sum of the distance between each sequential point in the path
  84642. * @returns the Path2 total length (float).
  84643. */
  84644. length(): number;
  84645. /**
  84646. * Gets the points which construct the path
  84647. * @returns the Path2 internal array of points.
  84648. */
  84649. getPoints(): Vector2[];
  84650. /**
  84651. * Retreives the point at the distance aways from the starting point
  84652. * @param normalizedLengthPosition the length along the path to retreive the point from
  84653. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84654. */
  84655. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84656. /**
  84657. * Creates a new path starting from an x and y position
  84658. * @param x starting x value
  84659. * @param y starting y value
  84660. * @returns a new Path2 starting at the coordinates (x, y).
  84661. */
  84662. static StartingAt(x: number, y: number): Path2;
  84663. }
  84664. /**
  84665. * Represents a 3D path made up of multiple 3D points
  84666. */
  84667. export class Path3D {
  84668. /**
  84669. * an array of Vector3, the curve axis of the Path3D
  84670. */
  84671. path: Vector3[];
  84672. private _curve;
  84673. private _distances;
  84674. private _tangents;
  84675. private _normals;
  84676. private _binormals;
  84677. private _raw;
  84678. private _alignTangentsWithPath;
  84679. private readonly _pointAtData;
  84680. /**
  84681. * new Path3D(path, normal, raw)
  84682. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84683. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84684. * @param path an array of Vector3, the curve axis of the Path3D
  84685. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84686. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84687. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84688. */
  84689. constructor(
  84690. /**
  84691. * an array of Vector3, the curve axis of the Path3D
  84692. */
  84693. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84694. /**
  84695. * Returns the Path3D array of successive Vector3 designing its curve.
  84696. * @returns the Path3D array of successive Vector3 designing its curve.
  84697. */
  84698. getCurve(): Vector3[];
  84699. /**
  84700. * Returns the Path3D array of successive Vector3 designing its curve.
  84701. * @returns the Path3D array of successive Vector3 designing its curve.
  84702. */
  84703. getPoints(): Vector3[];
  84704. /**
  84705. * @returns the computed length (float) of the path.
  84706. */
  84707. length(): number;
  84708. /**
  84709. * Returns an array populated with tangent vectors on each Path3D curve point.
  84710. * @returns an array populated with tangent vectors on each Path3D curve point.
  84711. */
  84712. getTangents(): Vector3[];
  84713. /**
  84714. * Returns an array populated with normal vectors on each Path3D curve point.
  84715. * @returns an array populated with normal vectors on each Path3D curve point.
  84716. */
  84717. getNormals(): Vector3[];
  84718. /**
  84719. * Returns an array populated with binormal vectors on each Path3D curve point.
  84720. * @returns an array populated with binormal vectors on each Path3D curve point.
  84721. */
  84722. getBinormals(): Vector3[];
  84723. /**
  84724. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84725. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84726. */
  84727. getDistances(): number[];
  84728. /**
  84729. * Returns an interpolated point along this path
  84730. * @param position the position of the point along this path, from 0.0 to 1.0
  84731. * @returns a new Vector3 as the point
  84732. */
  84733. getPointAt(position: number): Vector3;
  84734. /**
  84735. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84736. * @param position the position of the point along this path, from 0.0 to 1.0
  84737. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84738. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84739. */
  84740. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84741. /**
  84742. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84743. * @param position the position of the point along this path, from 0.0 to 1.0
  84744. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84745. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84746. */
  84747. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84748. /**
  84749. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84750. * @param position the position of the point along this path, from 0.0 to 1.0
  84751. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84752. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84753. */
  84754. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84755. /**
  84756. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84757. * @param position the position of the point along this path, from 0.0 to 1.0
  84758. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84759. */
  84760. getDistanceAt(position: number): number;
  84761. /**
  84762. * Returns the array index of the previous point of an interpolated point along this path
  84763. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84764. * @returns the array index
  84765. */
  84766. getPreviousPointIndexAt(position: number): number;
  84767. /**
  84768. * 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)
  84769. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84770. * @returns the sub position
  84771. */
  84772. getSubPositionAt(position: number): number;
  84773. /**
  84774. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84775. * @param target the vector of which to get the closest position to
  84776. * @returns the position of the closest virtual point on this path to the target vector
  84777. */
  84778. getClosestPositionTo(target: Vector3): number;
  84779. /**
  84780. * Returns a sub path (slice) of this path
  84781. * @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
  84782. * @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
  84783. * @returns a sub path (slice) of this path
  84784. */
  84785. slice(start?: number, end?: number): Path3D;
  84786. /**
  84787. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84788. * @param path path which all values are copied into the curves points
  84789. * @param firstNormal which should be projected onto the curve
  84790. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84791. * @returns the same object updated.
  84792. */
  84793. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84794. private _compute;
  84795. private _getFirstNonNullVector;
  84796. private _getLastNonNullVector;
  84797. private _normalVector;
  84798. /**
  84799. * Updates the point at data for an interpolated point along this curve
  84800. * @param position the position of the point along this curve, from 0.0 to 1.0
  84801. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84802. * @returns the (updated) point at data
  84803. */
  84804. private _updatePointAtData;
  84805. /**
  84806. * Updates the point at data from the specified parameters
  84807. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84808. * @param point the interpolated point
  84809. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84810. */
  84811. private _setPointAtData;
  84812. /**
  84813. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84814. */
  84815. private _updateInterpolationMatrix;
  84816. }
  84817. /**
  84818. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84819. * A Curve3 is designed from a series of successive Vector3.
  84820. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84821. */
  84822. export class Curve3 {
  84823. private _points;
  84824. private _length;
  84825. /**
  84826. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84827. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84828. * @param v1 (Vector3) the control point
  84829. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84830. * @param nbPoints (integer) the wanted number of points in the curve
  84831. * @returns the created Curve3
  84832. */
  84833. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84834. /**
  84835. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84836. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84837. * @param v1 (Vector3) the first control point
  84838. * @param v2 (Vector3) the second control point
  84839. * @param v3 (Vector3) the end point of the Cubic Bezier
  84840. * @param nbPoints (integer) the wanted number of points in the curve
  84841. * @returns the created Curve3
  84842. */
  84843. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84844. /**
  84845. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84846. * @param p1 (Vector3) the origin point of the Hermite Spline
  84847. * @param t1 (Vector3) the tangent vector at the origin point
  84848. * @param p2 (Vector3) the end point of the Hermite Spline
  84849. * @param t2 (Vector3) the tangent vector at the end point
  84850. * @param nbPoints (integer) the wanted number of points in the curve
  84851. * @returns the created Curve3
  84852. */
  84853. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84854. /**
  84855. * Returns a Curve3 object along a CatmullRom Spline curve :
  84856. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84857. * @param nbPoints (integer) the wanted number of points between each curve control points
  84858. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84859. * @returns the created Curve3
  84860. */
  84861. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84862. /**
  84863. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84864. * A Curve3 is designed from a series of successive Vector3.
  84865. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84866. * @param points points which make up the curve
  84867. */
  84868. constructor(points: Vector3[]);
  84869. /**
  84870. * @returns the Curve3 stored array of successive Vector3
  84871. */
  84872. getPoints(): Vector3[];
  84873. /**
  84874. * @returns the computed length (float) of the curve.
  84875. */
  84876. length(): number;
  84877. /**
  84878. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84879. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84880. * curveA and curveB keep unchanged.
  84881. * @param curve the curve to continue from this curve
  84882. * @returns the newly constructed curve
  84883. */
  84884. continue(curve: DeepImmutable<Curve3>): Curve3;
  84885. private _computeLength;
  84886. }
  84887. }
  84888. declare module BABYLON {
  84889. /**
  84890. * This represents the main contract an easing function should follow.
  84891. * Easing functions are used throughout the animation system.
  84892. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84893. */
  84894. export interface IEasingFunction {
  84895. /**
  84896. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84897. * of the easing function.
  84898. * The link below provides some of the most common examples of easing functions.
  84899. * @see https://easings.net/
  84900. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84901. * @returns the corresponding value on the curve defined by the easing function
  84902. */
  84903. ease(gradient: number): number;
  84904. }
  84905. /**
  84906. * Base class used for every default easing function.
  84907. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84908. */
  84909. export class EasingFunction implements IEasingFunction {
  84910. /**
  84911. * Interpolation follows the mathematical formula associated with the easing function.
  84912. */
  84913. static readonly EASINGMODE_EASEIN: number;
  84914. /**
  84915. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84916. */
  84917. static readonly EASINGMODE_EASEOUT: number;
  84918. /**
  84919. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84920. */
  84921. static readonly EASINGMODE_EASEINOUT: number;
  84922. private _easingMode;
  84923. /**
  84924. * Sets the easing mode of the current function.
  84925. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84926. */
  84927. setEasingMode(easingMode: number): void;
  84928. /**
  84929. * Gets the current easing mode.
  84930. * @returns the easing mode
  84931. */
  84932. getEasingMode(): number;
  84933. /**
  84934. * @hidden
  84935. */
  84936. easeInCore(gradient: number): number;
  84937. /**
  84938. * Given an input gradient between 0 and 1, this returns the corresponding value
  84939. * of the easing function.
  84940. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84941. * @returns the corresponding value on the curve defined by the easing function
  84942. */
  84943. ease(gradient: number): number;
  84944. }
  84945. /**
  84946. * Easing function with a circle shape (see link below).
  84947. * @see https://easings.net/#easeInCirc
  84948. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84949. */
  84950. export class CircleEase extends EasingFunction implements IEasingFunction {
  84951. /** @hidden */
  84952. easeInCore(gradient: number): number;
  84953. }
  84954. /**
  84955. * Easing function with a ease back shape (see link below).
  84956. * @see https://easings.net/#easeInBack
  84957. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84958. */
  84959. export class BackEase extends EasingFunction implements IEasingFunction {
  84960. /** Defines the amplitude of the function */
  84961. amplitude: number;
  84962. /**
  84963. * Instantiates a back ease easing
  84964. * @see https://easings.net/#easeInBack
  84965. * @param amplitude Defines the amplitude of the function
  84966. */
  84967. constructor(
  84968. /** Defines the amplitude of the function */
  84969. amplitude?: number);
  84970. /** @hidden */
  84971. easeInCore(gradient: number): number;
  84972. }
  84973. /**
  84974. * Easing function with a bouncing shape (see link below).
  84975. * @see https://easings.net/#easeInBounce
  84976. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84977. */
  84978. export class BounceEase extends EasingFunction implements IEasingFunction {
  84979. /** Defines the number of bounces */
  84980. bounces: number;
  84981. /** Defines the amplitude of the bounce */
  84982. bounciness: number;
  84983. /**
  84984. * Instantiates a bounce easing
  84985. * @see https://easings.net/#easeInBounce
  84986. * @param bounces Defines the number of bounces
  84987. * @param bounciness Defines the amplitude of the bounce
  84988. */
  84989. constructor(
  84990. /** Defines the number of bounces */
  84991. bounces?: number,
  84992. /** Defines the amplitude of the bounce */
  84993. bounciness?: number);
  84994. /** @hidden */
  84995. easeInCore(gradient: number): number;
  84996. }
  84997. /**
  84998. * Easing function with a power of 3 shape (see link below).
  84999. * @see https://easings.net/#easeInCubic
  85000. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85001. */
  85002. export class CubicEase extends EasingFunction implements IEasingFunction {
  85003. /** @hidden */
  85004. easeInCore(gradient: number): number;
  85005. }
  85006. /**
  85007. * Easing function with an elastic shape (see link below).
  85008. * @see https://easings.net/#easeInElastic
  85009. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85010. */
  85011. export class ElasticEase extends EasingFunction implements IEasingFunction {
  85012. /** Defines the number of oscillations*/
  85013. oscillations: number;
  85014. /** Defines the amplitude of the oscillations*/
  85015. springiness: number;
  85016. /**
  85017. * Instantiates an elastic easing function
  85018. * @see https://easings.net/#easeInElastic
  85019. * @param oscillations Defines the number of oscillations
  85020. * @param springiness Defines the amplitude of the oscillations
  85021. */
  85022. constructor(
  85023. /** Defines the number of oscillations*/
  85024. oscillations?: number,
  85025. /** Defines the amplitude of the oscillations*/
  85026. springiness?: number);
  85027. /** @hidden */
  85028. easeInCore(gradient: number): number;
  85029. }
  85030. /**
  85031. * Easing function with an exponential shape (see link below).
  85032. * @see https://easings.net/#easeInExpo
  85033. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85034. */
  85035. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85036. /** Defines the exponent of the function */
  85037. exponent: number;
  85038. /**
  85039. * Instantiates an exponential easing function
  85040. * @see https://easings.net/#easeInExpo
  85041. * @param exponent Defines the exponent of the function
  85042. */
  85043. constructor(
  85044. /** Defines the exponent of the function */
  85045. exponent?: number);
  85046. /** @hidden */
  85047. easeInCore(gradient: number): number;
  85048. }
  85049. /**
  85050. * Easing function with a power shape (see link below).
  85051. * @see https://easings.net/#easeInQuad
  85052. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85053. */
  85054. export class PowerEase extends EasingFunction implements IEasingFunction {
  85055. /** Defines the power of the function */
  85056. power: number;
  85057. /**
  85058. * Instantiates an power base easing function
  85059. * @see https://easings.net/#easeInQuad
  85060. * @param power Defines the power of the function
  85061. */
  85062. constructor(
  85063. /** Defines the power of the function */
  85064. power?: number);
  85065. /** @hidden */
  85066. easeInCore(gradient: number): number;
  85067. }
  85068. /**
  85069. * Easing function with a power of 2 shape (see link below).
  85070. * @see https://easings.net/#easeInQuad
  85071. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85072. */
  85073. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85074. /** @hidden */
  85075. easeInCore(gradient: number): number;
  85076. }
  85077. /**
  85078. * Easing function with a power of 4 shape (see link below).
  85079. * @see https://easings.net/#easeInQuart
  85080. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85081. */
  85082. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85083. /** @hidden */
  85084. easeInCore(gradient: number): number;
  85085. }
  85086. /**
  85087. * Easing function with a power of 5 shape (see link below).
  85088. * @see https://easings.net/#easeInQuint
  85089. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85090. */
  85091. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85092. /** @hidden */
  85093. easeInCore(gradient: number): number;
  85094. }
  85095. /**
  85096. * Easing function with a sin shape (see link below).
  85097. * @see https://easings.net/#easeInSine
  85098. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85099. */
  85100. export class SineEase extends EasingFunction implements IEasingFunction {
  85101. /** @hidden */
  85102. easeInCore(gradient: number): number;
  85103. }
  85104. /**
  85105. * Easing function with a bezier shape (see link below).
  85106. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85107. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85108. */
  85109. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85110. /** Defines the x component of the start tangent in the bezier curve */
  85111. x1: number;
  85112. /** Defines the y component of the start tangent in the bezier curve */
  85113. y1: number;
  85114. /** Defines the x component of the end tangent in the bezier curve */
  85115. x2: number;
  85116. /** Defines the y component of the end tangent in the bezier curve */
  85117. y2: number;
  85118. /**
  85119. * Instantiates a bezier function
  85120. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85121. * @param x1 Defines the x component of the start tangent in the bezier curve
  85122. * @param y1 Defines the y component of the start tangent in the bezier curve
  85123. * @param x2 Defines the x component of the end tangent in the bezier curve
  85124. * @param y2 Defines the y component of the end tangent in the bezier curve
  85125. */
  85126. constructor(
  85127. /** Defines the x component of the start tangent in the bezier curve */
  85128. x1?: number,
  85129. /** Defines the y component of the start tangent in the bezier curve */
  85130. y1?: number,
  85131. /** Defines the x component of the end tangent in the bezier curve */
  85132. x2?: number,
  85133. /** Defines the y component of the end tangent in the bezier curve */
  85134. y2?: number);
  85135. /** @hidden */
  85136. easeInCore(gradient: number): number;
  85137. }
  85138. }
  85139. declare module BABYLON {
  85140. /**
  85141. * Class used to hold a RBG color
  85142. */
  85143. export class Color3 {
  85144. /**
  85145. * Defines the red component (between 0 and 1, default is 0)
  85146. */
  85147. r: number;
  85148. /**
  85149. * Defines the green component (between 0 and 1, default is 0)
  85150. */
  85151. g: number;
  85152. /**
  85153. * Defines the blue component (between 0 and 1, default is 0)
  85154. */
  85155. b: number;
  85156. /**
  85157. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85158. * @param r defines the red component (between 0 and 1, default is 0)
  85159. * @param g defines the green component (between 0 and 1, default is 0)
  85160. * @param b defines the blue component (between 0 and 1, default is 0)
  85161. */
  85162. constructor(
  85163. /**
  85164. * Defines the red component (between 0 and 1, default is 0)
  85165. */
  85166. r?: number,
  85167. /**
  85168. * Defines the green component (between 0 and 1, default is 0)
  85169. */
  85170. g?: number,
  85171. /**
  85172. * Defines the blue component (between 0 and 1, default is 0)
  85173. */
  85174. b?: number);
  85175. /**
  85176. * Creates a string with the Color3 current values
  85177. * @returns the string representation of the Color3 object
  85178. */
  85179. toString(): string;
  85180. /**
  85181. * Returns the string "Color3"
  85182. * @returns "Color3"
  85183. */
  85184. getClassName(): string;
  85185. /**
  85186. * Compute the Color3 hash code
  85187. * @returns an unique number that can be used to hash Color3 objects
  85188. */
  85189. getHashCode(): number;
  85190. /**
  85191. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85192. * @param array defines the array where to store the r,g,b components
  85193. * @param index defines an optional index in the target array to define where to start storing values
  85194. * @returns the current Color3 object
  85195. */
  85196. toArray(array: FloatArray, index?: number): Color3;
  85197. /**
  85198. * Update the current color with values stored in an array from the starting index of the given array
  85199. * @param array defines the source array
  85200. * @param offset defines an offset in the source array
  85201. * @returns the current Color3 object
  85202. */
  85203. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85204. /**
  85205. * Returns a new Color4 object from the current Color3 and the given alpha
  85206. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85207. * @returns a new Color4 object
  85208. */
  85209. toColor4(alpha?: number): Color4;
  85210. /**
  85211. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85212. * @returns the new array
  85213. */
  85214. asArray(): number[];
  85215. /**
  85216. * Returns the luminance value
  85217. * @returns a float value
  85218. */
  85219. toLuminance(): number;
  85220. /**
  85221. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85222. * @param otherColor defines the second operand
  85223. * @returns the new Color3 object
  85224. */
  85225. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85226. /**
  85227. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85228. * @param otherColor defines the second operand
  85229. * @param result defines the Color3 object where to store the result
  85230. * @returns the current Color3
  85231. */
  85232. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85233. /**
  85234. * Determines equality between Color3 objects
  85235. * @param otherColor defines the second operand
  85236. * @returns true if the rgb values are equal to the given ones
  85237. */
  85238. equals(otherColor: DeepImmutable<Color3>): boolean;
  85239. /**
  85240. * Determines equality between the current Color3 object and a set of r,b,g values
  85241. * @param r defines the red component to check
  85242. * @param g defines the green component to check
  85243. * @param b defines the blue component to check
  85244. * @returns true if the rgb values are equal to the given ones
  85245. */
  85246. equalsFloats(r: number, g: number, b: number): boolean;
  85247. /**
  85248. * Multiplies in place each rgb value by scale
  85249. * @param scale defines the scaling factor
  85250. * @returns the updated Color3
  85251. */
  85252. scale(scale: number): Color3;
  85253. /**
  85254. * Multiplies the rgb values by scale and stores the result into "result"
  85255. * @param scale defines the scaling factor
  85256. * @param result defines the Color3 object where to store the result
  85257. * @returns the unmodified current Color3
  85258. */
  85259. scaleToRef(scale: number, result: Color3): Color3;
  85260. /**
  85261. * Scale the current Color3 values by a factor and add the result to a given Color3
  85262. * @param scale defines the scale factor
  85263. * @param result defines color to store the result into
  85264. * @returns the unmodified current Color3
  85265. */
  85266. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85267. /**
  85268. * Clamps the rgb values by the min and max values and stores the result into "result"
  85269. * @param min defines minimum clamping value (default is 0)
  85270. * @param max defines maximum clamping value (default is 1)
  85271. * @param result defines color to store the result into
  85272. * @returns the original Color3
  85273. */
  85274. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85275. /**
  85276. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85277. * @param otherColor defines the second operand
  85278. * @returns the new Color3
  85279. */
  85280. add(otherColor: DeepImmutable<Color3>): Color3;
  85281. /**
  85282. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85283. * @param otherColor defines the second operand
  85284. * @param result defines Color3 object to store the result into
  85285. * @returns the unmodified current Color3
  85286. */
  85287. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85288. /**
  85289. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85290. * @param otherColor defines the second operand
  85291. * @returns the new Color3
  85292. */
  85293. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85294. /**
  85295. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85296. * @param otherColor defines the second operand
  85297. * @param result defines Color3 object to store the result into
  85298. * @returns the unmodified current Color3
  85299. */
  85300. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85301. /**
  85302. * Copy the current object
  85303. * @returns a new Color3 copied the current one
  85304. */
  85305. clone(): Color3;
  85306. /**
  85307. * Copies the rgb values from the source in the current Color3
  85308. * @param source defines the source Color3 object
  85309. * @returns the updated Color3 object
  85310. */
  85311. copyFrom(source: DeepImmutable<Color3>): Color3;
  85312. /**
  85313. * Updates the Color3 rgb values from the given floats
  85314. * @param r defines the red component to read from
  85315. * @param g defines the green component to read from
  85316. * @param b defines the blue component to read from
  85317. * @returns the current Color3 object
  85318. */
  85319. copyFromFloats(r: number, g: number, b: number): Color3;
  85320. /**
  85321. * Updates the Color3 rgb values from the given floats
  85322. * @param r defines the red component to read from
  85323. * @param g defines the green component to read from
  85324. * @param b defines the blue component to read from
  85325. * @returns the current Color3 object
  85326. */
  85327. set(r: number, g: number, b: number): Color3;
  85328. /**
  85329. * Compute the Color3 hexadecimal code as a string
  85330. * @returns a string containing the hexadecimal representation of the Color3 object
  85331. */
  85332. toHexString(): string;
  85333. /**
  85334. * Computes a new Color3 converted from the current one to linear space
  85335. * @returns a new Color3 object
  85336. */
  85337. toLinearSpace(): Color3;
  85338. /**
  85339. * Converts current color in rgb space to HSV values
  85340. * @returns a new color3 representing the HSV values
  85341. */
  85342. toHSV(): Color3;
  85343. /**
  85344. * Converts current color in rgb space to HSV values
  85345. * @param result defines the Color3 where to store the HSV values
  85346. */
  85347. toHSVToRef(result: Color3): void;
  85348. /**
  85349. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85350. * @param convertedColor defines the Color3 object where to store the linear space version
  85351. * @returns the unmodified Color3
  85352. */
  85353. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85354. /**
  85355. * Computes a new Color3 converted from the current one to gamma space
  85356. * @returns a new Color3 object
  85357. */
  85358. toGammaSpace(): Color3;
  85359. /**
  85360. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85361. * @param convertedColor defines the Color3 object where to store the gamma space version
  85362. * @returns the unmodified Color3
  85363. */
  85364. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85365. private static _BlackReadOnly;
  85366. /**
  85367. * Convert Hue, saturation and value to a Color3 (RGB)
  85368. * @param hue defines the hue
  85369. * @param saturation defines the saturation
  85370. * @param value defines the value
  85371. * @param result defines the Color3 where to store the RGB values
  85372. */
  85373. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85374. /**
  85375. * Creates a new Color3 from the string containing valid hexadecimal values
  85376. * @param hex defines a string containing valid hexadecimal values
  85377. * @returns a new Color3 object
  85378. */
  85379. static FromHexString(hex: string): Color3;
  85380. /**
  85381. * Creates a new Color3 from the starting index of the given array
  85382. * @param array defines the source array
  85383. * @param offset defines an offset in the source array
  85384. * @returns a new Color3 object
  85385. */
  85386. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85387. /**
  85388. * Creates a new Color3 from the starting index element of the given array
  85389. * @param array defines the source array to read from
  85390. * @param offset defines the offset in the source array
  85391. * @param result defines the target Color3 object
  85392. */
  85393. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85394. /**
  85395. * Creates a new Color3 from integer values (< 256)
  85396. * @param r defines the red component to read from (value between 0 and 255)
  85397. * @param g defines the green component to read from (value between 0 and 255)
  85398. * @param b defines the blue component to read from (value between 0 and 255)
  85399. * @returns a new Color3 object
  85400. */
  85401. static FromInts(r: number, g: number, b: number): Color3;
  85402. /**
  85403. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85404. * @param start defines the start Color3 value
  85405. * @param end defines the end Color3 value
  85406. * @param amount defines the gradient value between start and end
  85407. * @returns a new Color3 object
  85408. */
  85409. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85410. /**
  85411. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85412. * @param left defines the start value
  85413. * @param right defines the end value
  85414. * @param amount defines the gradient factor
  85415. * @param result defines the Color3 object where to store the result
  85416. */
  85417. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85418. /**
  85419. * Returns a Color3 value containing a red color
  85420. * @returns a new Color3 object
  85421. */
  85422. static Red(): Color3;
  85423. /**
  85424. * Returns a Color3 value containing a green color
  85425. * @returns a new Color3 object
  85426. */
  85427. static Green(): Color3;
  85428. /**
  85429. * Returns a Color3 value containing a blue color
  85430. * @returns a new Color3 object
  85431. */
  85432. static Blue(): Color3;
  85433. /**
  85434. * Returns a Color3 value containing a black color
  85435. * @returns a new Color3 object
  85436. */
  85437. static Black(): Color3;
  85438. /**
  85439. * Gets a Color3 value containing a black color that must not be updated
  85440. */
  85441. static get BlackReadOnly(): DeepImmutable<Color3>;
  85442. /**
  85443. * Returns a Color3 value containing a white color
  85444. * @returns a new Color3 object
  85445. */
  85446. static White(): Color3;
  85447. /**
  85448. * Returns a Color3 value containing a purple color
  85449. * @returns a new Color3 object
  85450. */
  85451. static Purple(): Color3;
  85452. /**
  85453. * Returns a Color3 value containing a magenta color
  85454. * @returns a new Color3 object
  85455. */
  85456. static Magenta(): Color3;
  85457. /**
  85458. * Returns a Color3 value containing a yellow color
  85459. * @returns a new Color3 object
  85460. */
  85461. static Yellow(): Color3;
  85462. /**
  85463. * Returns a Color3 value containing a gray color
  85464. * @returns a new Color3 object
  85465. */
  85466. static Gray(): Color3;
  85467. /**
  85468. * Returns a Color3 value containing a teal color
  85469. * @returns a new Color3 object
  85470. */
  85471. static Teal(): Color3;
  85472. /**
  85473. * Returns a Color3 value containing a random color
  85474. * @returns a new Color3 object
  85475. */
  85476. static Random(): Color3;
  85477. }
  85478. /**
  85479. * Class used to hold a RBGA color
  85480. */
  85481. export class Color4 {
  85482. /**
  85483. * Defines the red component (between 0 and 1, default is 0)
  85484. */
  85485. r: number;
  85486. /**
  85487. * Defines the green component (between 0 and 1, default is 0)
  85488. */
  85489. g: number;
  85490. /**
  85491. * Defines the blue component (between 0 and 1, default is 0)
  85492. */
  85493. b: number;
  85494. /**
  85495. * Defines the alpha component (between 0 and 1, default is 1)
  85496. */
  85497. a: number;
  85498. /**
  85499. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85500. * @param r defines the red component (between 0 and 1, default is 0)
  85501. * @param g defines the green component (between 0 and 1, default is 0)
  85502. * @param b defines the blue component (between 0 and 1, default is 0)
  85503. * @param a defines the alpha component (between 0 and 1, default is 1)
  85504. */
  85505. constructor(
  85506. /**
  85507. * Defines the red component (between 0 and 1, default is 0)
  85508. */
  85509. r?: number,
  85510. /**
  85511. * Defines the green component (between 0 and 1, default is 0)
  85512. */
  85513. g?: number,
  85514. /**
  85515. * Defines the blue component (between 0 and 1, default is 0)
  85516. */
  85517. b?: number,
  85518. /**
  85519. * Defines the alpha component (between 0 and 1, default is 1)
  85520. */
  85521. a?: number);
  85522. /**
  85523. * Adds in place the given Color4 values to the current Color4 object
  85524. * @param right defines the second operand
  85525. * @returns the current updated Color4 object
  85526. */
  85527. addInPlace(right: DeepImmutable<Color4>): Color4;
  85528. /**
  85529. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85530. * @returns the new array
  85531. */
  85532. asArray(): number[];
  85533. /**
  85534. * Stores from the starting index in the given array the Color4 successive values
  85535. * @param array defines the array where to store the r,g,b components
  85536. * @param index defines an optional index in the target array to define where to start storing values
  85537. * @returns the current Color4 object
  85538. */
  85539. toArray(array: number[], index?: number): Color4;
  85540. /**
  85541. * Update the current color with values stored in an array from the starting index of the given array
  85542. * @param array defines the source array
  85543. * @param offset defines an offset in the source array
  85544. * @returns the current Color4 object
  85545. */
  85546. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85547. /**
  85548. * Determines equality between Color4 objects
  85549. * @param otherColor defines the second operand
  85550. * @returns true if the rgba values are equal to the given ones
  85551. */
  85552. equals(otherColor: DeepImmutable<Color4>): boolean;
  85553. /**
  85554. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85555. * @param right defines the second operand
  85556. * @returns a new Color4 object
  85557. */
  85558. add(right: DeepImmutable<Color4>): Color4;
  85559. /**
  85560. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85561. * @param right defines the second operand
  85562. * @returns a new Color4 object
  85563. */
  85564. subtract(right: DeepImmutable<Color4>): Color4;
  85565. /**
  85566. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85567. * @param right defines the second operand
  85568. * @param result defines the Color4 object where to store the result
  85569. * @returns the current Color4 object
  85570. */
  85571. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85572. /**
  85573. * Creates a new Color4 with the current Color4 values multiplied by scale
  85574. * @param scale defines the scaling factor to apply
  85575. * @returns a new Color4 object
  85576. */
  85577. scale(scale: number): Color4;
  85578. /**
  85579. * Multiplies the current Color4 values by scale and stores the result in "result"
  85580. * @param scale defines the scaling factor to apply
  85581. * @param result defines the Color4 object where to store the result
  85582. * @returns the current unmodified Color4
  85583. */
  85584. scaleToRef(scale: number, result: Color4): Color4;
  85585. /**
  85586. * Scale the current Color4 values by a factor and add the result to a given Color4
  85587. * @param scale defines the scale factor
  85588. * @param result defines the Color4 object where to store the result
  85589. * @returns the unmodified current Color4
  85590. */
  85591. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85592. /**
  85593. * Clamps the rgb values by the min and max values and stores the result into "result"
  85594. * @param min defines minimum clamping value (default is 0)
  85595. * @param max defines maximum clamping value (default is 1)
  85596. * @param result defines color to store the result into.
  85597. * @returns the cuurent Color4
  85598. */
  85599. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85600. /**
  85601. * Multipy an Color4 value by another and return a new Color4 object
  85602. * @param color defines the Color4 value to multiply by
  85603. * @returns a new Color4 object
  85604. */
  85605. multiply(color: Color4): Color4;
  85606. /**
  85607. * Multipy a Color4 value by another and push the result in a reference value
  85608. * @param color defines the Color4 value to multiply by
  85609. * @param result defines the Color4 to fill the result in
  85610. * @returns the result Color4
  85611. */
  85612. multiplyToRef(color: Color4, result: Color4): Color4;
  85613. /**
  85614. * Creates a string with the Color4 current values
  85615. * @returns the string representation of the Color4 object
  85616. */
  85617. toString(): string;
  85618. /**
  85619. * Returns the string "Color4"
  85620. * @returns "Color4"
  85621. */
  85622. getClassName(): string;
  85623. /**
  85624. * Compute the Color4 hash code
  85625. * @returns an unique number that can be used to hash Color4 objects
  85626. */
  85627. getHashCode(): number;
  85628. /**
  85629. * Creates a new Color4 copied from the current one
  85630. * @returns a new Color4 object
  85631. */
  85632. clone(): Color4;
  85633. /**
  85634. * Copies the given Color4 values into the current one
  85635. * @param source defines the source Color4 object
  85636. * @returns the current updated Color4 object
  85637. */
  85638. copyFrom(source: Color4): Color4;
  85639. /**
  85640. * Copies the given float values into the current one
  85641. * @param r defines the red component to read from
  85642. * @param g defines the green component to read from
  85643. * @param b defines the blue component to read from
  85644. * @param a defines the alpha component to read from
  85645. * @returns the current updated Color4 object
  85646. */
  85647. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85648. /**
  85649. * Copies the given float values into the current one
  85650. * @param r defines the red component to read from
  85651. * @param g defines the green component to read from
  85652. * @param b defines the blue component to read from
  85653. * @param a defines the alpha component to read from
  85654. * @returns the current updated Color4 object
  85655. */
  85656. set(r: number, g: number, b: number, a: number): Color4;
  85657. /**
  85658. * Compute the Color4 hexadecimal code as a string
  85659. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85660. * @returns a string containing the hexadecimal representation of the Color4 object
  85661. */
  85662. toHexString(returnAsColor3?: boolean): string;
  85663. /**
  85664. * Computes a new Color4 converted from the current one to linear space
  85665. * @returns a new Color4 object
  85666. */
  85667. toLinearSpace(): Color4;
  85668. /**
  85669. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85670. * @param convertedColor defines the Color4 object where to store the linear space version
  85671. * @returns the unmodified Color4
  85672. */
  85673. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85674. /**
  85675. * Computes a new Color4 converted from the current one to gamma space
  85676. * @returns a new Color4 object
  85677. */
  85678. toGammaSpace(): Color4;
  85679. /**
  85680. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85681. * @param convertedColor defines the Color4 object where to store the gamma space version
  85682. * @returns the unmodified Color4
  85683. */
  85684. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85685. /**
  85686. * Creates a new Color4 from the string containing valid hexadecimal values
  85687. * @param hex defines a string containing valid hexadecimal values
  85688. * @returns a new Color4 object
  85689. */
  85690. static FromHexString(hex: string): Color4;
  85691. /**
  85692. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85693. * @param left defines the start value
  85694. * @param right defines the end value
  85695. * @param amount defines the gradient factor
  85696. * @returns a new Color4 object
  85697. */
  85698. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85699. /**
  85700. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85701. * @param left defines the start value
  85702. * @param right defines the end value
  85703. * @param amount defines the gradient factor
  85704. * @param result defines the Color4 object where to store data
  85705. */
  85706. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85707. /**
  85708. * Creates a new Color4 from a Color3 and an alpha value
  85709. * @param color3 defines the source Color3 to read from
  85710. * @param alpha defines the alpha component (1.0 by default)
  85711. * @returns a new Color4 object
  85712. */
  85713. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85714. /**
  85715. * Creates a new Color4 from the starting index element of the given array
  85716. * @param array defines the source array to read from
  85717. * @param offset defines the offset in the source array
  85718. * @returns a new Color4 object
  85719. */
  85720. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85721. /**
  85722. * Creates a new Color4 from the starting index element of the given array
  85723. * @param array defines the source array to read from
  85724. * @param offset defines the offset in the source array
  85725. * @param result defines the target Color4 object
  85726. */
  85727. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85728. /**
  85729. * Creates a new Color3 from integer values (< 256)
  85730. * @param r defines the red component to read from (value between 0 and 255)
  85731. * @param g defines the green component to read from (value between 0 and 255)
  85732. * @param b defines the blue component to read from (value between 0 and 255)
  85733. * @param a defines the alpha component to read from (value between 0 and 255)
  85734. * @returns a new Color3 object
  85735. */
  85736. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85737. /**
  85738. * Check the content of a given array and convert it to an array containing RGBA data
  85739. * If the original array was already containing count * 4 values then it is returned directly
  85740. * @param colors defines the array to check
  85741. * @param count defines the number of RGBA data to expect
  85742. * @returns an array containing count * 4 values (RGBA)
  85743. */
  85744. static CheckColors4(colors: number[], count: number): number[];
  85745. }
  85746. /**
  85747. * @hidden
  85748. */
  85749. export class TmpColors {
  85750. static Color3: Color3[];
  85751. static Color4: Color4[];
  85752. }
  85753. }
  85754. declare module BABYLON {
  85755. /**
  85756. * Defines an interface which represents an animation key frame
  85757. */
  85758. export interface IAnimationKey {
  85759. /**
  85760. * Frame of the key frame
  85761. */
  85762. frame: number;
  85763. /**
  85764. * Value at the specifies key frame
  85765. */
  85766. value: any;
  85767. /**
  85768. * The input tangent for the cubic hermite spline
  85769. */
  85770. inTangent?: any;
  85771. /**
  85772. * The output tangent for the cubic hermite spline
  85773. */
  85774. outTangent?: any;
  85775. /**
  85776. * The animation interpolation type
  85777. */
  85778. interpolation?: AnimationKeyInterpolation;
  85779. }
  85780. /**
  85781. * Enum for the animation key frame interpolation type
  85782. */
  85783. export enum AnimationKeyInterpolation {
  85784. /**
  85785. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85786. */
  85787. STEP = 1
  85788. }
  85789. }
  85790. declare module BABYLON {
  85791. /**
  85792. * Represents the range of an animation
  85793. */
  85794. export class AnimationRange {
  85795. /**The name of the animation range**/
  85796. name: string;
  85797. /**The starting frame of the animation */
  85798. from: number;
  85799. /**The ending frame of the animation*/
  85800. to: number;
  85801. /**
  85802. * Initializes the range of an animation
  85803. * @param name The name of the animation range
  85804. * @param from The starting frame of the animation
  85805. * @param to The ending frame of the animation
  85806. */
  85807. constructor(
  85808. /**The name of the animation range**/
  85809. name: string,
  85810. /**The starting frame of the animation */
  85811. from: number,
  85812. /**The ending frame of the animation*/
  85813. to: number);
  85814. /**
  85815. * Makes a copy of the animation range
  85816. * @returns A copy of the animation range
  85817. */
  85818. clone(): AnimationRange;
  85819. }
  85820. }
  85821. declare module BABYLON {
  85822. /**
  85823. * Composed of a frame, and an action function
  85824. */
  85825. export class AnimationEvent {
  85826. /** The frame for which the event is triggered **/
  85827. frame: number;
  85828. /** The event to perform when triggered **/
  85829. action: (currentFrame: number) => void;
  85830. /** Specifies if the event should be triggered only once**/
  85831. onlyOnce?: boolean | undefined;
  85832. /**
  85833. * Specifies if the animation event is done
  85834. */
  85835. isDone: boolean;
  85836. /**
  85837. * Initializes the animation event
  85838. * @param frame The frame for which the event is triggered
  85839. * @param action The event to perform when triggered
  85840. * @param onlyOnce Specifies if the event should be triggered only once
  85841. */
  85842. constructor(
  85843. /** The frame for which the event is triggered **/
  85844. frame: number,
  85845. /** The event to perform when triggered **/
  85846. action: (currentFrame: number) => void,
  85847. /** Specifies if the event should be triggered only once**/
  85848. onlyOnce?: boolean | undefined);
  85849. /** @hidden */
  85850. _clone(): AnimationEvent;
  85851. }
  85852. }
  85853. declare module BABYLON {
  85854. /**
  85855. * Interface used to define a behavior
  85856. */
  85857. export interface Behavior<T> {
  85858. /** gets or sets behavior's name */
  85859. name: string;
  85860. /**
  85861. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85862. */
  85863. init(): void;
  85864. /**
  85865. * Called when the behavior is attached to a target
  85866. * @param target defines the target where the behavior is attached to
  85867. */
  85868. attach(target: T): void;
  85869. /**
  85870. * Called when the behavior is detached from its target
  85871. */
  85872. detach(): void;
  85873. }
  85874. /**
  85875. * Interface implemented by classes supporting behaviors
  85876. */
  85877. export interface IBehaviorAware<T> {
  85878. /**
  85879. * Attach a behavior
  85880. * @param behavior defines the behavior to attach
  85881. * @returns the current host
  85882. */
  85883. addBehavior(behavior: Behavior<T>): T;
  85884. /**
  85885. * Remove a behavior from the current object
  85886. * @param behavior defines the behavior to detach
  85887. * @returns the current host
  85888. */
  85889. removeBehavior(behavior: Behavior<T>): T;
  85890. /**
  85891. * Gets a behavior using its name to search
  85892. * @param name defines the name to search
  85893. * @returns the behavior or null if not found
  85894. */
  85895. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85896. }
  85897. }
  85898. declare module BABYLON {
  85899. /**
  85900. * Defines an array and its length.
  85901. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85902. */
  85903. export interface ISmartArrayLike<T> {
  85904. /**
  85905. * The data of the array.
  85906. */
  85907. data: Array<T>;
  85908. /**
  85909. * The active length of the array.
  85910. */
  85911. length: number;
  85912. }
  85913. /**
  85914. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85915. */
  85916. export class SmartArray<T> implements ISmartArrayLike<T> {
  85917. /**
  85918. * The full set of data from the array.
  85919. */
  85920. data: Array<T>;
  85921. /**
  85922. * The active length of the array.
  85923. */
  85924. length: number;
  85925. protected _id: number;
  85926. /**
  85927. * Instantiates a Smart Array.
  85928. * @param capacity defines the default capacity of the array.
  85929. */
  85930. constructor(capacity: number);
  85931. /**
  85932. * Pushes a value at the end of the active data.
  85933. * @param value defines the object to push in the array.
  85934. */
  85935. push(value: T): void;
  85936. /**
  85937. * Iterates over the active data and apply the lambda to them.
  85938. * @param func defines the action to apply on each value.
  85939. */
  85940. forEach(func: (content: T) => void): void;
  85941. /**
  85942. * Sorts the full sets of data.
  85943. * @param compareFn defines the comparison function to apply.
  85944. */
  85945. sort(compareFn: (a: T, b: T) => number): void;
  85946. /**
  85947. * Resets the active data to an empty array.
  85948. */
  85949. reset(): void;
  85950. /**
  85951. * Releases all the data from the array as well as the array.
  85952. */
  85953. dispose(): void;
  85954. /**
  85955. * Concats the active data with a given array.
  85956. * @param array defines the data to concatenate with.
  85957. */
  85958. concat(array: any): void;
  85959. /**
  85960. * Returns the position of a value in the active data.
  85961. * @param value defines the value to find the index for
  85962. * @returns the index if found in the active data otherwise -1
  85963. */
  85964. indexOf(value: T): number;
  85965. /**
  85966. * Returns whether an element is part of the active data.
  85967. * @param value defines the value to look for
  85968. * @returns true if found in the active data otherwise false
  85969. */
  85970. contains(value: T): boolean;
  85971. private static _GlobalId;
  85972. }
  85973. /**
  85974. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85975. * The data in this array can only be present once
  85976. */
  85977. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85978. private _duplicateId;
  85979. /**
  85980. * Pushes a value at the end of the active data.
  85981. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85982. * @param value defines the object to push in the array.
  85983. */
  85984. push(value: T): void;
  85985. /**
  85986. * Pushes a value at the end of the active data.
  85987. * If the data is already present, it won t be added again
  85988. * @param value defines the object to push in the array.
  85989. * @returns true if added false if it was already present
  85990. */
  85991. pushNoDuplicate(value: T): boolean;
  85992. /**
  85993. * Resets the active data to an empty array.
  85994. */
  85995. reset(): void;
  85996. /**
  85997. * Concats the active data with a given array.
  85998. * This ensures no dupplicate will be present in the result.
  85999. * @param array defines the data to concatenate with.
  86000. */
  86001. concatWithNoDuplicate(array: any): void;
  86002. }
  86003. }
  86004. declare module BABYLON {
  86005. /**
  86006. * @ignore
  86007. * This is a list of all the different input types that are available in the application.
  86008. * Fo instance: ArcRotateCameraGamepadInput...
  86009. */
  86010. export var CameraInputTypes: {};
  86011. /**
  86012. * This is the contract to implement in order to create a new input class.
  86013. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86014. */
  86015. export interface ICameraInput<TCamera extends Camera> {
  86016. /**
  86017. * Defines the camera the input is attached to.
  86018. */
  86019. camera: Nullable<TCamera>;
  86020. /**
  86021. * Gets the class name of the current intput.
  86022. * @returns the class name
  86023. */
  86024. getClassName(): string;
  86025. /**
  86026. * Get the friendly name associated with the input class.
  86027. * @returns the input friendly name
  86028. */
  86029. getSimpleName(): string;
  86030. /**
  86031. * Attach the input controls to a specific dom element to get the input from.
  86032. * @param element Defines the element the controls should be listened from
  86033. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86034. */
  86035. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86036. /**
  86037. * Detach the current controls from the specified dom element.
  86038. * @param element Defines the element to stop listening the inputs from
  86039. */
  86040. detachControl(element: Nullable<HTMLElement>): void;
  86041. /**
  86042. * Update the current camera state depending on the inputs that have been used this frame.
  86043. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86044. */
  86045. checkInputs?: () => void;
  86046. }
  86047. /**
  86048. * Represents a map of input types to input instance or input index to input instance.
  86049. */
  86050. export interface CameraInputsMap<TCamera extends Camera> {
  86051. /**
  86052. * Accessor to the input by input type.
  86053. */
  86054. [name: string]: ICameraInput<TCamera>;
  86055. /**
  86056. * Accessor to the input by input index.
  86057. */
  86058. [idx: number]: ICameraInput<TCamera>;
  86059. }
  86060. /**
  86061. * This represents the input manager used within a camera.
  86062. * It helps dealing with all the different kind of input attached to a camera.
  86063. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86064. */
  86065. export class CameraInputsManager<TCamera extends Camera> {
  86066. /**
  86067. * Defines the list of inputs attahed to the camera.
  86068. */
  86069. attached: CameraInputsMap<TCamera>;
  86070. /**
  86071. * Defines the dom element the camera is collecting inputs from.
  86072. * This is null if the controls have not been attached.
  86073. */
  86074. attachedElement: Nullable<HTMLElement>;
  86075. /**
  86076. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86077. */
  86078. noPreventDefault: boolean;
  86079. /**
  86080. * Defined the camera the input manager belongs to.
  86081. */
  86082. camera: TCamera;
  86083. /**
  86084. * Update the current camera state depending on the inputs that have been used this frame.
  86085. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86086. */
  86087. checkInputs: () => void;
  86088. /**
  86089. * Instantiate a new Camera Input Manager.
  86090. * @param camera Defines the camera the input manager blongs to
  86091. */
  86092. constructor(camera: TCamera);
  86093. /**
  86094. * Add an input method to a camera
  86095. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86096. * @param input camera input method
  86097. */
  86098. add(input: ICameraInput<TCamera>): void;
  86099. /**
  86100. * Remove a specific input method from a camera
  86101. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86102. * @param inputToRemove camera input method
  86103. */
  86104. remove(inputToRemove: ICameraInput<TCamera>): void;
  86105. /**
  86106. * Remove a specific input type from a camera
  86107. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86108. * @param inputType the type of the input to remove
  86109. */
  86110. removeByType(inputType: string): void;
  86111. private _addCheckInputs;
  86112. /**
  86113. * Attach the input controls to the currently attached dom element to listen the events from.
  86114. * @param input Defines the input to attach
  86115. */
  86116. attachInput(input: ICameraInput<TCamera>): void;
  86117. /**
  86118. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86119. * @param element Defines the dom element to collect the events from
  86120. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86121. */
  86122. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86123. /**
  86124. * Detach the current manager inputs controls from a specific dom element.
  86125. * @param element Defines the dom element to collect the events from
  86126. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86127. */
  86128. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86129. /**
  86130. * Rebuild the dynamic inputCheck function from the current list of
  86131. * defined inputs in the manager.
  86132. */
  86133. rebuildInputCheck(): void;
  86134. /**
  86135. * Remove all attached input methods from a camera
  86136. */
  86137. clear(): void;
  86138. /**
  86139. * Serialize the current input manager attached to a camera.
  86140. * This ensures than once parsed,
  86141. * the input associated to the camera will be identical to the current ones
  86142. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86143. */
  86144. serialize(serializedCamera: any): void;
  86145. /**
  86146. * Parses an input manager serialized JSON to restore the previous list of inputs
  86147. * and states associated to a camera.
  86148. * @param parsedCamera Defines the JSON to parse
  86149. */
  86150. parse(parsedCamera: any): void;
  86151. }
  86152. }
  86153. declare module BABYLON {
  86154. /**
  86155. * Class used to store data that will be store in GPU memory
  86156. */
  86157. export class Buffer {
  86158. private _engine;
  86159. private _buffer;
  86160. /** @hidden */
  86161. _data: Nullable<DataArray>;
  86162. private _updatable;
  86163. private _instanced;
  86164. private _divisor;
  86165. /**
  86166. * Gets the byte stride.
  86167. */
  86168. readonly byteStride: number;
  86169. /**
  86170. * Constructor
  86171. * @param engine the engine
  86172. * @param data the data to use for this buffer
  86173. * @param updatable whether the data is updatable
  86174. * @param stride the stride (optional)
  86175. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86176. * @param instanced whether the buffer is instanced (optional)
  86177. * @param useBytes set to true if the stride in in bytes (optional)
  86178. * @param divisor sets an optional divisor for instances (1 by default)
  86179. */
  86180. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86181. /**
  86182. * Create a new VertexBuffer based on the current buffer
  86183. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86184. * @param offset defines offset in the buffer (0 by default)
  86185. * @param size defines the size in floats of attributes (position is 3 for instance)
  86186. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86187. * @param instanced defines if the vertex buffer contains indexed data
  86188. * @param useBytes defines if the offset and stride are in bytes *
  86189. * @param divisor sets an optional divisor for instances (1 by default)
  86190. * @returns the new vertex buffer
  86191. */
  86192. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86193. /**
  86194. * Gets a boolean indicating if the Buffer is updatable?
  86195. * @returns true if the buffer is updatable
  86196. */
  86197. isUpdatable(): boolean;
  86198. /**
  86199. * Gets current buffer's data
  86200. * @returns a DataArray or null
  86201. */
  86202. getData(): Nullable<DataArray>;
  86203. /**
  86204. * Gets underlying native buffer
  86205. * @returns underlying native buffer
  86206. */
  86207. getBuffer(): Nullable<DataBuffer>;
  86208. /**
  86209. * Gets the stride in float32 units (i.e. byte stride / 4).
  86210. * May not be an integer if the byte stride is not divisible by 4.
  86211. * @returns the stride in float32 units
  86212. * @deprecated Please use byteStride instead.
  86213. */
  86214. getStrideSize(): number;
  86215. /**
  86216. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86217. * @param data defines the data to store
  86218. */
  86219. create(data?: Nullable<DataArray>): void;
  86220. /** @hidden */
  86221. _rebuild(): void;
  86222. /**
  86223. * Update current buffer data
  86224. * @param data defines the data to store
  86225. */
  86226. update(data: DataArray): void;
  86227. /**
  86228. * Updates the data directly.
  86229. * @param data the new data
  86230. * @param offset the new offset
  86231. * @param vertexCount the vertex count (optional)
  86232. * @param useBytes set to true if the offset is in bytes
  86233. */
  86234. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86235. /**
  86236. * Release all resources
  86237. */
  86238. dispose(): void;
  86239. }
  86240. /**
  86241. * Specialized buffer used to store vertex data
  86242. */
  86243. export class VertexBuffer {
  86244. /** @hidden */
  86245. _buffer: Buffer;
  86246. private _kind;
  86247. private _size;
  86248. private _ownsBuffer;
  86249. private _instanced;
  86250. private _instanceDivisor;
  86251. /**
  86252. * The byte type.
  86253. */
  86254. static readonly BYTE: number;
  86255. /**
  86256. * The unsigned byte type.
  86257. */
  86258. static readonly UNSIGNED_BYTE: number;
  86259. /**
  86260. * The short type.
  86261. */
  86262. static readonly SHORT: number;
  86263. /**
  86264. * The unsigned short type.
  86265. */
  86266. static readonly UNSIGNED_SHORT: number;
  86267. /**
  86268. * The integer type.
  86269. */
  86270. static readonly INT: number;
  86271. /**
  86272. * The unsigned integer type.
  86273. */
  86274. static readonly UNSIGNED_INT: number;
  86275. /**
  86276. * The float type.
  86277. */
  86278. static readonly FLOAT: number;
  86279. /**
  86280. * Gets or sets the instance divisor when in instanced mode
  86281. */
  86282. get instanceDivisor(): number;
  86283. set instanceDivisor(value: number);
  86284. /**
  86285. * Gets the byte stride.
  86286. */
  86287. readonly byteStride: number;
  86288. /**
  86289. * Gets the byte offset.
  86290. */
  86291. readonly byteOffset: number;
  86292. /**
  86293. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86294. */
  86295. readonly normalized: boolean;
  86296. /**
  86297. * Gets the data type of each component in the array.
  86298. */
  86299. readonly type: number;
  86300. /**
  86301. * Constructor
  86302. * @param engine the engine
  86303. * @param data the data to use for this vertex buffer
  86304. * @param kind the vertex buffer kind
  86305. * @param updatable whether the data is updatable
  86306. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86307. * @param stride the stride (optional)
  86308. * @param instanced whether the buffer is instanced (optional)
  86309. * @param offset the offset of the data (optional)
  86310. * @param size the number of components (optional)
  86311. * @param type the type of the component (optional)
  86312. * @param normalized whether the data contains normalized data (optional)
  86313. * @param useBytes set to true if stride and offset are in bytes (optional)
  86314. * @param divisor defines the instance divisor to use (1 by default)
  86315. */
  86316. 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);
  86317. /** @hidden */
  86318. _rebuild(): void;
  86319. /**
  86320. * Returns the kind of the VertexBuffer (string)
  86321. * @returns a string
  86322. */
  86323. getKind(): string;
  86324. /**
  86325. * Gets a boolean indicating if the VertexBuffer is updatable?
  86326. * @returns true if the buffer is updatable
  86327. */
  86328. isUpdatable(): boolean;
  86329. /**
  86330. * Gets current buffer's data
  86331. * @returns a DataArray or null
  86332. */
  86333. getData(): Nullable<DataArray>;
  86334. /**
  86335. * Gets underlying native buffer
  86336. * @returns underlying native buffer
  86337. */
  86338. getBuffer(): Nullable<DataBuffer>;
  86339. /**
  86340. * Gets the stride in float32 units (i.e. byte stride / 4).
  86341. * May not be an integer if the byte stride is not divisible by 4.
  86342. * @returns the stride in float32 units
  86343. * @deprecated Please use byteStride instead.
  86344. */
  86345. getStrideSize(): number;
  86346. /**
  86347. * Returns the offset as a multiple of the type byte length.
  86348. * @returns the offset in bytes
  86349. * @deprecated Please use byteOffset instead.
  86350. */
  86351. getOffset(): number;
  86352. /**
  86353. * Returns the number of components per vertex attribute (integer)
  86354. * @returns the size in float
  86355. */
  86356. getSize(): number;
  86357. /**
  86358. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86359. * @returns true if this buffer is instanced
  86360. */
  86361. getIsInstanced(): boolean;
  86362. /**
  86363. * Returns the instancing divisor, zero for non-instanced (integer).
  86364. * @returns a number
  86365. */
  86366. getInstanceDivisor(): number;
  86367. /**
  86368. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86369. * @param data defines the data to store
  86370. */
  86371. create(data?: DataArray): void;
  86372. /**
  86373. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86374. * This function will create a new buffer if the current one is not updatable
  86375. * @param data defines the data to store
  86376. */
  86377. update(data: DataArray): void;
  86378. /**
  86379. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86380. * Returns the directly updated WebGLBuffer.
  86381. * @param data the new data
  86382. * @param offset the new offset
  86383. * @param useBytes set to true if the offset is in bytes
  86384. */
  86385. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86386. /**
  86387. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86388. */
  86389. dispose(): void;
  86390. /**
  86391. * Enumerates each value of this vertex buffer as numbers.
  86392. * @param count the number of values to enumerate
  86393. * @param callback the callback function called for each value
  86394. */
  86395. forEach(count: number, callback: (value: number, index: number) => void): void;
  86396. /**
  86397. * Positions
  86398. */
  86399. static readonly PositionKind: string;
  86400. /**
  86401. * Normals
  86402. */
  86403. static readonly NormalKind: string;
  86404. /**
  86405. * Tangents
  86406. */
  86407. static readonly TangentKind: string;
  86408. /**
  86409. * Texture coordinates
  86410. */
  86411. static readonly UVKind: string;
  86412. /**
  86413. * Texture coordinates 2
  86414. */
  86415. static readonly UV2Kind: string;
  86416. /**
  86417. * Texture coordinates 3
  86418. */
  86419. static readonly UV3Kind: string;
  86420. /**
  86421. * Texture coordinates 4
  86422. */
  86423. static readonly UV4Kind: string;
  86424. /**
  86425. * Texture coordinates 5
  86426. */
  86427. static readonly UV5Kind: string;
  86428. /**
  86429. * Texture coordinates 6
  86430. */
  86431. static readonly UV6Kind: string;
  86432. /**
  86433. * Colors
  86434. */
  86435. static readonly ColorKind: string;
  86436. /**
  86437. * Matrix indices (for bones)
  86438. */
  86439. static readonly MatricesIndicesKind: string;
  86440. /**
  86441. * Matrix weights (for bones)
  86442. */
  86443. static readonly MatricesWeightsKind: string;
  86444. /**
  86445. * Additional matrix indices (for bones)
  86446. */
  86447. static readonly MatricesIndicesExtraKind: string;
  86448. /**
  86449. * Additional matrix weights (for bones)
  86450. */
  86451. static readonly MatricesWeightsExtraKind: string;
  86452. /**
  86453. * Deduces the stride given a kind.
  86454. * @param kind The kind string to deduce
  86455. * @returns The deduced stride
  86456. */
  86457. static DeduceStride(kind: string): number;
  86458. /**
  86459. * Gets the byte length of the given type.
  86460. * @param type the type
  86461. * @returns the number of bytes
  86462. */
  86463. static GetTypeByteLength(type: number): number;
  86464. /**
  86465. * Enumerates each value of the given parameters as numbers.
  86466. * @param data the data to enumerate
  86467. * @param byteOffset the byte offset of the data
  86468. * @param byteStride the byte stride of the data
  86469. * @param componentCount the number of components per element
  86470. * @param componentType the type of the component
  86471. * @param count the number of values to enumerate
  86472. * @param normalized whether the data is normalized
  86473. * @param callback the callback function called for each value
  86474. */
  86475. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86476. private static _GetFloatValue;
  86477. }
  86478. }
  86479. declare module BABYLON {
  86480. /**
  86481. * @hidden
  86482. */
  86483. export class IntersectionInfo {
  86484. bu: Nullable<number>;
  86485. bv: Nullable<number>;
  86486. distance: number;
  86487. faceId: number;
  86488. subMeshId: number;
  86489. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86490. }
  86491. }
  86492. declare module BABYLON {
  86493. /**
  86494. * Class used to store bounding sphere information
  86495. */
  86496. export class BoundingSphere {
  86497. /**
  86498. * Gets the center of the bounding sphere in local space
  86499. */
  86500. readonly center: Vector3;
  86501. /**
  86502. * Radius of the bounding sphere in local space
  86503. */
  86504. radius: number;
  86505. /**
  86506. * Gets the center of the bounding sphere in world space
  86507. */
  86508. readonly centerWorld: Vector3;
  86509. /**
  86510. * Radius of the bounding sphere in world space
  86511. */
  86512. radiusWorld: number;
  86513. /**
  86514. * Gets the minimum vector in local space
  86515. */
  86516. readonly minimum: Vector3;
  86517. /**
  86518. * Gets the maximum vector in local space
  86519. */
  86520. readonly maximum: Vector3;
  86521. private _worldMatrix;
  86522. private static readonly TmpVector3;
  86523. /**
  86524. * Creates a new bounding sphere
  86525. * @param min defines the minimum vector (in local space)
  86526. * @param max defines the maximum vector (in local space)
  86527. * @param worldMatrix defines the new world matrix
  86528. */
  86529. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86530. /**
  86531. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86532. * @param min defines the new minimum vector (in local space)
  86533. * @param max defines the new maximum vector (in local space)
  86534. * @param worldMatrix defines the new world matrix
  86535. */
  86536. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86537. /**
  86538. * Scale the current bounding sphere by applying a scale factor
  86539. * @param factor defines the scale factor to apply
  86540. * @returns the current bounding box
  86541. */
  86542. scale(factor: number): BoundingSphere;
  86543. /**
  86544. * Gets the world matrix of the bounding box
  86545. * @returns a matrix
  86546. */
  86547. getWorldMatrix(): DeepImmutable<Matrix>;
  86548. /** @hidden */
  86549. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86550. /**
  86551. * Tests if the bounding sphere is intersecting the frustum planes
  86552. * @param frustumPlanes defines the frustum planes to test
  86553. * @returns true if there is an intersection
  86554. */
  86555. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86556. /**
  86557. * Tests if the bounding sphere center is in between the frustum planes.
  86558. * Used for optimistic fast inclusion.
  86559. * @param frustumPlanes defines the frustum planes to test
  86560. * @returns true if the sphere center is in between the frustum planes
  86561. */
  86562. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86563. /**
  86564. * Tests if a point is inside the bounding sphere
  86565. * @param point defines the point to test
  86566. * @returns true if the point is inside the bounding sphere
  86567. */
  86568. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86569. /**
  86570. * Checks if two sphere intersct
  86571. * @param sphere0 sphere 0
  86572. * @param sphere1 sphere 1
  86573. * @returns true if the speres intersect
  86574. */
  86575. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86576. }
  86577. }
  86578. declare module BABYLON {
  86579. /**
  86580. * Class used to store bounding box information
  86581. */
  86582. export class BoundingBox implements ICullable {
  86583. /**
  86584. * Gets the 8 vectors representing the bounding box in local space
  86585. */
  86586. readonly vectors: Vector3[];
  86587. /**
  86588. * Gets the center of the bounding box in local space
  86589. */
  86590. readonly center: Vector3;
  86591. /**
  86592. * Gets the center of the bounding box in world space
  86593. */
  86594. readonly centerWorld: Vector3;
  86595. /**
  86596. * Gets the extend size in local space
  86597. */
  86598. readonly extendSize: Vector3;
  86599. /**
  86600. * Gets the extend size in world space
  86601. */
  86602. readonly extendSizeWorld: Vector3;
  86603. /**
  86604. * Gets the OBB (object bounding box) directions
  86605. */
  86606. readonly directions: Vector3[];
  86607. /**
  86608. * Gets the 8 vectors representing the bounding box in world space
  86609. */
  86610. readonly vectorsWorld: Vector3[];
  86611. /**
  86612. * Gets the minimum vector in world space
  86613. */
  86614. readonly minimumWorld: Vector3;
  86615. /**
  86616. * Gets the maximum vector in world space
  86617. */
  86618. readonly maximumWorld: Vector3;
  86619. /**
  86620. * Gets the minimum vector in local space
  86621. */
  86622. readonly minimum: Vector3;
  86623. /**
  86624. * Gets the maximum vector in local space
  86625. */
  86626. readonly maximum: Vector3;
  86627. private _worldMatrix;
  86628. private static readonly TmpVector3;
  86629. /**
  86630. * @hidden
  86631. */
  86632. _tag: number;
  86633. /**
  86634. * Creates a new bounding box
  86635. * @param min defines the minimum vector (in local space)
  86636. * @param max defines the maximum vector (in local space)
  86637. * @param worldMatrix defines the new world matrix
  86638. */
  86639. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86640. /**
  86641. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86642. * @param min defines the new minimum vector (in local space)
  86643. * @param max defines the new maximum vector (in local space)
  86644. * @param worldMatrix defines the new world matrix
  86645. */
  86646. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86647. /**
  86648. * Scale the current bounding box by applying a scale factor
  86649. * @param factor defines the scale factor to apply
  86650. * @returns the current bounding box
  86651. */
  86652. scale(factor: number): BoundingBox;
  86653. /**
  86654. * Gets the world matrix of the bounding box
  86655. * @returns a matrix
  86656. */
  86657. getWorldMatrix(): DeepImmutable<Matrix>;
  86658. /** @hidden */
  86659. _update(world: DeepImmutable<Matrix>): void;
  86660. /**
  86661. * Tests if the bounding box is intersecting the frustum planes
  86662. * @param frustumPlanes defines the frustum planes to test
  86663. * @returns true if there is an intersection
  86664. */
  86665. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86666. /**
  86667. * Tests if the bounding box is entirely inside the frustum planes
  86668. * @param frustumPlanes defines the frustum planes to test
  86669. * @returns true if there is an inclusion
  86670. */
  86671. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86672. /**
  86673. * Tests if a point is inside the bounding box
  86674. * @param point defines the point to test
  86675. * @returns true if the point is inside the bounding box
  86676. */
  86677. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86678. /**
  86679. * Tests if the bounding box intersects with a bounding sphere
  86680. * @param sphere defines the sphere to test
  86681. * @returns true if there is an intersection
  86682. */
  86683. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86684. /**
  86685. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86686. * @param min defines the min vector to use
  86687. * @param max defines the max vector to use
  86688. * @returns true if there is an intersection
  86689. */
  86690. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86691. /**
  86692. * Tests if two bounding boxes are intersections
  86693. * @param box0 defines the first box to test
  86694. * @param box1 defines the second box to test
  86695. * @returns true if there is an intersection
  86696. */
  86697. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86698. /**
  86699. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86700. * @param minPoint defines the minimum vector of the bounding box
  86701. * @param maxPoint defines the maximum vector of the bounding box
  86702. * @param sphereCenter defines the sphere center
  86703. * @param sphereRadius defines the sphere radius
  86704. * @returns true if there is an intersection
  86705. */
  86706. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86707. /**
  86708. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86709. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86710. * @param frustumPlanes defines the frustum planes to test
  86711. * @return true if there is an inclusion
  86712. */
  86713. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86714. /**
  86715. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86716. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86717. * @param frustumPlanes defines the frustum planes to test
  86718. * @return true if there is an intersection
  86719. */
  86720. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86721. }
  86722. }
  86723. declare module BABYLON {
  86724. /** @hidden */
  86725. export class Collider {
  86726. /** Define if a collision was found */
  86727. collisionFound: boolean;
  86728. /**
  86729. * Define last intersection point in local space
  86730. */
  86731. intersectionPoint: Vector3;
  86732. /**
  86733. * Define last collided mesh
  86734. */
  86735. collidedMesh: Nullable<AbstractMesh>;
  86736. private _collisionPoint;
  86737. private _planeIntersectionPoint;
  86738. private _tempVector;
  86739. private _tempVector2;
  86740. private _tempVector3;
  86741. private _tempVector4;
  86742. private _edge;
  86743. private _baseToVertex;
  86744. private _destinationPoint;
  86745. private _slidePlaneNormal;
  86746. private _displacementVector;
  86747. /** @hidden */
  86748. _radius: Vector3;
  86749. /** @hidden */
  86750. _retry: number;
  86751. private _velocity;
  86752. private _basePoint;
  86753. private _epsilon;
  86754. /** @hidden */
  86755. _velocityWorldLength: number;
  86756. /** @hidden */
  86757. _basePointWorld: Vector3;
  86758. private _velocityWorld;
  86759. private _normalizedVelocity;
  86760. /** @hidden */
  86761. _initialVelocity: Vector3;
  86762. /** @hidden */
  86763. _initialPosition: Vector3;
  86764. private _nearestDistance;
  86765. private _collisionMask;
  86766. get collisionMask(): number;
  86767. set collisionMask(mask: number);
  86768. /**
  86769. * Gets the plane normal used to compute the sliding response (in local space)
  86770. */
  86771. get slidePlaneNormal(): Vector3;
  86772. /** @hidden */
  86773. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86774. /** @hidden */
  86775. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86776. /** @hidden */
  86777. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86778. /** @hidden */
  86779. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86780. /** @hidden */
  86781. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86782. /** @hidden */
  86783. _getResponse(pos: Vector3, vel: Vector3): void;
  86784. }
  86785. }
  86786. declare module BABYLON {
  86787. /**
  86788. * Interface for cullable objects
  86789. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86790. */
  86791. export interface ICullable {
  86792. /**
  86793. * Checks if the object or part of the object is in the frustum
  86794. * @param frustumPlanes Camera near/planes
  86795. * @returns true if the object is in frustum otherwise false
  86796. */
  86797. isInFrustum(frustumPlanes: Plane[]): boolean;
  86798. /**
  86799. * Checks if a cullable object (mesh...) is in the camera frustum
  86800. * Unlike isInFrustum this cheks the full bounding box
  86801. * @param frustumPlanes Camera near/planes
  86802. * @returns true if the object is in frustum otherwise false
  86803. */
  86804. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86805. }
  86806. /**
  86807. * Info for a bounding data of a mesh
  86808. */
  86809. export class BoundingInfo implements ICullable {
  86810. /**
  86811. * Bounding box for the mesh
  86812. */
  86813. readonly boundingBox: BoundingBox;
  86814. /**
  86815. * Bounding sphere for the mesh
  86816. */
  86817. readonly boundingSphere: BoundingSphere;
  86818. private _isLocked;
  86819. private static readonly TmpVector3;
  86820. /**
  86821. * Constructs bounding info
  86822. * @param minimum min vector of the bounding box/sphere
  86823. * @param maximum max vector of the bounding box/sphere
  86824. * @param worldMatrix defines the new world matrix
  86825. */
  86826. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86827. /**
  86828. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86829. * @param min defines the new minimum vector (in local space)
  86830. * @param max defines the new maximum vector (in local space)
  86831. * @param worldMatrix defines the new world matrix
  86832. */
  86833. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86834. /**
  86835. * min vector of the bounding box/sphere
  86836. */
  86837. get minimum(): Vector3;
  86838. /**
  86839. * max vector of the bounding box/sphere
  86840. */
  86841. get maximum(): Vector3;
  86842. /**
  86843. * If the info is locked and won't be updated to avoid perf overhead
  86844. */
  86845. get isLocked(): boolean;
  86846. set isLocked(value: boolean);
  86847. /**
  86848. * Updates the bounding sphere and box
  86849. * @param world world matrix to be used to update
  86850. */
  86851. update(world: DeepImmutable<Matrix>): void;
  86852. /**
  86853. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86854. * @param center New center of the bounding info
  86855. * @param extend New extend of the bounding info
  86856. * @returns the current bounding info
  86857. */
  86858. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86859. /**
  86860. * Scale the current bounding info by applying a scale factor
  86861. * @param factor defines the scale factor to apply
  86862. * @returns the current bounding info
  86863. */
  86864. scale(factor: number): BoundingInfo;
  86865. /**
  86866. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86867. * @param frustumPlanes defines the frustum to test
  86868. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86869. * @returns true if the bounding info is in the frustum planes
  86870. */
  86871. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86872. /**
  86873. * Gets the world distance between the min and max points of the bounding box
  86874. */
  86875. get diagonalLength(): number;
  86876. /**
  86877. * Checks if a cullable object (mesh...) is in the camera frustum
  86878. * Unlike isInFrustum this cheks the full bounding box
  86879. * @param frustumPlanes Camera near/planes
  86880. * @returns true if the object is in frustum otherwise false
  86881. */
  86882. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86883. /** @hidden */
  86884. _checkCollision(collider: Collider): boolean;
  86885. /**
  86886. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86887. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86888. * @param point the point to check intersection with
  86889. * @returns if the point intersects
  86890. */
  86891. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86892. /**
  86893. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86894. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86895. * @param boundingInfo the bounding info to check intersection with
  86896. * @param precise if the intersection should be done using OBB
  86897. * @returns if the bounding info intersects
  86898. */
  86899. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86900. }
  86901. }
  86902. declare module BABYLON {
  86903. /**
  86904. * Extracts minimum and maximum values from a list of indexed positions
  86905. * @param positions defines the positions to use
  86906. * @param indices defines the indices to the positions
  86907. * @param indexStart defines the start index
  86908. * @param indexCount defines the end index
  86909. * @param bias defines bias value to add to the result
  86910. * @return minimum and maximum values
  86911. */
  86912. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86913. minimum: Vector3;
  86914. maximum: Vector3;
  86915. };
  86916. /**
  86917. * Extracts minimum and maximum values from a list of positions
  86918. * @param positions defines the positions to use
  86919. * @param start defines the start index in the positions array
  86920. * @param count defines the number of positions to handle
  86921. * @param bias defines bias value to add to the result
  86922. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86923. * @return minimum and maximum values
  86924. */
  86925. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86926. minimum: Vector3;
  86927. maximum: Vector3;
  86928. };
  86929. }
  86930. declare module BABYLON {
  86931. /** @hidden */
  86932. export class WebGLDataBuffer extends DataBuffer {
  86933. private _buffer;
  86934. constructor(resource: WebGLBuffer);
  86935. get underlyingResource(): any;
  86936. }
  86937. }
  86938. declare module BABYLON {
  86939. /** @hidden */
  86940. export class WebGLPipelineContext implements IPipelineContext {
  86941. engine: ThinEngine;
  86942. program: Nullable<WebGLProgram>;
  86943. context?: WebGLRenderingContext;
  86944. vertexShader?: WebGLShader;
  86945. fragmentShader?: WebGLShader;
  86946. isParallelCompiled: boolean;
  86947. onCompiled?: () => void;
  86948. transformFeedback?: WebGLTransformFeedback | null;
  86949. vertexCompilationError: Nullable<string>;
  86950. fragmentCompilationError: Nullable<string>;
  86951. programLinkError: Nullable<string>;
  86952. programValidationError: Nullable<string>;
  86953. get isAsync(): boolean;
  86954. get isReady(): boolean;
  86955. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86956. _getVertexShaderCode(): string | null;
  86957. _getFragmentShaderCode(): string | null;
  86958. }
  86959. }
  86960. declare module BABYLON {
  86961. interface ThinEngine {
  86962. /**
  86963. * Create an uniform buffer
  86964. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86965. * @param elements defines the content of the uniform buffer
  86966. * @returns the webGL uniform buffer
  86967. */
  86968. createUniformBuffer(elements: FloatArray): DataBuffer;
  86969. /**
  86970. * Create a dynamic uniform buffer
  86971. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86972. * @param elements defines the content of the uniform buffer
  86973. * @returns the webGL uniform buffer
  86974. */
  86975. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86976. /**
  86977. * Update an existing uniform buffer
  86978. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86979. * @param uniformBuffer defines the target uniform buffer
  86980. * @param elements defines the content to update
  86981. * @param offset defines the offset in the uniform buffer where update should start
  86982. * @param count defines the size of the data to update
  86983. */
  86984. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86985. /**
  86986. * Bind an uniform buffer to the current webGL context
  86987. * @param buffer defines the buffer to bind
  86988. */
  86989. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86990. /**
  86991. * Bind a buffer to the current webGL context at a given location
  86992. * @param buffer defines the buffer to bind
  86993. * @param location defines the index where to bind the buffer
  86994. */
  86995. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86996. /**
  86997. * Bind a specific block at a given index in a specific shader program
  86998. * @param pipelineContext defines the pipeline context to use
  86999. * @param blockName defines the block name
  87000. * @param index defines the index where to bind the block
  87001. */
  87002. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  87003. }
  87004. }
  87005. declare module BABYLON {
  87006. /**
  87007. * Uniform buffer objects.
  87008. *
  87009. * Handles blocks of uniform on the GPU.
  87010. *
  87011. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87012. *
  87013. * For more information, please refer to :
  87014. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87015. */
  87016. export class UniformBuffer {
  87017. private _engine;
  87018. private _buffer;
  87019. private _data;
  87020. private _bufferData;
  87021. private _dynamic?;
  87022. private _uniformLocations;
  87023. private _uniformSizes;
  87024. private _uniformLocationPointer;
  87025. private _needSync;
  87026. private _noUBO;
  87027. private _currentEffect;
  87028. /** @hidden */
  87029. _alreadyBound: boolean;
  87030. private static _MAX_UNIFORM_SIZE;
  87031. private static _tempBuffer;
  87032. /**
  87033. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87034. * This is dynamic to allow compat with webgl 1 and 2.
  87035. * You will need to pass the name of the uniform as well as the value.
  87036. */
  87037. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87038. /**
  87039. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87040. * This is dynamic to allow compat with webgl 1 and 2.
  87041. * You will need to pass the name of the uniform as well as the value.
  87042. */
  87043. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87044. /**
  87045. * Lambda to Update a single float in a uniform buffer.
  87046. * This is dynamic to allow compat with webgl 1 and 2.
  87047. * You will need to pass the name of the uniform as well as the value.
  87048. */
  87049. updateFloat: (name: string, x: number) => void;
  87050. /**
  87051. * Lambda to Update a vec2 of float in a uniform buffer.
  87052. * This is dynamic to allow compat with webgl 1 and 2.
  87053. * You will need to pass the name of the uniform as well as the value.
  87054. */
  87055. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87056. /**
  87057. * Lambda to Update a vec3 of float in a uniform buffer.
  87058. * This is dynamic to allow compat with webgl 1 and 2.
  87059. * You will need to pass the name of the uniform as well as the value.
  87060. */
  87061. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87062. /**
  87063. * Lambda to Update a vec4 of float in a uniform buffer.
  87064. * This is dynamic to allow compat with webgl 1 and 2.
  87065. * You will need to pass the name of the uniform as well as the value.
  87066. */
  87067. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87068. /**
  87069. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87070. * This is dynamic to allow compat with webgl 1 and 2.
  87071. * You will need to pass the name of the uniform as well as the value.
  87072. */
  87073. updateMatrix: (name: string, mat: Matrix) => void;
  87074. /**
  87075. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87076. * This is dynamic to allow compat with webgl 1 and 2.
  87077. * You will need to pass the name of the uniform as well as the value.
  87078. */
  87079. updateVector3: (name: string, vector: Vector3) => void;
  87080. /**
  87081. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87082. * This is dynamic to allow compat with webgl 1 and 2.
  87083. * You will need to pass the name of the uniform as well as the value.
  87084. */
  87085. updateVector4: (name: string, vector: Vector4) => void;
  87086. /**
  87087. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87088. * This is dynamic to allow compat with webgl 1 and 2.
  87089. * You will need to pass the name of the uniform as well as the value.
  87090. */
  87091. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87092. /**
  87093. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87094. * This is dynamic to allow compat with webgl 1 and 2.
  87095. * You will need to pass the name of the uniform as well as the value.
  87096. */
  87097. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87098. /**
  87099. * Instantiates a new Uniform buffer objects.
  87100. *
  87101. * Handles blocks of uniform on the GPU.
  87102. *
  87103. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87104. *
  87105. * For more information, please refer to :
  87106. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87107. * @param engine Define the engine the buffer is associated with
  87108. * @param data Define the data contained in the buffer
  87109. * @param dynamic Define if the buffer is updatable
  87110. */
  87111. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87112. /**
  87113. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87114. * or just falling back on setUniformXXX calls.
  87115. */
  87116. get useUbo(): boolean;
  87117. /**
  87118. * Indicates if the WebGL underlying uniform buffer is in sync
  87119. * with the javascript cache data.
  87120. */
  87121. get isSync(): boolean;
  87122. /**
  87123. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87124. * Also, a dynamic UniformBuffer will disable cache verification and always
  87125. * update the underlying WebGL uniform buffer to the GPU.
  87126. * @returns if Dynamic, otherwise false
  87127. */
  87128. isDynamic(): boolean;
  87129. /**
  87130. * The data cache on JS side.
  87131. * @returns the underlying data as a float array
  87132. */
  87133. getData(): Float32Array;
  87134. /**
  87135. * The underlying WebGL Uniform buffer.
  87136. * @returns the webgl buffer
  87137. */
  87138. getBuffer(): Nullable<DataBuffer>;
  87139. /**
  87140. * std140 layout specifies how to align data within an UBO structure.
  87141. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87142. * for specs.
  87143. */
  87144. private _fillAlignment;
  87145. /**
  87146. * Adds an uniform in the buffer.
  87147. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87148. * for the layout to be correct !
  87149. * @param name Name of the uniform, as used in the uniform block in the shader.
  87150. * @param size Data size, or data directly.
  87151. */
  87152. addUniform(name: string, size: number | number[]): void;
  87153. /**
  87154. * Adds a Matrix 4x4 to the uniform buffer.
  87155. * @param name Name of the uniform, as used in the uniform block in the shader.
  87156. * @param mat A 4x4 matrix.
  87157. */
  87158. addMatrix(name: string, mat: Matrix): void;
  87159. /**
  87160. * Adds a vec2 to the uniform buffer.
  87161. * @param name Name of the uniform, as used in the uniform block in the shader.
  87162. * @param x Define the x component value of the vec2
  87163. * @param y Define the y component value of the vec2
  87164. */
  87165. addFloat2(name: string, x: number, y: number): void;
  87166. /**
  87167. * Adds a vec3 to the uniform buffer.
  87168. * @param name Name of the uniform, as used in the uniform block in the shader.
  87169. * @param x Define the x component value of the vec3
  87170. * @param y Define the y component value of the vec3
  87171. * @param z Define the z component value of the vec3
  87172. */
  87173. addFloat3(name: string, x: number, y: number, z: number): void;
  87174. /**
  87175. * Adds a vec3 to the uniform buffer.
  87176. * @param name Name of the uniform, as used in the uniform block in the shader.
  87177. * @param color Define the vec3 from a Color
  87178. */
  87179. addColor3(name: string, color: Color3): void;
  87180. /**
  87181. * Adds a vec4 to the uniform buffer.
  87182. * @param name Name of the uniform, as used in the uniform block in the shader.
  87183. * @param color Define the rgb components from a Color
  87184. * @param alpha Define the a component of the vec4
  87185. */
  87186. addColor4(name: string, color: Color3, alpha: number): void;
  87187. /**
  87188. * Adds a vec3 to the uniform buffer.
  87189. * @param name Name of the uniform, as used in the uniform block in the shader.
  87190. * @param vector Define the vec3 components from a Vector
  87191. */
  87192. addVector3(name: string, vector: Vector3): void;
  87193. /**
  87194. * Adds a Matrix 3x3 to the uniform buffer.
  87195. * @param name Name of the uniform, as used in the uniform block in the shader.
  87196. */
  87197. addMatrix3x3(name: string): void;
  87198. /**
  87199. * Adds a Matrix 2x2 to the uniform buffer.
  87200. * @param name Name of the uniform, as used in the uniform block in the shader.
  87201. */
  87202. addMatrix2x2(name: string): void;
  87203. /**
  87204. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87205. */
  87206. create(): void;
  87207. /** @hidden */
  87208. _rebuild(): void;
  87209. /**
  87210. * Updates the WebGL Uniform Buffer on the GPU.
  87211. * If the `dynamic` flag is set to true, no cache comparison is done.
  87212. * Otherwise, the buffer will be updated only if the cache differs.
  87213. */
  87214. update(): void;
  87215. /**
  87216. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87217. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87218. * @param data Define the flattened data
  87219. * @param size Define the size of the data.
  87220. */
  87221. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87222. private _valueCache;
  87223. private _cacheMatrix;
  87224. private _updateMatrix3x3ForUniform;
  87225. private _updateMatrix3x3ForEffect;
  87226. private _updateMatrix2x2ForEffect;
  87227. private _updateMatrix2x2ForUniform;
  87228. private _updateFloatForEffect;
  87229. private _updateFloatForUniform;
  87230. private _updateFloat2ForEffect;
  87231. private _updateFloat2ForUniform;
  87232. private _updateFloat3ForEffect;
  87233. private _updateFloat3ForUniform;
  87234. private _updateFloat4ForEffect;
  87235. private _updateFloat4ForUniform;
  87236. private _updateMatrixForEffect;
  87237. private _updateMatrixForUniform;
  87238. private _updateVector3ForEffect;
  87239. private _updateVector3ForUniform;
  87240. private _updateVector4ForEffect;
  87241. private _updateVector4ForUniform;
  87242. private _updateColor3ForEffect;
  87243. private _updateColor3ForUniform;
  87244. private _updateColor4ForEffect;
  87245. private _updateColor4ForUniform;
  87246. /**
  87247. * Sets a sampler uniform on the effect.
  87248. * @param name Define the name of the sampler.
  87249. * @param texture Define the texture to set in the sampler
  87250. */
  87251. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87252. /**
  87253. * Directly updates the value of the uniform in the cache AND on the GPU.
  87254. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87255. * @param data Define the flattened data
  87256. */
  87257. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87258. /**
  87259. * Binds this uniform buffer to an effect.
  87260. * @param effect Define the effect to bind the buffer to
  87261. * @param name Name of the uniform block in the shader.
  87262. */
  87263. bindToEffect(effect: Effect, name: string): void;
  87264. /**
  87265. * Disposes the uniform buffer.
  87266. */
  87267. dispose(): void;
  87268. }
  87269. }
  87270. declare module BABYLON {
  87271. /**
  87272. * Enum that determines the text-wrapping mode to use.
  87273. */
  87274. export enum InspectableType {
  87275. /**
  87276. * Checkbox for booleans
  87277. */
  87278. Checkbox = 0,
  87279. /**
  87280. * Sliders for numbers
  87281. */
  87282. Slider = 1,
  87283. /**
  87284. * Vector3
  87285. */
  87286. Vector3 = 2,
  87287. /**
  87288. * Quaternions
  87289. */
  87290. Quaternion = 3,
  87291. /**
  87292. * Color3
  87293. */
  87294. Color3 = 4,
  87295. /**
  87296. * String
  87297. */
  87298. String = 5
  87299. }
  87300. /**
  87301. * Interface used to define custom inspectable properties.
  87302. * This interface is used by the inspector to display custom property grids
  87303. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87304. */
  87305. export interface IInspectable {
  87306. /**
  87307. * Gets the label to display
  87308. */
  87309. label: string;
  87310. /**
  87311. * Gets the name of the property to edit
  87312. */
  87313. propertyName: string;
  87314. /**
  87315. * Gets the type of the editor to use
  87316. */
  87317. type: InspectableType;
  87318. /**
  87319. * Gets the minimum value of the property when using in "slider" mode
  87320. */
  87321. min?: number;
  87322. /**
  87323. * Gets the maximum value of the property when using in "slider" mode
  87324. */
  87325. max?: number;
  87326. /**
  87327. * Gets the setp to use when using in "slider" mode
  87328. */
  87329. step?: number;
  87330. }
  87331. }
  87332. declare module BABYLON {
  87333. /**
  87334. * Class used to provide helper for timing
  87335. */
  87336. export class TimingTools {
  87337. /**
  87338. * Polyfill for setImmediate
  87339. * @param action defines the action to execute after the current execution block
  87340. */
  87341. static SetImmediate(action: () => void): void;
  87342. }
  87343. }
  87344. declare module BABYLON {
  87345. /**
  87346. * Class used to enable instatition of objects by class name
  87347. */
  87348. export class InstantiationTools {
  87349. /**
  87350. * Use this object to register external classes like custom textures or material
  87351. * to allow the laoders to instantiate them
  87352. */
  87353. static RegisteredExternalClasses: {
  87354. [key: string]: Object;
  87355. };
  87356. /**
  87357. * Tries to instantiate a new object from a given class name
  87358. * @param className defines the class name to instantiate
  87359. * @returns the new object or null if the system was not able to do the instantiation
  87360. */
  87361. static Instantiate(className: string): any;
  87362. }
  87363. }
  87364. declare module BABYLON {
  87365. /**
  87366. * Define options used to create a depth texture
  87367. */
  87368. export class DepthTextureCreationOptions {
  87369. /** Specifies whether or not a stencil should be allocated in the texture */
  87370. generateStencil?: boolean;
  87371. /** Specifies whether or not bilinear filtering is enable on the texture */
  87372. bilinearFiltering?: boolean;
  87373. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87374. comparisonFunction?: number;
  87375. /** Specifies if the created texture is a cube texture */
  87376. isCube?: boolean;
  87377. }
  87378. }
  87379. declare module BABYLON {
  87380. interface ThinEngine {
  87381. /**
  87382. * Creates a depth stencil cube texture.
  87383. * This is only available in WebGL 2.
  87384. * @param size The size of face edge in the cube texture.
  87385. * @param options The options defining the cube texture.
  87386. * @returns The cube texture
  87387. */
  87388. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87389. /**
  87390. * Creates a cube texture
  87391. * @param rootUrl defines the url where the files to load is located
  87392. * @param scene defines the current scene
  87393. * @param files defines the list of files to load (1 per face)
  87394. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87395. * @param onLoad defines an optional callback raised when the texture is loaded
  87396. * @param onError defines an optional callback raised if there is an issue to load the texture
  87397. * @param format defines the format of the data
  87398. * @param forcedExtension defines the extension to use to pick the right loader
  87399. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87400. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87401. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87402. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87403. * @returns the cube texture as an InternalTexture
  87404. */
  87405. 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;
  87406. /**
  87407. * Creates a cube texture
  87408. * @param rootUrl defines the url where the files to load is located
  87409. * @param scene defines the current scene
  87410. * @param files defines the list of files to load (1 per face)
  87411. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87412. * @param onLoad defines an optional callback raised when the texture is loaded
  87413. * @param onError defines an optional callback raised if there is an issue to load the texture
  87414. * @param format defines the format of the data
  87415. * @param forcedExtension defines the extension to use to pick the right loader
  87416. * @returns the cube texture as an InternalTexture
  87417. */
  87418. 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;
  87419. /**
  87420. * Creates a cube texture
  87421. * @param rootUrl defines the url where the files to load is located
  87422. * @param scene defines the current scene
  87423. * @param files defines the list of files to load (1 per face)
  87424. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87425. * @param onLoad defines an optional callback raised when the texture is loaded
  87426. * @param onError defines an optional callback raised if there is an issue to load the texture
  87427. * @param format defines the format of the data
  87428. * @param forcedExtension defines the extension to use to pick the right loader
  87429. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87430. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87431. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87432. * @returns the cube texture as an InternalTexture
  87433. */
  87434. 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;
  87435. /** @hidden */
  87436. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87437. /** @hidden */
  87438. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87439. /** @hidden */
  87440. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87441. /** @hidden */
  87442. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87443. /**
  87444. * @hidden
  87445. */
  87446. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87447. }
  87448. }
  87449. declare module BABYLON {
  87450. /**
  87451. * Class for creating a cube texture
  87452. */
  87453. export class CubeTexture extends BaseTexture {
  87454. private _delayedOnLoad;
  87455. /**
  87456. * Observable triggered once the texture has been loaded.
  87457. */
  87458. onLoadObservable: Observable<CubeTexture>;
  87459. /**
  87460. * The url of the texture
  87461. */
  87462. url: string;
  87463. /**
  87464. * Gets or sets the center of the bounding box associated with the cube texture.
  87465. * It must define where the camera used to render the texture was set
  87466. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87467. */
  87468. boundingBoxPosition: Vector3;
  87469. private _boundingBoxSize;
  87470. /**
  87471. * Gets or sets the size of the bounding box associated with the cube texture
  87472. * When defined, the cubemap will switch to local mode
  87473. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87474. * @example https://www.babylonjs-playground.com/#RNASML
  87475. */
  87476. set boundingBoxSize(value: Vector3);
  87477. /**
  87478. * Returns the bounding box size
  87479. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87480. */
  87481. get boundingBoxSize(): Vector3;
  87482. protected _rotationY: number;
  87483. /**
  87484. * Sets texture matrix rotation angle around Y axis in radians.
  87485. */
  87486. set rotationY(value: number);
  87487. /**
  87488. * Gets texture matrix rotation angle around Y axis radians.
  87489. */
  87490. get rotationY(): number;
  87491. /**
  87492. * Are mip maps generated for this texture or not.
  87493. */
  87494. get noMipmap(): boolean;
  87495. private _noMipmap;
  87496. private _files;
  87497. protected _forcedExtension: Nullable<string>;
  87498. private _extensions;
  87499. private _textureMatrix;
  87500. private _format;
  87501. private _createPolynomials;
  87502. /**
  87503. * Creates a cube texture from an array of image urls
  87504. * @param files defines an array of image urls
  87505. * @param scene defines the hosting scene
  87506. * @param noMipmap specifies if mip maps are not used
  87507. * @returns a cube texture
  87508. */
  87509. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87510. /**
  87511. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87512. * @param url defines the url of the prefiltered texture
  87513. * @param scene defines the scene the texture is attached to
  87514. * @param forcedExtension defines the extension of the file if different from the url
  87515. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87516. * @return the prefiltered texture
  87517. */
  87518. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87519. /**
  87520. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87521. * as prefiltered data.
  87522. * @param rootUrl defines the url of the texture or the root name of the six images
  87523. * @param null defines the scene or engine the texture is attached to
  87524. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87525. * @param noMipmap defines if mipmaps should be created or not
  87526. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87527. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87528. * @param onError defines a callback triggered in case of error during load
  87529. * @param format defines the internal format to use for the texture once loaded
  87530. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87531. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87532. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87533. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87534. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87535. * @return the cube texture
  87536. */
  87537. 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);
  87538. /**
  87539. * Get the current class name of the texture useful for serialization or dynamic coding.
  87540. * @returns "CubeTexture"
  87541. */
  87542. getClassName(): string;
  87543. /**
  87544. * Update the url (and optional buffer) of this texture if url was null during construction.
  87545. * @param url the url of the texture
  87546. * @param forcedExtension defines the extension to use
  87547. * @param onLoad callback called when the texture is loaded (defaults to null)
  87548. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87549. */
  87550. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87551. /**
  87552. * Delays loading of the cube texture
  87553. * @param forcedExtension defines the extension to use
  87554. */
  87555. delayLoad(forcedExtension?: string): void;
  87556. /**
  87557. * Returns the reflection texture matrix
  87558. * @returns the reflection texture matrix
  87559. */
  87560. getReflectionTextureMatrix(): Matrix;
  87561. /**
  87562. * Sets the reflection texture matrix
  87563. * @param value Reflection texture matrix
  87564. */
  87565. setReflectionTextureMatrix(value: Matrix): void;
  87566. /**
  87567. * Parses text to create a cube texture
  87568. * @param parsedTexture define the serialized text to read from
  87569. * @param scene defines the hosting scene
  87570. * @param rootUrl defines the root url of the cube texture
  87571. * @returns a cube texture
  87572. */
  87573. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87574. /**
  87575. * Makes a clone, or deep copy, of the cube texture
  87576. * @returns a new cube texture
  87577. */
  87578. clone(): CubeTexture;
  87579. }
  87580. }
  87581. declare module BABYLON {
  87582. /**
  87583. * Manages the defines for the Material
  87584. */
  87585. export class MaterialDefines {
  87586. /** @hidden */
  87587. protected _keys: string[];
  87588. private _isDirty;
  87589. /** @hidden */
  87590. _renderId: number;
  87591. /** @hidden */
  87592. _areLightsDirty: boolean;
  87593. /** @hidden */
  87594. _areLightsDisposed: boolean;
  87595. /** @hidden */
  87596. _areAttributesDirty: boolean;
  87597. /** @hidden */
  87598. _areTexturesDirty: boolean;
  87599. /** @hidden */
  87600. _areFresnelDirty: boolean;
  87601. /** @hidden */
  87602. _areMiscDirty: boolean;
  87603. /** @hidden */
  87604. _areImageProcessingDirty: boolean;
  87605. /** @hidden */
  87606. _normals: boolean;
  87607. /** @hidden */
  87608. _uvs: boolean;
  87609. /** @hidden */
  87610. _needNormals: boolean;
  87611. /** @hidden */
  87612. _needUVs: boolean;
  87613. [id: string]: any;
  87614. /**
  87615. * Specifies if the material needs to be re-calculated
  87616. */
  87617. get isDirty(): boolean;
  87618. /**
  87619. * Marks the material to indicate that it has been re-calculated
  87620. */
  87621. markAsProcessed(): void;
  87622. /**
  87623. * Marks the material to indicate that it needs to be re-calculated
  87624. */
  87625. markAsUnprocessed(): void;
  87626. /**
  87627. * Marks the material to indicate all of its defines need to be re-calculated
  87628. */
  87629. markAllAsDirty(): void;
  87630. /**
  87631. * Marks the material to indicate that image processing needs to be re-calculated
  87632. */
  87633. markAsImageProcessingDirty(): void;
  87634. /**
  87635. * Marks the material to indicate the lights need to be re-calculated
  87636. * @param disposed Defines whether the light is dirty due to dispose or not
  87637. */
  87638. markAsLightDirty(disposed?: boolean): void;
  87639. /**
  87640. * Marks the attribute state as changed
  87641. */
  87642. markAsAttributesDirty(): void;
  87643. /**
  87644. * Marks the texture state as changed
  87645. */
  87646. markAsTexturesDirty(): void;
  87647. /**
  87648. * Marks the fresnel state as changed
  87649. */
  87650. markAsFresnelDirty(): void;
  87651. /**
  87652. * Marks the misc state as changed
  87653. */
  87654. markAsMiscDirty(): void;
  87655. /**
  87656. * Rebuilds the material defines
  87657. */
  87658. rebuild(): void;
  87659. /**
  87660. * Specifies if two material defines are equal
  87661. * @param other - A material define instance to compare to
  87662. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87663. */
  87664. isEqual(other: MaterialDefines): boolean;
  87665. /**
  87666. * Clones this instance's defines to another instance
  87667. * @param other - material defines to clone values to
  87668. */
  87669. cloneTo(other: MaterialDefines): void;
  87670. /**
  87671. * Resets the material define values
  87672. */
  87673. reset(): void;
  87674. /**
  87675. * Converts the material define values to a string
  87676. * @returns - String of material define information
  87677. */
  87678. toString(): string;
  87679. }
  87680. }
  87681. declare module BABYLON {
  87682. /**
  87683. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87684. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87685. * 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;
  87686. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87687. */
  87688. export class ColorCurves {
  87689. private _dirty;
  87690. private _tempColor;
  87691. private _globalCurve;
  87692. private _highlightsCurve;
  87693. private _midtonesCurve;
  87694. private _shadowsCurve;
  87695. private _positiveCurve;
  87696. private _negativeCurve;
  87697. private _globalHue;
  87698. private _globalDensity;
  87699. private _globalSaturation;
  87700. private _globalExposure;
  87701. /**
  87702. * Gets the global Hue value.
  87703. * 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).
  87704. */
  87705. get globalHue(): number;
  87706. /**
  87707. * Sets the global Hue value.
  87708. * 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).
  87709. */
  87710. set globalHue(value: number);
  87711. /**
  87712. * Gets the global Density value.
  87713. * 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.
  87714. * Values less than zero provide a filter of opposite hue.
  87715. */
  87716. get globalDensity(): number;
  87717. /**
  87718. * Sets the global Density value.
  87719. * 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.
  87720. * Values less than zero provide a filter of opposite hue.
  87721. */
  87722. set globalDensity(value: number);
  87723. /**
  87724. * Gets the global Saturation value.
  87725. * 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.
  87726. */
  87727. get globalSaturation(): number;
  87728. /**
  87729. * Sets the global Saturation value.
  87730. * 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.
  87731. */
  87732. set globalSaturation(value: number);
  87733. /**
  87734. * Gets the global Exposure value.
  87735. * 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.
  87736. */
  87737. get globalExposure(): number;
  87738. /**
  87739. * Sets the global Exposure value.
  87740. * 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.
  87741. */
  87742. set globalExposure(value: number);
  87743. private _highlightsHue;
  87744. private _highlightsDensity;
  87745. private _highlightsSaturation;
  87746. private _highlightsExposure;
  87747. /**
  87748. * Gets the highlights Hue value.
  87749. * 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).
  87750. */
  87751. get highlightsHue(): number;
  87752. /**
  87753. * Sets the highlights Hue value.
  87754. * 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).
  87755. */
  87756. set highlightsHue(value: number);
  87757. /**
  87758. * Gets the highlights Density value.
  87759. * 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.
  87760. * Values less than zero provide a filter of opposite hue.
  87761. */
  87762. get highlightsDensity(): number;
  87763. /**
  87764. * Sets the highlights Density value.
  87765. * 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.
  87766. * Values less than zero provide a filter of opposite hue.
  87767. */
  87768. set highlightsDensity(value: number);
  87769. /**
  87770. * Gets the highlights Saturation value.
  87771. * 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.
  87772. */
  87773. get highlightsSaturation(): number;
  87774. /**
  87775. * Sets the highlights Saturation value.
  87776. * 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.
  87777. */
  87778. set highlightsSaturation(value: number);
  87779. /**
  87780. * Gets the highlights Exposure value.
  87781. * 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.
  87782. */
  87783. get highlightsExposure(): number;
  87784. /**
  87785. * Sets the highlights Exposure value.
  87786. * 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.
  87787. */
  87788. set highlightsExposure(value: number);
  87789. private _midtonesHue;
  87790. private _midtonesDensity;
  87791. private _midtonesSaturation;
  87792. private _midtonesExposure;
  87793. /**
  87794. * Gets the midtones Hue value.
  87795. * 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).
  87796. */
  87797. get midtonesHue(): number;
  87798. /**
  87799. * Sets the midtones Hue value.
  87800. * 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).
  87801. */
  87802. set midtonesHue(value: number);
  87803. /**
  87804. * Gets the midtones Density value.
  87805. * 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.
  87806. * Values less than zero provide a filter of opposite hue.
  87807. */
  87808. get midtonesDensity(): number;
  87809. /**
  87810. * Sets the midtones Density value.
  87811. * 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.
  87812. * Values less than zero provide a filter of opposite hue.
  87813. */
  87814. set midtonesDensity(value: number);
  87815. /**
  87816. * Gets the midtones Saturation value.
  87817. * 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.
  87818. */
  87819. get midtonesSaturation(): number;
  87820. /**
  87821. * Sets the midtones Saturation value.
  87822. * 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.
  87823. */
  87824. set midtonesSaturation(value: number);
  87825. /**
  87826. * Gets the midtones Exposure value.
  87827. * 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.
  87828. */
  87829. get midtonesExposure(): number;
  87830. /**
  87831. * Sets the midtones Exposure value.
  87832. * 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.
  87833. */
  87834. set midtonesExposure(value: number);
  87835. private _shadowsHue;
  87836. private _shadowsDensity;
  87837. private _shadowsSaturation;
  87838. private _shadowsExposure;
  87839. /**
  87840. * Gets the shadows Hue value.
  87841. * 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).
  87842. */
  87843. get shadowsHue(): number;
  87844. /**
  87845. * Sets the shadows Hue value.
  87846. * 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).
  87847. */
  87848. set shadowsHue(value: number);
  87849. /**
  87850. * Gets the shadows Density value.
  87851. * 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.
  87852. * Values less than zero provide a filter of opposite hue.
  87853. */
  87854. get shadowsDensity(): number;
  87855. /**
  87856. * Sets the shadows Density value.
  87857. * 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.
  87858. * Values less than zero provide a filter of opposite hue.
  87859. */
  87860. set shadowsDensity(value: number);
  87861. /**
  87862. * Gets the shadows Saturation value.
  87863. * 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.
  87864. */
  87865. get shadowsSaturation(): number;
  87866. /**
  87867. * Sets the shadows Saturation value.
  87868. * 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.
  87869. */
  87870. set shadowsSaturation(value: number);
  87871. /**
  87872. * Gets the shadows Exposure value.
  87873. * 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.
  87874. */
  87875. get shadowsExposure(): number;
  87876. /**
  87877. * Sets the shadows Exposure value.
  87878. * 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.
  87879. */
  87880. set shadowsExposure(value: number);
  87881. /**
  87882. * Returns the class name
  87883. * @returns The class name
  87884. */
  87885. getClassName(): string;
  87886. /**
  87887. * Binds the color curves to the shader.
  87888. * @param colorCurves The color curve to bind
  87889. * @param effect The effect to bind to
  87890. * @param positiveUniform The positive uniform shader parameter
  87891. * @param neutralUniform The neutral uniform shader parameter
  87892. * @param negativeUniform The negative uniform shader parameter
  87893. */
  87894. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87895. /**
  87896. * Prepare the list of uniforms associated with the ColorCurves effects.
  87897. * @param uniformsList The list of uniforms used in the effect
  87898. */
  87899. static PrepareUniforms(uniformsList: string[]): void;
  87900. /**
  87901. * Returns color grading data based on a hue, density, saturation and exposure value.
  87902. * @param filterHue The hue of the color filter.
  87903. * @param filterDensity The density of the color filter.
  87904. * @param saturation The saturation.
  87905. * @param exposure The exposure.
  87906. * @param result The result data container.
  87907. */
  87908. private getColorGradingDataToRef;
  87909. /**
  87910. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87911. * @param value The input slider value in range [-100,100].
  87912. * @returns Adjusted value.
  87913. */
  87914. private static applyColorGradingSliderNonlinear;
  87915. /**
  87916. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87917. * @param hue The hue (H) input.
  87918. * @param saturation The saturation (S) input.
  87919. * @param brightness The brightness (B) input.
  87920. * @result An RGBA color represented as Vector4.
  87921. */
  87922. private static fromHSBToRef;
  87923. /**
  87924. * Returns a value clamped between min and max
  87925. * @param value The value to clamp
  87926. * @param min The minimum of value
  87927. * @param max The maximum of value
  87928. * @returns The clamped value.
  87929. */
  87930. private static clamp;
  87931. /**
  87932. * Clones the current color curve instance.
  87933. * @return The cloned curves
  87934. */
  87935. clone(): ColorCurves;
  87936. /**
  87937. * Serializes the current color curve instance to a json representation.
  87938. * @return a JSON representation
  87939. */
  87940. serialize(): any;
  87941. /**
  87942. * Parses the color curve from a json representation.
  87943. * @param source the JSON source to parse
  87944. * @return The parsed curves
  87945. */
  87946. static Parse(source: any): ColorCurves;
  87947. }
  87948. }
  87949. declare module BABYLON {
  87950. /**
  87951. * Interface to follow in your material defines to integrate easily the
  87952. * Image proccessing functions.
  87953. * @hidden
  87954. */
  87955. export interface IImageProcessingConfigurationDefines {
  87956. IMAGEPROCESSING: boolean;
  87957. VIGNETTE: boolean;
  87958. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87959. VIGNETTEBLENDMODEOPAQUE: boolean;
  87960. TONEMAPPING: boolean;
  87961. TONEMAPPING_ACES: boolean;
  87962. CONTRAST: boolean;
  87963. EXPOSURE: boolean;
  87964. COLORCURVES: boolean;
  87965. COLORGRADING: boolean;
  87966. COLORGRADING3D: boolean;
  87967. SAMPLER3DGREENDEPTH: boolean;
  87968. SAMPLER3DBGRMAP: boolean;
  87969. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87970. }
  87971. /**
  87972. * @hidden
  87973. */
  87974. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87975. IMAGEPROCESSING: boolean;
  87976. VIGNETTE: boolean;
  87977. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87978. VIGNETTEBLENDMODEOPAQUE: boolean;
  87979. TONEMAPPING: boolean;
  87980. TONEMAPPING_ACES: boolean;
  87981. CONTRAST: boolean;
  87982. COLORCURVES: boolean;
  87983. COLORGRADING: boolean;
  87984. COLORGRADING3D: boolean;
  87985. SAMPLER3DGREENDEPTH: boolean;
  87986. SAMPLER3DBGRMAP: boolean;
  87987. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87988. EXPOSURE: boolean;
  87989. constructor();
  87990. }
  87991. /**
  87992. * This groups together the common properties used for image processing either in direct forward pass
  87993. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87994. * or not.
  87995. */
  87996. export class ImageProcessingConfiguration {
  87997. /**
  87998. * Default tone mapping applied in BabylonJS.
  87999. */
  88000. static readonly TONEMAPPING_STANDARD: number;
  88001. /**
  88002. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  88003. * to other engines rendering to increase portability.
  88004. */
  88005. static readonly TONEMAPPING_ACES: number;
  88006. /**
  88007. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  88008. */
  88009. colorCurves: Nullable<ColorCurves>;
  88010. private _colorCurvesEnabled;
  88011. /**
  88012. * Gets wether the color curves effect is enabled.
  88013. */
  88014. get colorCurvesEnabled(): boolean;
  88015. /**
  88016. * Sets wether the color curves effect is enabled.
  88017. */
  88018. set colorCurvesEnabled(value: boolean);
  88019. private _colorGradingTexture;
  88020. /**
  88021. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88022. */
  88023. get colorGradingTexture(): Nullable<BaseTexture>;
  88024. /**
  88025. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88026. */
  88027. set colorGradingTexture(value: Nullable<BaseTexture>);
  88028. private _colorGradingEnabled;
  88029. /**
  88030. * Gets wether the color grading effect is enabled.
  88031. */
  88032. get colorGradingEnabled(): boolean;
  88033. /**
  88034. * Sets wether the color grading effect is enabled.
  88035. */
  88036. set colorGradingEnabled(value: boolean);
  88037. private _colorGradingWithGreenDepth;
  88038. /**
  88039. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88040. */
  88041. get colorGradingWithGreenDepth(): boolean;
  88042. /**
  88043. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88044. */
  88045. set colorGradingWithGreenDepth(value: boolean);
  88046. private _colorGradingBGR;
  88047. /**
  88048. * Gets wether the color grading texture contains BGR values.
  88049. */
  88050. get colorGradingBGR(): boolean;
  88051. /**
  88052. * Sets wether the color grading texture contains BGR values.
  88053. */
  88054. set colorGradingBGR(value: boolean);
  88055. /** @hidden */
  88056. _exposure: number;
  88057. /**
  88058. * Gets the Exposure used in the effect.
  88059. */
  88060. get exposure(): number;
  88061. /**
  88062. * Sets the Exposure used in the effect.
  88063. */
  88064. set exposure(value: number);
  88065. private _toneMappingEnabled;
  88066. /**
  88067. * Gets wether the tone mapping effect is enabled.
  88068. */
  88069. get toneMappingEnabled(): boolean;
  88070. /**
  88071. * Sets wether the tone mapping effect is enabled.
  88072. */
  88073. set toneMappingEnabled(value: boolean);
  88074. private _toneMappingType;
  88075. /**
  88076. * Gets the type of tone mapping effect.
  88077. */
  88078. get toneMappingType(): number;
  88079. /**
  88080. * Sets the type of tone mapping effect used in BabylonJS.
  88081. */
  88082. set toneMappingType(value: number);
  88083. protected _contrast: number;
  88084. /**
  88085. * Gets the contrast used in the effect.
  88086. */
  88087. get contrast(): number;
  88088. /**
  88089. * Sets the contrast used in the effect.
  88090. */
  88091. set contrast(value: number);
  88092. /**
  88093. * Vignette stretch size.
  88094. */
  88095. vignetteStretch: number;
  88096. /**
  88097. * Vignette centre X Offset.
  88098. */
  88099. vignetteCentreX: number;
  88100. /**
  88101. * Vignette centre Y Offset.
  88102. */
  88103. vignetteCentreY: number;
  88104. /**
  88105. * Vignette weight or intensity of the vignette effect.
  88106. */
  88107. vignetteWeight: number;
  88108. /**
  88109. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88110. * if vignetteEnabled is set to true.
  88111. */
  88112. vignetteColor: Color4;
  88113. /**
  88114. * Camera field of view used by the Vignette effect.
  88115. */
  88116. vignetteCameraFov: number;
  88117. private _vignetteBlendMode;
  88118. /**
  88119. * Gets the vignette blend mode allowing different kind of effect.
  88120. */
  88121. get vignetteBlendMode(): number;
  88122. /**
  88123. * Sets the vignette blend mode allowing different kind of effect.
  88124. */
  88125. set vignetteBlendMode(value: number);
  88126. private _vignetteEnabled;
  88127. /**
  88128. * Gets wether the vignette effect is enabled.
  88129. */
  88130. get vignetteEnabled(): boolean;
  88131. /**
  88132. * Sets wether the vignette effect is enabled.
  88133. */
  88134. set vignetteEnabled(value: boolean);
  88135. private _applyByPostProcess;
  88136. /**
  88137. * Gets wether the image processing is applied through a post process or not.
  88138. */
  88139. get applyByPostProcess(): boolean;
  88140. /**
  88141. * Sets wether the image processing is applied through a post process or not.
  88142. */
  88143. set applyByPostProcess(value: boolean);
  88144. private _isEnabled;
  88145. /**
  88146. * Gets wether the image processing is enabled or not.
  88147. */
  88148. get isEnabled(): boolean;
  88149. /**
  88150. * Sets wether the image processing is enabled or not.
  88151. */
  88152. set isEnabled(value: boolean);
  88153. /**
  88154. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88155. */
  88156. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88157. /**
  88158. * Method called each time the image processing information changes requires to recompile the effect.
  88159. */
  88160. protected _updateParameters(): void;
  88161. /**
  88162. * Gets the current class name.
  88163. * @return "ImageProcessingConfiguration"
  88164. */
  88165. getClassName(): string;
  88166. /**
  88167. * Prepare the list of uniforms associated with the Image Processing effects.
  88168. * @param uniforms The list of uniforms used in the effect
  88169. * @param defines the list of defines currently in use
  88170. */
  88171. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88172. /**
  88173. * Prepare the list of samplers associated with the Image Processing effects.
  88174. * @param samplersList The list of uniforms used in the effect
  88175. * @param defines the list of defines currently in use
  88176. */
  88177. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88178. /**
  88179. * Prepare the list of defines associated to the shader.
  88180. * @param defines the list of defines to complete
  88181. * @param forPostProcess Define if we are currently in post process mode or not
  88182. */
  88183. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88184. /**
  88185. * Returns true if all the image processing information are ready.
  88186. * @returns True if ready, otherwise, false
  88187. */
  88188. isReady(): boolean;
  88189. /**
  88190. * Binds the image processing to the shader.
  88191. * @param effect The effect to bind to
  88192. * @param overrideAspectRatio Override the aspect ratio of the effect
  88193. */
  88194. bind(effect: Effect, overrideAspectRatio?: number): void;
  88195. /**
  88196. * Clones the current image processing instance.
  88197. * @return The cloned image processing
  88198. */
  88199. clone(): ImageProcessingConfiguration;
  88200. /**
  88201. * Serializes the current image processing instance to a json representation.
  88202. * @return a JSON representation
  88203. */
  88204. serialize(): any;
  88205. /**
  88206. * Parses the image processing from a json representation.
  88207. * @param source the JSON source to parse
  88208. * @return The parsed image processing
  88209. */
  88210. static Parse(source: any): ImageProcessingConfiguration;
  88211. private static _VIGNETTEMODE_MULTIPLY;
  88212. private static _VIGNETTEMODE_OPAQUE;
  88213. /**
  88214. * Used to apply the vignette as a mix with the pixel color.
  88215. */
  88216. static get VIGNETTEMODE_MULTIPLY(): number;
  88217. /**
  88218. * Used to apply the vignette as a replacement of the pixel color.
  88219. */
  88220. static get VIGNETTEMODE_OPAQUE(): number;
  88221. }
  88222. }
  88223. declare module BABYLON {
  88224. /** @hidden */
  88225. export var postprocessVertexShader: {
  88226. name: string;
  88227. shader: string;
  88228. };
  88229. }
  88230. declare module BABYLON {
  88231. interface ThinEngine {
  88232. /**
  88233. * Creates a new render target texture
  88234. * @param size defines the size of the texture
  88235. * @param options defines the options used to create the texture
  88236. * @returns a new render target texture stored in an InternalTexture
  88237. */
  88238. createRenderTargetTexture(size: number | {
  88239. width: number;
  88240. height: number;
  88241. layers?: number;
  88242. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88243. /**
  88244. * Creates a depth stencil texture.
  88245. * This is only available in WebGL 2 or with the depth texture extension available.
  88246. * @param size The size of face edge in the texture.
  88247. * @param options The options defining the texture.
  88248. * @returns The texture
  88249. */
  88250. createDepthStencilTexture(size: number | {
  88251. width: number;
  88252. height: number;
  88253. layers?: number;
  88254. }, options: DepthTextureCreationOptions): InternalTexture;
  88255. /** @hidden */
  88256. _createDepthStencilTexture(size: number | {
  88257. width: number;
  88258. height: number;
  88259. layers?: number;
  88260. }, options: DepthTextureCreationOptions): InternalTexture;
  88261. }
  88262. }
  88263. declare module BABYLON {
  88264. /**
  88265. * Defines the kind of connection point for node based material
  88266. */
  88267. export enum NodeMaterialBlockConnectionPointTypes {
  88268. /** Float */
  88269. Float = 1,
  88270. /** Int */
  88271. Int = 2,
  88272. /** Vector2 */
  88273. Vector2 = 4,
  88274. /** Vector3 */
  88275. Vector3 = 8,
  88276. /** Vector4 */
  88277. Vector4 = 16,
  88278. /** Color3 */
  88279. Color3 = 32,
  88280. /** Color4 */
  88281. Color4 = 64,
  88282. /** Matrix */
  88283. Matrix = 128,
  88284. /** Custom object */
  88285. Object = 256,
  88286. /** Detect type based on connection */
  88287. AutoDetect = 1024,
  88288. /** Output type that will be defined by input type */
  88289. BasedOnInput = 2048
  88290. }
  88291. }
  88292. declare module BABYLON {
  88293. /**
  88294. * Enum used to define the target of a block
  88295. */
  88296. export enum NodeMaterialBlockTargets {
  88297. /** Vertex shader */
  88298. Vertex = 1,
  88299. /** Fragment shader */
  88300. Fragment = 2,
  88301. /** Neutral */
  88302. Neutral = 4,
  88303. /** Vertex and Fragment */
  88304. VertexAndFragment = 3
  88305. }
  88306. }
  88307. declare module BABYLON {
  88308. /**
  88309. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88310. */
  88311. export enum NodeMaterialBlockConnectionPointMode {
  88312. /** Value is an uniform */
  88313. Uniform = 0,
  88314. /** Value is a mesh attribute */
  88315. Attribute = 1,
  88316. /** Value is a varying between vertex and fragment shaders */
  88317. Varying = 2,
  88318. /** Mode is undefined */
  88319. Undefined = 3
  88320. }
  88321. }
  88322. declare module BABYLON {
  88323. /**
  88324. * Enum used to define system values e.g. values automatically provided by the system
  88325. */
  88326. export enum NodeMaterialSystemValues {
  88327. /** World */
  88328. World = 1,
  88329. /** View */
  88330. View = 2,
  88331. /** Projection */
  88332. Projection = 3,
  88333. /** ViewProjection */
  88334. ViewProjection = 4,
  88335. /** WorldView */
  88336. WorldView = 5,
  88337. /** WorldViewProjection */
  88338. WorldViewProjection = 6,
  88339. /** CameraPosition */
  88340. CameraPosition = 7,
  88341. /** Fog Color */
  88342. FogColor = 8,
  88343. /** Delta time */
  88344. DeltaTime = 9
  88345. }
  88346. }
  88347. declare module BABYLON {
  88348. /** Defines supported spaces */
  88349. export enum Space {
  88350. /** Local (object) space */
  88351. LOCAL = 0,
  88352. /** World space */
  88353. WORLD = 1,
  88354. /** Bone space */
  88355. BONE = 2
  88356. }
  88357. /** Defines the 3 main axes */
  88358. export class Axis {
  88359. /** X axis */
  88360. static X: Vector3;
  88361. /** Y axis */
  88362. static Y: Vector3;
  88363. /** Z axis */
  88364. static Z: Vector3;
  88365. }
  88366. }
  88367. declare module BABYLON {
  88368. /**
  88369. * Represents a camera frustum
  88370. */
  88371. export class Frustum {
  88372. /**
  88373. * Gets the planes representing the frustum
  88374. * @param transform matrix to be applied to the returned planes
  88375. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88376. */
  88377. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88378. /**
  88379. * Gets the near frustum plane transformed by the transform matrix
  88380. * @param transform transformation matrix to be applied to the resulting frustum plane
  88381. * @param frustumPlane the resuling frustum plane
  88382. */
  88383. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88384. /**
  88385. * Gets the far frustum plane transformed by the transform matrix
  88386. * @param transform transformation matrix to be applied to the resulting frustum plane
  88387. * @param frustumPlane the resuling frustum plane
  88388. */
  88389. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88390. /**
  88391. * Gets the left frustum plane transformed by the transform matrix
  88392. * @param transform transformation matrix to be applied to the resulting frustum plane
  88393. * @param frustumPlane the resuling frustum plane
  88394. */
  88395. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88396. /**
  88397. * Gets the right frustum plane transformed by the transform matrix
  88398. * @param transform transformation matrix to be applied to the resulting frustum plane
  88399. * @param frustumPlane the resuling frustum plane
  88400. */
  88401. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88402. /**
  88403. * Gets the top frustum plane transformed by the transform matrix
  88404. * @param transform transformation matrix to be applied to the resulting frustum plane
  88405. * @param frustumPlane the resuling frustum plane
  88406. */
  88407. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88408. /**
  88409. * Gets the bottom frustum plane transformed by the transform matrix
  88410. * @param transform transformation matrix to be applied to the resulting frustum plane
  88411. * @param frustumPlane the resuling frustum plane
  88412. */
  88413. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88414. /**
  88415. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88416. * @param transform transformation matrix to be applied to the resulting frustum planes
  88417. * @param frustumPlanes the resuling frustum planes
  88418. */
  88419. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88420. }
  88421. }
  88422. declare module BABYLON {
  88423. /**
  88424. * Interface for the size containing width and height
  88425. */
  88426. export interface ISize {
  88427. /**
  88428. * Width
  88429. */
  88430. width: number;
  88431. /**
  88432. * Heighht
  88433. */
  88434. height: number;
  88435. }
  88436. /**
  88437. * Size containing widht and height
  88438. */
  88439. export class Size implements ISize {
  88440. /**
  88441. * Width
  88442. */
  88443. width: number;
  88444. /**
  88445. * Height
  88446. */
  88447. height: number;
  88448. /**
  88449. * Creates a Size object from the given width and height (floats).
  88450. * @param width width of the new size
  88451. * @param height height of the new size
  88452. */
  88453. constructor(width: number, height: number);
  88454. /**
  88455. * Returns a string with the Size width and height
  88456. * @returns a string with the Size width and height
  88457. */
  88458. toString(): string;
  88459. /**
  88460. * "Size"
  88461. * @returns the string "Size"
  88462. */
  88463. getClassName(): string;
  88464. /**
  88465. * Returns the Size hash code.
  88466. * @returns a hash code for a unique width and height
  88467. */
  88468. getHashCode(): number;
  88469. /**
  88470. * Updates the current size from the given one.
  88471. * @param src the given size
  88472. */
  88473. copyFrom(src: Size): void;
  88474. /**
  88475. * Updates in place the current Size from the given floats.
  88476. * @param width width of the new size
  88477. * @param height height of the new size
  88478. * @returns the updated Size.
  88479. */
  88480. copyFromFloats(width: number, height: number): Size;
  88481. /**
  88482. * Updates in place the current Size from the given floats.
  88483. * @param width width to set
  88484. * @param height height to set
  88485. * @returns the updated Size.
  88486. */
  88487. set(width: number, height: number): Size;
  88488. /**
  88489. * Multiplies the width and height by numbers
  88490. * @param w factor to multiple the width by
  88491. * @param h factor to multiple the height by
  88492. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88493. */
  88494. multiplyByFloats(w: number, h: number): Size;
  88495. /**
  88496. * Clones the size
  88497. * @returns a new Size copied from the given one.
  88498. */
  88499. clone(): Size;
  88500. /**
  88501. * True if the current Size and the given one width and height are strictly equal.
  88502. * @param other the other size to compare against
  88503. * @returns True if the current Size and the given one width and height are strictly equal.
  88504. */
  88505. equals(other: Size): boolean;
  88506. /**
  88507. * The surface of the Size : width * height (float).
  88508. */
  88509. get surface(): number;
  88510. /**
  88511. * Create a new size of zero
  88512. * @returns a new Size set to (0.0, 0.0)
  88513. */
  88514. static Zero(): Size;
  88515. /**
  88516. * Sums the width and height of two sizes
  88517. * @param otherSize size to add to this size
  88518. * @returns a new Size set as the addition result of the current Size and the given one.
  88519. */
  88520. add(otherSize: Size): Size;
  88521. /**
  88522. * Subtracts the width and height of two
  88523. * @param otherSize size to subtract to this size
  88524. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88525. */
  88526. subtract(otherSize: Size): Size;
  88527. /**
  88528. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88529. * @param start starting size to lerp between
  88530. * @param end end size to lerp between
  88531. * @param amount amount to lerp between the start and end values
  88532. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88533. */
  88534. static Lerp(start: Size, end: Size, amount: number): Size;
  88535. }
  88536. }
  88537. declare module BABYLON {
  88538. /**
  88539. * Contains position and normal vectors for a vertex
  88540. */
  88541. export class PositionNormalVertex {
  88542. /** the position of the vertex (defaut: 0,0,0) */
  88543. position: Vector3;
  88544. /** the normal of the vertex (defaut: 0,1,0) */
  88545. normal: Vector3;
  88546. /**
  88547. * Creates a PositionNormalVertex
  88548. * @param position the position of the vertex (defaut: 0,0,0)
  88549. * @param normal the normal of the vertex (defaut: 0,1,0)
  88550. */
  88551. constructor(
  88552. /** the position of the vertex (defaut: 0,0,0) */
  88553. position?: Vector3,
  88554. /** the normal of the vertex (defaut: 0,1,0) */
  88555. normal?: Vector3);
  88556. /**
  88557. * Clones the PositionNormalVertex
  88558. * @returns the cloned PositionNormalVertex
  88559. */
  88560. clone(): PositionNormalVertex;
  88561. }
  88562. /**
  88563. * Contains position, normal and uv vectors for a vertex
  88564. */
  88565. export class PositionNormalTextureVertex {
  88566. /** the position of the vertex (defaut: 0,0,0) */
  88567. position: Vector3;
  88568. /** the normal of the vertex (defaut: 0,1,0) */
  88569. normal: Vector3;
  88570. /** the uv of the vertex (default: 0,0) */
  88571. uv: Vector2;
  88572. /**
  88573. * Creates a PositionNormalTextureVertex
  88574. * @param position the position of the vertex (defaut: 0,0,0)
  88575. * @param normal the normal of the vertex (defaut: 0,1,0)
  88576. * @param uv the uv of the vertex (default: 0,0)
  88577. */
  88578. constructor(
  88579. /** the position of the vertex (defaut: 0,0,0) */
  88580. position?: Vector3,
  88581. /** the normal of the vertex (defaut: 0,1,0) */
  88582. normal?: Vector3,
  88583. /** the uv of the vertex (default: 0,0) */
  88584. uv?: Vector2);
  88585. /**
  88586. * Clones the PositionNormalTextureVertex
  88587. * @returns the cloned PositionNormalTextureVertex
  88588. */
  88589. clone(): PositionNormalTextureVertex;
  88590. }
  88591. }
  88592. declare module BABYLON {
  88593. /**
  88594. * Enum defining the type of animations supported by InputBlock
  88595. */
  88596. export enum AnimatedInputBlockTypes {
  88597. /** No animation */
  88598. None = 0,
  88599. /** Time based animation. Will only work for floats */
  88600. Time = 1
  88601. }
  88602. }
  88603. declare module BABYLON {
  88604. /**
  88605. * Interface describing all the common properties and methods a shadow light needs to implement.
  88606. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88607. * as well as binding the different shadow properties to the effects.
  88608. */
  88609. export interface IShadowLight extends Light {
  88610. /**
  88611. * The light id in the scene (used in scene.findLighById for instance)
  88612. */
  88613. id: string;
  88614. /**
  88615. * The position the shdow will be casted from.
  88616. */
  88617. position: Vector3;
  88618. /**
  88619. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88620. */
  88621. direction: Vector3;
  88622. /**
  88623. * The transformed position. Position of the light in world space taking parenting in account.
  88624. */
  88625. transformedPosition: Vector3;
  88626. /**
  88627. * The transformed direction. Direction of the light in world space taking parenting in account.
  88628. */
  88629. transformedDirection: Vector3;
  88630. /**
  88631. * The friendly name of the light in the scene.
  88632. */
  88633. name: string;
  88634. /**
  88635. * Defines the shadow projection clipping minimum z value.
  88636. */
  88637. shadowMinZ: number;
  88638. /**
  88639. * Defines the shadow projection clipping maximum z value.
  88640. */
  88641. shadowMaxZ: number;
  88642. /**
  88643. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88644. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88645. */
  88646. computeTransformedInformation(): boolean;
  88647. /**
  88648. * Gets the scene the light belongs to.
  88649. * @returns The scene
  88650. */
  88651. getScene(): Scene;
  88652. /**
  88653. * Callback defining a custom Projection Matrix Builder.
  88654. * This can be used to override the default projection matrix computation.
  88655. */
  88656. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88657. /**
  88658. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88659. * @param matrix The materix to updated with the projection information
  88660. * @param viewMatrix The transform matrix of the light
  88661. * @param renderList The list of mesh to render in the map
  88662. * @returns The current light
  88663. */
  88664. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88665. /**
  88666. * Gets the current depth scale used in ESM.
  88667. * @returns The scale
  88668. */
  88669. getDepthScale(): number;
  88670. /**
  88671. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88672. * @returns true if a cube texture needs to be use
  88673. */
  88674. needCube(): boolean;
  88675. /**
  88676. * Detects if the projection matrix requires to be recomputed this frame.
  88677. * @returns true if it requires to be recomputed otherwise, false.
  88678. */
  88679. needProjectionMatrixCompute(): boolean;
  88680. /**
  88681. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88682. */
  88683. forceProjectionMatrixCompute(): void;
  88684. /**
  88685. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88686. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88687. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88688. */
  88689. getShadowDirection(faceIndex?: number): Vector3;
  88690. /**
  88691. * Gets the minZ used for shadow according to both the scene and the light.
  88692. * @param activeCamera The camera we are returning the min for
  88693. * @returns the depth min z
  88694. */
  88695. getDepthMinZ(activeCamera: Camera): number;
  88696. /**
  88697. * Gets the maxZ used for shadow according to both the scene and the light.
  88698. * @param activeCamera The camera we are returning the max for
  88699. * @returns the depth max z
  88700. */
  88701. getDepthMaxZ(activeCamera: Camera): number;
  88702. }
  88703. /**
  88704. * Base implementation IShadowLight
  88705. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88706. */
  88707. export abstract class ShadowLight extends Light implements IShadowLight {
  88708. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88709. protected _position: Vector3;
  88710. protected _setPosition(value: Vector3): void;
  88711. /**
  88712. * Sets the position the shadow will be casted from. Also use as the light position for both
  88713. * point and spot lights.
  88714. */
  88715. get position(): Vector3;
  88716. /**
  88717. * Sets the position the shadow will be casted from. Also use as the light position for both
  88718. * point and spot lights.
  88719. */
  88720. set position(value: Vector3);
  88721. protected _direction: Vector3;
  88722. protected _setDirection(value: Vector3): void;
  88723. /**
  88724. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88725. * Also use as the light direction on spot and directional lights.
  88726. */
  88727. get direction(): Vector3;
  88728. /**
  88729. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88730. * Also use as the light direction on spot and directional lights.
  88731. */
  88732. set direction(value: Vector3);
  88733. protected _shadowMinZ: number;
  88734. /**
  88735. * Gets the shadow projection clipping minimum z value.
  88736. */
  88737. get shadowMinZ(): number;
  88738. /**
  88739. * Sets the shadow projection clipping minimum z value.
  88740. */
  88741. set shadowMinZ(value: number);
  88742. protected _shadowMaxZ: number;
  88743. /**
  88744. * Sets the shadow projection clipping maximum z value.
  88745. */
  88746. get shadowMaxZ(): number;
  88747. /**
  88748. * Gets the shadow projection clipping maximum z value.
  88749. */
  88750. set shadowMaxZ(value: number);
  88751. /**
  88752. * Callback defining a custom Projection Matrix Builder.
  88753. * This can be used to override the default projection matrix computation.
  88754. */
  88755. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88756. /**
  88757. * The transformed position. Position of the light in world space taking parenting in account.
  88758. */
  88759. transformedPosition: Vector3;
  88760. /**
  88761. * The transformed direction. Direction of the light in world space taking parenting in account.
  88762. */
  88763. transformedDirection: Vector3;
  88764. private _needProjectionMatrixCompute;
  88765. /**
  88766. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88767. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88768. */
  88769. computeTransformedInformation(): boolean;
  88770. /**
  88771. * Return the depth scale used for the shadow map.
  88772. * @returns the depth scale.
  88773. */
  88774. getDepthScale(): number;
  88775. /**
  88776. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88777. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88778. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88779. */
  88780. getShadowDirection(faceIndex?: number): Vector3;
  88781. /**
  88782. * Returns the ShadowLight absolute position in the World.
  88783. * @returns the position vector in world space
  88784. */
  88785. getAbsolutePosition(): Vector3;
  88786. /**
  88787. * Sets the ShadowLight direction toward the passed target.
  88788. * @param target The point to target in local space
  88789. * @returns the updated ShadowLight direction
  88790. */
  88791. setDirectionToTarget(target: Vector3): Vector3;
  88792. /**
  88793. * Returns the light rotation in euler definition.
  88794. * @returns the x y z rotation in local space.
  88795. */
  88796. getRotation(): Vector3;
  88797. /**
  88798. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88799. * @returns true if a cube texture needs to be use
  88800. */
  88801. needCube(): boolean;
  88802. /**
  88803. * Detects if the projection matrix requires to be recomputed this frame.
  88804. * @returns true if it requires to be recomputed otherwise, false.
  88805. */
  88806. needProjectionMatrixCompute(): boolean;
  88807. /**
  88808. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88809. */
  88810. forceProjectionMatrixCompute(): void;
  88811. /** @hidden */
  88812. _initCache(): void;
  88813. /** @hidden */
  88814. _isSynchronized(): boolean;
  88815. /**
  88816. * Computes the world matrix of the node
  88817. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88818. * @returns the world matrix
  88819. */
  88820. computeWorldMatrix(force?: boolean): Matrix;
  88821. /**
  88822. * Gets the minZ used for shadow according to both the scene and the light.
  88823. * @param activeCamera The camera we are returning the min for
  88824. * @returns the depth min z
  88825. */
  88826. getDepthMinZ(activeCamera: Camera): number;
  88827. /**
  88828. * Gets the maxZ used for shadow according to both the scene and the light.
  88829. * @param activeCamera The camera we are returning the max for
  88830. * @returns the depth max z
  88831. */
  88832. getDepthMaxZ(activeCamera: Camera): number;
  88833. /**
  88834. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88835. * @param matrix The materix to updated with the projection information
  88836. * @param viewMatrix The transform matrix of the light
  88837. * @param renderList The list of mesh to render in the map
  88838. * @returns The current light
  88839. */
  88840. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88841. }
  88842. }
  88843. declare module BABYLON {
  88844. /** @hidden */
  88845. export var packingFunctions: {
  88846. name: string;
  88847. shader: string;
  88848. };
  88849. }
  88850. declare module BABYLON {
  88851. /** @hidden */
  88852. export var bayerDitherFunctions: {
  88853. name: string;
  88854. shader: string;
  88855. };
  88856. }
  88857. declare module BABYLON {
  88858. /** @hidden */
  88859. export var shadowMapFragmentDeclaration: {
  88860. name: string;
  88861. shader: string;
  88862. };
  88863. }
  88864. declare module BABYLON {
  88865. /** @hidden */
  88866. export var clipPlaneFragmentDeclaration: {
  88867. name: string;
  88868. shader: string;
  88869. };
  88870. }
  88871. declare module BABYLON {
  88872. /** @hidden */
  88873. export var clipPlaneFragment: {
  88874. name: string;
  88875. shader: string;
  88876. };
  88877. }
  88878. declare module BABYLON {
  88879. /** @hidden */
  88880. export var shadowMapFragment: {
  88881. name: string;
  88882. shader: string;
  88883. };
  88884. }
  88885. declare module BABYLON {
  88886. /** @hidden */
  88887. export var shadowMapPixelShader: {
  88888. name: string;
  88889. shader: string;
  88890. };
  88891. }
  88892. declare module BABYLON {
  88893. /** @hidden */
  88894. export var bonesDeclaration: {
  88895. name: string;
  88896. shader: string;
  88897. };
  88898. }
  88899. declare module BABYLON {
  88900. /** @hidden */
  88901. export var morphTargetsVertexGlobalDeclaration: {
  88902. name: string;
  88903. shader: string;
  88904. };
  88905. }
  88906. declare module BABYLON {
  88907. /** @hidden */
  88908. export var morphTargetsVertexDeclaration: {
  88909. name: string;
  88910. shader: string;
  88911. };
  88912. }
  88913. declare module BABYLON {
  88914. /** @hidden */
  88915. export var instancesDeclaration: {
  88916. name: string;
  88917. shader: string;
  88918. };
  88919. }
  88920. declare module BABYLON {
  88921. /** @hidden */
  88922. export var helperFunctions: {
  88923. name: string;
  88924. shader: string;
  88925. };
  88926. }
  88927. declare module BABYLON {
  88928. /** @hidden */
  88929. export var shadowMapVertexDeclaration: {
  88930. name: string;
  88931. shader: string;
  88932. };
  88933. }
  88934. declare module BABYLON {
  88935. /** @hidden */
  88936. export var clipPlaneVertexDeclaration: {
  88937. name: string;
  88938. shader: string;
  88939. };
  88940. }
  88941. declare module BABYLON {
  88942. /** @hidden */
  88943. export var morphTargetsVertex: {
  88944. name: string;
  88945. shader: string;
  88946. };
  88947. }
  88948. declare module BABYLON {
  88949. /** @hidden */
  88950. export var instancesVertex: {
  88951. name: string;
  88952. shader: string;
  88953. };
  88954. }
  88955. declare module BABYLON {
  88956. /** @hidden */
  88957. export var bonesVertex: {
  88958. name: string;
  88959. shader: string;
  88960. };
  88961. }
  88962. declare module BABYLON {
  88963. /** @hidden */
  88964. export var shadowMapVertexNormalBias: {
  88965. name: string;
  88966. shader: string;
  88967. };
  88968. }
  88969. declare module BABYLON {
  88970. /** @hidden */
  88971. export var shadowMapVertexMetric: {
  88972. name: string;
  88973. shader: string;
  88974. };
  88975. }
  88976. declare module BABYLON {
  88977. /** @hidden */
  88978. export var clipPlaneVertex: {
  88979. name: string;
  88980. shader: string;
  88981. };
  88982. }
  88983. declare module BABYLON {
  88984. /** @hidden */
  88985. export var shadowMapVertexShader: {
  88986. name: string;
  88987. shader: string;
  88988. };
  88989. }
  88990. declare module BABYLON {
  88991. /** @hidden */
  88992. export var depthBoxBlurPixelShader: {
  88993. name: string;
  88994. shader: string;
  88995. };
  88996. }
  88997. declare module BABYLON {
  88998. /** @hidden */
  88999. export var shadowMapFragmentSoftTransparentShadow: {
  89000. name: string;
  89001. shader: string;
  89002. };
  89003. }
  89004. declare module BABYLON {
  89005. /**
  89006. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  89007. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  89008. */
  89009. export class EffectFallbacks implements IEffectFallbacks {
  89010. private _defines;
  89011. private _currentRank;
  89012. private _maxRank;
  89013. private _mesh;
  89014. /**
  89015. * Removes the fallback from the bound mesh.
  89016. */
  89017. unBindMesh(): void;
  89018. /**
  89019. * Adds a fallback on the specified property.
  89020. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89021. * @param define The name of the define in the shader
  89022. */
  89023. addFallback(rank: number, define: string): void;
  89024. /**
  89025. * Sets the mesh to use CPU skinning when needing to fallback.
  89026. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89027. * @param mesh The mesh to use the fallbacks.
  89028. */
  89029. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89030. /**
  89031. * Checks to see if more fallbacks are still availible.
  89032. */
  89033. get hasMoreFallbacks(): boolean;
  89034. /**
  89035. * Removes the defines that should be removed when falling back.
  89036. * @param currentDefines defines the current define statements for the shader.
  89037. * @param effect defines the current effect we try to compile
  89038. * @returns The resulting defines with defines of the current rank removed.
  89039. */
  89040. reduce(currentDefines: string, effect: Effect): string;
  89041. }
  89042. }
  89043. declare module BABYLON {
  89044. /**
  89045. * Interface used to define Action
  89046. */
  89047. export interface IAction {
  89048. /**
  89049. * Trigger for the action
  89050. */
  89051. trigger: number;
  89052. /** Options of the trigger */
  89053. triggerOptions: any;
  89054. /**
  89055. * Gets the trigger parameters
  89056. * @returns the trigger parameters
  89057. */
  89058. getTriggerParameter(): any;
  89059. /**
  89060. * Internal only - executes current action event
  89061. * @hidden
  89062. */
  89063. _executeCurrent(evt?: ActionEvent): void;
  89064. /**
  89065. * Serialize placeholder for child classes
  89066. * @param parent of child
  89067. * @returns the serialized object
  89068. */
  89069. serialize(parent: any): any;
  89070. /**
  89071. * Internal only
  89072. * @hidden
  89073. */
  89074. _prepare(): void;
  89075. /**
  89076. * Internal only - manager for action
  89077. * @hidden
  89078. */
  89079. _actionManager: Nullable<AbstractActionManager>;
  89080. /**
  89081. * Adds action to chain of actions, may be a DoNothingAction
  89082. * @param action defines the next action to execute
  89083. * @returns The action passed in
  89084. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89085. */
  89086. then(action: IAction): IAction;
  89087. }
  89088. /**
  89089. * The action to be carried out following a trigger
  89090. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89091. */
  89092. export class Action implements IAction {
  89093. /** the trigger, with or without parameters, for the action */
  89094. triggerOptions: any;
  89095. /**
  89096. * Trigger for the action
  89097. */
  89098. trigger: number;
  89099. /**
  89100. * Internal only - manager for action
  89101. * @hidden
  89102. */
  89103. _actionManager: ActionManager;
  89104. private _nextActiveAction;
  89105. private _child;
  89106. private _condition?;
  89107. private _triggerParameter;
  89108. /**
  89109. * An event triggered prior to action being executed.
  89110. */
  89111. onBeforeExecuteObservable: Observable<Action>;
  89112. /**
  89113. * Creates a new Action
  89114. * @param triggerOptions the trigger, with or without parameters, for the action
  89115. * @param condition an optional determinant of action
  89116. */
  89117. constructor(
  89118. /** the trigger, with or without parameters, for the action */
  89119. triggerOptions: any, condition?: Condition);
  89120. /**
  89121. * Internal only
  89122. * @hidden
  89123. */
  89124. _prepare(): void;
  89125. /**
  89126. * Gets the trigger parameters
  89127. * @returns the trigger parameters
  89128. */
  89129. getTriggerParameter(): any;
  89130. /**
  89131. * Internal only - executes current action event
  89132. * @hidden
  89133. */
  89134. _executeCurrent(evt?: ActionEvent): void;
  89135. /**
  89136. * Execute placeholder for child classes
  89137. * @param evt optional action event
  89138. */
  89139. execute(evt?: ActionEvent): void;
  89140. /**
  89141. * Skips to next active action
  89142. */
  89143. skipToNextActiveAction(): void;
  89144. /**
  89145. * Adds action to chain of actions, may be a DoNothingAction
  89146. * @param action defines the next action to execute
  89147. * @returns The action passed in
  89148. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89149. */
  89150. then(action: Action): Action;
  89151. /**
  89152. * Internal only
  89153. * @hidden
  89154. */
  89155. _getProperty(propertyPath: string): string;
  89156. /**
  89157. * Internal only
  89158. * @hidden
  89159. */
  89160. _getEffectiveTarget(target: any, propertyPath: string): any;
  89161. /**
  89162. * Serialize placeholder for child classes
  89163. * @param parent of child
  89164. * @returns the serialized object
  89165. */
  89166. serialize(parent: any): any;
  89167. /**
  89168. * Internal only called by serialize
  89169. * @hidden
  89170. */
  89171. protected _serialize(serializedAction: any, parent?: any): any;
  89172. /**
  89173. * Internal only
  89174. * @hidden
  89175. */
  89176. static _SerializeValueAsString: (value: any) => string;
  89177. /**
  89178. * Internal only
  89179. * @hidden
  89180. */
  89181. static _GetTargetProperty: (target: Scene | Node) => {
  89182. name: string;
  89183. targetType: string;
  89184. value: string;
  89185. };
  89186. }
  89187. }
  89188. declare module BABYLON {
  89189. /**
  89190. * A Condition applied to an Action
  89191. */
  89192. export class Condition {
  89193. /**
  89194. * Internal only - manager for action
  89195. * @hidden
  89196. */
  89197. _actionManager: ActionManager;
  89198. /**
  89199. * Internal only
  89200. * @hidden
  89201. */
  89202. _evaluationId: number;
  89203. /**
  89204. * Internal only
  89205. * @hidden
  89206. */
  89207. _currentResult: boolean;
  89208. /**
  89209. * Creates a new Condition
  89210. * @param actionManager the manager of the action the condition is applied to
  89211. */
  89212. constructor(actionManager: ActionManager);
  89213. /**
  89214. * Check if the current condition is valid
  89215. * @returns a boolean
  89216. */
  89217. isValid(): boolean;
  89218. /**
  89219. * Internal only
  89220. * @hidden
  89221. */
  89222. _getProperty(propertyPath: string): string;
  89223. /**
  89224. * Internal only
  89225. * @hidden
  89226. */
  89227. _getEffectiveTarget(target: any, propertyPath: string): any;
  89228. /**
  89229. * Serialize placeholder for child classes
  89230. * @returns the serialized object
  89231. */
  89232. serialize(): any;
  89233. /**
  89234. * Internal only
  89235. * @hidden
  89236. */
  89237. protected _serialize(serializedCondition: any): any;
  89238. }
  89239. /**
  89240. * Defines specific conditional operators as extensions of Condition
  89241. */
  89242. export class ValueCondition extends Condition {
  89243. /** path to specify the property of the target the conditional operator uses */
  89244. propertyPath: string;
  89245. /** the value compared by the conditional operator against the current value of the property */
  89246. value: any;
  89247. /** the conditional operator, default ValueCondition.IsEqual */
  89248. operator: number;
  89249. /**
  89250. * Internal only
  89251. * @hidden
  89252. */
  89253. private static _IsEqual;
  89254. /**
  89255. * Internal only
  89256. * @hidden
  89257. */
  89258. private static _IsDifferent;
  89259. /**
  89260. * Internal only
  89261. * @hidden
  89262. */
  89263. private static _IsGreater;
  89264. /**
  89265. * Internal only
  89266. * @hidden
  89267. */
  89268. private static _IsLesser;
  89269. /**
  89270. * returns the number for IsEqual
  89271. */
  89272. static get IsEqual(): number;
  89273. /**
  89274. * Returns the number for IsDifferent
  89275. */
  89276. static get IsDifferent(): number;
  89277. /**
  89278. * Returns the number for IsGreater
  89279. */
  89280. static get IsGreater(): number;
  89281. /**
  89282. * Returns the number for IsLesser
  89283. */
  89284. static get IsLesser(): number;
  89285. /**
  89286. * Internal only The action manager for the condition
  89287. * @hidden
  89288. */
  89289. _actionManager: ActionManager;
  89290. /**
  89291. * Internal only
  89292. * @hidden
  89293. */
  89294. private _target;
  89295. /**
  89296. * Internal only
  89297. * @hidden
  89298. */
  89299. private _effectiveTarget;
  89300. /**
  89301. * Internal only
  89302. * @hidden
  89303. */
  89304. private _property;
  89305. /**
  89306. * Creates a new ValueCondition
  89307. * @param actionManager manager for the action the condition applies to
  89308. * @param target for the action
  89309. * @param propertyPath path to specify the property of the target the conditional operator uses
  89310. * @param value the value compared by the conditional operator against the current value of the property
  89311. * @param operator the conditional operator, default ValueCondition.IsEqual
  89312. */
  89313. constructor(actionManager: ActionManager, target: any,
  89314. /** path to specify the property of the target the conditional operator uses */
  89315. propertyPath: string,
  89316. /** the value compared by the conditional operator against the current value of the property */
  89317. value: any,
  89318. /** the conditional operator, default ValueCondition.IsEqual */
  89319. operator?: number);
  89320. /**
  89321. * Compares the given value with the property value for the specified conditional operator
  89322. * @returns the result of the comparison
  89323. */
  89324. isValid(): boolean;
  89325. /**
  89326. * Serialize the ValueCondition into a JSON compatible object
  89327. * @returns serialization object
  89328. */
  89329. serialize(): any;
  89330. /**
  89331. * Gets the name of the conditional operator for the ValueCondition
  89332. * @param operator the conditional operator
  89333. * @returns the name
  89334. */
  89335. static GetOperatorName(operator: number): string;
  89336. }
  89337. /**
  89338. * Defines a predicate condition as an extension of Condition
  89339. */
  89340. export class PredicateCondition extends Condition {
  89341. /** defines the predicate function used to validate the condition */
  89342. predicate: () => boolean;
  89343. /**
  89344. * Internal only - manager for action
  89345. * @hidden
  89346. */
  89347. _actionManager: ActionManager;
  89348. /**
  89349. * Creates a new PredicateCondition
  89350. * @param actionManager manager for the action the condition applies to
  89351. * @param predicate defines the predicate function used to validate the condition
  89352. */
  89353. constructor(actionManager: ActionManager,
  89354. /** defines the predicate function used to validate the condition */
  89355. predicate: () => boolean);
  89356. /**
  89357. * @returns the validity of the predicate condition
  89358. */
  89359. isValid(): boolean;
  89360. }
  89361. /**
  89362. * Defines a state condition as an extension of Condition
  89363. */
  89364. export class StateCondition extends Condition {
  89365. /** Value to compare with target state */
  89366. value: string;
  89367. /**
  89368. * Internal only - manager for action
  89369. * @hidden
  89370. */
  89371. _actionManager: ActionManager;
  89372. /**
  89373. * Internal only
  89374. * @hidden
  89375. */
  89376. private _target;
  89377. /**
  89378. * Creates a new StateCondition
  89379. * @param actionManager manager for the action the condition applies to
  89380. * @param target of the condition
  89381. * @param value to compare with target state
  89382. */
  89383. constructor(actionManager: ActionManager, target: any,
  89384. /** Value to compare with target state */
  89385. value: string);
  89386. /**
  89387. * Gets a boolean indicating if the current condition is met
  89388. * @returns the validity of the state
  89389. */
  89390. isValid(): boolean;
  89391. /**
  89392. * Serialize the StateCondition into a JSON compatible object
  89393. * @returns serialization object
  89394. */
  89395. serialize(): any;
  89396. }
  89397. }
  89398. declare module BABYLON {
  89399. /**
  89400. * This defines an action responsible to toggle a boolean once triggered.
  89401. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89402. */
  89403. export class SwitchBooleanAction extends Action {
  89404. /**
  89405. * The path to the boolean property in the target object
  89406. */
  89407. propertyPath: string;
  89408. private _target;
  89409. private _effectiveTarget;
  89410. private _property;
  89411. /**
  89412. * Instantiate the action
  89413. * @param triggerOptions defines the trigger options
  89414. * @param target defines the object containing the boolean
  89415. * @param propertyPath defines the path to the boolean property in the target object
  89416. * @param condition defines the trigger related conditions
  89417. */
  89418. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89419. /** @hidden */
  89420. _prepare(): void;
  89421. /**
  89422. * Execute the action toggle the boolean value.
  89423. */
  89424. execute(): void;
  89425. /**
  89426. * Serializes the actions and its related information.
  89427. * @param parent defines the object to serialize in
  89428. * @returns the serialized object
  89429. */
  89430. serialize(parent: any): any;
  89431. }
  89432. /**
  89433. * This defines an action responsible to set a the state field of the target
  89434. * to a desired value once triggered.
  89435. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89436. */
  89437. export class SetStateAction extends Action {
  89438. /**
  89439. * The value to store in the state field.
  89440. */
  89441. value: string;
  89442. private _target;
  89443. /**
  89444. * Instantiate the action
  89445. * @param triggerOptions defines the trigger options
  89446. * @param target defines the object containing the state property
  89447. * @param value defines the value to store in the state field
  89448. * @param condition defines the trigger related conditions
  89449. */
  89450. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89451. /**
  89452. * Execute the action and store the value on the target state property.
  89453. */
  89454. execute(): void;
  89455. /**
  89456. * Serializes the actions and its related information.
  89457. * @param parent defines the object to serialize in
  89458. * @returns the serialized object
  89459. */
  89460. serialize(parent: any): any;
  89461. }
  89462. /**
  89463. * This defines an action responsible to set a property of the target
  89464. * to a desired value once triggered.
  89465. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89466. */
  89467. export class SetValueAction extends Action {
  89468. /**
  89469. * The path of the property to set in the target.
  89470. */
  89471. propertyPath: string;
  89472. /**
  89473. * The value to set in the property
  89474. */
  89475. value: any;
  89476. private _target;
  89477. private _effectiveTarget;
  89478. private _property;
  89479. /**
  89480. * Instantiate the action
  89481. * @param triggerOptions defines the trigger options
  89482. * @param target defines the object containing the property
  89483. * @param propertyPath defines the path of the property to set in the target
  89484. * @param value defines the value to set in the property
  89485. * @param condition defines the trigger related conditions
  89486. */
  89487. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89488. /** @hidden */
  89489. _prepare(): void;
  89490. /**
  89491. * Execute the action and set the targetted property to the desired value.
  89492. */
  89493. execute(): void;
  89494. /**
  89495. * Serializes the actions and its related information.
  89496. * @param parent defines the object to serialize in
  89497. * @returns the serialized object
  89498. */
  89499. serialize(parent: any): any;
  89500. }
  89501. /**
  89502. * This defines an action responsible to increment the target value
  89503. * to a desired value once triggered.
  89504. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89505. */
  89506. export class IncrementValueAction extends Action {
  89507. /**
  89508. * The path of the property to increment in the target.
  89509. */
  89510. propertyPath: string;
  89511. /**
  89512. * The value we should increment the property by.
  89513. */
  89514. value: any;
  89515. private _target;
  89516. private _effectiveTarget;
  89517. private _property;
  89518. /**
  89519. * Instantiate the action
  89520. * @param triggerOptions defines the trigger options
  89521. * @param target defines the object containing the property
  89522. * @param propertyPath defines the path of the property to increment in the target
  89523. * @param value defines the value value we should increment the property by
  89524. * @param condition defines the trigger related conditions
  89525. */
  89526. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89527. /** @hidden */
  89528. _prepare(): void;
  89529. /**
  89530. * Execute the action and increment the target of the value amount.
  89531. */
  89532. execute(): void;
  89533. /**
  89534. * Serializes the actions and its related information.
  89535. * @param parent defines the object to serialize in
  89536. * @returns the serialized object
  89537. */
  89538. serialize(parent: any): any;
  89539. }
  89540. /**
  89541. * This defines an action responsible to start an animation once triggered.
  89542. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89543. */
  89544. export class PlayAnimationAction extends Action {
  89545. /**
  89546. * Where the animation should start (animation frame)
  89547. */
  89548. from: number;
  89549. /**
  89550. * Where the animation should stop (animation frame)
  89551. */
  89552. to: number;
  89553. /**
  89554. * Define if the animation should loop or stop after the first play.
  89555. */
  89556. loop?: boolean;
  89557. private _target;
  89558. /**
  89559. * Instantiate the action
  89560. * @param triggerOptions defines the trigger options
  89561. * @param target defines the target animation or animation name
  89562. * @param from defines from where the animation should start (animation frame)
  89563. * @param end defines where the animation should stop (animation frame)
  89564. * @param loop defines if the animation should loop or stop after the first play
  89565. * @param condition defines the trigger related conditions
  89566. */
  89567. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89568. /** @hidden */
  89569. _prepare(): void;
  89570. /**
  89571. * Execute the action and play the animation.
  89572. */
  89573. execute(): void;
  89574. /**
  89575. * Serializes the actions and its related information.
  89576. * @param parent defines the object to serialize in
  89577. * @returns the serialized object
  89578. */
  89579. serialize(parent: any): any;
  89580. }
  89581. /**
  89582. * This defines an action responsible to stop an animation once triggered.
  89583. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89584. */
  89585. export class StopAnimationAction extends Action {
  89586. private _target;
  89587. /**
  89588. * Instantiate the action
  89589. * @param triggerOptions defines the trigger options
  89590. * @param target defines the target animation or animation name
  89591. * @param condition defines the trigger related conditions
  89592. */
  89593. constructor(triggerOptions: any, target: any, condition?: Condition);
  89594. /** @hidden */
  89595. _prepare(): void;
  89596. /**
  89597. * Execute the action and stop the animation.
  89598. */
  89599. execute(): void;
  89600. /**
  89601. * Serializes the actions and its related information.
  89602. * @param parent defines the object to serialize in
  89603. * @returns the serialized object
  89604. */
  89605. serialize(parent: any): any;
  89606. }
  89607. /**
  89608. * This defines an action responsible that does nothing once triggered.
  89609. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89610. */
  89611. export class DoNothingAction extends Action {
  89612. /**
  89613. * Instantiate the action
  89614. * @param triggerOptions defines the trigger options
  89615. * @param condition defines the trigger related conditions
  89616. */
  89617. constructor(triggerOptions?: any, condition?: Condition);
  89618. /**
  89619. * Execute the action and do nothing.
  89620. */
  89621. execute(): void;
  89622. /**
  89623. * Serializes the actions and its related information.
  89624. * @param parent defines the object to serialize in
  89625. * @returns the serialized object
  89626. */
  89627. serialize(parent: any): any;
  89628. }
  89629. /**
  89630. * This defines an action responsible to trigger several actions once triggered.
  89631. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89632. */
  89633. export class CombineAction extends Action {
  89634. /**
  89635. * The list of aggregated animations to run.
  89636. */
  89637. children: Action[];
  89638. /**
  89639. * Instantiate the action
  89640. * @param triggerOptions defines the trigger options
  89641. * @param children defines the list of aggregated animations to run
  89642. * @param condition defines the trigger related conditions
  89643. */
  89644. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89645. /** @hidden */
  89646. _prepare(): void;
  89647. /**
  89648. * Execute the action and executes all the aggregated actions.
  89649. */
  89650. execute(evt: ActionEvent): void;
  89651. /**
  89652. * Serializes the actions and its related information.
  89653. * @param parent defines the object to serialize in
  89654. * @returns the serialized object
  89655. */
  89656. serialize(parent: any): any;
  89657. }
  89658. /**
  89659. * This defines an action responsible to run code (external event) once triggered.
  89660. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89661. */
  89662. export class ExecuteCodeAction extends Action {
  89663. /**
  89664. * The callback function to run.
  89665. */
  89666. func: (evt: ActionEvent) => void;
  89667. /**
  89668. * Instantiate the action
  89669. * @param triggerOptions defines the trigger options
  89670. * @param func defines the callback function to run
  89671. * @param condition defines the trigger related conditions
  89672. */
  89673. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89674. /**
  89675. * Execute the action and run the attached code.
  89676. */
  89677. execute(evt: ActionEvent): void;
  89678. }
  89679. /**
  89680. * This defines an action responsible to set the parent property of the target once triggered.
  89681. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89682. */
  89683. export class SetParentAction extends Action {
  89684. private _parent;
  89685. private _target;
  89686. /**
  89687. * Instantiate the action
  89688. * @param triggerOptions defines the trigger options
  89689. * @param target defines the target containing the parent property
  89690. * @param parent defines from where the animation should start (animation frame)
  89691. * @param condition defines the trigger related conditions
  89692. */
  89693. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89694. /** @hidden */
  89695. _prepare(): void;
  89696. /**
  89697. * Execute the action and set the parent property.
  89698. */
  89699. execute(): void;
  89700. /**
  89701. * Serializes the actions and its related information.
  89702. * @param parent defines the object to serialize in
  89703. * @returns the serialized object
  89704. */
  89705. serialize(parent: any): any;
  89706. }
  89707. }
  89708. declare module BABYLON {
  89709. /**
  89710. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89711. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89712. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89713. */
  89714. export class ActionManager extends AbstractActionManager {
  89715. /**
  89716. * Nothing
  89717. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89718. */
  89719. static readonly NothingTrigger: number;
  89720. /**
  89721. * On pick
  89722. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89723. */
  89724. static readonly OnPickTrigger: number;
  89725. /**
  89726. * On left pick
  89727. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89728. */
  89729. static readonly OnLeftPickTrigger: number;
  89730. /**
  89731. * On right pick
  89732. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89733. */
  89734. static readonly OnRightPickTrigger: number;
  89735. /**
  89736. * On center pick
  89737. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89738. */
  89739. static readonly OnCenterPickTrigger: number;
  89740. /**
  89741. * On pick down
  89742. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89743. */
  89744. static readonly OnPickDownTrigger: number;
  89745. /**
  89746. * On double pick
  89747. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89748. */
  89749. static readonly OnDoublePickTrigger: number;
  89750. /**
  89751. * On pick up
  89752. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89753. */
  89754. static readonly OnPickUpTrigger: number;
  89755. /**
  89756. * On pick out.
  89757. * This trigger will only be raised if you also declared a OnPickDown
  89758. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89759. */
  89760. static readonly OnPickOutTrigger: number;
  89761. /**
  89762. * On long press
  89763. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89764. */
  89765. static readonly OnLongPressTrigger: number;
  89766. /**
  89767. * On pointer over
  89768. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89769. */
  89770. static readonly OnPointerOverTrigger: number;
  89771. /**
  89772. * On pointer out
  89773. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89774. */
  89775. static readonly OnPointerOutTrigger: number;
  89776. /**
  89777. * On every frame
  89778. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89779. */
  89780. static readonly OnEveryFrameTrigger: number;
  89781. /**
  89782. * On intersection enter
  89783. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89784. */
  89785. static readonly OnIntersectionEnterTrigger: number;
  89786. /**
  89787. * On intersection exit
  89788. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89789. */
  89790. static readonly OnIntersectionExitTrigger: number;
  89791. /**
  89792. * On key down
  89793. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89794. */
  89795. static readonly OnKeyDownTrigger: number;
  89796. /**
  89797. * On key up
  89798. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89799. */
  89800. static readonly OnKeyUpTrigger: number;
  89801. private _scene;
  89802. /**
  89803. * Creates a new action manager
  89804. * @param scene defines the hosting scene
  89805. */
  89806. constructor(scene: Scene);
  89807. /**
  89808. * Releases all associated resources
  89809. */
  89810. dispose(): void;
  89811. /**
  89812. * Gets hosting scene
  89813. * @returns the hosting scene
  89814. */
  89815. getScene(): Scene;
  89816. /**
  89817. * Does this action manager handles actions of any of the given triggers
  89818. * @param triggers defines the triggers to be tested
  89819. * @return a boolean indicating whether one (or more) of the triggers is handled
  89820. */
  89821. hasSpecificTriggers(triggers: number[]): boolean;
  89822. /**
  89823. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89824. * speed.
  89825. * @param triggerA defines the trigger to be tested
  89826. * @param triggerB defines the trigger to be tested
  89827. * @return a boolean indicating whether one (or more) of the triggers is handled
  89828. */
  89829. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89830. /**
  89831. * Does this action manager handles actions of a given trigger
  89832. * @param trigger defines the trigger to be tested
  89833. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89834. * @return whether the trigger is handled
  89835. */
  89836. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89837. /**
  89838. * Does this action manager has pointer triggers
  89839. */
  89840. get hasPointerTriggers(): boolean;
  89841. /**
  89842. * Does this action manager has pick triggers
  89843. */
  89844. get hasPickTriggers(): boolean;
  89845. /**
  89846. * Registers an action to this action manager
  89847. * @param action defines the action to be registered
  89848. * @return the action amended (prepared) after registration
  89849. */
  89850. registerAction(action: IAction): Nullable<IAction>;
  89851. /**
  89852. * Unregisters an action to this action manager
  89853. * @param action defines the action to be unregistered
  89854. * @return a boolean indicating whether the action has been unregistered
  89855. */
  89856. unregisterAction(action: IAction): Boolean;
  89857. /**
  89858. * Process a specific trigger
  89859. * @param trigger defines the trigger to process
  89860. * @param evt defines the event details to be processed
  89861. */
  89862. processTrigger(trigger: number, evt?: IActionEvent): void;
  89863. /** @hidden */
  89864. _getEffectiveTarget(target: any, propertyPath: string): any;
  89865. /** @hidden */
  89866. _getProperty(propertyPath: string): string;
  89867. /**
  89868. * Serialize this manager to a JSON object
  89869. * @param name defines the property name to store this manager
  89870. * @returns a JSON representation of this manager
  89871. */
  89872. serialize(name: string): any;
  89873. /**
  89874. * Creates a new ActionManager from a JSON data
  89875. * @param parsedActions defines the JSON data to read from
  89876. * @param object defines the hosting mesh
  89877. * @param scene defines the hosting scene
  89878. */
  89879. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89880. /**
  89881. * Get a trigger name by index
  89882. * @param trigger defines the trigger index
  89883. * @returns a trigger name
  89884. */
  89885. static GetTriggerName(trigger: number): string;
  89886. }
  89887. }
  89888. declare module BABYLON {
  89889. /**
  89890. * Class used to represent a sprite
  89891. * @see https://doc.babylonjs.com/babylon101/sprites
  89892. */
  89893. export class Sprite implements IAnimatable {
  89894. /** defines the name */
  89895. name: string;
  89896. /** Gets or sets the current world position */
  89897. position: Vector3;
  89898. /** Gets or sets the main color */
  89899. color: Color4;
  89900. /** Gets or sets the width */
  89901. width: number;
  89902. /** Gets or sets the height */
  89903. height: number;
  89904. /** Gets or sets rotation angle */
  89905. angle: number;
  89906. /** Gets or sets the cell index in the sprite sheet */
  89907. cellIndex: number;
  89908. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89909. cellRef: string;
  89910. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89911. invertU: boolean;
  89912. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89913. invertV: boolean;
  89914. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89915. disposeWhenFinishedAnimating: boolean;
  89916. /** Gets the list of attached animations */
  89917. animations: Nullable<Array<Animation>>;
  89918. /** Gets or sets a boolean indicating if the sprite can be picked */
  89919. isPickable: boolean;
  89920. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89921. useAlphaForPicking: boolean;
  89922. /** @hidden */
  89923. _xOffset: number;
  89924. /** @hidden */
  89925. _yOffset: number;
  89926. /** @hidden */
  89927. _xSize: number;
  89928. /** @hidden */
  89929. _ySize: number;
  89930. /**
  89931. * Gets or sets the associated action manager
  89932. */
  89933. actionManager: Nullable<ActionManager>;
  89934. /**
  89935. * An event triggered when the control has been disposed
  89936. */
  89937. onDisposeObservable: Observable<Sprite>;
  89938. private _animationStarted;
  89939. private _loopAnimation;
  89940. private _fromIndex;
  89941. private _toIndex;
  89942. private _delay;
  89943. private _direction;
  89944. private _manager;
  89945. private _time;
  89946. private _onAnimationEnd;
  89947. /**
  89948. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89949. */
  89950. isVisible: boolean;
  89951. /**
  89952. * Gets or sets the sprite size
  89953. */
  89954. get size(): number;
  89955. set size(value: number);
  89956. /**
  89957. * Returns a boolean indicating if the animation is started
  89958. */
  89959. get animationStarted(): boolean;
  89960. /**
  89961. * Gets or sets the unique id of the sprite
  89962. */
  89963. uniqueId: number;
  89964. /**
  89965. * Gets the manager of this sprite
  89966. */
  89967. get manager(): ISpriteManager;
  89968. /**
  89969. * Creates a new Sprite
  89970. * @param name defines the name
  89971. * @param manager defines the manager
  89972. */
  89973. constructor(
  89974. /** defines the name */
  89975. name: string, manager: ISpriteManager);
  89976. /**
  89977. * Returns the string "Sprite"
  89978. * @returns "Sprite"
  89979. */
  89980. getClassName(): string;
  89981. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89982. get fromIndex(): number;
  89983. set fromIndex(value: number);
  89984. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89985. get toIndex(): number;
  89986. set toIndex(value: number);
  89987. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89988. get loopAnimation(): boolean;
  89989. set loopAnimation(value: boolean);
  89990. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89991. get delay(): number;
  89992. set delay(value: number);
  89993. /**
  89994. * Starts an animation
  89995. * @param from defines the initial key
  89996. * @param to defines the end key
  89997. * @param loop defines if the animation must loop
  89998. * @param delay defines the start delay (in ms)
  89999. * @param onAnimationEnd defines a callback to call when animation ends
  90000. */
  90001. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  90002. /** Stops current animation (if any) */
  90003. stopAnimation(): void;
  90004. /** @hidden */
  90005. _animate(deltaTime: number): void;
  90006. /** Release associated resources */
  90007. dispose(): void;
  90008. /**
  90009. * Serializes the sprite to a JSON object
  90010. * @returns the JSON object
  90011. */
  90012. serialize(): any;
  90013. /**
  90014. * Parses a JSON object to create a new sprite
  90015. * @param parsedSprite The JSON object to parse
  90016. * @param manager defines the hosting manager
  90017. * @returns the new sprite
  90018. */
  90019. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90020. }
  90021. }
  90022. declare module BABYLON {
  90023. /**
  90024. * Information about the result of picking within a scene
  90025. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90026. */
  90027. export class PickingInfo {
  90028. /** @hidden */
  90029. _pickingUnavailable: boolean;
  90030. /**
  90031. * If the pick collided with an object
  90032. */
  90033. hit: boolean;
  90034. /**
  90035. * Distance away where the pick collided
  90036. */
  90037. distance: number;
  90038. /**
  90039. * The location of pick collision
  90040. */
  90041. pickedPoint: Nullable<Vector3>;
  90042. /**
  90043. * The mesh corresponding the the pick collision
  90044. */
  90045. pickedMesh: Nullable<AbstractMesh>;
  90046. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90047. bu: number;
  90048. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90049. bv: number;
  90050. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90051. faceId: number;
  90052. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90053. subMeshFaceId: number;
  90054. /** Id of the the submesh that was picked */
  90055. subMeshId: number;
  90056. /** If a sprite was picked, this will be the sprite the pick collided with */
  90057. pickedSprite: Nullable<Sprite>;
  90058. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90059. thinInstanceIndex: number;
  90060. /**
  90061. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90062. */
  90063. originMesh: Nullable<AbstractMesh>;
  90064. /**
  90065. * The ray that was used to perform the picking.
  90066. */
  90067. ray: Nullable<Ray>;
  90068. /**
  90069. * Gets the normal correspodning to the face the pick collided with
  90070. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90071. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90072. * @returns The normal correspodning to the face the pick collided with
  90073. */
  90074. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90075. /**
  90076. * Gets the texture coordinates of where the pick occured
  90077. * @returns the vector containing the coordnates of the texture
  90078. */
  90079. getTextureCoordinates(): Nullable<Vector2>;
  90080. }
  90081. }
  90082. declare module BABYLON {
  90083. /**
  90084. * Class representing a ray with position and direction
  90085. */
  90086. export class Ray {
  90087. /** origin point */
  90088. origin: Vector3;
  90089. /** direction */
  90090. direction: Vector3;
  90091. /** length of the ray */
  90092. length: number;
  90093. private static readonly _TmpVector3;
  90094. private _tmpRay;
  90095. /**
  90096. * Creates a new ray
  90097. * @param origin origin point
  90098. * @param direction direction
  90099. * @param length length of the ray
  90100. */
  90101. constructor(
  90102. /** origin point */
  90103. origin: Vector3,
  90104. /** direction */
  90105. direction: Vector3,
  90106. /** length of the ray */
  90107. length?: number);
  90108. /**
  90109. * Checks if the ray intersects a box
  90110. * This does not account for the ray lenght by design to improve perfs.
  90111. * @param minimum bound of the box
  90112. * @param maximum bound of the box
  90113. * @param intersectionTreshold extra extend to be added to the box in all direction
  90114. * @returns if the box was hit
  90115. */
  90116. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90117. /**
  90118. * Checks if the ray intersects a box
  90119. * This does not account for the ray lenght by design to improve perfs.
  90120. * @param box the bounding box to check
  90121. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90122. * @returns if the box was hit
  90123. */
  90124. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90125. /**
  90126. * If the ray hits a sphere
  90127. * @param sphere the bounding sphere to check
  90128. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90129. * @returns true if it hits the sphere
  90130. */
  90131. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90132. /**
  90133. * If the ray hits a triange
  90134. * @param vertex0 triangle vertex
  90135. * @param vertex1 triangle vertex
  90136. * @param vertex2 triangle vertex
  90137. * @returns intersection information if hit
  90138. */
  90139. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90140. /**
  90141. * Checks if ray intersects a plane
  90142. * @param plane the plane to check
  90143. * @returns the distance away it was hit
  90144. */
  90145. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90146. /**
  90147. * Calculate the intercept of a ray on a given axis
  90148. * @param axis to check 'x' | 'y' | 'z'
  90149. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90150. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90151. */
  90152. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90153. /**
  90154. * Checks if ray intersects a mesh
  90155. * @param mesh the mesh to check
  90156. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90157. * @returns picking info of the intersecton
  90158. */
  90159. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90160. /**
  90161. * Checks if ray intersects a mesh
  90162. * @param meshes the meshes to check
  90163. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90164. * @param results array to store result in
  90165. * @returns Array of picking infos
  90166. */
  90167. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90168. private _comparePickingInfo;
  90169. private static smallnum;
  90170. private static rayl;
  90171. /**
  90172. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90173. * @param sega the first point of the segment to test the intersection against
  90174. * @param segb the second point of the segment to test the intersection against
  90175. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90176. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90177. */
  90178. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90179. /**
  90180. * Update the ray from viewport position
  90181. * @param x position
  90182. * @param y y position
  90183. * @param viewportWidth viewport width
  90184. * @param viewportHeight viewport height
  90185. * @param world world matrix
  90186. * @param view view matrix
  90187. * @param projection projection matrix
  90188. * @returns this ray updated
  90189. */
  90190. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90191. /**
  90192. * Creates a ray with origin and direction of 0,0,0
  90193. * @returns the new ray
  90194. */
  90195. static Zero(): Ray;
  90196. /**
  90197. * Creates a new ray from screen space and viewport
  90198. * @param x position
  90199. * @param y y position
  90200. * @param viewportWidth viewport width
  90201. * @param viewportHeight viewport height
  90202. * @param world world matrix
  90203. * @param view view matrix
  90204. * @param projection projection matrix
  90205. * @returns new ray
  90206. */
  90207. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90208. /**
  90209. * 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
  90210. * transformed to the given world matrix.
  90211. * @param origin The origin point
  90212. * @param end The end point
  90213. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90214. * @returns the new ray
  90215. */
  90216. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90217. /**
  90218. * Transforms a ray by a matrix
  90219. * @param ray ray to transform
  90220. * @param matrix matrix to apply
  90221. * @returns the resulting new ray
  90222. */
  90223. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90224. /**
  90225. * Transforms a ray by a matrix
  90226. * @param ray ray to transform
  90227. * @param matrix matrix to apply
  90228. * @param result ray to store result in
  90229. */
  90230. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90231. /**
  90232. * Unproject a ray from screen space to object space
  90233. * @param sourceX defines the screen space x coordinate to use
  90234. * @param sourceY defines the screen space y coordinate to use
  90235. * @param viewportWidth defines the current width of the viewport
  90236. * @param viewportHeight defines the current height of the viewport
  90237. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90238. * @param view defines the view matrix to use
  90239. * @param projection defines the projection matrix to use
  90240. */
  90241. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90242. }
  90243. /**
  90244. * Type used to define predicate used to select faces when a mesh intersection is detected
  90245. */
  90246. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90247. interface Scene {
  90248. /** @hidden */
  90249. _tempPickingRay: Nullable<Ray>;
  90250. /** @hidden */
  90251. _cachedRayForTransform: Ray;
  90252. /** @hidden */
  90253. _pickWithRayInverseMatrix: Matrix;
  90254. /** @hidden */
  90255. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90256. /** @hidden */
  90257. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90258. /** @hidden */
  90259. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90260. }
  90261. }
  90262. declare module BABYLON {
  90263. /**
  90264. * Groups all the scene component constants in one place to ease maintenance.
  90265. * @hidden
  90266. */
  90267. export class SceneComponentConstants {
  90268. static readonly NAME_EFFECTLAYER: string;
  90269. static readonly NAME_LAYER: string;
  90270. static readonly NAME_LENSFLARESYSTEM: string;
  90271. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90272. static readonly NAME_PARTICLESYSTEM: string;
  90273. static readonly NAME_GAMEPAD: string;
  90274. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90275. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90276. static readonly NAME_PREPASSRENDERER: string;
  90277. static readonly NAME_DEPTHRENDERER: string;
  90278. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90279. static readonly NAME_SPRITE: string;
  90280. static readonly NAME_OUTLINERENDERER: string;
  90281. static readonly NAME_PROCEDURALTEXTURE: string;
  90282. static readonly NAME_SHADOWGENERATOR: string;
  90283. static readonly NAME_OCTREE: string;
  90284. static readonly NAME_PHYSICSENGINE: string;
  90285. static readonly NAME_AUDIO: string;
  90286. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90287. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90288. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90289. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90290. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90291. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90292. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90293. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90294. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90295. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90296. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90297. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90298. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90299. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90300. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90301. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90302. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90303. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90304. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90305. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90306. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90307. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90308. static readonly STEP_AFTERRENDER_AUDIO: number;
  90309. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90310. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90311. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90312. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90313. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90314. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90315. static readonly STEP_POINTERMOVE_SPRITE: number;
  90316. static readonly STEP_POINTERDOWN_SPRITE: number;
  90317. static readonly STEP_POINTERUP_SPRITE: number;
  90318. }
  90319. /**
  90320. * This represents a scene component.
  90321. *
  90322. * This is used to decouple the dependency the scene is having on the different workloads like
  90323. * layers, post processes...
  90324. */
  90325. export interface ISceneComponent {
  90326. /**
  90327. * The name of the component. Each component must have a unique name.
  90328. */
  90329. name: string;
  90330. /**
  90331. * The scene the component belongs to.
  90332. */
  90333. scene: Scene;
  90334. /**
  90335. * Register the component to one instance of a scene.
  90336. */
  90337. register(): void;
  90338. /**
  90339. * Rebuilds the elements related to this component in case of
  90340. * context lost for instance.
  90341. */
  90342. rebuild(): void;
  90343. /**
  90344. * Disposes the component and the associated ressources.
  90345. */
  90346. dispose(): void;
  90347. }
  90348. /**
  90349. * This represents a SERIALIZABLE scene component.
  90350. *
  90351. * This extends Scene Component to add Serialization methods on top.
  90352. */
  90353. export interface ISceneSerializableComponent extends ISceneComponent {
  90354. /**
  90355. * Adds all the elements from the container to the scene
  90356. * @param container the container holding the elements
  90357. */
  90358. addFromContainer(container: AbstractScene): void;
  90359. /**
  90360. * Removes all the elements in the container from the scene
  90361. * @param container contains the elements to remove
  90362. * @param dispose if the removed element should be disposed (default: false)
  90363. */
  90364. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90365. /**
  90366. * Serializes the component data to the specified json object
  90367. * @param serializationObject The object to serialize to
  90368. */
  90369. serialize(serializationObject: any): void;
  90370. }
  90371. /**
  90372. * Strong typing of a Mesh related stage step action
  90373. */
  90374. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90375. /**
  90376. * Strong typing of a Evaluate Sub Mesh related stage step action
  90377. */
  90378. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90379. /**
  90380. * Strong typing of a Active Mesh related stage step action
  90381. */
  90382. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90383. /**
  90384. * Strong typing of a Camera related stage step action
  90385. */
  90386. export type CameraStageAction = (camera: Camera) => void;
  90387. /**
  90388. * Strong typing of a Camera Frame buffer related stage step action
  90389. */
  90390. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90391. /**
  90392. * Strong typing of a Render Target related stage step action
  90393. */
  90394. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90395. /**
  90396. * Strong typing of a RenderingGroup related stage step action
  90397. */
  90398. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90399. /**
  90400. * Strong typing of a Mesh Render related stage step action
  90401. */
  90402. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90403. /**
  90404. * Strong typing of a simple stage step action
  90405. */
  90406. export type SimpleStageAction = () => void;
  90407. /**
  90408. * Strong typing of a render target action.
  90409. */
  90410. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90411. /**
  90412. * Strong typing of a pointer move action.
  90413. */
  90414. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90415. /**
  90416. * Strong typing of a pointer up/down action.
  90417. */
  90418. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90419. /**
  90420. * Representation of a stage in the scene (Basically a list of ordered steps)
  90421. * @hidden
  90422. */
  90423. export class Stage<T extends Function> extends Array<{
  90424. index: number;
  90425. component: ISceneComponent;
  90426. action: T;
  90427. }> {
  90428. /**
  90429. * Hide ctor from the rest of the world.
  90430. * @param items The items to add.
  90431. */
  90432. private constructor();
  90433. /**
  90434. * Creates a new Stage.
  90435. * @returns A new instance of a Stage
  90436. */
  90437. static Create<T extends Function>(): Stage<T>;
  90438. /**
  90439. * Registers a step in an ordered way in the targeted stage.
  90440. * @param index Defines the position to register the step in
  90441. * @param component Defines the component attached to the step
  90442. * @param action Defines the action to launch during the step
  90443. */
  90444. registerStep(index: number, component: ISceneComponent, action: T): void;
  90445. /**
  90446. * Clears all the steps from the stage.
  90447. */
  90448. clear(): void;
  90449. }
  90450. }
  90451. declare module BABYLON {
  90452. interface Scene {
  90453. /** @hidden */
  90454. _pointerOverSprite: Nullable<Sprite>;
  90455. /** @hidden */
  90456. _pickedDownSprite: Nullable<Sprite>;
  90457. /** @hidden */
  90458. _tempSpritePickingRay: Nullable<Ray>;
  90459. /**
  90460. * All of the sprite managers added to this scene
  90461. * @see https://doc.babylonjs.com/babylon101/sprites
  90462. */
  90463. spriteManagers: Array<ISpriteManager>;
  90464. /**
  90465. * An event triggered when sprites rendering is about to start
  90466. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90467. */
  90468. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90469. /**
  90470. * An event triggered when sprites rendering is done
  90471. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90472. */
  90473. onAfterSpritesRenderingObservable: Observable<Scene>;
  90474. /** @hidden */
  90475. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90476. /** Launch a ray to try to pick a sprite in the scene
  90477. * @param x position on screen
  90478. * @param y position on screen
  90479. * @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
  90480. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90481. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90482. * @returns a PickingInfo
  90483. */
  90484. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90485. /** Use the given ray to pick a sprite in the scene
  90486. * @param ray The ray (in world space) to use to pick meshes
  90487. * @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
  90488. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90489. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90490. * @returns a PickingInfo
  90491. */
  90492. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90493. /** @hidden */
  90494. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90495. /** Launch a ray to try to pick sprites in the scene
  90496. * @param x position on screen
  90497. * @param y position on screen
  90498. * @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
  90499. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90500. * @returns a PickingInfo array
  90501. */
  90502. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90503. /** Use the given ray to pick sprites in the scene
  90504. * @param ray The ray (in world space) to use to pick meshes
  90505. * @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
  90506. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90507. * @returns a PickingInfo array
  90508. */
  90509. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90510. /**
  90511. * Force the sprite under the pointer
  90512. * @param sprite defines the sprite to use
  90513. */
  90514. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90515. /**
  90516. * Gets the sprite under the pointer
  90517. * @returns a Sprite or null if no sprite is under the pointer
  90518. */
  90519. getPointerOverSprite(): Nullable<Sprite>;
  90520. }
  90521. /**
  90522. * Defines the sprite scene component responsible to manage sprites
  90523. * in a given scene.
  90524. */
  90525. export class SpriteSceneComponent implements ISceneComponent {
  90526. /**
  90527. * The component name helpfull to identify the component in the list of scene components.
  90528. */
  90529. readonly name: string;
  90530. /**
  90531. * The scene the component belongs to.
  90532. */
  90533. scene: Scene;
  90534. /** @hidden */
  90535. private _spritePredicate;
  90536. /**
  90537. * Creates a new instance of the component for the given scene
  90538. * @param scene Defines the scene to register the component in
  90539. */
  90540. constructor(scene: Scene);
  90541. /**
  90542. * Registers the component in a given scene
  90543. */
  90544. register(): void;
  90545. /**
  90546. * Rebuilds the elements related to this component in case of
  90547. * context lost for instance.
  90548. */
  90549. rebuild(): void;
  90550. /**
  90551. * Disposes the component and the associated ressources.
  90552. */
  90553. dispose(): void;
  90554. private _pickSpriteButKeepRay;
  90555. private _pointerMove;
  90556. private _pointerDown;
  90557. private _pointerUp;
  90558. }
  90559. }
  90560. declare module BABYLON {
  90561. /** @hidden */
  90562. export var fogFragmentDeclaration: {
  90563. name: string;
  90564. shader: string;
  90565. };
  90566. }
  90567. declare module BABYLON {
  90568. /** @hidden */
  90569. export var fogFragment: {
  90570. name: string;
  90571. shader: string;
  90572. };
  90573. }
  90574. declare module BABYLON {
  90575. /** @hidden */
  90576. export var spritesPixelShader: {
  90577. name: string;
  90578. shader: string;
  90579. };
  90580. }
  90581. declare module BABYLON {
  90582. /** @hidden */
  90583. export var fogVertexDeclaration: {
  90584. name: string;
  90585. shader: string;
  90586. };
  90587. }
  90588. declare module BABYLON {
  90589. /** @hidden */
  90590. export var spritesVertexShader: {
  90591. name: string;
  90592. shader: string;
  90593. };
  90594. }
  90595. declare module BABYLON {
  90596. /**
  90597. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90598. */
  90599. export interface ISpriteManager extends IDisposable {
  90600. /**
  90601. * Gets manager's name
  90602. */
  90603. name: string;
  90604. /**
  90605. * Restricts the camera to viewing objects with the same layerMask.
  90606. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90607. */
  90608. layerMask: number;
  90609. /**
  90610. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90611. */
  90612. isPickable: boolean;
  90613. /**
  90614. * Gets the hosting scene
  90615. */
  90616. scene: Scene;
  90617. /**
  90618. * Specifies the rendering group id for this mesh (0 by default)
  90619. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90620. */
  90621. renderingGroupId: number;
  90622. /**
  90623. * Defines the list of sprites managed by the manager.
  90624. */
  90625. sprites: Array<Sprite>;
  90626. /**
  90627. * Gets or sets the spritesheet texture
  90628. */
  90629. texture: Texture;
  90630. /** Defines the default width of a cell in the spritesheet */
  90631. cellWidth: number;
  90632. /** Defines the default height of a cell in the spritesheet */
  90633. cellHeight: number;
  90634. /**
  90635. * Tests the intersection of a sprite with a specific ray.
  90636. * @param ray The ray we are sending to test the collision
  90637. * @param camera The camera space we are sending rays in
  90638. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90639. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90640. * @returns picking info or null.
  90641. */
  90642. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90643. /**
  90644. * Intersects the sprites with a ray
  90645. * @param ray defines the ray to intersect with
  90646. * @param camera defines the current active camera
  90647. * @param predicate defines a predicate used to select candidate sprites
  90648. * @returns null if no hit or a PickingInfo array
  90649. */
  90650. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90651. /**
  90652. * Renders the list of sprites on screen.
  90653. */
  90654. render(): void;
  90655. }
  90656. /**
  90657. * Class used to manage multiple sprites on the same spritesheet
  90658. * @see https://doc.babylonjs.com/babylon101/sprites
  90659. */
  90660. export class SpriteManager implements ISpriteManager {
  90661. /** defines the manager's name */
  90662. name: string;
  90663. /** Define the Url to load snippets */
  90664. static SnippetUrl: string;
  90665. /** Snippet ID if the manager was created from the snippet server */
  90666. snippetId: string;
  90667. /** Gets the list of sprites */
  90668. sprites: Sprite[];
  90669. /** Gets or sets the rendering group id (0 by default) */
  90670. renderingGroupId: number;
  90671. /** Gets or sets camera layer mask */
  90672. layerMask: number;
  90673. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90674. fogEnabled: boolean;
  90675. /** Gets or sets a boolean indicating if the sprites are pickable */
  90676. isPickable: boolean;
  90677. /** Defines the default width of a cell in the spritesheet */
  90678. cellWidth: number;
  90679. /** Defines the default height of a cell in the spritesheet */
  90680. cellHeight: number;
  90681. /** Associative array from JSON sprite data file */
  90682. private _cellData;
  90683. /** Array of sprite names from JSON sprite data file */
  90684. private _spriteMap;
  90685. /** True when packed cell data from JSON file is ready*/
  90686. private _packedAndReady;
  90687. private _textureContent;
  90688. private _useInstancing;
  90689. /**
  90690. * An event triggered when the manager is disposed.
  90691. */
  90692. onDisposeObservable: Observable<SpriteManager>;
  90693. private _onDisposeObserver;
  90694. /**
  90695. * Callback called when the manager is disposed
  90696. */
  90697. set onDispose(callback: () => void);
  90698. private _capacity;
  90699. private _fromPacked;
  90700. private _spriteTexture;
  90701. private _epsilon;
  90702. private _scene;
  90703. private _vertexData;
  90704. private _buffer;
  90705. private _vertexBuffers;
  90706. private _spriteBuffer;
  90707. private _indexBuffer;
  90708. private _effectBase;
  90709. private _effectFog;
  90710. private _vertexBufferSize;
  90711. /**
  90712. * Gets or sets the unique id of the sprite
  90713. */
  90714. uniqueId: number;
  90715. /**
  90716. * Gets the array of sprites
  90717. */
  90718. get children(): Sprite[];
  90719. /**
  90720. * Gets the hosting scene
  90721. */
  90722. get scene(): Scene;
  90723. /**
  90724. * Gets the capacity of the manager
  90725. */
  90726. get capacity(): number;
  90727. /**
  90728. * Gets or sets the spritesheet texture
  90729. */
  90730. get texture(): Texture;
  90731. set texture(value: Texture);
  90732. private _blendMode;
  90733. /**
  90734. * Blend mode use to render the particle, it can be any of
  90735. * the static Constants.ALPHA_x properties provided in this class.
  90736. * Default value is Constants.ALPHA_COMBINE
  90737. */
  90738. get blendMode(): number;
  90739. set blendMode(blendMode: number);
  90740. /** Disables writing to the depth buffer when rendering the sprites.
  90741. * It can be handy to disable depth writing when using textures without alpha channel
  90742. * and setting some specific blend modes.
  90743. */
  90744. disableDepthWrite: boolean;
  90745. /**
  90746. * Creates a new sprite manager
  90747. * @param name defines the manager's name
  90748. * @param imgUrl defines the sprite sheet url
  90749. * @param capacity defines the maximum allowed number of sprites
  90750. * @param cellSize defines the size of a sprite cell
  90751. * @param scene defines the hosting scene
  90752. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90753. * @param samplingMode defines the smapling mode to use with spritesheet
  90754. * @param fromPacked set to false; do not alter
  90755. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90756. */
  90757. constructor(
  90758. /** defines the manager's name */
  90759. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90760. /**
  90761. * Returns the string "SpriteManager"
  90762. * @returns "SpriteManager"
  90763. */
  90764. getClassName(): string;
  90765. private _makePacked;
  90766. private _appendSpriteVertex;
  90767. private _checkTextureAlpha;
  90768. /**
  90769. * Intersects the sprites with a ray
  90770. * @param ray defines the ray to intersect with
  90771. * @param camera defines the current active camera
  90772. * @param predicate defines a predicate used to select candidate sprites
  90773. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90774. * @returns null if no hit or a PickingInfo
  90775. */
  90776. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90777. /**
  90778. * Intersects the sprites with a ray
  90779. * @param ray defines the ray to intersect with
  90780. * @param camera defines the current active camera
  90781. * @param predicate defines a predicate used to select candidate sprites
  90782. * @returns null if no hit or a PickingInfo array
  90783. */
  90784. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90785. /**
  90786. * Render all child sprites
  90787. */
  90788. render(): void;
  90789. /**
  90790. * Release associated resources
  90791. */
  90792. dispose(): void;
  90793. /**
  90794. * Serializes the sprite manager to a JSON object
  90795. * @param serializeTexture defines if the texture must be serialized as well
  90796. * @returns the JSON object
  90797. */
  90798. serialize(serializeTexture?: boolean): any;
  90799. /**
  90800. * Parses a JSON object to create a new sprite manager.
  90801. * @param parsedManager The JSON object to parse
  90802. * @param scene The scene to create the sprite managerin
  90803. * @param rootUrl The root url to use to load external dependencies like texture
  90804. * @returns the new sprite manager
  90805. */
  90806. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90807. /**
  90808. * Creates a sprite manager from a snippet saved in a remote file
  90809. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90810. * @param url defines the url to load from
  90811. * @param scene defines the hosting scene
  90812. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90813. * @returns a promise that will resolve to the new sprite manager
  90814. */
  90815. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90816. /**
  90817. * Creates a sprite manager from a snippet saved by the sprite editor
  90818. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90819. * @param scene defines the hosting scene
  90820. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90821. * @returns a promise that will resolve to the new sprite manager
  90822. */
  90823. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90824. }
  90825. }
  90826. declare module BABYLON {
  90827. /** Interface used by value gradients (color, factor, ...) */
  90828. export interface IValueGradient {
  90829. /**
  90830. * Gets or sets the gradient value (between 0 and 1)
  90831. */
  90832. gradient: number;
  90833. }
  90834. /** Class used to store color4 gradient */
  90835. export class ColorGradient implements IValueGradient {
  90836. /**
  90837. * Gets or sets the gradient value (between 0 and 1)
  90838. */
  90839. gradient: number;
  90840. /**
  90841. * Gets or sets first associated color
  90842. */
  90843. color1: Color4;
  90844. /**
  90845. * Gets or sets second associated color
  90846. */
  90847. color2?: Color4 | undefined;
  90848. /**
  90849. * Creates a new color4 gradient
  90850. * @param gradient gets or sets the gradient value (between 0 and 1)
  90851. * @param color1 gets or sets first associated color
  90852. * @param color2 gets or sets first second color
  90853. */
  90854. constructor(
  90855. /**
  90856. * Gets or sets the gradient value (between 0 and 1)
  90857. */
  90858. gradient: number,
  90859. /**
  90860. * Gets or sets first associated color
  90861. */
  90862. color1: Color4,
  90863. /**
  90864. * Gets or sets second associated color
  90865. */
  90866. color2?: Color4 | undefined);
  90867. /**
  90868. * Will get a color picked randomly between color1 and color2.
  90869. * If color2 is undefined then color1 will be used
  90870. * @param result defines the target Color4 to store the result in
  90871. */
  90872. getColorToRef(result: Color4): void;
  90873. }
  90874. /** Class used to store color 3 gradient */
  90875. export class Color3Gradient implements IValueGradient {
  90876. /**
  90877. * Gets or sets the gradient value (between 0 and 1)
  90878. */
  90879. gradient: number;
  90880. /**
  90881. * Gets or sets the associated color
  90882. */
  90883. color: Color3;
  90884. /**
  90885. * Creates a new color3 gradient
  90886. * @param gradient gets or sets the gradient value (between 0 and 1)
  90887. * @param color gets or sets associated color
  90888. */
  90889. constructor(
  90890. /**
  90891. * Gets or sets the gradient value (between 0 and 1)
  90892. */
  90893. gradient: number,
  90894. /**
  90895. * Gets or sets the associated color
  90896. */
  90897. color: Color3);
  90898. }
  90899. /** Class used to store factor gradient */
  90900. export class FactorGradient implements IValueGradient {
  90901. /**
  90902. * Gets or sets the gradient value (between 0 and 1)
  90903. */
  90904. gradient: number;
  90905. /**
  90906. * Gets or sets first associated factor
  90907. */
  90908. factor1: number;
  90909. /**
  90910. * Gets or sets second associated factor
  90911. */
  90912. factor2?: number | undefined;
  90913. /**
  90914. * Creates a new factor gradient
  90915. * @param gradient gets or sets the gradient value (between 0 and 1)
  90916. * @param factor1 gets or sets first associated factor
  90917. * @param factor2 gets or sets second associated factor
  90918. */
  90919. constructor(
  90920. /**
  90921. * Gets or sets the gradient value (between 0 and 1)
  90922. */
  90923. gradient: number,
  90924. /**
  90925. * Gets or sets first associated factor
  90926. */
  90927. factor1: number,
  90928. /**
  90929. * Gets or sets second associated factor
  90930. */
  90931. factor2?: number | undefined);
  90932. /**
  90933. * Will get a number picked randomly between factor1 and factor2.
  90934. * If factor2 is undefined then factor1 will be used
  90935. * @returns the picked number
  90936. */
  90937. getFactor(): number;
  90938. }
  90939. /**
  90940. * Helper used to simplify some generic gradient tasks
  90941. */
  90942. export class GradientHelper {
  90943. /**
  90944. * Gets the current gradient from an array of IValueGradient
  90945. * @param ratio defines the current ratio to get
  90946. * @param gradients defines the array of IValueGradient
  90947. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90948. */
  90949. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90950. }
  90951. }
  90952. declare module BABYLON {
  90953. interface ThinEngine {
  90954. /**
  90955. * Creates a raw texture
  90956. * @param data defines the data to store in the texture
  90957. * @param width defines the width of the texture
  90958. * @param height defines the height of the texture
  90959. * @param format defines the format of the data
  90960. * @param generateMipMaps defines if the engine should generate the mip levels
  90961. * @param invertY defines if data must be stored with Y axis inverted
  90962. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90963. * @param compression defines the compression used (null by default)
  90964. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90965. * @returns the raw texture inside an InternalTexture
  90966. */
  90967. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90968. /**
  90969. * Update a raw texture
  90970. * @param texture defines the texture to update
  90971. * @param data defines the data to store in the texture
  90972. * @param format defines the format of the data
  90973. * @param invertY defines if data must be stored with Y axis inverted
  90974. */
  90975. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90976. /**
  90977. * Update a raw texture
  90978. * @param texture defines the texture to update
  90979. * @param data defines the data to store in the texture
  90980. * @param format defines the format of the data
  90981. * @param invertY defines if data must be stored with Y axis inverted
  90982. * @param compression defines the compression used (null by default)
  90983. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90984. */
  90985. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90986. /**
  90987. * Creates a new raw cube texture
  90988. * @param data defines the array of data to use to create each face
  90989. * @param size defines the size of the textures
  90990. * @param format defines the format of the data
  90991. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90992. * @param generateMipMaps defines if the engine should generate the mip levels
  90993. * @param invertY defines if data must be stored with Y axis inverted
  90994. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90995. * @param compression defines the compression used (null by default)
  90996. * @returns the cube texture as an InternalTexture
  90997. */
  90998. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90999. /**
  91000. * Update a raw cube texture
  91001. * @param texture defines the texture to udpdate
  91002. * @param data defines the data to store
  91003. * @param format defines the data format
  91004. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91005. * @param invertY defines if data must be stored with Y axis inverted
  91006. */
  91007. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  91008. /**
  91009. * Update a raw cube texture
  91010. * @param texture defines the texture to udpdate
  91011. * @param data defines the data to store
  91012. * @param format defines the data format
  91013. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91014. * @param invertY defines if data must be stored with Y axis inverted
  91015. * @param compression defines the compression used (null by default)
  91016. */
  91017. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91018. /**
  91019. * Update a raw cube texture
  91020. * @param texture defines the texture to udpdate
  91021. * @param data defines the data to store
  91022. * @param format defines the data format
  91023. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91024. * @param invertY defines if data must be stored with Y axis inverted
  91025. * @param compression defines the compression used (null by default)
  91026. * @param level defines which level of the texture to update
  91027. */
  91028. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91029. /**
  91030. * Creates a new raw cube texture from a specified url
  91031. * @param url defines the url where the data is located
  91032. * @param scene defines the current scene
  91033. * @param size defines the size of the textures
  91034. * @param format defines the format of the data
  91035. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91036. * @param noMipmap defines if the engine should avoid generating the mip levels
  91037. * @param callback defines a callback used to extract texture data from loaded data
  91038. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91039. * @param onLoad defines a callback called when texture is loaded
  91040. * @param onError defines a callback called if there is an error
  91041. * @returns the cube texture as an InternalTexture
  91042. */
  91043. 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;
  91044. /**
  91045. * Creates a new raw cube texture from a specified url
  91046. * @param url defines the url where the data is located
  91047. * @param scene defines the current scene
  91048. * @param size defines the size of the textures
  91049. * @param format defines the format of the data
  91050. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91051. * @param noMipmap defines if the engine should avoid generating the mip levels
  91052. * @param callback defines a callback used to extract texture data from loaded data
  91053. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91054. * @param onLoad defines a callback called when texture is loaded
  91055. * @param onError defines a callback called if there is an error
  91056. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91057. * @param invertY defines if data must be stored with Y axis inverted
  91058. * @returns the cube texture as an InternalTexture
  91059. */
  91060. 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;
  91061. /**
  91062. * Creates a new raw 3D texture
  91063. * @param data defines the data used to create the texture
  91064. * @param width defines the width of the texture
  91065. * @param height defines the height of the texture
  91066. * @param depth defines the depth of the texture
  91067. * @param format defines the format of the texture
  91068. * @param generateMipMaps defines if the engine must generate mip levels
  91069. * @param invertY defines if data must be stored with Y axis inverted
  91070. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91071. * @param compression defines the compressed used (can be null)
  91072. * @param textureType defines the compressed used (can be null)
  91073. * @returns a new raw 3D texture (stored in an InternalTexture)
  91074. */
  91075. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91076. /**
  91077. * Update a raw 3D texture
  91078. * @param texture defines the texture to update
  91079. * @param data defines the data to store
  91080. * @param format defines the data format
  91081. * @param invertY defines if data must be stored with Y axis inverted
  91082. */
  91083. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91084. /**
  91085. * Update a raw 3D texture
  91086. * @param texture defines the texture to update
  91087. * @param data defines the data to store
  91088. * @param format defines the data format
  91089. * @param invertY defines if data must be stored with Y axis inverted
  91090. * @param compression defines the used compression (can be null)
  91091. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91092. */
  91093. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91094. /**
  91095. * Creates a new raw 2D array texture
  91096. * @param data defines the data used to create the texture
  91097. * @param width defines the width of the texture
  91098. * @param height defines the height of the texture
  91099. * @param depth defines the number of layers of the texture
  91100. * @param format defines the format of the texture
  91101. * @param generateMipMaps defines if the engine must generate mip levels
  91102. * @param invertY defines if data must be stored with Y axis inverted
  91103. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91104. * @param compression defines the compressed used (can be null)
  91105. * @param textureType defines the compressed used (can be null)
  91106. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91107. */
  91108. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91109. /**
  91110. * Update a raw 2D array texture
  91111. * @param texture defines the texture to update
  91112. * @param data defines the data to store
  91113. * @param format defines the data format
  91114. * @param invertY defines if data must be stored with Y axis inverted
  91115. */
  91116. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91117. /**
  91118. * Update a raw 2D array texture
  91119. * @param texture defines the texture to update
  91120. * @param data defines the data to store
  91121. * @param format defines the data format
  91122. * @param invertY defines if data must be stored with Y axis inverted
  91123. * @param compression defines the used compression (can be null)
  91124. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91125. */
  91126. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91127. }
  91128. }
  91129. declare module BABYLON {
  91130. /**
  91131. * Raw texture can help creating a texture directly from an array of data.
  91132. * This can be super useful if you either get the data from an uncompressed source or
  91133. * if you wish to create your texture pixel by pixel.
  91134. */
  91135. export class RawTexture extends Texture {
  91136. /**
  91137. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91138. */
  91139. format: number;
  91140. /**
  91141. * Instantiates a new RawTexture.
  91142. * Raw texture can help creating a texture directly from an array of data.
  91143. * This can be super useful if you either get the data from an uncompressed source or
  91144. * if you wish to create your texture pixel by pixel.
  91145. * @param data define the array of data to use to create the texture
  91146. * @param width define the width of the texture
  91147. * @param height define the height of the texture
  91148. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91149. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91150. * @param generateMipMaps define whether mip maps should be generated or not
  91151. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91152. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91153. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91154. */
  91155. constructor(data: ArrayBufferView, width: number, height: number,
  91156. /**
  91157. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91158. */
  91159. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91160. /**
  91161. * Updates the texture underlying data.
  91162. * @param data Define the new data of the texture
  91163. */
  91164. update(data: ArrayBufferView): void;
  91165. /**
  91166. * Creates a luminance texture from some data.
  91167. * @param data Define the texture data
  91168. * @param width Define the width of the texture
  91169. * @param height Define the height of the texture
  91170. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91171. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91172. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91173. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91174. * @returns the luminance texture
  91175. */
  91176. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91177. /**
  91178. * Creates a luminance alpha texture from some data.
  91179. * @param data Define the texture data
  91180. * @param width Define the width of the texture
  91181. * @param height Define the height of the texture
  91182. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91183. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91184. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91185. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91186. * @returns the luminance alpha texture
  91187. */
  91188. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91189. /**
  91190. * Creates an alpha texture from some data.
  91191. * @param data Define the texture data
  91192. * @param width Define the width of the texture
  91193. * @param height Define the height of the texture
  91194. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91195. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91196. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91197. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91198. * @returns the alpha texture
  91199. */
  91200. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91201. /**
  91202. * Creates a RGB texture from some data.
  91203. * @param data Define the texture data
  91204. * @param width Define the width of the texture
  91205. * @param height Define the height of the texture
  91206. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91207. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91208. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91209. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91210. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91211. * @returns the RGB alpha texture
  91212. */
  91213. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91214. /**
  91215. * Creates a RGBA texture from some data.
  91216. * @param data Define the texture data
  91217. * @param width Define the width of the texture
  91218. * @param height Define the height of the texture
  91219. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91220. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91221. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91222. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91223. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91224. * @returns the RGBA texture
  91225. */
  91226. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91227. /**
  91228. * Creates a R texture from some data.
  91229. * @param data Define the texture data
  91230. * @param width Define the width of the texture
  91231. * @param height Define the height of the texture
  91232. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91233. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91234. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91235. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91236. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91237. * @returns the R texture
  91238. */
  91239. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91240. }
  91241. }
  91242. declare module BABYLON {
  91243. interface ThinEngine {
  91244. /**
  91245. * Update a dynamic index buffer
  91246. * @param indexBuffer defines the target index buffer
  91247. * @param indices defines the data to update
  91248. * @param offset defines the offset in the target index buffer where update should start
  91249. */
  91250. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91251. /**
  91252. * Updates a dynamic vertex buffer.
  91253. * @param vertexBuffer the vertex buffer to update
  91254. * @param data the data used to update the vertex buffer
  91255. * @param byteOffset the byte offset of the data
  91256. * @param byteLength the byte length of the data
  91257. */
  91258. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91259. }
  91260. }
  91261. declare module BABYLON {
  91262. interface AbstractScene {
  91263. /**
  91264. * The list of procedural textures added to the scene
  91265. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91266. */
  91267. proceduralTextures: Array<ProceduralTexture>;
  91268. }
  91269. /**
  91270. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91271. * in a given scene.
  91272. */
  91273. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91274. /**
  91275. * The component name helpfull to identify the component in the list of scene components.
  91276. */
  91277. readonly name: string;
  91278. /**
  91279. * The scene the component belongs to.
  91280. */
  91281. scene: Scene;
  91282. /**
  91283. * Creates a new instance of the component for the given scene
  91284. * @param scene Defines the scene to register the component in
  91285. */
  91286. constructor(scene: Scene);
  91287. /**
  91288. * Registers the component in a given scene
  91289. */
  91290. register(): void;
  91291. /**
  91292. * Rebuilds the elements related to this component in case of
  91293. * context lost for instance.
  91294. */
  91295. rebuild(): void;
  91296. /**
  91297. * Disposes the component and the associated ressources.
  91298. */
  91299. dispose(): void;
  91300. private _beforeClear;
  91301. }
  91302. }
  91303. declare module BABYLON {
  91304. interface ThinEngine {
  91305. /**
  91306. * Creates a new render target cube texture
  91307. * @param size defines the size of the texture
  91308. * @param options defines the options used to create the texture
  91309. * @returns a new render target cube texture stored in an InternalTexture
  91310. */
  91311. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91312. }
  91313. }
  91314. declare module BABYLON {
  91315. /** @hidden */
  91316. export var proceduralVertexShader: {
  91317. name: string;
  91318. shader: string;
  91319. };
  91320. }
  91321. declare module BABYLON {
  91322. /**
  91323. * 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.
  91324. * This is the base class of any Procedural texture and contains most of the shareable code.
  91325. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91326. */
  91327. export class ProceduralTexture extends Texture {
  91328. /**
  91329. * Define if the texture is enabled or not (disabled texture will not render)
  91330. */
  91331. isEnabled: boolean;
  91332. /**
  91333. * Define if the texture must be cleared before rendering (default is true)
  91334. */
  91335. autoClear: boolean;
  91336. /**
  91337. * Callback called when the texture is generated
  91338. */
  91339. onGenerated: () => void;
  91340. /**
  91341. * Event raised when the texture is generated
  91342. */
  91343. onGeneratedObservable: Observable<ProceduralTexture>;
  91344. /** @hidden */
  91345. _generateMipMaps: boolean;
  91346. /** @hidden **/
  91347. _effect: Effect;
  91348. /** @hidden */
  91349. _textures: {
  91350. [key: string]: Texture;
  91351. };
  91352. /** @hidden */
  91353. protected _fallbackTexture: Nullable<Texture>;
  91354. private _size;
  91355. private _currentRefreshId;
  91356. private _frameId;
  91357. private _refreshRate;
  91358. private _vertexBuffers;
  91359. private _indexBuffer;
  91360. private _uniforms;
  91361. private _samplers;
  91362. private _fragment;
  91363. private _floats;
  91364. private _ints;
  91365. private _floatsArrays;
  91366. private _colors3;
  91367. private _colors4;
  91368. private _vectors2;
  91369. private _vectors3;
  91370. private _matrices;
  91371. private _fallbackTextureUsed;
  91372. private _fullEngine;
  91373. private _cachedDefines;
  91374. private _contentUpdateId;
  91375. private _contentData;
  91376. /**
  91377. * Instantiates a new procedural texture.
  91378. * 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.
  91379. * This is the base class of any Procedural texture and contains most of the shareable code.
  91380. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91381. * @param name Define the name of the texture
  91382. * @param size Define the size of the texture to create
  91383. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91384. * @param scene Define the scene the texture belongs to
  91385. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91386. * @param generateMipMaps Define if the texture should creates mip maps or not
  91387. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91388. */
  91389. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91390. /**
  91391. * The effect that is created when initializing the post process.
  91392. * @returns The created effect corresponding the the postprocess.
  91393. */
  91394. getEffect(): Effect;
  91395. /**
  91396. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91397. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91398. */
  91399. getContent(): Nullable<ArrayBufferView>;
  91400. private _createIndexBuffer;
  91401. /** @hidden */
  91402. _rebuild(): void;
  91403. /**
  91404. * Resets the texture in order to recreate its associated resources.
  91405. * This can be called in case of context loss
  91406. */
  91407. reset(): void;
  91408. protected _getDefines(): string;
  91409. /**
  91410. * Is the texture ready to be used ? (rendered at least once)
  91411. * @returns true if ready, otherwise, false.
  91412. */
  91413. isReady(): boolean;
  91414. /**
  91415. * Resets the refresh counter of the texture and start bak from scratch.
  91416. * Could be useful to regenerate the texture if it is setup to render only once.
  91417. */
  91418. resetRefreshCounter(): void;
  91419. /**
  91420. * Set the fragment shader to use in order to render the texture.
  91421. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91422. */
  91423. setFragment(fragment: any): void;
  91424. /**
  91425. * Define the refresh rate of the texture or the rendering frequency.
  91426. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91427. */
  91428. get refreshRate(): number;
  91429. set refreshRate(value: number);
  91430. /** @hidden */
  91431. _shouldRender(): boolean;
  91432. /**
  91433. * Get the size the texture is rendering at.
  91434. * @returns the size (texture is always squared)
  91435. */
  91436. getRenderSize(): number;
  91437. /**
  91438. * Resize the texture to new value.
  91439. * @param size Define the new size the texture should have
  91440. * @param generateMipMaps Define whether the new texture should create mip maps
  91441. */
  91442. resize(size: number, generateMipMaps: boolean): void;
  91443. private _checkUniform;
  91444. /**
  91445. * Set a texture in the shader program used to render.
  91446. * @param name Define the name of the uniform samplers as defined in the shader
  91447. * @param texture Define the texture to bind to this sampler
  91448. * @return the texture itself allowing "fluent" like uniform updates
  91449. */
  91450. setTexture(name: string, texture: Texture): ProceduralTexture;
  91451. /**
  91452. * Set a float in the shader.
  91453. * @param name Define the name of the uniform as defined in the shader
  91454. * @param value Define the value to give to the uniform
  91455. * @return the texture itself allowing "fluent" like uniform updates
  91456. */
  91457. setFloat(name: string, value: number): ProceduralTexture;
  91458. /**
  91459. * Set a int in the shader.
  91460. * @param name Define the name of the uniform as defined in the shader
  91461. * @param value Define the value to give to the uniform
  91462. * @return the texture itself allowing "fluent" like uniform updates
  91463. */
  91464. setInt(name: string, value: number): ProceduralTexture;
  91465. /**
  91466. * Set an array of floats in the shader.
  91467. * @param name Define the name of the uniform as defined in the shader
  91468. * @param value Define the value to give to the uniform
  91469. * @return the texture itself allowing "fluent" like uniform updates
  91470. */
  91471. setFloats(name: string, value: number[]): ProceduralTexture;
  91472. /**
  91473. * Set a vec3 in the shader from a Color3.
  91474. * @param name Define the name of the uniform as defined in the shader
  91475. * @param value Define the value to give to the uniform
  91476. * @return the texture itself allowing "fluent" like uniform updates
  91477. */
  91478. setColor3(name: string, value: Color3): ProceduralTexture;
  91479. /**
  91480. * Set a vec4 in the shader from a Color4.
  91481. * @param name Define the name of the uniform as defined in the shader
  91482. * @param value Define the value to give to the uniform
  91483. * @return the texture itself allowing "fluent" like uniform updates
  91484. */
  91485. setColor4(name: string, value: Color4): ProceduralTexture;
  91486. /**
  91487. * Set a vec2 in the shader from a Vector2.
  91488. * @param name Define the name of the uniform as defined in the shader
  91489. * @param value Define the value to give to the uniform
  91490. * @return the texture itself allowing "fluent" like uniform updates
  91491. */
  91492. setVector2(name: string, value: Vector2): ProceduralTexture;
  91493. /**
  91494. * Set a vec3 in the shader from a Vector3.
  91495. * @param name Define the name of the uniform as defined in the shader
  91496. * @param value Define the value to give to the uniform
  91497. * @return the texture itself allowing "fluent" like uniform updates
  91498. */
  91499. setVector3(name: string, value: Vector3): ProceduralTexture;
  91500. /**
  91501. * Set a mat4 in the shader from a MAtrix.
  91502. * @param name Define the name of the uniform as defined in the shader
  91503. * @param value Define the value to give to the uniform
  91504. * @return the texture itself allowing "fluent" like uniform updates
  91505. */
  91506. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91507. /**
  91508. * Render the texture to its associated render target.
  91509. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91510. */
  91511. render(useCameraPostProcess?: boolean): void;
  91512. /**
  91513. * Clone the texture.
  91514. * @returns the cloned texture
  91515. */
  91516. clone(): ProceduralTexture;
  91517. /**
  91518. * Dispose the texture and release its asoociated resources.
  91519. */
  91520. dispose(): void;
  91521. }
  91522. }
  91523. declare module BABYLON {
  91524. /**
  91525. * This represents the base class for particle system in Babylon.
  91526. * 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.
  91527. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91528. * @example https://doc.babylonjs.com/babylon101/particles
  91529. */
  91530. export class BaseParticleSystem {
  91531. /**
  91532. * Source color is added to the destination color without alpha affecting the result
  91533. */
  91534. static BLENDMODE_ONEONE: number;
  91535. /**
  91536. * Blend current color and particle color using particle’s alpha
  91537. */
  91538. static BLENDMODE_STANDARD: number;
  91539. /**
  91540. * Add current color and particle color multiplied by particle’s alpha
  91541. */
  91542. static BLENDMODE_ADD: number;
  91543. /**
  91544. * Multiply current color with particle color
  91545. */
  91546. static BLENDMODE_MULTIPLY: number;
  91547. /**
  91548. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91549. */
  91550. static BLENDMODE_MULTIPLYADD: number;
  91551. /**
  91552. * List of animations used by the particle system.
  91553. */
  91554. animations: Animation[];
  91555. /**
  91556. * Gets or sets the unique id of the particle system
  91557. */
  91558. uniqueId: number;
  91559. /**
  91560. * The id of the Particle system.
  91561. */
  91562. id: string;
  91563. /**
  91564. * The friendly name of the Particle system.
  91565. */
  91566. name: string;
  91567. /**
  91568. * Snippet ID if the particle system was created from the snippet server
  91569. */
  91570. snippetId: string;
  91571. /**
  91572. * The rendering group used by the Particle system to chose when to render.
  91573. */
  91574. renderingGroupId: number;
  91575. /**
  91576. * The emitter represents the Mesh or position we are attaching the particle system to.
  91577. */
  91578. emitter: Nullable<AbstractMesh | Vector3>;
  91579. /**
  91580. * The maximum number of particles to emit per frame
  91581. */
  91582. emitRate: number;
  91583. /**
  91584. * If you want to launch only a few particles at once, that can be done, as well.
  91585. */
  91586. manualEmitCount: number;
  91587. /**
  91588. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91589. */
  91590. updateSpeed: number;
  91591. /**
  91592. * The amount of time the particle system is running (depends of the overall update speed).
  91593. */
  91594. targetStopDuration: number;
  91595. /**
  91596. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91597. */
  91598. disposeOnStop: boolean;
  91599. /**
  91600. * Minimum power of emitting particles.
  91601. */
  91602. minEmitPower: number;
  91603. /**
  91604. * Maximum power of emitting particles.
  91605. */
  91606. maxEmitPower: number;
  91607. /**
  91608. * Minimum life time of emitting particles.
  91609. */
  91610. minLifeTime: number;
  91611. /**
  91612. * Maximum life time of emitting particles.
  91613. */
  91614. maxLifeTime: number;
  91615. /**
  91616. * Minimum Size of emitting particles.
  91617. */
  91618. minSize: number;
  91619. /**
  91620. * Maximum Size of emitting particles.
  91621. */
  91622. maxSize: number;
  91623. /**
  91624. * Minimum scale of emitting particles on X axis.
  91625. */
  91626. minScaleX: number;
  91627. /**
  91628. * Maximum scale of emitting particles on X axis.
  91629. */
  91630. maxScaleX: number;
  91631. /**
  91632. * Minimum scale of emitting particles on Y axis.
  91633. */
  91634. minScaleY: number;
  91635. /**
  91636. * Maximum scale of emitting particles on Y axis.
  91637. */
  91638. maxScaleY: number;
  91639. /**
  91640. * Gets or sets the minimal initial rotation in radians.
  91641. */
  91642. minInitialRotation: number;
  91643. /**
  91644. * Gets or sets the maximal initial rotation in radians.
  91645. */
  91646. maxInitialRotation: number;
  91647. /**
  91648. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91649. */
  91650. minAngularSpeed: number;
  91651. /**
  91652. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91653. */
  91654. maxAngularSpeed: number;
  91655. /**
  91656. * The texture used to render each particle. (this can be a spritesheet)
  91657. */
  91658. particleTexture: Nullable<BaseTexture>;
  91659. /**
  91660. * The layer mask we are rendering the particles through.
  91661. */
  91662. layerMask: number;
  91663. /**
  91664. * This can help using your own shader to render the particle system.
  91665. * The according effect will be created
  91666. */
  91667. customShader: any;
  91668. /**
  91669. * By default particle system starts as soon as they are created. This prevents the
  91670. * automatic start to happen and let you decide when to start emitting particles.
  91671. */
  91672. preventAutoStart: boolean;
  91673. private _noiseTexture;
  91674. /**
  91675. * Gets or sets a texture used to add random noise to particle positions
  91676. */
  91677. get noiseTexture(): Nullable<ProceduralTexture>;
  91678. set noiseTexture(value: Nullable<ProceduralTexture>);
  91679. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91680. noiseStrength: Vector3;
  91681. /**
  91682. * Callback triggered when the particle animation is ending.
  91683. */
  91684. onAnimationEnd: Nullable<() => void>;
  91685. /**
  91686. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91687. */
  91688. blendMode: number;
  91689. /**
  91690. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91691. * to override the particles.
  91692. */
  91693. forceDepthWrite: boolean;
  91694. /** 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 */
  91695. preWarmCycles: number;
  91696. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91697. preWarmStepOffset: number;
  91698. /**
  91699. * 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)
  91700. */
  91701. spriteCellChangeSpeed: number;
  91702. /**
  91703. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91704. */
  91705. startSpriteCellID: number;
  91706. /**
  91707. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91708. */
  91709. endSpriteCellID: number;
  91710. /**
  91711. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91712. */
  91713. spriteCellWidth: number;
  91714. /**
  91715. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91716. */
  91717. spriteCellHeight: number;
  91718. /**
  91719. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91720. */
  91721. spriteRandomStartCell: boolean;
  91722. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91723. translationPivot: Vector2;
  91724. /** @hidden */
  91725. protected _isAnimationSheetEnabled: boolean;
  91726. /**
  91727. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91728. */
  91729. beginAnimationOnStart: boolean;
  91730. /**
  91731. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91732. */
  91733. beginAnimationFrom: number;
  91734. /**
  91735. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91736. */
  91737. beginAnimationTo: number;
  91738. /**
  91739. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91740. */
  91741. beginAnimationLoop: boolean;
  91742. /**
  91743. * Gets or sets a world offset applied to all particles
  91744. */
  91745. worldOffset: Vector3;
  91746. /**
  91747. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91748. */
  91749. get isAnimationSheetEnabled(): boolean;
  91750. set isAnimationSheetEnabled(value: boolean);
  91751. /**
  91752. * Get hosting scene
  91753. * @returns the scene
  91754. */
  91755. getScene(): Nullable<Scene>;
  91756. /**
  91757. * You can use gravity if you want to give an orientation to your particles.
  91758. */
  91759. gravity: Vector3;
  91760. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91761. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91762. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91763. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91764. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91765. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91766. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91767. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91768. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91769. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91770. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91771. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91772. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91773. /**
  91774. * Defines the delay in milliseconds before starting the system (0 by default)
  91775. */
  91776. startDelay: number;
  91777. /**
  91778. * Gets the current list of drag gradients.
  91779. * You must use addDragGradient and removeDragGradient to udpate this list
  91780. * @returns the list of drag gradients
  91781. */
  91782. getDragGradients(): Nullable<Array<FactorGradient>>;
  91783. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91784. limitVelocityDamping: number;
  91785. /**
  91786. * Gets the current list of limit velocity gradients.
  91787. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91788. * @returns the list of limit velocity gradients
  91789. */
  91790. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91791. /**
  91792. * Gets the current list of color gradients.
  91793. * You must use addColorGradient and removeColorGradient to udpate this list
  91794. * @returns the list of color gradients
  91795. */
  91796. getColorGradients(): Nullable<Array<ColorGradient>>;
  91797. /**
  91798. * Gets the current list of size gradients.
  91799. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91800. * @returns the list of size gradients
  91801. */
  91802. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91803. /**
  91804. * Gets the current list of color remap gradients.
  91805. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91806. * @returns the list of color remap gradients
  91807. */
  91808. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91809. /**
  91810. * Gets the current list of alpha remap gradients.
  91811. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91812. * @returns the list of alpha remap gradients
  91813. */
  91814. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91815. /**
  91816. * Gets the current list of life time gradients.
  91817. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91818. * @returns the list of life time gradients
  91819. */
  91820. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91821. /**
  91822. * Gets the current list of angular speed gradients.
  91823. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91824. * @returns the list of angular speed gradients
  91825. */
  91826. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91827. /**
  91828. * Gets the current list of velocity gradients.
  91829. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91830. * @returns the list of velocity gradients
  91831. */
  91832. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91833. /**
  91834. * Gets the current list of start size gradients.
  91835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91836. * @returns the list of start size gradients
  91837. */
  91838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91839. /**
  91840. * Gets the current list of emit rate gradients.
  91841. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91842. * @returns the list of emit rate gradients
  91843. */
  91844. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91845. /**
  91846. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91847. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91848. */
  91849. get direction1(): Vector3;
  91850. set direction1(value: Vector3);
  91851. /**
  91852. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91853. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91854. */
  91855. get direction2(): Vector3;
  91856. set direction2(value: Vector3);
  91857. /**
  91858. * 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.
  91859. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91860. */
  91861. get minEmitBox(): Vector3;
  91862. set minEmitBox(value: Vector3);
  91863. /**
  91864. * 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.
  91865. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91866. */
  91867. get maxEmitBox(): Vector3;
  91868. set maxEmitBox(value: Vector3);
  91869. /**
  91870. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91871. */
  91872. color1: Color4;
  91873. /**
  91874. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91875. */
  91876. color2: Color4;
  91877. /**
  91878. * Color the particle will have at the end of its lifetime
  91879. */
  91880. colorDead: Color4;
  91881. /**
  91882. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91883. */
  91884. textureMask: Color4;
  91885. /**
  91886. * The particle emitter type defines the emitter used by the particle system.
  91887. * It can be for example box, sphere, or cone...
  91888. */
  91889. particleEmitterType: IParticleEmitterType;
  91890. /** @hidden */
  91891. _isSubEmitter: boolean;
  91892. /**
  91893. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91894. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91895. */
  91896. billboardMode: number;
  91897. protected _isBillboardBased: boolean;
  91898. /**
  91899. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91900. */
  91901. get isBillboardBased(): boolean;
  91902. set isBillboardBased(value: boolean);
  91903. /**
  91904. * The scene the particle system belongs to.
  91905. */
  91906. protected _scene: Nullable<Scene>;
  91907. /**
  91908. * The engine the particle system belongs to.
  91909. */
  91910. protected _engine: ThinEngine;
  91911. /**
  91912. * Local cache of defines for image processing.
  91913. */
  91914. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91915. /**
  91916. * Default configuration related to image processing available in the standard Material.
  91917. */
  91918. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91919. /**
  91920. * Gets the image processing configuration used either in this material.
  91921. */
  91922. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91923. /**
  91924. * Sets the Default image processing configuration used either in the this material.
  91925. *
  91926. * If sets to null, the scene one is in use.
  91927. */
  91928. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91929. /**
  91930. * Attaches a new image processing configuration to the Standard Material.
  91931. * @param configuration
  91932. */
  91933. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91934. /** @hidden */
  91935. protected _reset(): void;
  91936. /** @hidden */
  91937. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91938. /**
  91939. * Instantiates a particle system.
  91940. * 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.
  91941. * @param name The name of the particle system
  91942. */
  91943. constructor(name: string);
  91944. /**
  91945. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91946. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91947. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91948. * @returns the emitter
  91949. */
  91950. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91951. /**
  91952. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91953. * @param radius The radius of the hemisphere to emit from
  91954. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91955. * @returns the emitter
  91956. */
  91957. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91958. /**
  91959. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91960. * @param radius The radius of the sphere to emit from
  91961. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91962. * @returns the emitter
  91963. */
  91964. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91965. /**
  91966. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91967. * @param radius The radius of the sphere to emit from
  91968. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91969. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91970. * @returns the emitter
  91971. */
  91972. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91973. /**
  91974. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91975. * @param radius The radius of the emission cylinder
  91976. * @param height The height of the emission cylinder
  91977. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91978. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91979. * @returns the emitter
  91980. */
  91981. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91982. /**
  91983. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91984. * @param radius The radius of the cylinder to emit from
  91985. * @param height The height of the emission cylinder
  91986. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91987. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91988. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91989. * @returns the emitter
  91990. */
  91991. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91992. /**
  91993. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91994. * @param radius The radius of the cone to emit from
  91995. * @param angle The base angle of the cone
  91996. * @returns the emitter
  91997. */
  91998. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91999. /**
  92000. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92001. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92002. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92003. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92004. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92005. * @returns the emitter
  92006. */
  92007. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92008. }
  92009. }
  92010. declare module BABYLON {
  92011. /**
  92012. * Type of sub emitter
  92013. */
  92014. export enum SubEmitterType {
  92015. /**
  92016. * Attached to the particle over it's lifetime
  92017. */
  92018. ATTACHED = 0,
  92019. /**
  92020. * Created when the particle dies
  92021. */
  92022. END = 1
  92023. }
  92024. /**
  92025. * Sub emitter class used to emit particles from an existing particle
  92026. */
  92027. export class SubEmitter {
  92028. /**
  92029. * the particle system to be used by the sub emitter
  92030. */
  92031. particleSystem: ParticleSystem;
  92032. /**
  92033. * Type of the submitter (Default: END)
  92034. */
  92035. type: SubEmitterType;
  92036. /**
  92037. * 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)
  92038. * Note: This only is supported when using an emitter of type Mesh
  92039. */
  92040. inheritDirection: boolean;
  92041. /**
  92042. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92043. */
  92044. inheritedVelocityAmount: number;
  92045. /**
  92046. * Creates a sub emitter
  92047. * @param particleSystem the particle system to be used by the sub emitter
  92048. */
  92049. constructor(
  92050. /**
  92051. * the particle system to be used by the sub emitter
  92052. */
  92053. particleSystem: ParticleSystem);
  92054. /**
  92055. * Clones the sub emitter
  92056. * @returns the cloned sub emitter
  92057. */
  92058. clone(): SubEmitter;
  92059. /**
  92060. * Serialize current object to a JSON object
  92061. * @returns the serialized object
  92062. */
  92063. serialize(): any;
  92064. /** @hidden */
  92065. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92066. /**
  92067. * Creates a new SubEmitter from a serialized JSON version
  92068. * @param serializationObject defines the JSON object to read from
  92069. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92070. * @param rootUrl defines the rootUrl for data loading
  92071. * @returns a new SubEmitter
  92072. */
  92073. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92074. /** Release associated resources */
  92075. dispose(): void;
  92076. }
  92077. }
  92078. declare module BABYLON {
  92079. /** @hidden */
  92080. export var imageProcessingDeclaration: {
  92081. name: string;
  92082. shader: string;
  92083. };
  92084. }
  92085. declare module BABYLON {
  92086. /** @hidden */
  92087. export var imageProcessingFunctions: {
  92088. name: string;
  92089. shader: string;
  92090. };
  92091. }
  92092. declare module BABYLON {
  92093. /** @hidden */
  92094. export var particlesPixelShader: {
  92095. name: string;
  92096. shader: string;
  92097. };
  92098. }
  92099. declare module BABYLON {
  92100. /** @hidden */
  92101. export var particlesVertexShader: {
  92102. name: string;
  92103. shader: string;
  92104. };
  92105. }
  92106. declare module BABYLON {
  92107. /**
  92108. * Interface used to define entities containing multiple clip planes
  92109. */
  92110. export interface IClipPlanesHolder {
  92111. /**
  92112. * Gets or sets the active clipplane 1
  92113. */
  92114. clipPlane: Nullable<Plane>;
  92115. /**
  92116. * Gets or sets the active clipplane 2
  92117. */
  92118. clipPlane2: Nullable<Plane>;
  92119. /**
  92120. * Gets or sets the active clipplane 3
  92121. */
  92122. clipPlane3: Nullable<Plane>;
  92123. /**
  92124. * Gets or sets the active clipplane 4
  92125. */
  92126. clipPlane4: Nullable<Plane>;
  92127. /**
  92128. * Gets or sets the active clipplane 5
  92129. */
  92130. clipPlane5: Nullable<Plane>;
  92131. /**
  92132. * Gets or sets the active clipplane 6
  92133. */
  92134. clipPlane6: Nullable<Plane>;
  92135. }
  92136. }
  92137. declare module BABYLON {
  92138. /**
  92139. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92140. *
  92141. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92142. *
  92143. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92144. */
  92145. export class ThinMaterialHelper {
  92146. /**
  92147. * Binds the clip plane information from the holder to the effect.
  92148. * @param effect The effect we are binding the data to
  92149. * @param holder The entity containing the clip plane information
  92150. */
  92151. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92152. }
  92153. }
  92154. declare module BABYLON {
  92155. interface ThinEngine {
  92156. /**
  92157. * Sets alpha constants used by some alpha blending modes
  92158. * @param r defines the red component
  92159. * @param g defines the green component
  92160. * @param b defines the blue component
  92161. * @param a defines the alpha component
  92162. */
  92163. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92164. /**
  92165. * Sets the current alpha mode
  92166. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92167. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92168. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92169. */
  92170. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92171. /**
  92172. * Gets the current alpha mode
  92173. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92174. * @returns the current alpha mode
  92175. */
  92176. getAlphaMode(): number;
  92177. /**
  92178. * Sets the current alpha equation
  92179. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92180. */
  92181. setAlphaEquation(equation: number): void;
  92182. /**
  92183. * Gets the current alpha equation.
  92184. * @returns the current alpha equation
  92185. */
  92186. getAlphaEquation(): number;
  92187. }
  92188. }
  92189. declare module BABYLON {
  92190. /**
  92191. * This represents a particle system in Babylon.
  92192. * 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.
  92193. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92194. * @example https://doc.babylonjs.com/babylon101/particles
  92195. */
  92196. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92197. /**
  92198. * Billboard mode will only apply to Y axis
  92199. */
  92200. static readonly BILLBOARDMODE_Y: number;
  92201. /**
  92202. * Billboard mode will apply to all axes
  92203. */
  92204. static readonly BILLBOARDMODE_ALL: number;
  92205. /**
  92206. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92207. */
  92208. static readonly BILLBOARDMODE_STRETCHED: number;
  92209. /**
  92210. * This function can be defined to provide custom update for active particles.
  92211. * This function will be called instead of regular update (age, position, color, etc.).
  92212. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92213. */
  92214. updateFunction: (particles: Particle[]) => void;
  92215. private _emitterWorldMatrix;
  92216. /**
  92217. * This function can be defined to specify initial direction for every new particle.
  92218. * It by default use the emitterType defined function
  92219. */
  92220. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92221. /**
  92222. * This function can be defined to specify initial position for every new particle.
  92223. * It by default use the emitterType defined function
  92224. */
  92225. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92226. /**
  92227. * @hidden
  92228. */
  92229. _inheritedVelocityOffset: Vector3;
  92230. /**
  92231. * An event triggered when the system is disposed
  92232. */
  92233. onDisposeObservable: Observable<IParticleSystem>;
  92234. private _onDisposeObserver;
  92235. /**
  92236. * Sets a callback that will be triggered when the system is disposed
  92237. */
  92238. set onDispose(callback: () => void);
  92239. private _particles;
  92240. private _epsilon;
  92241. private _capacity;
  92242. private _stockParticles;
  92243. private _newPartsExcess;
  92244. private _vertexData;
  92245. private _vertexBuffer;
  92246. private _vertexBuffers;
  92247. private _spriteBuffer;
  92248. private _indexBuffer;
  92249. private _effect;
  92250. private _customEffect;
  92251. private _cachedDefines;
  92252. private _scaledColorStep;
  92253. private _colorDiff;
  92254. private _scaledDirection;
  92255. private _scaledGravity;
  92256. private _currentRenderId;
  92257. private _alive;
  92258. private _useInstancing;
  92259. private _started;
  92260. private _stopped;
  92261. private _actualFrame;
  92262. private _scaledUpdateSpeed;
  92263. private _vertexBufferSize;
  92264. /** @hidden */
  92265. _currentEmitRateGradient: Nullable<FactorGradient>;
  92266. /** @hidden */
  92267. _currentEmitRate1: number;
  92268. /** @hidden */
  92269. _currentEmitRate2: number;
  92270. /** @hidden */
  92271. _currentStartSizeGradient: Nullable<FactorGradient>;
  92272. /** @hidden */
  92273. _currentStartSize1: number;
  92274. /** @hidden */
  92275. _currentStartSize2: number;
  92276. private readonly _rawTextureWidth;
  92277. private _rampGradientsTexture;
  92278. private _useRampGradients;
  92279. /** Gets or sets a matrix to use to compute projection */
  92280. defaultProjectionMatrix: Matrix;
  92281. /** Gets or sets a matrix to use to compute view */
  92282. defaultViewMatrix: Matrix;
  92283. /** Gets or sets a boolean indicating that ramp gradients must be used
  92284. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92285. */
  92286. get useRampGradients(): boolean;
  92287. set useRampGradients(value: boolean);
  92288. /**
  92289. * 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.
  92290. * 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: [])
  92291. */
  92292. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92293. private _subEmitters;
  92294. /**
  92295. * @hidden
  92296. * If the particle systems emitter should be disposed when the particle system is disposed
  92297. */
  92298. _disposeEmitterOnDispose: boolean;
  92299. /**
  92300. * The current active Sub-systems, this property is used by the root particle system only.
  92301. */
  92302. activeSubSystems: Array<ParticleSystem>;
  92303. /**
  92304. * Specifies if the particles are updated in emitter local space or world space
  92305. */
  92306. isLocal: boolean;
  92307. private _rootParticleSystem;
  92308. /**
  92309. * Gets the current list of active particles
  92310. */
  92311. get particles(): Particle[];
  92312. /**
  92313. * Gets the number of particles active at the same time.
  92314. * @returns The number of active particles.
  92315. */
  92316. getActiveCount(): number;
  92317. /**
  92318. * Returns the string "ParticleSystem"
  92319. * @returns a string containing the class name
  92320. */
  92321. getClassName(): string;
  92322. /**
  92323. * Gets a boolean indicating that the system is stopping
  92324. * @returns true if the system is currently stopping
  92325. */
  92326. isStopping(): boolean;
  92327. /**
  92328. * Gets the custom effect used to render the particles
  92329. * @param blendMode Blend mode for which the effect should be retrieved
  92330. * @returns The effect
  92331. */
  92332. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92333. /**
  92334. * Sets the custom effect used to render the particles
  92335. * @param effect The effect to set
  92336. * @param blendMode Blend mode for which the effect should be set
  92337. */
  92338. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92339. /** @hidden */
  92340. private _onBeforeDrawParticlesObservable;
  92341. /**
  92342. * Observable that will be called just before the particles are drawn
  92343. */
  92344. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92345. /**
  92346. * Gets the name of the particle vertex shader
  92347. */
  92348. get vertexShaderName(): string;
  92349. /**
  92350. * Instantiates a particle system.
  92351. * 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.
  92352. * @param name The name of the particle system
  92353. * @param capacity The max number of particles alive at the same time
  92354. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92355. * @param customEffect a custom effect used to change the way particles are rendered by default
  92356. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92357. * @param epsilon Offset used to render the particles
  92358. */
  92359. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92360. private _addFactorGradient;
  92361. private _removeFactorGradient;
  92362. /**
  92363. * Adds a new life time gradient
  92364. * @param gradient defines the gradient to use (between 0 and 1)
  92365. * @param factor defines the life time factor to affect to the specified gradient
  92366. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92367. * @returns the current particle system
  92368. */
  92369. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92370. /**
  92371. * Remove a specific life time gradient
  92372. * @param gradient defines the gradient to remove
  92373. * @returns the current particle system
  92374. */
  92375. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92376. /**
  92377. * Adds a new size gradient
  92378. * @param gradient defines the gradient to use (between 0 and 1)
  92379. * @param factor defines the size factor to affect to the specified gradient
  92380. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92381. * @returns the current particle system
  92382. */
  92383. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92384. /**
  92385. * Remove a specific size gradient
  92386. * @param gradient defines the gradient to remove
  92387. * @returns the current particle system
  92388. */
  92389. removeSizeGradient(gradient: number): IParticleSystem;
  92390. /**
  92391. * Adds a new color remap gradient
  92392. * @param gradient defines the gradient to use (between 0 and 1)
  92393. * @param min defines the color remap minimal range
  92394. * @param max defines the color remap maximal range
  92395. * @returns the current particle system
  92396. */
  92397. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92398. /**
  92399. * Remove a specific color remap gradient
  92400. * @param gradient defines the gradient to remove
  92401. * @returns the current particle system
  92402. */
  92403. removeColorRemapGradient(gradient: number): IParticleSystem;
  92404. /**
  92405. * Adds a new alpha remap gradient
  92406. * @param gradient defines the gradient to use (between 0 and 1)
  92407. * @param min defines the alpha remap minimal range
  92408. * @param max defines the alpha remap maximal range
  92409. * @returns the current particle system
  92410. */
  92411. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92412. /**
  92413. * Remove a specific alpha remap gradient
  92414. * @param gradient defines the gradient to remove
  92415. * @returns the current particle system
  92416. */
  92417. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92418. /**
  92419. * Adds a new angular speed gradient
  92420. * @param gradient defines the gradient to use (between 0 and 1)
  92421. * @param factor defines the angular speed to affect to the specified gradient
  92422. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92423. * @returns the current particle system
  92424. */
  92425. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92426. /**
  92427. * Remove a specific angular speed gradient
  92428. * @param gradient defines the gradient to remove
  92429. * @returns the current particle system
  92430. */
  92431. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92432. /**
  92433. * Adds a new velocity gradient
  92434. * @param gradient defines the gradient to use (between 0 and 1)
  92435. * @param factor defines the velocity to affect to the specified gradient
  92436. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92437. * @returns the current particle system
  92438. */
  92439. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92440. /**
  92441. * Remove a specific velocity gradient
  92442. * @param gradient defines the gradient to remove
  92443. * @returns the current particle system
  92444. */
  92445. removeVelocityGradient(gradient: number): IParticleSystem;
  92446. /**
  92447. * Adds a new limit velocity gradient
  92448. * @param gradient defines the gradient to use (between 0 and 1)
  92449. * @param factor defines the limit velocity value to affect to the specified gradient
  92450. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92451. * @returns the current particle system
  92452. */
  92453. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92454. /**
  92455. * Remove a specific limit velocity gradient
  92456. * @param gradient defines the gradient to remove
  92457. * @returns the current particle system
  92458. */
  92459. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92460. /**
  92461. * Adds a new drag gradient
  92462. * @param gradient defines the gradient to use (between 0 and 1)
  92463. * @param factor defines the drag value to affect to the specified gradient
  92464. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92465. * @returns the current particle system
  92466. */
  92467. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92468. /**
  92469. * Remove a specific drag gradient
  92470. * @param gradient defines the gradient to remove
  92471. * @returns the current particle system
  92472. */
  92473. removeDragGradient(gradient: number): IParticleSystem;
  92474. /**
  92475. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92476. * @param gradient defines the gradient to use (between 0 and 1)
  92477. * @param factor defines the emit rate value to affect to the specified gradient
  92478. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92479. * @returns the current particle system
  92480. */
  92481. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92482. /**
  92483. * Remove a specific emit rate gradient
  92484. * @param gradient defines the gradient to remove
  92485. * @returns the current particle system
  92486. */
  92487. removeEmitRateGradient(gradient: number): IParticleSystem;
  92488. /**
  92489. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92490. * @param gradient defines the gradient to use (between 0 and 1)
  92491. * @param factor defines the start size value to affect to the specified gradient
  92492. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92493. * @returns the current particle system
  92494. */
  92495. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92496. /**
  92497. * Remove a specific start size gradient
  92498. * @param gradient defines the gradient to remove
  92499. * @returns the current particle system
  92500. */
  92501. removeStartSizeGradient(gradient: number): IParticleSystem;
  92502. private _createRampGradientTexture;
  92503. /**
  92504. * Gets the current list of ramp gradients.
  92505. * You must use addRampGradient and removeRampGradient to udpate this list
  92506. * @returns the list of ramp gradients
  92507. */
  92508. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92509. /** Force the system to rebuild all gradients that need to be resync */
  92510. forceRefreshGradients(): void;
  92511. private _syncRampGradientTexture;
  92512. /**
  92513. * Adds a new ramp gradient used to remap particle colors
  92514. * @param gradient defines the gradient to use (between 0 and 1)
  92515. * @param color defines the color to affect to the specified gradient
  92516. * @returns the current particle system
  92517. */
  92518. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92519. /**
  92520. * Remove a specific ramp gradient
  92521. * @param gradient defines the gradient to remove
  92522. * @returns the current particle system
  92523. */
  92524. removeRampGradient(gradient: number): ParticleSystem;
  92525. /**
  92526. * Adds a new color gradient
  92527. * @param gradient defines the gradient to use (between 0 and 1)
  92528. * @param color1 defines the color to affect to the specified gradient
  92529. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92530. * @returns this particle system
  92531. */
  92532. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92533. /**
  92534. * Remove a specific color gradient
  92535. * @param gradient defines the gradient to remove
  92536. * @returns this particle system
  92537. */
  92538. removeColorGradient(gradient: number): IParticleSystem;
  92539. private _fetchR;
  92540. protected _reset(): void;
  92541. private _resetEffect;
  92542. private _createVertexBuffers;
  92543. private _createIndexBuffer;
  92544. /**
  92545. * Gets the maximum number of particles active at the same time.
  92546. * @returns The max number of active particles.
  92547. */
  92548. getCapacity(): number;
  92549. /**
  92550. * Gets whether there are still active particles in the system.
  92551. * @returns True if it is alive, otherwise false.
  92552. */
  92553. isAlive(): boolean;
  92554. /**
  92555. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92556. * @returns True if it has been started, otherwise false.
  92557. */
  92558. isStarted(): boolean;
  92559. private _prepareSubEmitterInternalArray;
  92560. /**
  92561. * Starts the particle system and begins to emit
  92562. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92563. */
  92564. start(delay?: number): void;
  92565. /**
  92566. * Stops the particle system.
  92567. * @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.
  92568. */
  92569. stop(stopSubEmitters?: boolean): void;
  92570. /**
  92571. * Remove all active particles
  92572. */
  92573. reset(): void;
  92574. /**
  92575. * @hidden (for internal use only)
  92576. */
  92577. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92578. /**
  92579. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92580. * Its lifetime will start back at 0.
  92581. */
  92582. recycleParticle: (particle: Particle) => void;
  92583. private _stopSubEmitters;
  92584. private _createParticle;
  92585. private _removeFromRoot;
  92586. private _emitFromParticle;
  92587. private _update;
  92588. /** @hidden */
  92589. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92590. /** @hidden */
  92591. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92592. /**
  92593. * Fill the defines array according to the current settings of the particle system
  92594. * @param defines Array to be updated
  92595. * @param blendMode blend mode to take into account when updating the array
  92596. */
  92597. fillDefines(defines: Array<string>, blendMode: number): void;
  92598. /**
  92599. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92600. * @param uniforms Uniforms array to fill
  92601. * @param attributes Attributes array to fill
  92602. * @param samplers Samplers array to fill
  92603. */
  92604. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92605. /** @hidden */
  92606. private _getEffect;
  92607. /**
  92608. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92609. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92610. */
  92611. animate(preWarmOnly?: boolean): void;
  92612. private _appendParticleVertices;
  92613. /**
  92614. * Rebuilds the particle system.
  92615. */
  92616. rebuild(): void;
  92617. /**
  92618. * Is this system ready to be used/rendered
  92619. * @return true if the system is ready
  92620. */
  92621. isReady(): boolean;
  92622. private _render;
  92623. /**
  92624. * Renders the particle system in its current state.
  92625. * @returns the current number of particles
  92626. */
  92627. render(): number;
  92628. /**
  92629. * Disposes the particle system and free the associated resources
  92630. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92631. */
  92632. dispose(disposeTexture?: boolean): void;
  92633. /**
  92634. * Clones the particle system.
  92635. * @param name The name of the cloned object
  92636. * @param newEmitter The new emitter to use
  92637. * @returns the cloned particle system
  92638. */
  92639. clone(name: string, newEmitter: any): ParticleSystem;
  92640. /**
  92641. * Serializes the particle system to a JSON object
  92642. * @param serializeTexture defines if the texture must be serialized as well
  92643. * @returns the JSON object
  92644. */
  92645. serialize(serializeTexture?: boolean): any;
  92646. /** @hidden */
  92647. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92648. /** @hidden */
  92649. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92650. /**
  92651. * Parses a JSON object to create a particle system.
  92652. * @param parsedParticleSystem The JSON object to parse
  92653. * @param sceneOrEngine The scene or the engine to create the particle system in
  92654. * @param rootUrl The root url to use to load external dependencies like texture
  92655. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92656. * @returns the Parsed particle system
  92657. */
  92658. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92659. }
  92660. }
  92661. declare module BABYLON {
  92662. /**
  92663. * A particle represents one of the element emitted by a particle system.
  92664. * This is mainly define by its coordinates, direction, velocity and age.
  92665. */
  92666. export class Particle {
  92667. /**
  92668. * The particle system the particle belongs to.
  92669. */
  92670. particleSystem: ParticleSystem;
  92671. private static _Count;
  92672. /**
  92673. * Unique ID of the particle
  92674. */
  92675. id: number;
  92676. /**
  92677. * The world position of the particle in the scene.
  92678. */
  92679. position: Vector3;
  92680. /**
  92681. * The world direction of the particle in the scene.
  92682. */
  92683. direction: Vector3;
  92684. /**
  92685. * The color of the particle.
  92686. */
  92687. color: Color4;
  92688. /**
  92689. * The color change of the particle per step.
  92690. */
  92691. colorStep: Color4;
  92692. /**
  92693. * Defines how long will the life of the particle be.
  92694. */
  92695. lifeTime: number;
  92696. /**
  92697. * The current age of the particle.
  92698. */
  92699. age: number;
  92700. /**
  92701. * The current size of the particle.
  92702. */
  92703. size: number;
  92704. /**
  92705. * The current scale of the particle.
  92706. */
  92707. scale: Vector2;
  92708. /**
  92709. * The current angle of the particle.
  92710. */
  92711. angle: number;
  92712. /**
  92713. * Defines how fast is the angle changing.
  92714. */
  92715. angularSpeed: number;
  92716. /**
  92717. * Defines the cell index used by the particle to be rendered from a sprite.
  92718. */
  92719. cellIndex: number;
  92720. /**
  92721. * The information required to support color remapping
  92722. */
  92723. remapData: Vector4;
  92724. /** @hidden */
  92725. _randomCellOffset?: number;
  92726. /** @hidden */
  92727. _initialDirection: Nullable<Vector3>;
  92728. /** @hidden */
  92729. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92730. /** @hidden */
  92731. _initialStartSpriteCellID: number;
  92732. /** @hidden */
  92733. _initialEndSpriteCellID: number;
  92734. /** @hidden */
  92735. _currentColorGradient: Nullable<ColorGradient>;
  92736. /** @hidden */
  92737. _currentColor1: Color4;
  92738. /** @hidden */
  92739. _currentColor2: Color4;
  92740. /** @hidden */
  92741. _currentSizeGradient: Nullable<FactorGradient>;
  92742. /** @hidden */
  92743. _currentSize1: number;
  92744. /** @hidden */
  92745. _currentSize2: number;
  92746. /** @hidden */
  92747. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92748. /** @hidden */
  92749. _currentAngularSpeed1: number;
  92750. /** @hidden */
  92751. _currentAngularSpeed2: number;
  92752. /** @hidden */
  92753. _currentVelocityGradient: Nullable<FactorGradient>;
  92754. /** @hidden */
  92755. _currentVelocity1: number;
  92756. /** @hidden */
  92757. _currentVelocity2: number;
  92758. /** @hidden */
  92759. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92760. /** @hidden */
  92761. _currentLimitVelocity1: number;
  92762. /** @hidden */
  92763. _currentLimitVelocity2: number;
  92764. /** @hidden */
  92765. _currentDragGradient: Nullable<FactorGradient>;
  92766. /** @hidden */
  92767. _currentDrag1: number;
  92768. /** @hidden */
  92769. _currentDrag2: number;
  92770. /** @hidden */
  92771. _randomNoiseCoordinates1: Vector3;
  92772. /** @hidden */
  92773. _randomNoiseCoordinates2: Vector3;
  92774. /** @hidden */
  92775. _localPosition?: Vector3;
  92776. /**
  92777. * Creates a new instance Particle
  92778. * @param particleSystem the particle system the particle belongs to
  92779. */
  92780. constructor(
  92781. /**
  92782. * The particle system the particle belongs to.
  92783. */
  92784. particleSystem: ParticleSystem);
  92785. private updateCellInfoFromSystem;
  92786. /**
  92787. * Defines how the sprite cell index is updated for the particle
  92788. */
  92789. updateCellIndex(): void;
  92790. /** @hidden */
  92791. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92792. /** @hidden */
  92793. _inheritParticleInfoToSubEmitters(): void;
  92794. /** @hidden */
  92795. _reset(): void;
  92796. /**
  92797. * Copy the properties of particle to another one.
  92798. * @param other the particle to copy the information to.
  92799. */
  92800. copyTo(other: Particle): void;
  92801. }
  92802. }
  92803. declare module BABYLON {
  92804. /**
  92805. * Particle emitter represents a volume emitting particles.
  92806. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92807. */
  92808. export interface IParticleEmitterType {
  92809. /**
  92810. * Called by the particle System when the direction is computed for the created particle.
  92811. * @param worldMatrix is the world matrix of the particle system
  92812. * @param directionToUpdate is the direction vector to update with the result
  92813. * @param particle is the particle we are computed the direction for
  92814. * @param isLocal defines if the direction should be set in local space
  92815. */
  92816. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92817. /**
  92818. * Called by the particle System when the position is computed for the created particle.
  92819. * @param worldMatrix is the world matrix of the particle system
  92820. * @param positionToUpdate is the position vector to update with the result
  92821. * @param particle is the particle we are computed the position for
  92822. * @param isLocal defines if the position should be set in local space
  92823. */
  92824. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92825. /**
  92826. * Clones the current emitter and returns a copy of it
  92827. * @returns the new emitter
  92828. */
  92829. clone(): IParticleEmitterType;
  92830. /**
  92831. * Called by the GPUParticleSystem to setup the update shader
  92832. * @param effect defines the update shader
  92833. */
  92834. applyToShader(effect: Effect): void;
  92835. /**
  92836. * Returns a string to use to update the GPU particles update shader
  92837. * @returns the effect defines string
  92838. */
  92839. getEffectDefines(): string;
  92840. /**
  92841. * Returns a string representing the class name
  92842. * @returns a string containing the class name
  92843. */
  92844. getClassName(): string;
  92845. /**
  92846. * Serializes the particle system to a JSON object.
  92847. * @returns the JSON object
  92848. */
  92849. serialize(): any;
  92850. /**
  92851. * Parse properties from a JSON object
  92852. * @param serializationObject defines the JSON object
  92853. * @param scene defines the hosting scene
  92854. */
  92855. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92856. }
  92857. }
  92858. declare module BABYLON {
  92859. /**
  92860. * Particle emitter emitting particles from the inside of a box.
  92861. * It emits the particles randomly between 2 given directions.
  92862. */
  92863. export class BoxParticleEmitter implements IParticleEmitterType {
  92864. /**
  92865. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92866. */
  92867. direction1: Vector3;
  92868. /**
  92869. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92870. */
  92871. direction2: Vector3;
  92872. /**
  92873. * 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.
  92874. */
  92875. minEmitBox: Vector3;
  92876. /**
  92877. * 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.
  92878. */
  92879. maxEmitBox: Vector3;
  92880. /**
  92881. * Creates a new instance BoxParticleEmitter
  92882. */
  92883. constructor();
  92884. /**
  92885. * Called by the particle System when the direction is computed for the created particle.
  92886. * @param worldMatrix is the world matrix of the particle system
  92887. * @param directionToUpdate is the direction vector to update with the result
  92888. * @param particle is the particle we are computed the direction for
  92889. * @param isLocal defines if the direction should be set in local space
  92890. */
  92891. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92892. /**
  92893. * Called by the particle System when the position is computed for the created particle.
  92894. * @param worldMatrix is the world matrix of the particle system
  92895. * @param positionToUpdate is the position vector to update with the result
  92896. * @param particle is the particle we are computed the position for
  92897. * @param isLocal defines if the position should be set in local space
  92898. */
  92899. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92900. /**
  92901. * Clones the current emitter and returns a copy of it
  92902. * @returns the new emitter
  92903. */
  92904. clone(): BoxParticleEmitter;
  92905. /**
  92906. * Called by the GPUParticleSystem to setup the update shader
  92907. * @param effect defines the update shader
  92908. */
  92909. applyToShader(effect: Effect): void;
  92910. /**
  92911. * Returns a string to use to update the GPU particles update shader
  92912. * @returns a string containng the defines string
  92913. */
  92914. getEffectDefines(): string;
  92915. /**
  92916. * Returns the string "BoxParticleEmitter"
  92917. * @returns a string containing the class name
  92918. */
  92919. getClassName(): string;
  92920. /**
  92921. * Serializes the particle system to a JSON object.
  92922. * @returns the JSON object
  92923. */
  92924. serialize(): any;
  92925. /**
  92926. * Parse properties from a JSON object
  92927. * @param serializationObject defines the JSON object
  92928. */
  92929. parse(serializationObject: any): void;
  92930. }
  92931. }
  92932. declare module BABYLON {
  92933. /**
  92934. * Particle emitter emitting particles from the inside of a cone.
  92935. * It emits the particles alongside the cone volume from the base to the particle.
  92936. * The emission direction might be randomized.
  92937. */
  92938. export class ConeParticleEmitter implements IParticleEmitterType {
  92939. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92940. directionRandomizer: number;
  92941. private _radius;
  92942. private _angle;
  92943. private _height;
  92944. /**
  92945. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92946. */
  92947. radiusRange: number;
  92948. /**
  92949. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92950. */
  92951. heightRange: number;
  92952. /**
  92953. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92954. */
  92955. emitFromSpawnPointOnly: boolean;
  92956. /**
  92957. * Gets or sets the radius of the emission cone
  92958. */
  92959. get radius(): number;
  92960. set radius(value: number);
  92961. /**
  92962. * Gets or sets the angle of the emission cone
  92963. */
  92964. get angle(): number;
  92965. set angle(value: number);
  92966. private _buildHeight;
  92967. /**
  92968. * Creates a new instance ConeParticleEmitter
  92969. * @param radius the radius of the emission cone (1 by default)
  92970. * @param angle the cone base angle (PI by default)
  92971. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92972. */
  92973. constructor(radius?: number, angle?: number,
  92974. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92975. directionRandomizer?: number);
  92976. /**
  92977. * Called by the particle System when the direction is computed for the created particle.
  92978. * @param worldMatrix is the world matrix of the particle system
  92979. * @param directionToUpdate is the direction vector to update with the result
  92980. * @param particle is the particle we are computed the direction for
  92981. * @param isLocal defines if the direction should be set in local space
  92982. */
  92983. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92984. /**
  92985. * Called by the particle System when the position is computed for the created particle.
  92986. * @param worldMatrix is the world matrix of the particle system
  92987. * @param positionToUpdate is the position vector to update with the result
  92988. * @param particle is the particle we are computed the position for
  92989. * @param isLocal defines if the position should be set in local space
  92990. */
  92991. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92992. /**
  92993. * Clones the current emitter and returns a copy of it
  92994. * @returns the new emitter
  92995. */
  92996. clone(): ConeParticleEmitter;
  92997. /**
  92998. * Called by the GPUParticleSystem to setup the update shader
  92999. * @param effect defines the update shader
  93000. */
  93001. applyToShader(effect: Effect): void;
  93002. /**
  93003. * Returns a string to use to update the GPU particles update shader
  93004. * @returns a string containng the defines string
  93005. */
  93006. getEffectDefines(): string;
  93007. /**
  93008. * Returns the string "ConeParticleEmitter"
  93009. * @returns a string containing the class name
  93010. */
  93011. getClassName(): string;
  93012. /**
  93013. * Serializes the particle system to a JSON object.
  93014. * @returns the JSON object
  93015. */
  93016. serialize(): any;
  93017. /**
  93018. * Parse properties from a JSON object
  93019. * @param serializationObject defines the JSON object
  93020. */
  93021. parse(serializationObject: any): void;
  93022. }
  93023. }
  93024. declare module BABYLON {
  93025. /**
  93026. * Particle emitter emitting particles from the inside of a cylinder.
  93027. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93028. */
  93029. export class CylinderParticleEmitter implements IParticleEmitterType {
  93030. /**
  93031. * The radius of the emission cylinder.
  93032. */
  93033. radius: number;
  93034. /**
  93035. * The height of the emission cylinder.
  93036. */
  93037. height: number;
  93038. /**
  93039. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93040. */
  93041. radiusRange: number;
  93042. /**
  93043. * How much to randomize the particle direction [0-1].
  93044. */
  93045. directionRandomizer: number;
  93046. /**
  93047. * Creates a new instance CylinderParticleEmitter
  93048. * @param radius the radius of the emission cylinder (1 by default)
  93049. * @param height the height of the emission cylinder (1 by default)
  93050. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93051. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93052. */
  93053. constructor(
  93054. /**
  93055. * The radius of the emission cylinder.
  93056. */
  93057. radius?: number,
  93058. /**
  93059. * The height of the emission cylinder.
  93060. */
  93061. height?: number,
  93062. /**
  93063. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93064. */
  93065. radiusRange?: number,
  93066. /**
  93067. * How much to randomize the particle direction [0-1].
  93068. */
  93069. directionRandomizer?: number);
  93070. /**
  93071. * Called by the particle System when the direction is computed for the created particle.
  93072. * @param worldMatrix is the world matrix of the particle system
  93073. * @param directionToUpdate is the direction vector to update with the result
  93074. * @param particle is the particle we are computed the direction for
  93075. * @param isLocal defines if the direction should be set in local space
  93076. */
  93077. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93078. /**
  93079. * Called by the particle System when the position is computed for the created particle.
  93080. * @param worldMatrix is the world matrix of the particle system
  93081. * @param positionToUpdate is the position vector to update with the result
  93082. * @param particle is the particle we are computed the position for
  93083. * @param isLocal defines if the position should be set in local space
  93084. */
  93085. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93086. /**
  93087. * Clones the current emitter and returns a copy of it
  93088. * @returns the new emitter
  93089. */
  93090. clone(): CylinderParticleEmitter;
  93091. /**
  93092. * Called by the GPUParticleSystem to setup the update shader
  93093. * @param effect defines the update shader
  93094. */
  93095. applyToShader(effect: Effect): void;
  93096. /**
  93097. * Returns a string to use to update the GPU particles update shader
  93098. * @returns a string containng the defines string
  93099. */
  93100. getEffectDefines(): string;
  93101. /**
  93102. * Returns the string "CylinderParticleEmitter"
  93103. * @returns a string containing the class name
  93104. */
  93105. getClassName(): string;
  93106. /**
  93107. * Serializes the particle system to a JSON object.
  93108. * @returns the JSON object
  93109. */
  93110. serialize(): any;
  93111. /**
  93112. * Parse properties from a JSON object
  93113. * @param serializationObject defines the JSON object
  93114. */
  93115. parse(serializationObject: any): void;
  93116. }
  93117. /**
  93118. * Particle emitter emitting particles from the inside of a cylinder.
  93119. * It emits the particles randomly between two vectors.
  93120. */
  93121. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93122. /**
  93123. * The min limit of the emission direction.
  93124. */
  93125. direction1: Vector3;
  93126. /**
  93127. * The max limit of the emission direction.
  93128. */
  93129. direction2: Vector3;
  93130. /**
  93131. * Creates a new instance CylinderDirectedParticleEmitter
  93132. * @param radius the radius of the emission cylinder (1 by default)
  93133. * @param height the height of the emission cylinder (1 by default)
  93134. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93135. * @param direction1 the min limit of the emission direction (up vector by default)
  93136. * @param direction2 the max limit of the emission direction (up vector by default)
  93137. */
  93138. constructor(radius?: number, height?: number, radiusRange?: number,
  93139. /**
  93140. * The min limit of the emission direction.
  93141. */
  93142. direction1?: Vector3,
  93143. /**
  93144. * The max limit of the emission direction.
  93145. */
  93146. direction2?: Vector3);
  93147. /**
  93148. * Called by the particle System when the direction is computed for the created particle.
  93149. * @param worldMatrix is the world matrix of the particle system
  93150. * @param directionToUpdate is the direction vector to update with the result
  93151. * @param particle is the particle we are computed the direction for
  93152. */
  93153. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93154. /**
  93155. * Clones the current emitter and returns a copy of it
  93156. * @returns the new emitter
  93157. */
  93158. clone(): CylinderDirectedParticleEmitter;
  93159. /**
  93160. * Called by the GPUParticleSystem to setup the update shader
  93161. * @param effect defines the update shader
  93162. */
  93163. applyToShader(effect: Effect): void;
  93164. /**
  93165. * Returns a string to use to update the GPU particles update shader
  93166. * @returns a string containng the defines string
  93167. */
  93168. getEffectDefines(): string;
  93169. /**
  93170. * Returns the string "CylinderDirectedParticleEmitter"
  93171. * @returns a string containing the class name
  93172. */
  93173. getClassName(): string;
  93174. /**
  93175. * Serializes the particle system to a JSON object.
  93176. * @returns the JSON object
  93177. */
  93178. serialize(): any;
  93179. /**
  93180. * Parse properties from a JSON object
  93181. * @param serializationObject defines the JSON object
  93182. */
  93183. parse(serializationObject: any): void;
  93184. }
  93185. }
  93186. declare module BABYLON {
  93187. /**
  93188. * Particle emitter emitting particles from the inside of a hemisphere.
  93189. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93190. */
  93191. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93192. /**
  93193. * The radius of the emission hemisphere.
  93194. */
  93195. radius: number;
  93196. /**
  93197. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93198. */
  93199. radiusRange: number;
  93200. /**
  93201. * How much to randomize the particle direction [0-1].
  93202. */
  93203. directionRandomizer: number;
  93204. /**
  93205. * Creates a new instance HemisphericParticleEmitter
  93206. * @param radius the radius of the emission hemisphere (1 by default)
  93207. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93208. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93209. */
  93210. constructor(
  93211. /**
  93212. * The radius of the emission hemisphere.
  93213. */
  93214. radius?: number,
  93215. /**
  93216. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93217. */
  93218. radiusRange?: number,
  93219. /**
  93220. * How much to randomize the particle direction [0-1].
  93221. */
  93222. directionRandomizer?: number);
  93223. /**
  93224. * Called by the particle System when the direction is computed for the created particle.
  93225. * @param worldMatrix is the world matrix of the particle system
  93226. * @param directionToUpdate is the direction vector to update with the result
  93227. * @param particle is the particle we are computed the direction for
  93228. * @param isLocal defines if the direction should be set in local space
  93229. */
  93230. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93231. /**
  93232. * Called by the particle System when the position is computed for the created particle.
  93233. * @param worldMatrix is the world matrix of the particle system
  93234. * @param positionToUpdate is the position vector to update with the result
  93235. * @param particle is the particle we are computed the position for
  93236. * @param isLocal defines if the position should be set in local space
  93237. */
  93238. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93239. /**
  93240. * Clones the current emitter and returns a copy of it
  93241. * @returns the new emitter
  93242. */
  93243. clone(): HemisphericParticleEmitter;
  93244. /**
  93245. * Called by the GPUParticleSystem to setup the update shader
  93246. * @param effect defines the update shader
  93247. */
  93248. applyToShader(effect: Effect): void;
  93249. /**
  93250. * Returns a string to use to update the GPU particles update shader
  93251. * @returns a string containng the defines string
  93252. */
  93253. getEffectDefines(): string;
  93254. /**
  93255. * Returns the string "HemisphericParticleEmitter"
  93256. * @returns a string containing the class name
  93257. */
  93258. getClassName(): string;
  93259. /**
  93260. * Serializes the particle system to a JSON object.
  93261. * @returns the JSON object
  93262. */
  93263. serialize(): any;
  93264. /**
  93265. * Parse properties from a JSON object
  93266. * @param serializationObject defines the JSON object
  93267. */
  93268. parse(serializationObject: any): void;
  93269. }
  93270. }
  93271. declare module BABYLON {
  93272. /**
  93273. * Particle emitter emitting particles from a point.
  93274. * It emits the particles randomly between 2 given directions.
  93275. */
  93276. export class PointParticleEmitter implements IParticleEmitterType {
  93277. /**
  93278. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93279. */
  93280. direction1: Vector3;
  93281. /**
  93282. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93283. */
  93284. direction2: Vector3;
  93285. /**
  93286. * Creates a new instance PointParticleEmitter
  93287. */
  93288. constructor();
  93289. /**
  93290. * Called by the particle System when the direction is computed for the created particle.
  93291. * @param worldMatrix is the world matrix of the particle system
  93292. * @param directionToUpdate is the direction vector to update with the result
  93293. * @param particle is the particle we are computed the direction for
  93294. * @param isLocal defines if the direction should be set in local space
  93295. */
  93296. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93297. /**
  93298. * Called by the particle System when the position is computed for the created particle.
  93299. * @param worldMatrix is the world matrix of the particle system
  93300. * @param positionToUpdate is the position vector to update with the result
  93301. * @param particle is the particle we are computed the position for
  93302. * @param isLocal defines if the position should be set in local space
  93303. */
  93304. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93305. /**
  93306. * Clones the current emitter and returns a copy of it
  93307. * @returns the new emitter
  93308. */
  93309. clone(): PointParticleEmitter;
  93310. /**
  93311. * Called by the GPUParticleSystem to setup the update shader
  93312. * @param effect defines the update shader
  93313. */
  93314. applyToShader(effect: Effect): void;
  93315. /**
  93316. * Returns a string to use to update the GPU particles update shader
  93317. * @returns a string containng the defines string
  93318. */
  93319. getEffectDefines(): string;
  93320. /**
  93321. * Returns the string "PointParticleEmitter"
  93322. * @returns a string containing the class name
  93323. */
  93324. getClassName(): string;
  93325. /**
  93326. * Serializes the particle system to a JSON object.
  93327. * @returns the JSON object
  93328. */
  93329. serialize(): any;
  93330. /**
  93331. * Parse properties from a JSON object
  93332. * @param serializationObject defines the JSON object
  93333. */
  93334. parse(serializationObject: any): void;
  93335. }
  93336. }
  93337. declare module BABYLON {
  93338. /**
  93339. * Particle emitter emitting particles from the inside of a sphere.
  93340. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93341. */
  93342. export class SphereParticleEmitter implements IParticleEmitterType {
  93343. /**
  93344. * The radius of the emission sphere.
  93345. */
  93346. radius: number;
  93347. /**
  93348. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93349. */
  93350. radiusRange: number;
  93351. /**
  93352. * How much to randomize the particle direction [0-1].
  93353. */
  93354. directionRandomizer: number;
  93355. /**
  93356. * Creates a new instance SphereParticleEmitter
  93357. * @param radius the radius of the emission sphere (1 by default)
  93358. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93359. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93360. */
  93361. constructor(
  93362. /**
  93363. * The radius of the emission sphere.
  93364. */
  93365. radius?: number,
  93366. /**
  93367. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93368. */
  93369. radiusRange?: number,
  93370. /**
  93371. * How much to randomize the particle direction [0-1].
  93372. */
  93373. directionRandomizer?: number);
  93374. /**
  93375. * Called by the particle System when the direction is computed for the created particle.
  93376. * @param worldMatrix is the world matrix of the particle system
  93377. * @param directionToUpdate is the direction vector to update with the result
  93378. * @param particle is the particle we are computed the direction for
  93379. * @param isLocal defines if the direction should be set in local space
  93380. */
  93381. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93382. /**
  93383. * Called by the particle System when the position is computed for the created particle.
  93384. * @param worldMatrix is the world matrix of the particle system
  93385. * @param positionToUpdate is the position vector to update with the result
  93386. * @param particle is the particle we are computed the position for
  93387. * @param isLocal defines if the position should be set in local space
  93388. */
  93389. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93390. /**
  93391. * Clones the current emitter and returns a copy of it
  93392. * @returns the new emitter
  93393. */
  93394. clone(): SphereParticleEmitter;
  93395. /**
  93396. * Called by the GPUParticleSystem to setup the update shader
  93397. * @param effect defines the update shader
  93398. */
  93399. applyToShader(effect: Effect): void;
  93400. /**
  93401. * Returns a string to use to update the GPU particles update shader
  93402. * @returns a string containng the defines string
  93403. */
  93404. getEffectDefines(): string;
  93405. /**
  93406. * Returns the string "SphereParticleEmitter"
  93407. * @returns a string containing the class name
  93408. */
  93409. getClassName(): string;
  93410. /**
  93411. * Serializes the particle system to a JSON object.
  93412. * @returns the JSON object
  93413. */
  93414. serialize(): any;
  93415. /**
  93416. * Parse properties from a JSON object
  93417. * @param serializationObject defines the JSON object
  93418. */
  93419. parse(serializationObject: any): void;
  93420. }
  93421. /**
  93422. * Particle emitter emitting particles from the inside of a sphere.
  93423. * It emits the particles randomly between two vectors.
  93424. */
  93425. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93426. /**
  93427. * The min limit of the emission direction.
  93428. */
  93429. direction1: Vector3;
  93430. /**
  93431. * The max limit of the emission direction.
  93432. */
  93433. direction2: Vector3;
  93434. /**
  93435. * Creates a new instance SphereDirectedParticleEmitter
  93436. * @param radius the radius of the emission sphere (1 by default)
  93437. * @param direction1 the min limit of the emission direction (up vector by default)
  93438. * @param direction2 the max limit of the emission direction (up vector by default)
  93439. */
  93440. constructor(radius?: number,
  93441. /**
  93442. * The min limit of the emission direction.
  93443. */
  93444. direction1?: Vector3,
  93445. /**
  93446. * The max limit of the emission direction.
  93447. */
  93448. direction2?: Vector3);
  93449. /**
  93450. * Called by the particle System when the direction is computed for the created particle.
  93451. * @param worldMatrix is the world matrix of the particle system
  93452. * @param directionToUpdate is the direction vector to update with the result
  93453. * @param particle is the particle we are computed the direction for
  93454. */
  93455. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93456. /**
  93457. * Clones the current emitter and returns a copy of it
  93458. * @returns the new emitter
  93459. */
  93460. clone(): SphereDirectedParticleEmitter;
  93461. /**
  93462. * Called by the GPUParticleSystem to setup the update shader
  93463. * @param effect defines the update shader
  93464. */
  93465. applyToShader(effect: Effect): void;
  93466. /**
  93467. * Returns a string to use to update the GPU particles update shader
  93468. * @returns a string containng the defines string
  93469. */
  93470. getEffectDefines(): string;
  93471. /**
  93472. * Returns the string "SphereDirectedParticleEmitter"
  93473. * @returns a string containing the class name
  93474. */
  93475. getClassName(): string;
  93476. /**
  93477. * Serializes the particle system to a JSON object.
  93478. * @returns the JSON object
  93479. */
  93480. serialize(): any;
  93481. /**
  93482. * Parse properties from a JSON object
  93483. * @param serializationObject defines the JSON object
  93484. */
  93485. parse(serializationObject: any): void;
  93486. }
  93487. }
  93488. declare module BABYLON {
  93489. /**
  93490. * Particle emitter emitting particles from a custom list of positions.
  93491. */
  93492. export class CustomParticleEmitter implements IParticleEmitterType {
  93493. /**
  93494. * Gets or sets the position generator that will create the inital position of each particle.
  93495. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93496. */
  93497. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93498. /**
  93499. * Gets or sets the destination generator that will create the final destination of each particle.
  93500. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93501. */
  93502. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93503. /**
  93504. * Creates a new instance CustomParticleEmitter
  93505. */
  93506. constructor();
  93507. /**
  93508. * Called by the particle System when the direction is computed for the created particle.
  93509. * @param worldMatrix is the world matrix of the particle system
  93510. * @param directionToUpdate is the direction vector to update with the result
  93511. * @param particle is the particle we are computed the direction for
  93512. * @param isLocal defines if the direction should be set in local space
  93513. */
  93514. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93515. /**
  93516. * Called by the particle System when the position is computed for the created particle.
  93517. * @param worldMatrix is the world matrix of the particle system
  93518. * @param positionToUpdate is the position vector to update with the result
  93519. * @param particle is the particle we are computed the position for
  93520. * @param isLocal defines if the position should be set in local space
  93521. */
  93522. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93523. /**
  93524. * Clones the current emitter and returns a copy of it
  93525. * @returns the new emitter
  93526. */
  93527. clone(): CustomParticleEmitter;
  93528. /**
  93529. * Called by the GPUParticleSystem to setup the update shader
  93530. * @param effect defines the update shader
  93531. */
  93532. applyToShader(effect: Effect): void;
  93533. /**
  93534. * Returns a string to use to update the GPU particles update shader
  93535. * @returns a string containng the defines string
  93536. */
  93537. getEffectDefines(): string;
  93538. /**
  93539. * Returns the string "PointParticleEmitter"
  93540. * @returns a string containing the class name
  93541. */
  93542. getClassName(): string;
  93543. /**
  93544. * Serializes the particle system to a JSON object.
  93545. * @returns the JSON object
  93546. */
  93547. serialize(): any;
  93548. /**
  93549. * Parse properties from a JSON object
  93550. * @param serializationObject defines the JSON object
  93551. */
  93552. parse(serializationObject: any): void;
  93553. }
  93554. }
  93555. declare module BABYLON {
  93556. /**
  93557. * Particle emitter emitting particles from the inside of a box.
  93558. * It emits the particles randomly between 2 given directions.
  93559. */
  93560. export class MeshParticleEmitter implements IParticleEmitterType {
  93561. private _indices;
  93562. private _positions;
  93563. private _normals;
  93564. private _storedNormal;
  93565. private _mesh;
  93566. /**
  93567. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93568. */
  93569. direction1: Vector3;
  93570. /**
  93571. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93572. */
  93573. direction2: Vector3;
  93574. /**
  93575. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93576. */
  93577. useMeshNormalsForDirection: boolean;
  93578. /** Defines the mesh to use as source */
  93579. get mesh(): Nullable<AbstractMesh>;
  93580. set mesh(value: Nullable<AbstractMesh>);
  93581. /**
  93582. * Creates a new instance MeshParticleEmitter
  93583. * @param mesh defines the mesh to use as source
  93584. */
  93585. constructor(mesh?: Nullable<AbstractMesh>);
  93586. /**
  93587. * Called by the particle System when the direction is computed for the created particle.
  93588. * @param worldMatrix is the world matrix of the particle system
  93589. * @param directionToUpdate is the direction vector to update with the result
  93590. * @param particle is the particle we are computed the direction for
  93591. * @param isLocal defines if the direction should be set in local space
  93592. */
  93593. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93594. /**
  93595. * Called by the particle System when the position is computed for the created particle.
  93596. * @param worldMatrix is the world matrix of the particle system
  93597. * @param positionToUpdate is the position vector to update with the result
  93598. * @param particle is the particle we are computed the position for
  93599. * @param isLocal defines if the position should be set in local space
  93600. */
  93601. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93602. /**
  93603. * Clones the current emitter and returns a copy of it
  93604. * @returns the new emitter
  93605. */
  93606. clone(): MeshParticleEmitter;
  93607. /**
  93608. * Called by the GPUParticleSystem to setup the update shader
  93609. * @param effect defines the update shader
  93610. */
  93611. applyToShader(effect: Effect): void;
  93612. /**
  93613. * Returns a string to use to update the GPU particles update shader
  93614. * @returns a string containng the defines string
  93615. */
  93616. getEffectDefines(): string;
  93617. /**
  93618. * Returns the string "BoxParticleEmitter"
  93619. * @returns a string containing the class name
  93620. */
  93621. getClassName(): string;
  93622. /**
  93623. * Serializes the particle system to a JSON object.
  93624. * @returns the JSON object
  93625. */
  93626. serialize(): any;
  93627. /**
  93628. * Parse properties from a JSON object
  93629. * @param serializationObject defines the JSON object
  93630. * @param scene defines the hosting scene
  93631. */
  93632. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93633. }
  93634. }
  93635. declare module BABYLON {
  93636. /**
  93637. * Interface representing a particle system in Babylon.js.
  93638. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93639. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93640. */
  93641. export interface IParticleSystem {
  93642. /**
  93643. * List of animations used by the particle system.
  93644. */
  93645. animations: Animation[];
  93646. /**
  93647. * The id of the Particle system.
  93648. */
  93649. id: string;
  93650. /**
  93651. * The name of the Particle system.
  93652. */
  93653. name: string;
  93654. /**
  93655. * The emitter represents the Mesh or position we are attaching the particle system to.
  93656. */
  93657. emitter: Nullable<AbstractMesh | Vector3>;
  93658. /**
  93659. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93660. */
  93661. isBillboardBased: boolean;
  93662. /**
  93663. * The rendering group used by the Particle system to chose when to render.
  93664. */
  93665. renderingGroupId: number;
  93666. /**
  93667. * The layer mask we are rendering the particles through.
  93668. */
  93669. layerMask: number;
  93670. /**
  93671. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93672. */
  93673. updateSpeed: number;
  93674. /**
  93675. * The amount of time the particle system is running (depends of the overall update speed).
  93676. */
  93677. targetStopDuration: number;
  93678. /**
  93679. * The texture used to render each particle. (this can be a spritesheet)
  93680. */
  93681. particleTexture: Nullable<BaseTexture>;
  93682. /**
  93683. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93684. */
  93685. blendMode: number;
  93686. /**
  93687. * Minimum life time of emitting particles.
  93688. */
  93689. minLifeTime: number;
  93690. /**
  93691. * Maximum life time of emitting particles.
  93692. */
  93693. maxLifeTime: number;
  93694. /**
  93695. * Minimum Size of emitting particles.
  93696. */
  93697. minSize: number;
  93698. /**
  93699. * Maximum Size of emitting particles.
  93700. */
  93701. maxSize: number;
  93702. /**
  93703. * Minimum scale of emitting particles on X axis.
  93704. */
  93705. minScaleX: number;
  93706. /**
  93707. * Maximum scale of emitting particles on X axis.
  93708. */
  93709. maxScaleX: number;
  93710. /**
  93711. * Minimum scale of emitting particles on Y axis.
  93712. */
  93713. minScaleY: number;
  93714. /**
  93715. * Maximum scale of emitting particles on Y axis.
  93716. */
  93717. maxScaleY: number;
  93718. /**
  93719. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93720. */
  93721. color1: Color4;
  93722. /**
  93723. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93724. */
  93725. color2: Color4;
  93726. /**
  93727. * Color the particle will have at the end of its lifetime.
  93728. */
  93729. colorDead: Color4;
  93730. /**
  93731. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93732. */
  93733. emitRate: number;
  93734. /**
  93735. * You can use gravity if you want to give an orientation to your particles.
  93736. */
  93737. gravity: Vector3;
  93738. /**
  93739. * Minimum power of emitting particles.
  93740. */
  93741. minEmitPower: number;
  93742. /**
  93743. * Maximum power of emitting particles.
  93744. */
  93745. maxEmitPower: number;
  93746. /**
  93747. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93748. */
  93749. minAngularSpeed: number;
  93750. /**
  93751. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93752. */
  93753. maxAngularSpeed: number;
  93754. /**
  93755. * Gets or sets the minimal initial rotation in radians.
  93756. */
  93757. minInitialRotation: number;
  93758. /**
  93759. * Gets or sets the maximal initial rotation in radians.
  93760. */
  93761. maxInitialRotation: number;
  93762. /**
  93763. * The particle emitter type defines the emitter used by the particle system.
  93764. * It can be for example box, sphere, or cone...
  93765. */
  93766. particleEmitterType: Nullable<IParticleEmitterType>;
  93767. /**
  93768. * Defines the delay in milliseconds before starting the system (0 by default)
  93769. */
  93770. startDelay: number;
  93771. /**
  93772. * 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
  93773. */
  93774. preWarmCycles: number;
  93775. /**
  93776. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93777. */
  93778. preWarmStepOffset: number;
  93779. /**
  93780. * 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)
  93781. */
  93782. spriteCellChangeSpeed: number;
  93783. /**
  93784. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93785. */
  93786. startSpriteCellID: number;
  93787. /**
  93788. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93789. */
  93790. endSpriteCellID: number;
  93791. /**
  93792. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93793. */
  93794. spriteCellWidth: number;
  93795. /**
  93796. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93797. */
  93798. spriteCellHeight: number;
  93799. /**
  93800. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93801. */
  93802. spriteRandomStartCell: boolean;
  93803. /**
  93804. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93805. */
  93806. isAnimationSheetEnabled: boolean;
  93807. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93808. translationPivot: Vector2;
  93809. /**
  93810. * Gets or sets a texture used to add random noise to particle positions
  93811. */
  93812. noiseTexture: Nullable<BaseTexture>;
  93813. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93814. noiseStrength: Vector3;
  93815. /**
  93816. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93817. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93818. */
  93819. billboardMode: number;
  93820. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93821. limitVelocityDamping: number;
  93822. /**
  93823. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93824. */
  93825. beginAnimationOnStart: boolean;
  93826. /**
  93827. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93828. */
  93829. beginAnimationFrom: number;
  93830. /**
  93831. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93832. */
  93833. beginAnimationTo: number;
  93834. /**
  93835. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93836. */
  93837. beginAnimationLoop: boolean;
  93838. /**
  93839. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93840. */
  93841. disposeOnStop: boolean;
  93842. /**
  93843. * Specifies if the particles are updated in emitter local space or world space
  93844. */
  93845. isLocal: boolean;
  93846. /** Snippet ID if the particle system was created from the snippet server */
  93847. snippetId: string;
  93848. /** Gets or sets a matrix to use to compute projection */
  93849. defaultProjectionMatrix: Matrix;
  93850. /**
  93851. * Gets the maximum number of particles active at the same time.
  93852. * @returns The max number of active particles.
  93853. */
  93854. getCapacity(): number;
  93855. /**
  93856. * Gets the number of particles active at the same time.
  93857. * @returns The number of active particles.
  93858. */
  93859. getActiveCount(): number;
  93860. /**
  93861. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93862. * @returns True if it has been started, otherwise false.
  93863. */
  93864. isStarted(): boolean;
  93865. /**
  93866. * Animates the particle system for this frame.
  93867. */
  93868. animate(): void;
  93869. /**
  93870. * Renders the particle system in its current state.
  93871. * @returns the current number of particles
  93872. */
  93873. render(): number;
  93874. /**
  93875. * Dispose the particle system and frees its associated resources.
  93876. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93877. */
  93878. dispose(disposeTexture?: boolean): void;
  93879. /**
  93880. * An event triggered when the system is disposed
  93881. */
  93882. onDisposeObservable: Observable<IParticleSystem>;
  93883. /**
  93884. * Clones the particle system.
  93885. * @param name The name of the cloned object
  93886. * @param newEmitter The new emitter to use
  93887. * @returns the cloned particle system
  93888. */
  93889. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93890. /**
  93891. * Serializes the particle system to a JSON object
  93892. * @param serializeTexture defines if the texture must be serialized as well
  93893. * @returns the JSON object
  93894. */
  93895. serialize(serializeTexture: boolean): any;
  93896. /**
  93897. * Rebuild the particle system
  93898. */
  93899. rebuild(): void;
  93900. /** Force the system to rebuild all gradients that need to be resync */
  93901. forceRefreshGradients(): void;
  93902. /**
  93903. * Starts the particle system and begins to emit
  93904. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93905. */
  93906. start(delay?: number): void;
  93907. /**
  93908. * Stops the particle system.
  93909. */
  93910. stop(): void;
  93911. /**
  93912. * Remove all active particles
  93913. */
  93914. reset(): void;
  93915. /**
  93916. * Gets a boolean indicating that the system is stopping
  93917. * @returns true if the system is currently stopping
  93918. */
  93919. isStopping(): boolean;
  93920. /**
  93921. * Is this system ready to be used/rendered
  93922. * @return true if the system is ready
  93923. */
  93924. isReady(): boolean;
  93925. /**
  93926. * Returns the string "ParticleSystem"
  93927. * @returns a string containing the class name
  93928. */
  93929. getClassName(): string;
  93930. /**
  93931. * Gets the custom effect used to render the particles
  93932. * @param blendMode Blend mode for which the effect should be retrieved
  93933. * @returns The effect
  93934. */
  93935. getCustomEffect(blendMode: number): Nullable<Effect>;
  93936. /**
  93937. * Sets the custom effect used to render the particles
  93938. * @param effect The effect to set
  93939. * @param blendMode Blend mode for which the effect should be set
  93940. */
  93941. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93942. /**
  93943. * Fill the defines array according to the current settings of the particle system
  93944. * @param defines Array to be updated
  93945. * @param blendMode blend mode to take into account when updating the array
  93946. */
  93947. fillDefines(defines: Array<string>, blendMode: number): void;
  93948. /**
  93949. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93950. * @param uniforms Uniforms array to fill
  93951. * @param attributes Attributes array to fill
  93952. * @param samplers Samplers array to fill
  93953. */
  93954. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93955. /**
  93956. * Observable that will be called just before the particles are drawn
  93957. */
  93958. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93959. /**
  93960. * Gets the name of the particle vertex shader
  93961. */
  93962. vertexShaderName: string;
  93963. /**
  93964. * Adds a new color gradient
  93965. * @param gradient defines the gradient to use (between 0 and 1)
  93966. * @param color1 defines the color to affect to the specified gradient
  93967. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93968. * @returns the current particle system
  93969. */
  93970. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93971. /**
  93972. * Remove a specific color gradient
  93973. * @param gradient defines the gradient to remove
  93974. * @returns the current particle system
  93975. */
  93976. removeColorGradient(gradient: number): IParticleSystem;
  93977. /**
  93978. * Adds a new size gradient
  93979. * @param gradient defines the gradient to use (between 0 and 1)
  93980. * @param factor defines the size factor to affect to the specified gradient
  93981. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93982. * @returns the current particle system
  93983. */
  93984. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93985. /**
  93986. * Remove a specific size gradient
  93987. * @param gradient defines the gradient to remove
  93988. * @returns the current particle system
  93989. */
  93990. removeSizeGradient(gradient: number): IParticleSystem;
  93991. /**
  93992. * Gets the current list of color gradients.
  93993. * You must use addColorGradient and removeColorGradient to udpate this list
  93994. * @returns the list of color gradients
  93995. */
  93996. getColorGradients(): Nullable<Array<ColorGradient>>;
  93997. /**
  93998. * Gets the current list of size gradients.
  93999. * You must use addSizeGradient and removeSizeGradient to udpate this list
  94000. * @returns the list of size gradients
  94001. */
  94002. getSizeGradients(): Nullable<Array<FactorGradient>>;
  94003. /**
  94004. * Gets the current list of angular speed gradients.
  94005. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  94006. * @returns the list of angular speed gradients
  94007. */
  94008. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  94009. /**
  94010. * Adds a new angular speed gradient
  94011. * @param gradient defines the gradient to use (between 0 and 1)
  94012. * @param factor defines the angular speed to affect to the specified gradient
  94013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94014. * @returns the current particle system
  94015. */
  94016. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94017. /**
  94018. * Remove a specific angular speed gradient
  94019. * @param gradient defines the gradient to remove
  94020. * @returns the current particle system
  94021. */
  94022. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94023. /**
  94024. * Gets the current list of velocity gradients.
  94025. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94026. * @returns the list of velocity gradients
  94027. */
  94028. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94029. /**
  94030. * Adds a new velocity gradient
  94031. * @param gradient defines the gradient to use (between 0 and 1)
  94032. * @param factor defines the velocity to affect to the specified gradient
  94033. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94034. * @returns the current particle system
  94035. */
  94036. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94037. /**
  94038. * Remove a specific velocity gradient
  94039. * @param gradient defines the gradient to remove
  94040. * @returns the current particle system
  94041. */
  94042. removeVelocityGradient(gradient: number): IParticleSystem;
  94043. /**
  94044. * Gets the current list of limit velocity gradients.
  94045. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94046. * @returns the list of limit velocity gradients
  94047. */
  94048. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94049. /**
  94050. * Adds a new limit velocity gradient
  94051. * @param gradient defines the gradient to use (between 0 and 1)
  94052. * @param factor defines the limit velocity to affect to the specified gradient
  94053. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94054. * @returns the current particle system
  94055. */
  94056. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94057. /**
  94058. * Remove a specific limit velocity gradient
  94059. * @param gradient defines the gradient to remove
  94060. * @returns the current particle system
  94061. */
  94062. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94063. /**
  94064. * Adds a new drag gradient
  94065. * @param gradient defines the gradient to use (between 0 and 1)
  94066. * @param factor defines the drag to affect to the specified gradient
  94067. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94068. * @returns the current particle system
  94069. */
  94070. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94071. /**
  94072. * Remove a specific drag gradient
  94073. * @param gradient defines the gradient to remove
  94074. * @returns the current particle system
  94075. */
  94076. removeDragGradient(gradient: number): IParticleSystem;
  94077. /**
  94078. * Gets the current list of drag gradients.
  94079. * You must use addDragGradient and removeDragGradient to udpate this list
  94080. * @returns the list of drag gradients
  94081. */
  94082. getDragGradients(): Nullable<Array<FactorGradient>>;
  94083. /**
  94084. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94085. * @param gradient defines the gradient to use (between 0 and 1)
  94086. * @param factor defines the emit rate to affect to the specified gradient
  94087. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94088. * @returns the current particle system
  94089. */
  94090. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94091. /**
  94092. * Remove a specific emit rate gradient
  94093. * @param gradient defines the gradient to remove
  94094. * @returns the current particle system
  94095. */
  94096. removeEmitRateGradient(gradient: number): IParticleSystem;
  94097. /**
  94098. * Gets the current list of emit rate gradients.
  94099. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94100. * @returns the list of emit rate gradients
  94101. */
  94102. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94103. /**
  94104. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94105. * @param gradient defines the gradient to use (between 0 and 1)
  94106. * @param factor defines the start size to affect to the specified gradient
  94107. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94108. * @returns the current particle system
  94109. */
  94110. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94111. /**
  94112. * Remove a specific start size gradient
  94113. * @param gradient defines the gradient to remove
  94114. * @returns the current particle system
  94115. */
  94116. removeStartSizeGradient(gradient: number): IParticleSystem;
  94117. /**
  94118. * Gets the current list of start size gradients.
  94119. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94120. * @returns the list of start size gradients
  94121. */
  94122. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94123. /**
  94124. * Adds a new life time gradient
  94125. * @param gradient defines the gradient to use (between 0 and 1)
  94126. * @param factor defines the life time factor to affect to the specified gradient
  94127. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94128. * @returns the current particle system
  94129. */
  94130. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94131. /**
  94132. * Remove a specific life time gradient
  94133. * @param gradient defines the gradient to remove
  94134. * @returns the current particle system
  94135. */
  94136. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94137. /**
  94138. * Gets the current list of life time gradients.
  94139. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94140. * @returns the list of life time gradients
  94141. */
  94142. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94143. /**
  94144. * Gets the current list of color gradients.
  94145. * You must use addColorGradient and removeColorGradient to udpate this list
  94146. * @returns the list of color gradients
  94147. */
  94148. getColorGradients(): Nullable<Array<ColorGradient>>;
  94149. /**
  94150. * Adds a new ramp gradient used to remap particle colors
  94151. * @param gradient defines the gradient to use (between 0 and 1)
  94152. * @param color defines the color to affect to the specified gradient
  94153. * @returns the current particle system
  94154. */
  94155. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94156. /**
  94157. * Gets the current list of ramp gradients.
  94158. * You must use addRampGradient and removeRampGradient to udpate this list
  94159. * @returns the list of ramp gradients
  94160. */
  94161. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94162. /** Gets or sets a boolean indicating that ramp gradients must be used
  94163. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94164. */
  94165. useRampGradients: boolean;
  94166. /**
  94167. * Adds a new color remap gradient
  94168. * @param gradient defines the gradient to use (between 0 and 1)
  94169. * @param min defines the color remap minimal range
  94170. * @param max defines the color remap maximal range
  94171. * @returns the current particle system
  94172. */
  94173. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94174. /**
  94175. * Gets the current list of color remap gradients.
  94176. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94177. * @returns the list of color remap gradients
  94178. */
  94179. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94180. /**
  94181. * Adds a new alpha remap gradient
  94182. * @param gradient defines the gradient to use (between 0 and 1)
  94183. * @param min defines the alpha remap minimal range
  94184. * @param max defines the alpha remap maximal range
  94185. * @returns the current particle system
  94186. */
  94187. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94188. /**
  94189. * Gets the current list of alpha remap gradients.
  94190. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94191. * @returns the list of alpha remap gradients
  94192. */
  94193. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94194. /**
  94195. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94196. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94197. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94198. * @returns the emitter
  94199. */
  94200. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94201. /**
  94202. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94203. * @param radius The radius of the hemisphere to emit from
  94204. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94205. * @returns the emitter
  94206. */
  94207. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94208. /**
  94209. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94210. * @param radius The radius of the sphere to emit from
  94211. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94212. * @returns the emitter
  94213. */
  94214. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94215. /**
  94216. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94217. * @param radius The radius of the sphere to emit from
  94218. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94219. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94220. * @returns the emitter
  94221. */
  94222. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94223. /**
  94224. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94225. * @param radius The radius of the emission cylinder
  94226. * @param height The height of the emission cylinder
  94227. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94228. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94229. * @returns the emitter
  94230. */
  94231. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94232. /**
  94233. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94234. * @param radius The radius of the cylinder to emit from
  94235. * @param height The height of the emission cylinder
  94236. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94237. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94238. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94239. * @returns the emitter
  94240. */
  94241. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94242. /**
  94243. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94244. * @param radius The radius of the cone to emit from
  94245. * @param angle The base angle of the cone
  94246. * @returns the emitter
  94247. */
  94248. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94249. /**
  94250. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94251. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94252. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94253. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94254. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94255. * @returns the emitter
  94256. */
  94257. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94258. /**
  94259. * Get hosting scene
  94260. * @returns the scene
  94261. */
  94262. getScene(): Nullable<Scene>;
  94263. }
  94264. }
  94265. declare module BABYLON {
  94266. /**
  94267. * 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.
  94268. * @see https://doc.babylonjs.com/how_to/transformnode
  94269. */
  94270. export class TransformNode extends Node {
  94271. /**
  94272. * Object will not rotate to face the camera
  94273. */
  94274. static BILLBOARDMODE_NONE: number;
  94275. /**
  94276. * Object will rotate to face the camera but only on the x axis
  94277. */
  94278. static BILLBOARDMODE_X: number;
  94279. /**
  94280. * Object will rotate to face the camera but only on the y axis
  94281. */
  94282. static BILLBOARDMODE_Y: number;
  94283. /**
  94284. * Object will rotate to face the camera but only on the z axis
  94285. */
  94286. static BILLBOARDMODE_Z: number;
  94287. /**
  94288. * Object will rotate to face the camera
  94289. */
  94290. static BILLBOARDMODE_ALL: number;
  94291. /**
  94292. * Object will rotate to face the camera's position instead of orientation
  94293. */
  94294. static BILLBOARDMODE_USE_POSITION: number;
  94295. private static _TmpRotation;
  94296. private static _TmpScaling;
  94297. private static _TmpTranslation;
  94298. private _forward;
  94299. private _forwardInverted;
  94300. private _up;
  94301. private _right;
  94302. private _rightInverted;
  94303. private _position;
  94304. private _rotation;
  94305. private _rotationQuaternion;
  94306. protected _scaling: Vector3;
  94307. protected _isDirty: boolean;
  94308. private _transformToBoneReferal;
  94309. private _isAbsoluteSynced;
  94310. private _billboardMode;
  94311. /**
  94312. * Gets or sets the billboard mode. Default is 0.
  94313. *
  94314. * | Value | Type | Description |
  94315. * | --- | --- | --- |
  94316. * | 0 | BILLBOARDMODE_NONE | |
  94317. * | 1 | BILLBOARDMODE_X | |
  94318. * | 2 | BILLBOARDMODE_Y | |
  94319. * | 4 | BILLBOARDMODE_Z | |
  94320. * | 7 | BILLBOARDMODE_ALL | |
  94321. *
  94322. */
  94323. get billboardMode(): number;
  94324. set billboardMode(value: number);
  94325. private _preserveParentRotationForBillboard;
  94326. /**
  94327. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94328. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94329. */
  94330. get preserveParentRotationForBillboard(): boolean;
  94331. set preserveParentRotationForBillboard(value: boolean);
  94332. /**
  94333. * 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
  94334. */
  94335. scalingDeterminant: number;
  94336. private _infiniteDistance;
  94337. /**
  94338. * Gets or sets the distance of the object to max, often used by skybox
  94339. */
  94340. get infiniteDistance(): boolean;
  94341. set infiniteDistance(value: boolean);
  94342. /**
  94343. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94344. * By default the system will update normals to compensate
  94345. */
  94346. ignoreNonUniformScaling: boolean;
  94347. /**
  94348. * 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
  94349. */
  94350. reIntegrateRotationIntoRotationQuaternion: boolean;
  94351. /** @hidden */
  94352. _poseMatrix: Nullable<Matrix>;
  94353. /** @hidden */
  94354. _localMatrix: Matrix;
  94355. private _usePivotMatrix;
  94356. private _absolutePosition;
  94357. private _absoluteScaling;
  94358. private _absoluteRotationQuaternion;
  94359. private _pivotMatrix;
  94360. private _pivotMatrixInverse;
  94361. protected _postMultiplyPivotMatrix: boolean;
  94362. protected _isWorldMatrixFrozen: boolean;
  94363. /** @hidden */
  94364. _indexInSceneTransformNodesArray: number;
  94365. /**
  94366. * An event triggered after the world matrix is updated
  94367. */
  94368. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94369. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94370. /**
  94371. * Gets a string identifying the name of the class
  94372. * @returns "TransformNode" string
  94373. */
  94374. getClassName(): string;
  94375. /**
  94376. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94377. */
  94378. get position(): Vector3;
  94379. set position(newPosition: Vector3);
  94380. /**
  94381. * 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)).
  94382. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94383. */
  94384. get rotation(): Vector3;
  94385. set rotation(newRotation: Vector3);
  94386. /**
  94387. * 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)).
  94388. */
  94389. get scaling(): Vector3;
  94390. set scaling(newScaling: Vector3);
  94391. /**
  94392. * 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).
  94393. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94394. */
  94395. get rotationQuaternion(): Nullable<Quaternion>;
  94396. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94397. /**
  94398. * The forward direction of that transform in world space.
  94399. */
  94400. get forward(): Vector3;
  94401. /**
  94402. * The up direction of that transform in world space.
  94403. */
  94404. get up(): Vector3;
  94405. /**
  94406. * The right direction of that transform in world space.
  94407. */
  94408. get right(): Vector3;
  94409. /**
  94410. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94411. * @param matrix the matrix to copy the pose from
  94412. * @returns this TransformNode.
  94413. */
  94414. updatePoseMatrix(matrix: Matrix): TransformNode;
  94415. /**
  94416. * Returns the mesh Pose matrix.
  94417. * @returns the pose matrix
  94418. */
  94419. getPoseMatrix(): Matrix;
  94420. /** @hidden */
  94421. _isSynchronized(): boolean;
  94422. /** @hidden */
  94423. _initCache(): void;
  94424. /**
  94425. * Flag the transform node as dirty (Forcing it to update everything)
  94426. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94427. * @returns this transform node
  94428. */
  94429. markAsDirty(property: string): TransformNode;
  94430. /**
  94431. * Returns the current mesh absolute position.
  94432. * Returns a Vector3.
  94433. */
  94434. get absolutePosition(): Vector3;
  94435. /**
  94436. * Returns the current mesh absolute scaling.
  94437. * Returns a Vector3.
  94438. */
  94439. get absoluteScaling(): Vector3;
  94440. /**
  94441. * Returns the current mesh absolute rotation.
  94442. * Returns a Quaternion.
  94443. */
  94444. get absoluteRotationQuaternion(): Quaternion;
  94445. /**
  94446. * Sets a new matrix to apply before all other transformation
  94447. * @param matrix defines the transform matrix
  94448. * @returns the current TransformNode
  94449. */
  94450. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94451. /**
  94452. * Sets a new pivot matrix to the current node
  94453. * @param matrix defines the new pivot matrix to use
  94454. * @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
  94455. * @returns the current TransformNode
  94456. */
  94457. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94458. /**
  94459. * Returns the mesh pivot matrix.
  94460. * Default : Identity.
  94461. * @returns the matrix
  94462. */
  94463. getPivotMatrix(): Matrix;
  94464. /**
  94465. * Instantiate (when possible) or clone that node with its hierarchy
  94466. * @param newParent defines the new parent to use for the instance (or clone)
  94467. * @param options defines options to configure how copy is done
  94468. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94469. * @returns an instance (or a clone) of the current node with its hiearchy
  94470. */
  94471. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94472. doNotInstantiate: boolean;
  94473. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94474. /**
  94475. * Prevents the World matrix to be computed any longer
  94476. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94477. * @returns the TransformNode.
  94478. */
  94479. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94480. /**
  94481. * Allows back the World matrix computation.
  94482. * @returns the TransformNode.
  94483. */
  94484. unfreezeWorldMatrix(): this;
  94485. /**
  94486. * True if the World matrix has been frozen.
  94487. */
  94488. get isWorldMatrixFrozen(): boolean;
  94489. /**
  94490. * Retuns the mesh absolute position in the World.
  94491. * @returns a Vector3.
  94492. */
  94493. getAbsolutePosition(): Vector3;
  94494. /**
  94495. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94496. * @param absolutePosition the absolute position to set
  94497. * @returns the TransformNode.
  94498. */
  94499. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94500. /**
  94501. * Sets the mesh position in its local space.
  94502. * @param vector3 the position to set in localspace
  94503. * @returns the TransformNode.
  94504. */
  94505. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94506. /**
  94507. * Returns the mesh position in the local space from the current World matrix values.
  94508. * @returns a new Vector3.
  94509. */
  94510. getPositionExpressedInLocalSpace(): Vector3;
  94511. /**
  94512. * Translates the mesh along the passed Vector3 in its local space.
  94513. * @param vector3 the distance to translate in localspace
  94514. * @returns the TransformNode.
  94515. */
  94516. locallyTranslate(vector3: Vector3): TransformNode;
  94517. private static _lookAtVectorCache;
  94518. /**
  94519. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94520. * @param targetPoint the position (must be in same space as current mesh) to look at
  94521. * @param yawCor optional yaw (y-axis) correction in radians
  94522. * @param pitchCor optional pitch (x-axis) correction in radians
  94523. * @param rollCor optional roll (z-axis) correction in radians
  94524. * @param space the choosen space of the target
  94525. * @returns the TransformNode.
  94526. */
  94527. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94528. /**
  94529. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94530. * This Vector3 is expressed in the World space.
  94531. * @param localAxis axis to rotate
  94532. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94533. */
  94534. getDirection(localAxis: Vector3): Vector3;
  94535. /**
  94536. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94537. * localAxis is expressed in the mesh local space.
  94538. * result is computed in the Wordl space from the mesh World matrix.
  94539. * @param localAxis axis to rotate
  94540. * @param result the resulting transformnode
  94541. * @returns this TransformNode.
  94542. */
  94543. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94544. /**
  94545. * Sets this transform node rotation to the given local axis.
  94546. * @param localAxis the axis in local space
  94547. * @param yawCor optional yaw (y-axis) correction in radians
  94548. * @param pitchCor optional pitch (x-axis) correction in radians
  94549. * @param rollCor optional roll (z-axis) correction in radians
  94550. * @returns this TransformNode
  94551. */
  94552. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94553. /**
  94554. * Sets a new pivot point to the current node
  94555. * @param point defines the new pivot point to use
  94556. * @param space defines if the point is in world or local space (local by default)
  94557. * @returns the current TransformNode
  94558. */
  94559. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94560. /**
  94561. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94562. * @returns the pivot point
  94563. */
  94564. getPivotPoint(): Vector3;
  94565. /**
  94566. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94567. * @param result the vector3 to store the result
  94568. * @returns this TransformNode.
  94569. */
  94570. getPivotPointToRef(result: Vector3): TransformNode;
  94571. /**
  94572. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94573. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94574. */
  94575. getAbsolutePivotPoint(): Vector3;
  94576. /**
  94577. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94578. * @param result vector3 to store the result
  94579. * @returns this TransformNode.
  94580. */
  94581. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94582. /**
  94583. * Defines the passed node as the parent of the current node.
  94584. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94585. * @see https://doc.babylonjs.com/how_to/parenting
  94586. * @param node the node ot set as the parent
  94587. * @returns this TransformNode.
  94588. */
  94589. setParent(node: Nullable<Node>): TransformNode;
  94590. private _nonUniformScaling;
  94591. /**
  94592. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94593. */
  94594. get nonUniformScaling(): boolean;
  94595. /** @hidden */
  94596. _updateNonUniformScalingState(value: boolean): boolean;
  94597. /**
  94598. * Attach the current TransformNode to another TransformNode associated with a bone
  94599. * @param bone Bone affecting the TransformNode
  94600. * @param affectedTransformNode TransformNode associated with the bone
  94601. * @returns this object
  94602. */
  94603. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94604. /**
  94605. * Detach the transform node if its associated with a bone
  94606. * @returns this object
  94607. */
  94608. detachFromBone(): TransformNode;
  94609. private static _rotationAxisCache;
  94610. /**
  94611. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94612. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94613. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94614. * The passed axis is also normalized.
  94615. * @param axis the axis to rotate around
  94616. * @param amount the amount to rotate in radians
  94617. * @param space Space to rotate in (Default: local)
  94618. * @returns the TransformNode.
  94619. */
  94620. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94621. /**
  94622. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94623. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94624. * The passed axis is also normalized. .
  94625. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94626. * @param point the point to rotate around
  94627. * @param axis the axis to rotate around
  94628. * @param amount the amount to rotate in radians
  94629. * @returns the TransformNode
  94630. */
  94631. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94632. /**
  94633. * Translates the mesh along the axis vector for the passed distance in the given space.
  94634. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94635. * @param axis the axis to translate in
  94636. * @param distance the distance to translate
  94637. * @param space Space to rotate in (Default: local)
  94638. * @returns the TransformNode.
  94639. */
  94640. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94641. /**
  94642. * Adds a rotation step to the mesh current rotation.
  94643. * x, y, z are Euler angles expressed in radians.
  94644. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94645. * This means this rotation is made in the mesh local space only.
  94646. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94647. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94648. * ```javascript
  94649. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94650. * ```
  94651. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94652. * 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.
  94653. * @param x Rotation to add
  94654. * @param y Rotation to add
  94655. * @param z Rotation to add
  94656. * @returns the TransformNode.
  94657. */
  94658. addRotation(x: number, y: number, z: number): TransformNode;
  94659. /**
  94660. * @hidden
  94661. */
  94662. protected _getEffectiveParent(): Nullable<Node>;
  94663. /**
  94664. * Computes the world matrix of the node
  94665. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94666. * @returns the world matrix
  94667. */
  94668. computeWorldMatrix(force?: boolean): Matrix;
  94669. /**
  94670. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94671. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94672. */
  94673. resetLocalMatrix(independentOfChildren?: boolean): void;
  94674. protected _afterComputeWorldMatrix(): void;
  94675. /**
  94676. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94677. * @param func callback function to add
  94678. *
  94679. * @returns the TransformNode.
  94680. */
  94681. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94682. /**
  94683. * Removes a registered callback function.
  94684. * @param func callback function to remove
  94685. * @returns the TransformNode.
  94686. */
  94687. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94688. /**
  94689. * Gets the position of the current mesh in camera space
  94690. * @param camera defines the camera to use
  94691. * @returns a position
  94692. */
  94693. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94694. /**
  94695. * Returns the distance from the mesh to the active camera
  94696. * @param camera defines the camera to use
  94697. * @returns the distance
  94698. */
  94699. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94700. /**
  94701. * Clone the current transform node
  94702. * @param name Name of the new clone
  94703. * @param newParent New parent for the clone
  94704. * @param doNotCloneChildren Do not clone children hierarchy
  94705. * @returns the new transform node
  94706. */
  94707. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94708. /**
  94709. * Serializes the objects information.
  94710. * @param currentSerializationObject defines the object to serialize in
  94711. * @returns the serialized object
  94712. */
  94713. serialize(currentSerializationObject?: any): any;
  94714. /**
  94715. * Returns a new TransformNode object parsed from the source provided.
  94716. * @param parsedTransformNode is the source.
  94717. * @param scene the scne the object belongs to
  94718. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94719. * @returns a new TransformNode object parsed from the source provided.
  94720. */
  94721. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94722. /**
  94723. * Get all child-transformNodes of this node
  94724. * @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
  94725. * @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
  94726. * @returns an array of TransformNode
  94727. */
  94728. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94729. /**
  94730. * Releases resources associated with this transform node.
  94731. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94732. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94733. */
  94734. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94735. /**
  94736. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94737. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94738. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94739. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94740. * @returns the current mesh
  94741. */
  94742. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94743. private _syncAbsoluteScalingAndRotation;
  94744. }
  94745. }
  94746. declare module BABYLON {
  94747. /**
  94748. * Class used to override all child animations of a given target
  94749. */
  94750. export class AnimationPropertiesOverride {
  94751. /**
  94752. * Gets or sets a value indicating if animation blending must be used
  94753. */
  94754. enableBlending: boolean;
  94755. /**
  94756. * Gets or sets the blending speed to use when enableBlending is true
  94757. */
  94758. blendingSpeed: number;
  94759. /**
  94760. * Gets or sets the default loop mode to use
  94761. */
  94762. loopMode: number;
  94763. }
  94764. }
  94765. declare module BABYLON {
  94766. /**
  94767. * Class used to store bone information
  94768. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94769. */
  94770. export class Bone extends Node {
  94771. /**
  94772. * defines the bone name
  94773. */
  94774. name: string;
  94775. private static _tmpVecs;
  94776. private static _tmpQuat;
  94777. private static _tmpMats;
  94778. /**
  94779. * Gets the list of child bones
  94780. */
  94781. children: Bone[];
  94782. /** Gets the animations associated with this bone */
  94783. animations: Animation[];
  94784. /**
  94785. * Gets or sets bone length
  94786. */
  94787. length: number;
  94788. /**
  94789. * @hidden Internal only
  94790. * Set this value to map this bone to a different index in the transform matrices
  94791. * Set this value to -1 to exclude the bone from the transform matrices
  94792. */
  94793. _index: Nullable<number>;
  94794. private _skeleton;
  94795. private _localMatrix;
  94796. private _restPose;
  94797. private _bindPose;
  94798. private _baseMatrix;
  94799. private _absoluteTransform;
  94800. private _invertedAbsoluteTransform;
  94801. private _parent;
  94802. private _scalingDeterminant;
  94803. private _worldTransform;
  94804. private _localScaling;
  94805. private _localRotation;
  94806. private _localPosition;
  94807. private _needToDecompose;
  94808. private _needToCompose;
  94809. /** @hidden */
  94810. _linkedTransformNode: Nullable<TransformNode>;
  94811. /** @hidden */
  94812. _waitingTransformNodeId: Nullable<string>;
  94813. /** @hidden */
  94814. get _matrix(): Matrix;
  94815. /** @hidden */
  94816. set _matrix(value: Matrix);
  94817. /**
  94818. * Create a new bone
  94819. * @param name defines the bone name
  94820. * @param skeleton defines the parent skeleton
  94821. * @param parentBone defines the parent (can be null if the bone is the root)
  94822. * @param localMatrix defines the local matrix
  94823. * @param restPose defines the rest pose matrix
  94824. * @param baseMatrix defines the base matrix
  94825. * @param index defines index of the bone in the hiearchy
  94826. */
  94827. constructor(
  94828. /**
  94829. * defines the bone name
  94830. */
  94831. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94832. /**
  94833. * Gets the current object class name.
  94834. * @return the class name
  94835. */
  94836. getClassName(): string;
  94837. /**
  94838. * Gets the parent skeleton
  94839. * @returns a skeleton
  94840. */
  94841. getSkeleton(): Skeleton;
  94842. /**
  94843. * Gets parent bone
  94844. * @returns a bone or null if the bone is the root of the bone hierarchy
  94845. */
  94846. getParent(): Nullable<Bone>;
  94847. /**
  94848. * Returns an array containing the root bones
  94849. * @returns an array containing the root bones
  94850. */
  94851. getChildren(): Array<Bone>;
  94852. /**
  94853. * Gets the node index in matrix array generated for rendering
  94854. * @returns the node index
  94855. */
  94856. getIndex(): number;
  94857. /**
  94858. * Sets the parent bone
  94859. * @param parent defines the parent (can be null if the bone is the root)
  94860. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94861. */
  94862. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94863. /**
  94864. * Gets the local matrix
  94865. * @returns a matrix
  94866. */
  94867. getLocalMatrix(): Matrix;
  94868. /**
  94869. * Gets the base matrix (initial matrix which remains unchanged)
  94870. * @returns a matrix
  94871. */
  94872. getBaseMatrix(): Matrix;
  94873. /**
  94874. * Gets the rest pose matrix
  94875. * @returns a matrix
  94876. */
  94877. getRestPose(): Matrix;
  94878. /**
  94879. * Sets the rest pose matrix
  94880. * @param matrix the local-space rest pose to set for this bone
  94881. */
  94882. setRestPose(matrix: Matrix): void;
  94883. /**
  94884. * Gets the bind pose matrix
  94885. * @returns the bind pose matrix
  94886. */
  94887. getBindPose(): Matrix;
  94888. /**
  94889. * Sets the bind pose matrix
  94890. * @param matrix the local-space bind pose to set for this bone
  94891. */
  94892. setBindPose(matrix: Matrix): void;
  94893. /**
  94894. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94895. */
  94896. getWorldMatrix(): Matrix;
  94897. /**
  94898. * Sets the local matrix to rest pose matrix
  94899. */
  94900. returnToRest(): void;
  94901. /**
  94902. * Gets the inverse of the absolute transform matrix.
  94903. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94904. * @returns a matrix
  94905. */
  94906. getInvertedAbsoluteTransform(): Matrix;
  94907. /**
  94908. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94909. * @returns a matrix
  94910. */
  94911. getAbsoluteTransform(): Matrix;
  94912. /**
  94913. * Links with the given transform node.
  94914. * The local matrix of this bone is copied from the transform node every frame.
  94915. * @param transformNode defines the transform node to link to
  94916. */
  94917. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94918. /**
  94919. * Gets the node used to drive the bone's transformation
  94920. * @returns a transform node or null
  94921. */
  94922. getTransformNode(): Nullable<TransformNode>;
  94923. /** Gets or sets current position (in local space) */
  94924. get position(): Vector3;
  94925. set position(newPosition: Vector3);
  94926. /** Gets or sets current rotation (in local space) */
  94927. get rotation(): Vector3;
  94928. set rotation(newRotation: Vector3);
  94929. /** Gets or sets current rotation quaternion (in local space) */
  94930. get rotationQuaternion(): Quaternion;
  94931. set rotationQuaternion(newRotation: Quaternion);
  94932. /** Gets or sets current scaling (in local space) */
  94933. get scaling(): Vector3;
  94934. set scaling(newScaling: Vector3);
  94935. /**
  94936. * Gets the animation properties override
  94937. */
  94938. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94939. private _decompose;
  94940. private _compose;
  94941. /**
  94942. * Update the base and local matrices
  94943. * @param matrix defines the new base or local matrix
  94944. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94945. * @param updateLocalMatrix defines if the local matrix should be updated
  94946. */
  94947. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94948. /** @hidden */
  94949. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94950. /**
  94951. * Flag the bone as dirty (Forcing it to update everything)
  94952. */
  94953. markAsDirty(): void;
  94954. /** @hidden */
  94955. _markAsDirtyAndCompose(): void;
  94956. private _markAsDirtyAndDecompose;
  94957. /**
  94958. * Translate the bone in local or world space
  94959. * @param vec The amount to translate the bone
  94960. * @param space The space that the translation is in
  94961. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94962. */
  94963. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94964. /**
  94965. * Set the postion of the bone in local or world space
  94966. * @param position The position to set the bone
  94967. * @param space The space that the position is in
  94968. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94969. */
  94970. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94971. /**
  94972. * Set the absolute position of the bone (world space)
  94973. * @param position The position to set the bone
  94974. * @param mesh The mesh that this bone is attached to
  94975. */
  94976. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94977. /**
  94978. * Scale the bone on the x, y and z axes (in local space)
  94979. * @param x The amount to scale the bone on the x axis
  94980. * @param y The amount to scale the bone on the y axis
  94981. * @param z The amount to scale the bone on the z axis
  94982. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94983. */
  94984. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94985. /**
  94986. * Set the bone scaling in local space
  94987. * @param scale defines the scaling vector
  94988. */
  94989. setScale(scale: Vector3): void;
  94990. /**
  94991. * Gets the current scaling in local space
  94992. * @returns the current scaling vector
  94993. */
  94994. getScale(): Vector3;
  94995. /**
  94996. * Gets the current scaling in local space and stores it in a target vector
  94997. * @param result defines the target vector
  94998. */
  94999. getScaleToRef(result: Vector3): void;
  95000. /**
  95001. * Set the yaw, pitch, and roll of the bone in local or world space
  95002. * @param yaw The rotation of the bone on the y axis
  95003. * @param pitch The rotation of the bone on the x axis
  95004. * @param roll The rotation of the bone on the z axis
  95005. * @param space The space that the axes of rotation are in
  95006. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95007. */
  95008. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  95009. /**
  95010. * Add a rotation to the bone on an axis in local or world space
  95011. * @param axis The axis to rotate the bone on
  95012. * @param amount The amount to rotate the bone
  95013. * @param space The space that the axis is in
  95014. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95015. */
  95016. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95017. /**
  95018. * Set the rotation of the bone to a particular axis angle in local or world space
  95019. * @param axis The axis to rotate the bone on
  95020. * @param angle The angle that the bone should be rotated to
  95021. * @param space The space that the axis is in
  95022. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95023. */
  95024. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95025. /**
  95026. * Set the euler rotation of the bone in local of world space
  95027. * @param rotation The euler rotation that the bone should be set to
  95028. * @param space The space that the rotation is in
  95029. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95030. */
  95031. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95032. /**
  95033. * Set the quaternion rotation of the bone in local of world space
  95034. * @param quat The quaternion rotation that the bone should be set to
  95035. * @param space The space that the rotation is in
  95036. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95037. */
  95038. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95039. /**
  95040. * Set the rotation matrix of the bone in local of world space
  95041. * @param rotMat The rotation matrix that the bone should be set to
  95042. * @param space The space that the rotation is in
  95043. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95044. */
  95045. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95046. private _rotateWithMatrix;
  95047. private _getNegativeRotationToRef;
  95048. /**
  95049. * Get the position of the bone in local or world space
  95050. * @param space The space that the returned position is in
  95051. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95052. * @returns The position of the bone
  95053. */
  95054. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95055. /**
  95056. * Copy the position of the bone to a vector3 in local or world space
  95057. * @param space The space that the returned position is in
  95058. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95059. * @param result The vector3 to copy the position to
  95060. */
  95061. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95062. /**
  95063. * Get the absolute position of the bone (world space)
  95064. * @param mesh The mesh that this bone is attached to
  95065. * @returns The absolute position of the bone
  95066. */
  95067. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95068. /**
  95069. * Copy the absolute position of the bone (world space) to the result param
  95070. * @param mesh The mesh that this bone is attached to
  95071. * @param result The vector3 to copy the absolute position to
  95072. */
  95073. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95074. /**
  95075. * Compute the absolute transforms of this bone and its children
  95076. */
  95077. computeAbsoluteTransforms(): void;
  95078. /**
  95079. * Get the world direction from an axis that is in the local space of the bone
  95080. * @param localAxis The local direction that is used to compute the world direction
  95081. * @param mesh The mesh that this bone is attached to
  95082. * @returns The world direction
  95083. */
  95084. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95085. /**
  95086. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95087. * @param localAxis The local direction that is used to compute the world direction
  95088. * @param mesh The mesh that this bone is attached to
  95089. * @param result The vector3 that the world direction will be copied to
  95090. */
  95091. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95092. /**
  95093. * Get the euler rotation of the bone in local or world space
  95094. * @param space The space that the rotation should be in
  95095. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95096. * @returns The euler rotation
  95097. */
  95098. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95099. /**
  95100. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95101. * @param space The space that the rotation should be in
  95102. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95103. * @param result The vector3 that the rotation should be copied to
  95104. */
  95105. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95106. /**
  95107. * Get the quaternion rotation of the bone in either local or world space
  95108. * @param space The space that the rotation should be in
  95109. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95110. * @returns The quaternion rotation
  95111. */
  95112. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95113. /**
  95114. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95115. * @param space The space that the rotation should be in
  95116. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95117. * @param result The quaternion that the rotation should be copied to
  95118. */
  95119. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95120. /**
  95121. * Get the rotation matrix of the bone in local or world space
  95122. * @param space The space that the rotation should be in
  95123. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95124. * @returns The rotation matrix
  95125. */
  95126. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95127. /**
  95128. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95129. * @param space The space that the rotation should be in
  95130. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95131. * @param result The quaternion that the rotation should be copied to
  95132. */
  95133. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95134. /**
  95135. * Get the world position of a point that is in the local space of the bone
  95136. * @param position The local position
  95137. * @param mesh The mesh that this bone is attached to
  95138. * @returns The world position
  95139. */
  95140. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95141. /**
  95142. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95143. * @param position The local position
  95144. * @param mesh The mesh that this bone is attached to
  95145. * @param result The vector3 that the world position should be copied to
  95146. */
  95147. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95148. /**
  95149. * Get the local position of a point that is in world space
  95150. * @param position The world position
  95151. * @param mesh The mesh that this bone is attached to
  95152. * @returns The local position
  95153. */
  95154. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95155. /**
  95156. * Get the local position of a point that is in world space and copy it to the result param
  95157. * @param position The world position
  95158. * @param mesh The mesh that this bone is attached to
  95159. * @param result The vector3 that the local position should be copied to
  95160. */
  95161. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95162. }
  95163. }
  95164. declare module BABYLON {
  95165. /**
  95166. * Defines a runtime animation
  95167. */
  95168. export class RuntimeAnimation {
  95169. private _events;
  95170. /**
  95171. * The current frame of the runtime animation
  95172. */
  95173. private _currentFrame;
  95174. /**
  95175. * The animation used by the runtime animation
  95176. */
  95177. private _animation;
  95178. /**
  95179. * The target of the runtime animation
  95180. */
  95181. private _target;
  95182. /**
  95183. * The initiating animatable
  95184. */
  95185. private _host;
  95186. /**
  95187. * The original value of the runtime animation
  95188. */
  95189. private _originalValue;
  95190. /**
  95191. * The original blend value of the runtime animation
  95192. */
  95193. private _originalBlendValue;
  95194. /**
  95195. * The offsets cache of the runtime animation
  95196. */
  95197. private _offsetsCache;
  95198. /**
  95199. * The high limits cache of the runtime animation
  95200. */
  95201. private _highLimitsCache;
  95202. /**
  95203. * Specifies if the runtime animation has been stopped
  95204. */
  95205. private _stopped;
  95206. /**
  95207. * The blending factor of the runtime animation
  95208. */
  95209. private _blendingFactor;
  95210. /**
  95211. * The BabylonJS scene
  95212. */
  95213. private _scene;
  95214. /**
  95215. * The current value of the runtime animation
  95216. */
  95217. private _currentValue;
  95218. /** @hidden */
  95219. _animationState: _IAnimationState;
  95220. /**
  95221. * The active target of the runtime animation
  95222. */
  95223. private _activeTargets;
  95224. private _currentActiveTarget;
  95225. private _directTarget;
  95226. /**
  95227. * The target path of the runtime animation
  95228. */
  95229. private _targetPath;
  95230. /**
  95231. * The weight of the runtime animation
  95232. */
  95233. private _weight;
  95234. /**
  95235. * The ratio offset of the runtime animation
  95236. */
  95237. private _ratioOffset;
  95238. /**
  95239. * The previous delay of the runtime animation
  95240. */
  95241. private _previousDelay;
  95242. /**
  95243. * The previous ratio of the runtime animation
  95244. */
  95245. private _previousRatio;
  95246. private _enableBlending;
  95247. private _keys;
  95248. private _minFrame;
  95249. private _maxFrame;
  95250. private _minValue;
  95251. private _maxValue;
  95252. private _targetIsArray;
  95253. /**
  95254. * Gets the current frame of the runtime animation
  95255. */
  95256. get currentFrame(): number;
  95257. /**
  95258. * Gets the weight of the runtime animation
  95259. */
  95260. get weight(): number;
  95261. /**
  95262. * Gets the current value of the runtime animation
  95263. */
  95264. get currentValue(): any;
  95265. /**
  95266. * Gets the target path of the runtime animation
  95267. */
  95268. get targetPath(): string;
  95269. /**
  95270. * Gets the actual target of the runtime animation
  95271. */
  95272. get target(): any;
  95273. /**
  95274. * Gets the additive state of the runtime animation
  95275. */
  95276. get isAdditive(): boolean;
  95277. /** @hidden */
  95278. _onLoop: () => void;
  95279. /**
  95280. * Create a new RuntimeAnimation object
  95281. * @param target defines the target of the animation
  95282. * @param animation defines the source animation object
  95283. * @param scene defines the hosting scene
  95284. * @param host defines the initiating Animatable
  95285. */
  95286. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95287. private _preparePath;
  95288. /**
  95289. * Gets the animation from the runtime animation
  95290. */
  95291. get animation(): Animation;
  95292. /**
  95293. * Resets the runtime animation to the beginning
  95294. * @param restoreOriginal defines whether to restore the target property to the original value
  95295. */
  95296. reset(restoreOriginal?: boolean): void;
  95297. /**
  95298. * Specifies if the runtime animation is stopped
  95299. * @returns Boolean specifying if the runtime animation is stopped
  95300. */
  95301. isStopped(): boolean;
  95302. /**
  95303. * Disposes of the runtime animation
  95304. */
  95305. dispose(): void;
  95306. /**
  95307. * Apply the interpolated value to the target
  95308. * @param currentValue defines the value computed by the animation
  95309. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95310. */
  95311. setValue(currentValue: any, weight: number): void;
  95312. private _getOriginalValues;
  95313. private _setValue;
  95314. /**
  95315. * Gets the loop pmode of the runtime animation
  95316. * @returns Loop Mode
  95317. */
  95318. private _getCorrectLoopMode;
  95319. /**
  95320. * Move the current animation to a given frame
  95321. * @param frame defines the frame to move to
  95322. */
  95323. goToFrame(frame: number): void;
  95324. /**
  95325. * @hidden Internal use only
  95326. */
  95327. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95328. /**
  95329. * Execute the current animation
  95330. * @param delay defines the delay to add to the current frame
  95331. * @param from defines the lower bound of the animation range
  95332. * @param to defines the upper bound of the animation range
  95333. * @param loop defines if the current animation must loop
  95334. * @param speedRatio defines the current speed ratio
  95335. * @param weight defines the weight of the animation (default is -1 so no weight)
  95336. * @param onLoop optional callback called when animation loops
  95337. * @returns a boolean indicating if the animation is running
  95338. */
  95339. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95340. }
  95341. }
  95342. declare module BABYLON {
  95343. /**
  95344. * Class used to store an actual running animation
  95345. */
  95346. export class Animatable {
  95347. /** defines the target object */
  95348. target: any;
  95349. /** defines the starting frame number (default is 0) */
  95350. fromFrame: number;
  95351. /** defines the ending frame number (default is 100) */
  95352. toFrame: number;
  95353. /** defines if the animation must loop (default is false) */
  95354. loopAnimation: boolean;
  95355. /** defines a callback to call when animation ends if it is not looping */
  95356. onAnimationEnd?: (() => void) | null | undefined;
  95357. /** defines a callback to call when animation loops */
  95358. onAnimationLoop?: (() => void) | null | undefined;
  95359. /** defines whether the animation should be evaluated additively */
  95360. isAdditive: boolean;
  95361. private _localDelayOffset;
  95362. private _pausedDelay;
  95363. private _runtimeAnimations;
  95364. private _paused;
  95365. private _scene;
  95366. private _speedRatio;
  95367. private _weight;
  95368. private _syncRoot;
  95369. /**
  95370. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95371. * This will only apply for non looping animation (default is true)
  95372. */
  95373. disposeOnEnd: boolean;
  95374. /**
  95375. * Gets a boolean indicating if the animation has started
  95376. */
  95377. animationStarted: boolean;
  95378. /**
  95379. * Observer raised when the animation ends
  95380. */
  95381. onAnimationEndObservable: Observable<Animatable>;
  95382. /**
  95383. * Observer raised when the animation loops
  95384. */
  95385. onAnimationLoopObservable: Observable<Animatable>;
  95386. /**
  95387. * Gets the root Animatable used to synchronize and normalize animations
  95388. */
  95389. get syncRoot(): Nullable<Animatable>;
  95390. /**
  95391. * Gets the current frame of the first RuntimeAnimation
  95392. * Used to synchronize Animatables
  95393. */
  95394. get masterFrame(): number;
  95395. /**
  95396. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95397. */
  95398. get weight(): number;
  95399. set weight(value: number);
  95400. /**
  95401. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95402. */
  95403. get speedRatio(): number;
  95404. set speedRatio(value: number);
  95405. /**
  95406. * Creates a new Animatable
  95407. * @param scene defines the hosting scene
  95408. * @param target defines the target object
  95409. * @param fromFrame defines the starting frame number (default is 0)
  95410. * @param toFrame defines the ending frame number (default is 100)
  95411. * @param loopAnimation defines if the animation must loop (default is false)
  95412. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95413. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95414. * @param animations defines a group of animation to add to the new Animatable
  95415. * @param onAnimationLoop defines a callback to call when animation loops
  95416. * @param isAdditive defines whether the animation should be evaluated additively
  95417. */
  95418. constructor(scene: Scene,
  95419. /** defines the target object */
  95420. target: any,
  95421. /** defines the starting frame number (default is 0) */
  95422. fromFrame?: number,
  95423. /** defines the ending frame number (default is 100) */
  95424. toFrame?: number,
  95425. /** defines if the animation must loop (default is false) */
  95426. loopAnimation?: boolean, speedRatio?: number,
  95427. /** defines a callback to call when animation ends if it is not looping */
  95428. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95429. /** defines a callback to call when animation loops */
  95430. onAnimationLoop?: (() => void) | null | undefined,
  95431. /** defines whether the animation should be evaluated additively */
  95432. isAdditive?: boolean);
  95433. /**
  95434. * Synchronize and normalize current Animatable with a source Animatable
  95435. * This is useful when using animation weights and when animations are not of the same length
  95436. * @param root defines the root Animatable to synchronize with
  95437. * @returns the current Animatable
  95438. */
  95439. syncWith(root: Animatable): Animatable;
  95440. /**
  95441. * Gets the list of runtime animations
  95442. * @returns an array of RuntimeAnimation
  95443. */
  95444. getAnimations(): RuntimeAnimation[];
  95445. /**
  95446. * Adds more animations to the current animatable
  95447. * @param target defines the target of the animations
  95448. * @param animations defines the new animations to add
  95449. */
  95450. appendAnimations(target: any, animations: Animation[]): void;
  95451. /**
  95452. * Gets the source animation for a specific property
  95453. * @param property defines the propertyu to look for
  95454. * @returns null or the source animation for the given property
  95455. */
  95456. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95457. /**
  95458. * Gets the runtime animation for a specific property
  95459. * @param property defines the propertyu to look for
  95460. * @returns null or the runtime animation for the given property
  95461. */
  95462. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95463. /**
  95464. * Resets the animatable to its original state
  95465. */
  95466. reset(): void;
  95467. /**
  95468. * Allows the animatable to blend with current running animations
  95469. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95470. * @param blendingSpeed defines the blending speed to use
  95471. */
  95472. enableBlending(blendingSpeed: number): void;
  95473. /**
  95474. * Disable animation blending
  95475. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95476. */
  95477. disableBlending(): void;
  95478. /**
  95479. * Jump directly to a given frame
  95480. * @param frame defines the frame to jump to
  95481. */
  95482. goToFrame(frame: number): void;
  95483. /**
  95484. * Pause the animation
  95485. */
  95486. pause(): void;
  95487. /**
  95488. * Restart the animation
  95489. */
  95490. restart(): void;
  95491. private _raiseOnAnimationEnd;
  95492. /**
  95493. * Stop and delete the current animation
  95494. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95495. * @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)
  95496. */
  95497. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95498. /**
  95499. * Wait asynchronously for the animation to end
  95500. * @returns a promise which will be fullfilled when the animation ends
  95501. */
  95502. waitAsync(): Promise<Animatable>;
  95503. /** @hidden */
  95504. _animate(delay: number): boolean;
  95505. }
  95506. interface Scene {
  95507. /** @hidden */
  95508. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95509. /** @hidden */
  95510. _processLateAnimationBindingsForMatrices(holder: {
  95511. totalWeight: number;
  95512. totalAdditiveWeight: number;
  95513. animations: RuntimeAnimation[];
  95514. additiveAnimations: RuntimeAnimation[];
  95515. originalValue: Matrix;
  95516. }): any;
  95517. /** @hidden */
  95518. _processLateAnimationBindingsForQuaternions(holder: {
  95519. totalWeight: number;
  95520. totalAdditiveWeight: number;
  95521. animations: RuntimeAnimation[];
  95522. additiveAnimations: RuntimeAnimation[];
  95523. originalValue: Quaternion;
  95524. }, refQuaternion: Quaternion): Quaternion;
  95525. /** @hidden */
  95526. _processLateAnimationBindings(): void;
  95527. /**
  95528. * Will start the animation sequence of a given target
  95529. * @param target defines the target
  95530. * @param from defines from which frame should animation start
  95531. * @param to defines until which frame should animation run.
  95532. * @param weight defines the weight to apply to the animation (1.0 by default)
  95533. * @param loop defines if the animation loops
  95534. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95535. * @param onAnimationEnd defines the function to be executed when the animation ends
  95536. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95537. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95538. * @param onAnimationLoop defines the callback to call when an animation loops
  95539. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95540. * @returns the animatable object created for this animation
  95541. */
  95542. 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;
  95543. /**
  95544. * Will start the animation sequence of a given target
  95545. * @param target defines the target
  95546. * @param from defines from which frame should animation start
  95547. * @param to defines until which frame should animation run.
  95548. * @param loop defines if the animation loops
  95549. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95550. * @param onAnimationEnd defines the function to be executed when the animation ends
  95551. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95552. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95553. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95554. * @param onAnimationLoop defines the callback to call when an animation loops
  95555. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95556. * @returns the animatable object created for this animation
  95557. */
  95558. 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;
  95559. /**
  95560. * Will start the animation sequence of a given target and its hierarchy
  95561. * @param target defines the target
  95562. * @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.
  95563. * @param from defines from which frame should animation start
  95564. * @param to defines until which frame should animation run.
  95565. * @param loop defines if the animation loops
  95566. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95567. * @param onAnimationEnd defines the function to be executed when the animation ends
  95568. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95569. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95570. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95571. * @param onAnimationLoop defines the callback to call when an animation loops
  95572. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95573. * @returns the list of created animatables
  95574. */
  95575. 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[];
  95576. /**
  95577. * Begin a new animation on a given node
  95578. * @param target defines the target where the animation will take place
  95579. * @param animations defines the list of animations to start
  95580. * @param from defines the initial value
  95581. * @param to defines the final value
  95582. * @param loop defines if you want animation to loop (off by default)
  95583. * @param speedRatio defines the speed ratio to apply to all animations
  95584. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95585. * @param onAnimationLoop defines the callback to call when an animation loops
  95586. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95587. * @returns the list of created animatables
  95588. */
  95589. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95590. /**
  95591. * Begin a new animation on a given node and its hierarchy
  95592. * @param target defines the root node where the animation will take place
  95593. * @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.
  95594. * @param animations defines the list of animations to start
  95595. * @param from defines the initial value
  95596. * @param to defines the final value
  95597. * @param loop defines if you want animation to loop (off by default)
  95598. * @param speedRatio defines the speed ratio to apply to all animations
  95599. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95600. * @param onAnimationLoop defines the callback to call when an animation loops
  95601. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95602. * @returns the list of animatables created for all nodes
  95603. */
  95604. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95605. /**
  95606. * Gets the animatable associated with a specific target
  95607. * @param target defines the target of the animatable
  95608. * @returns the required animatable if found
  95609. */
  95610. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95611. /**
  95612. * Gets all animatables associated with a given target
  95613. * @param target defines the target to look animatables for
  95614. * @returns an array of Animatables
  95615. */
  95616. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95617. /**
  95618. * Stops and removes all animations that have been applied to the scene
  95619. */
  95620. stopAllAnimations(): void;
  95621. /**
  95622. * Gets the current delta time used by animation engine
  95623. */
  95624. deltaTime: number;
  95625. }
  95626. interface Bone {
  95627. /**
  95628. * Copy an animation range from another bone
  95629. * @param source defines the source bone
  95630. * @param rangeName defines the range name to copy
  95631. * @param frameOffset defines the frame offset
  95632. * @param rescaleAsRequired defines if rescaling must be applied if required
  95633. * @param skelDimensionsRatio defines the scaling ratio
  95634. * @returns true if operation was successful
  95635. */
  95636. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95637. }
  95638. }
  95639. declare module BABYLON {
  95640. /**
  95641. * Class used to handle skinning animations
  95642. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95643. */
  95644. export class Skeleton implements IAnimatable {
  95645. /** defines the skeleton name */
  95646. name: string;
  95647. /** defines the skeleton Id */
  95648. id: string;
  95649. /**
  95650. * Defines the list of child bones
  95651. */
  95652. bones: Bone[];
  95653. /**
  95654. * Defines an estimate of the dimension of the skeleton at rest
  95655. */
  95656. dimensionsAtRest: Vector3;
  95657. /**
  95658. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95659. */
  95660. needInitialSkinMatrix: boolean;
  95661. /**
  95662. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95663. */
  95664. overrideMesh: Nullable<AbstractMesh>;
  95665. /**
  95666. * Gets the list of animations attached to this skeleton
  95667. */
  95668. animations: Array<Animation>;
  95669. private _scene;
  95670. private _isDirty;
  95671. private _transformMatrices;
  95672. private _transformMatrixTexture;
  95673. private _meshesWithPoseMatrix;
  95674. private _animatables;
  95675. private _identity;
  95676. private _synchronizedWithMesh;
  95677. private _ranges;
  95678. private _lastAbsoluteTransformsUpdateId;
  95679. private _canUseTextureForBones;
  95680. private _uniqueId;
  95681. /** @hidden */
  95682. _numBonesWithLinkedTransformNode: number;
  95683. /** @hidden */
  95684. _hasWaitingData: Nullable<boolean>;
  95685. /** @hidden */
  95686. _waitingOverrideMeshId: Nullable<string>;
  95687. /**
  95688. * Specifies if the skeleton should be serialized
  95689. */
  95690. doNotSerialize: boolean;
  95691. private _useTextureToStoreBoneMatrices;
  95692. /**
  95693. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95694. * Please note that this option is not available if the hardware does not support it
  95695. */
  95696. get useTextureToStoreBoneMatrices(): boolean;
  95697. set useTextureToStoreBoneMatrices(value: boolean);
  95698. private _animationPropertiesOverride;
  95699. /**
  95700. * Gets or sets the animation properties override
  95701. */
  95702. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95703. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95704. /**
  95705. * List of inspectable custom properties (used by the Inspector)
  95706. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95707. */
  95708. inspectableCustomProperties: IInspectable[];
  95709. /**
  95710. * An observable triggered before computing the skeleton's matrices
  95711. */
  95712. onBeforeComputeObservable: Observable<Skeleton>;
  95713. /**
  95714. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95715. */
  95716. get isUsingTextureForMatrices(): boolean;
  95717. /**
  95718. * Gets the unique ID of this skeleton
  95719. */
  95720. get uniqueId(): number;
  95721. /**
  95722. * Creates a new skeleton
  95723. * @param name defines the skeleton name
  95724. * @param id defines the skeleton Id
  95725. * @param scene defines the hosting scene
  95726. */
  95727. constructor(
  95728. /** defines the skeleton name */
  95729. name: string,
  95730. /** defines the skeleton Id */
  95731. id: string, scene: Scene);
  95732. /**
  95733. * Gets the current object class name.
  95734. * @return the class name
  95735. */
  95736. getClassName(): string;
  95737. /**
  95738. * Returns an array containing the root bones
  95739. * @returns an array containing the root bones
  95740. */
  95741. getChildren(): Array<Bone>;
  95742. /**
  95743. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95744. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95745. * @returns a Float32Array containing matrices data
  95746. */
  95747. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95748. /**
  95749. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95750. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95751. * @returns a raw texture containing the data
  95752. */
  95753. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95754. /**
  95755. * Gets the current hosting scene
  95756. * @returns a scene object
  95757. */
  95758. getScene(): Scene;
  95759. /**
  95760. * Gets a string representing the current skeleton data
  95761. * @param fullDetails defines a boolean indicating if we want a verbose version
  95762. * @returns a string representing the current skeleton data
  95763. */
  95764. toString(fullDetails?: boolean): string;
  95765. /**
  95766. * Get bone's index searching by name
  95767. * @param name defines bone's name to search for
  95768. * @return the indice of the bone. Returns -1 if not found
  95769. */
  95770. getBoneIndexByName(name: string): number;
  95771. /**
  95772. * Creater a new animation range
  95773. * @param name defines the name of the range
  95774. * @param from defines the start key
  95775. * @param to defines the end key
  95776. */
  95777. createAnimationRange(name: string, from: number, to: number): void;
  95778. /**
  95779. * Delete a specific animation range
  95780. * @param name defines the name of the range
  95781. * @param deleteFrames defines if frames must be removed as well
  95782. */
  95783. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95784. /**
  95785. * Gets a specific animation range
  95786. * @param name defines the name of the range to look for
  95787. * @returns the requested animation range or null if not found
  95788. */
  95789. getAnimationRange(name: string): Nullable<AnimationRange>;
  95790. /**
  95791. * Gets the list of all animation ranges defined on this skeleton
  95792. * @returns an array
  95793. */
  95794. getAnimationRanges(): Nullable<AnimationRange>[];
  95795. /**
  95796. * Copy animation range from a source skeleton.
  95797. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95798. * @param source defines the source skeleton
  95799. * @param name defines the name of the range to copy
  95800. * @param rescaleAsRequired defines if rescaling must be applied if required
  95801. * @returns true if operation was successful
  95802. */
  95803. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95804. /**
  95805. * Forces the skeleton to go to rest pose
  95806. */
  95807. returnToRest(): void;
  95808. private _getHighestAnimationFrame;
  95809. /**
  95810. * Begin a specific animation range
  95811. * @param name defines the name of the range to start
  95812. * @param loop defines if looping must be turned on (false by default)
  95813. * @param speedRatio defines the speed ratio to apply (1 by default)
  95814. * @param onAnimationEnd defines a callback which will be called when animation will end
  95815. * @returns a new animatable
  95816. */
  95817. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95818. /**
  95819. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95820. * @param skeleton defines the Skeleton containing the animation range to convert
  95821. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95822. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95823. * @returns the original skeleton
  95824. */
  95825. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95826. /** @hidden */
  95827. _markAsDirty(): void;
  95828. /** @hidden */
  95829. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95830. /** @hidden */
  95831. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95832. private _computeTransformMatrices;
  95833. /**
  95834. * Build all resources required to render a skeleton
  95835. */
  95836. prepare(): void;
  95837. /**
  95838. * Gets the list of animatables currently running for this skeleton
  95839. * @returns an array of animatables
  95840. */
  95841. getAnimatables(): IAnimatable[];
  95842. /**
  95843. * Clone the current skeleton
  95844. * @param name defines the name of the new skeleton
  95845. * @param id defines the id of the new skeleton
  95846. * @returns the new skeleton
  95847. */
  95848. clone(name: string, id?: string): Skeleton;
  95849. /**
  95850. * Enable animation blending for this skeleton
  95851. * @param blendingSpeed defines the blending speed to apply
  95852. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95853. */
  95854. enableBlending(blendingSpeed?: number): void;
  95855. /**
  95856. * Releases all resources associated with the current skeleton
  95857. */
  95858. dispose(): void;
  95859. /**
  95860. * Serialize the skeleton in a JSON object
  95861. * @returns a JSON object
  95862. */
  95863. serialize(): any;
  95864. /**
  95865. * Creates a new skeleton from serialized data
  95866. * @param parsedSkeleton defines the serialized data
  95867. * @param scene defines the hosting scene
  95868. * @returns a new skeleton
  95869. */
  95870. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95871. /**
  95872. * Compute all node absolute transforms
  95873. * @param forceUpdate defines if computation must be done even if cache is up to date
  95874. */
  95875. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95876. /**
  95877. * Gets the root pose matrix
  95878. * @returns a matrix
  95879. */
  95880. getPoseMatrix(): Nullable<Matrix>;
  95881. /**
  95882. * Sorts bones per internal index
  95883. */
  95884. sortBones(): void;
  95885. private _sortBones;
  95886. }
  95887. }
  95888. declare module BABYLON {
  95889. /**
  95890. * Creates an instance based on a source mesh.
  95891. */
  95892. export class InstancedMesh extends AbstractMesh {
  95893. private _sourceMesh;
  95894. private _currentLOD;
  95895. /** @hidden */
  95896. _indexInSourceMeshInstanceArray: number;
  95897. constructor(name: string, source: Mesh);
  95898. /**
  95899. * Returns the string "InstancedMesh".
  95900. */
  95901. getClassName(): string;
  95902. /** Gets the list of lights affecting that mesh */
  95903. get lightSources(): Light[];
  95904. _resyncLightSources(): void;
  95905. _resyncLightSource(light: Light): void;
  95906. _removeLightSource(light: Light, dispose: boolean): void;
  95907. /**
  95908. * If the source mesh receives shadows
  95909. */
  95910. get receiveShadows(): boolean;
  95911. /**
  95912. * The material of the source mesh
  95913. */
  95914. get material(): Nullable<Material>;
  95915. /**
  95916. * Visibility of the source mesh
  95917. */
  95918. get visibility(): number;
  95919. /**
  95920. * Skeleton of the source mesh
  95921. */
  95922. get skeleton(): Nullable<Skeleton>;
  95923. /**
  95924. * Rendering ground id of the source mesh
  95925. */
  95926. get renderingGroupId(): number;
  95927. set renderingGroupId(value: number);
  95928. /**
  95929. * Returns the total number of vertices (integer).
  95930. */
  95931. getTotalVertices(): number;
  95932. /**
  95933. * Returns a positive integer : the total number of indices in this mesh geometry.
  95934. * @returns the numner of indices or zero if the mesh has no geometry.
  95935. */
  95936. getTotalIndices(): number;
  95937. /**
  95938. * The source mesh of the instance
  95939. */
  95940. get sourceMesh(): Mesh;
  95941. /**
  95942. * Creates a new InstancedMesh object from the mesh model.
  95943. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95944. * @param name defines the name of the new instance
  95945. * @returns a new InstancedMesh
  95946. */
  95947. createInstance(name: string): InstancedMesh;
  95948. /**
  95949. * Is this node ready to be used/rendered
  95950. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95951. * @return {boolean} is it ready
  95952. */
  95953. isReady(completeCheck?: boolean): boolean;
  95954. /**
  95955. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95956. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95957. * @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.
  95958. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95959. */
  95960. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95961. /**
  95962. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95963. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95964. * The `data` are either a numeric array either a Float32Array.
  95965. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95966. * 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).
  95967. * Note that a new underlying VertexBuffer object is created each call.
  95968. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95969. *
  95970. * Possible `kind` values :
  95971. * - VertexBuffer.PositionKind
  95972. * - VertexBuffer.UVKind
  95973. * - VertexBuffer.UV2Kind
  95974. * - VertexBuffer.UV3Kind
  95975. * - VertexBuffer.UV4Kind
  95976. * - VertexBuffer.UV5Kind
  95977. * - VertexBuffer.UV6Kind
  95978. * - VertexBuffer.ColorKind
  95979. * - VertexBuffer.MatricesIndicesKind
  95980. * - VertexBuffer.MatricesIndicesExtraKind
  95981. * - VertexBuffer.MatricesWeightsKind
  95982. * - VertexBuffer.MatricesWeightsExtraKind
  95983. *
  95984. * Returns the Mesh.
  95985. */
  95986. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95987. /**
  95988. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95989. * If the mesh has no geometry, it is simply returned as it is.
  95990. * The `data` are either a numeric array either a Float32Array.
  95991. * No new underlying VertexBuffer object is created.
  95992. * 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.
  95993. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95994. *
  95995. * Possible `kind` values :
  95996. * - VertexBuffer.PositionKind
  95997. * - VertexBuffer.UVKind
  95998. * - VertexBuffer.UV2Kind
  95999. * - VertexBuffer.UV3Kind
  96000. * - VertexBuffer.UV4Kind
  96001. * - VertexBuffer.UV5Kind
  96002. * - VertexBuffer.UV6Kind
  96003. * - VertexBuffer.ColorKind
  96004. * - VertexBuffer.MatricesIndicesKind
  96005. * - VertexBuffer.MatricesIndicesExtraKind
  96006. * - VertexBuffer.MatricesWeightsKind
  96007. * - VertexBuffer.MatricesWeightsExtraKind
  96008. *
  96009. * Returns the Mesh.
  96010. */
  96011. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  96012. /**
  96013. * Sets the mesh indices.
  96014. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96015. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96016. * This method creates a new index buffer each call.
  96017. * Returns the Mesh.
  96018. */
  96019. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96020. /**
  96021. * Boolean : True if the mesh owns the requested kind of data.
  96022. */
  96023. isVerticesDataPresent(kind: string): boolean;
  96024. /**
  96025. * Returns an array of indices (IndicesArray).
  96026. */
  96027. getIndices(): Nullable<IndicesArray>;
  96028. get _positions(): Nullable<Vector3[]>;
  96029. /**
  96030. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96031. * This means the mesh underlying bounding box and sphere are recomputed.
  96032. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96033. * @returns the current mesh
  96034. */
  96035. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96036. /** @hidden */
  96037. _preActivate(): InstancedMesh;
  96038. /** @hidden */
  96039. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96040. /** @hidden */
  96041. _postActivate(): void;
  96042. getWorldMatrix(): Matrix;
  96043. get isAnInstance(): boolean;
  96044. /**
  96045. * Returns the current associated LOD AbstractMesh.
  96046. */
  96047. getLOD(camera: Camera): AbstractMesh;
  96048. /** @hidden */
  96049. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96050. /** @hidden */
  96051. _syncSubMeshes(): InstancedMesh;
  96052. /** @hidden */
  96053. _generatePointsArray(): boolean;
  96054. /** @hidden */
  96055. _updateBoundingInfo(): AbstractMesh;
  96056. /**
  96057. * Creates a new InstancedMesh from the current mesh.
  96058. * - name (string) : the cloned mesh name
  96059. * - newParent (optional Node) : the optional Node to parent the clone to.
  96060. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96061. *
  96062. * Returns the clone.
  96063. */
  96064. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96065. /**
  96066. * Disposes the InstancedMesh.
  96067. * Returns nothing.
  96068. */
  96069. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96070. }
  96071. interface Mesh {
  96072. /**
  96073. * Register a custom buffer that will be instanced
  96074. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96075. * @param kind defines the buffer kind
  96076. * @param stride defines the stride in floats
  96077. */
  96078. registerInstancedBuffer(kind: string, stride: number): void;
  96079. /**
  96080. * true to use the edge renderer for all instances of this mesh
  96081. */
  96082. edgesShareWithInstances: boolean;
  96083. /** @hidden */
  96084. _userInstancedBuffersStorage: {
  96085. data: {
  96086. [key: string]: Float32Array;
  96087. };
  96088. sizes: {
  96089. [key: string]: number;
  96090. };
  96091. vertexBuffers: {
  96092. [key: string]: Nullable<VertexBuffer>;
  96093. };
  96094. strides: {
  96095. [key: string]: number;
  96096. };
  96097. };
  96098. }
  96099. interface AbstractMesh {
  96100. /**
  96101. * Object used to store instanced buffers defined by user
  96102. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96103. */
  96104. instancedBuffers: {
  96105. [key: string]: any;
  96106. };
  96107. }
  96108. }
  96109. declare module BABYLON {
  96110. /**
  96111. * Defines the options associated with the creation of a shader material.
  96112. */
  96113. export interface IShaderMaterialOptions {
  96114. /**
  96115. * Does the material work in alpha blend mode
  96116. */
  96117. needAlphaBlending: boolean;
  96118. /**
  96119. * Does the material work in alpha test mode
  96120. */
  96121. needAlphaTesting: boolean;
  96122. /**
  96123. * The list of attribute names used in the shader
  96124. */
  96125. attributes: string[];
  96126. /**
  96127. * The list of unifrom names used in the shader
  96128. */
  96129. uniforms: string[];
  96130. /**
  96131. * The list of UBO names used in the shader
  96132. */
  96133. uniformBuffers: string[];
  96134. /**
  96135. * The list of sampler names used in the shader
  96136. */
  96137. samplers: string[];
  96138. /**
  96139. * The list of defines used in the shader
  96140. */
  96141. defines: string[];
  96142. }
  96143. /**
  96144. * 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.
  96145. *
  96146. * This returned material effects how the mesh will look based on the code in the shaders.
  96147. *
  96148. * @see https://doc.babylonjs.com/how_to/shader_material
  96149. */
  96150. export class ShaderMaterial extends Material {
  96151. private _shaderPath;
  96152. private _options;
  96153. private _textures;
  96154. private _textureArrays;
  96155. private _floats;
  96156. private _ints;
  96157. private _floatsArrays;
  96158. private _colors3;
  96159. private _colors3Arrays;
  96160. private _colors4;
  96161. private _colors4Arrays;
  96162. private _vectors2;
  96163. private _vectors3;
  96164. private _vectors4;
  96165. private _matrices;
  96166. private _matrixArrays;
  96167. private _matrices3x3;
  96168. private _matrices2x2;
  96169. private _vectors2Arrays;
  96170. private _vectors3Arrays;
  96171. private _vectors4Arrays;
  96172. private _cachedWorldViewMatrix;
  96173. private _cachedWorldViewProjectionMatrix;
  96174. private _renderId;
  96175. private _multiview;
  96176. private _cachedDefines;
  96177. /** Define the Url to load snippets */
  96178. static SnippetUrl: string;
  96179. /** Snippet ID if the material was created from the snippet server */
  96180. snippetId: string;
  96181. /**
  96182. * Instantiate a new shader material.
  96183. * 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.
  96184. * This returned material effects how the mesh will look based on the code in the shaders.
  96185. * @see https://doc.babylonjs.com/how_to/shader_material
  96186. * @param name Define the name of the material in the scene
  96187. * @param scene Define the scene the material belongs to
  96188. * @param shaderPath Defines the route to the shader code in one of three ways:
  96189. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96190. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96191. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96192. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96193. * @param options Define the options used to create the shader
  96194. */
  96195. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96196. /**
  96197. * Gets the shader path used to define the shader code
  96198. * It can be modified to trigger a new compilation
  96199. */
  96200. get shaderPath(): any;
  96201. /**
  96202. * Sets the shader path used to define the shader code
  96203. * It can be modified to trigger a new compilation
  96204. */
  96205. set shaderPath(shaderPath: any);
  96206. /**
  96207. * Gets the options used to compile the shader.
  96208. * They can be modified to trigger a new compilation
  96209. */
  96210. get options(): IShaderMaterialOptions;
  96211. /**
  96212. * Gets the current class name of the material e.g. "ShaderMaterial"
  96213. * Mainly use in serialization.
  96214. * @returns the class name
  96215. */
  96216. getClassName(): string;
  96217. /**
  96218. * Specifies if the material will require alpha blending
  96219. * @returns a boolean specifying if alpha blending is needed
  96220. */
  96221. needAlphaBlending(): boolean;
  96222. /**
  96223. * Specifies if this material should be rendered in alpha test mode
  96224. * @returns a boolean specifying if an alpha test is needed.
  96225. */
  96226. needAlphaTesting(): boolean;
  96227. private _checkUniform;
  96228. /**
  96229. * Set a texture in the shader.
  96230. * @param name Define the name of the uniform samplers as defined in the shader
  96231. * @param texture Define the texture to bind to this sampler
  96232. * @return the material itself allowing "fluent" like uniform updates
  96233. */
  96234. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96235. /**
  96236. * Set a texture array in the shader.
  96237. * @param name Define the name of the uniform sampler array as defined in the shader
  96238. * @param textures Define the list of textures to bind to this sampler
  96239. * @return the material itself allowing "fluent" like uniform updates
  96240. */
  96241. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96242. /**
  96243. * Set a float in the shader.
  96244. * @param name Define the name of the uniform as defined in the shader
  96245. * @param value Define the value to give to the uniform
  96246. * @return the material itself allowing "fluent" like uniform updates
  96247. */
  96248. setFloat(name: string, value: number): ShaderMaterial;
  96249. /**
  96250. * Set a int in the shader.
  96251. * @param name Define the name of the uniform as defined in the shader
  96252. * @param value Define the value to give to the uniform
  96253. * @return the material itself allowing "fluent" like uniform updates
  96254. */
  96255. setInt(name: string, value: number): ShaderMaterial;
  96256. /**
  96257. * Set an array of floats in the shader.
  96258. * @param name Define the name of the uniform as defined in the shader
  96259. * @param value Define the value to give to the uniform
  96260. * @return the material itself allowing "fluent" like uniform updates
  96261. */
  96262. setFloats(name: string, value: number[]): ShaderMaterial;
  96263. /**
  96264. * Set a vec3 in the shader from a Color3.
  96265. * @param name Define the name of the uniform as defined in the shader
  96266. * @param value Define the value to give to the uniform
  96267. * @return the material itself allowing "fluent" like uniform updates
  96268. */
  96269. setColor3(name: string, value: Color3): ShaderMaterial;
  96270. /**
  96271. * Set a vec3 array in the shader from a Color3 array.
  96272. * @param name Define the name of the uniform as defined in the shader
  96273. * @param value Define the value to give to the uniform
  96274. * @return the material itself allowing "fluent" like uniform updates
  96275. */
  96276. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96277. /**
  96278. * Set a vec4 in the shader from a Color4.
  96279. * @param name Define the name of the uniform as defined in the shader
  96280. * @param value Define the value to give to the uniform
  96281. * @return the material itself allowing "fluent" like uniform updates
  96282. */
  96283. setColor4(name: string, value: Color4): ShaderMaterial;
  96284. /**
  96285. * Set a vec4 array in the shader from a Color4 array.
  96286. * @param name Define the name of the uniform as defined in the shader
  96287. * @param value Define the value to give to the uniform
  96288. * @return the material itself allowing "fluent" like uniform updates
  96289. */
  96290. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96291. /**
  96292. * Set a vec2 in the shader from a Vector2.
  96293. * @param name Define the name of the uniform as defined in the shader
  96294. * @param value Define the value to give to the uniform
  96295. * @return the material itself allowing "fluent" like uniform updates
  96296. */
  96297. setVector2(name: string, value: Vector2): ShaderMaterial;
  96298. /**
  96299. * Set a vec3 in the shader from a Vector3.
  96300. * @param name Define the name of the uniform as defined in the shader
  96301. * @param value Define the value to give to the uniform
  96302. * @return the material itself allowing "fluent" like uniform updates
  96303. */
  96304. setVector3(name: string, value: Vector3): ShaderMaterial;
  96305. /**
  96306. * Set a vec4 in the shader from a Vector4.
  96307. * @param name Define the name of the uniform as defined in the shader
  96308. * @param value Define the value to give to the uniform
  96309. * @return the material itself allowing "fluent" like uniform updates
  96310. */
  96311. setVector4(name: string, value: Vector4): ShaderMaterial;
  96312. /**
  96313. * Set a mat4 in the shader from a Matrix.
  96314. * @param name Define the name of the uniform as defined in the shader
  96315. * @param value Define the value to give to the uniform
  96316. * @return the material itself allowing "fluent" like uniform updates
  96317. */
  96318. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96319. /**
  96320. * Set a float32Array in the shader from a matrix array.
  96321. * @param name Define the name of the uniform as defined in the shader
  96322. * @param value Define the value to give to the uniform
  96323. * @return the material itself allowing "fluent" like uniform updates
  96324. */
  96325. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96326. /**
  96327. * Set a mat3 in the shader from a Float32Array.
  96328. * @param name Define the name of the uniform as defined in the shader
  96329. * @param value Define the value to give to the uniform
  96330. * @return the material itself allowing "fluent" like uniform updates
  96331. */
  96332. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96333. /**
  96334. * Set a mat2 in the shader from a Float32Array.
  96335. * @param name Define the name of the uniform as defined in the shader
  96336. * @param value Define the value to give to the uniform
  96337. * @return the material itself allowing "fluent" like uniform updates
  96338. */
  96339. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96340. /**
  96341. * Set a vec2 array in the shader from a number array.
  96342. * @param name Define the name of the uniform as defined in the shader
  96343. * @param value Define the value to give to the uniform
  96344. * @return the material itself allowing "fluent" like uniform updates
  96345. */
  96346. setArray2(name: string, value: number[]): ShaderMaterial;
  96347. /**
  96348. * Set a vec3 array in the shader from a number array.
  96349. * @param name Define the name of the uniform as defined in the shader
  96350. * @param value Define the value to give to the uniform
  96351. * @return the material itself allowing "fluent" like uniform updates
  96352. */
  96353. setArray3(name: string, value: number[]): ShaderMaterial;
  96354. /**
  96355. * Set a vec4 array in the shader from a number array.
  96356. * @param name Define the name of the uniform as defined in the shader
  96357. * @param value Define the value to give to the uniform
  96358. * @return the material itself allowing "fluent" like uniform updates
  96359. */
  96360. setArray4(name: string, value: number[]): ShaderMaterial;
  96361. private _checkCache;
  96362. /**
  96363. * Specifies that the submesh is ready to be used
  96364. * @param mesh defines the mesh to check
  96365. * @param subMesh defines which submesh to check
  96366. * @param useInstances specifies that instances should be used
  96367. * @returns a boolean indicating that the submesh is ready or not
  96368. */
  96369. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96370. /**
  96371. * Checks if the material is ready to render the requested mesh
  96372. * @param mesh Define the mesh to render
  96373. * @param useInstances Define whether or not the material is used with instances
  96374. * @returns true if ready, otherwise false
  96375. */
  96376. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96377. /**
  96378. * Binds the world matrix to the material
  96379. * @param world defines the world transformation matrix
  96380. * @param effectOverride - If provided, use this effect instead of internal effect
  96381. */
  96382. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96383. /**
  96384. * Binds the submesh to this material by preparing the effect and shader to draw
  96385. * @param world defines the world transformation matrix
  96386. * @param mesh defines the mesh containing the submesh
  96387. * @param subMesh defines the submesh to bind the material to
  96388. */
  96389. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96390. /**
  96391. * Binds the material to the mesh
  96392. * @param world defines the world transformation matrix
  96393. * @param mesh defines the mesh to bind the material to
  96394. * @param effectOverride - If provided, use this effect instead of internal effect
  96395. */
  96396. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96397. protected _afterBind(mesh?: Mesh): void;
  96398. /**
  96399. * Gets the active textures from the material
  96400. * @returns an array of textures
  96401. */
  96402. getActiveTextures(): BaseTexture[];
  96403. /**
  96404. * Specifies if the material uses a texture
  96405. * @param texture defines the texture to check against the material
  96406. * @returns a boolean specifying if the material uses the texture
  96407. */
  96408. hasTexture(texture: BaseTexture): boolean;
  96409. /**
  96410. * Makes a duplicate of the material, and gives it a new name
  96411. * @param name defines the new name for the duplicated material
  96412. * @returns the cloned material
  96413. */
  96414. clone(name: string): ShaderMaterial;
  96415. /**
  96416. * Disposes the material
  96417. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96418. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96419. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96420. */
  96421. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96422. /**
  96423. * Serializes this material in a JSON representation
  96424. * @returns the serialized material object
  96425. */
  96426. serialize(): any;
  96427. /**
  96428. * Creates a shader material from parsed shader material data
  96429. * @param source defines the JSON represnetation of the material
  96430. * @param scene defines the hosting scene
  96431. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96432. * @returns a new material
  96433. */
  96434. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96435. /**
  96436. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96437. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96438. * @param url defines the url to load from
  96439. * @param scene defines the hosting scene
  96440. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96441. * @returns a promise that will resolve to the new ShaderMaterial
  96442. */
  96443. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96444. /**
  96445. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96446. * @param snippetId defines the snippet to load
  96447. * @param scene defines the hosting scene
  96448. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96449. * @returns a promise that will resolve to the new ShaderMaterial
  96450. */
  96451. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96452. }
  96453. }
  96454. declare module BABYLON {
  96455. /** @hidden */
  96456. export var colorPixelShader: {
  96457. name: string;
  96458. shader: string;
  96459. };
  96460. }
  96461. declare module BABYLON {
  96462. /** @hidden */
  96463. export var colorVertexShader: {
  96464. name: string;
  96465. shader: string;
  96466. };
  96467. }
  96468. declare module BABYLON {
  96469. /**
  96470. * Line mesh
  96471. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96472. */
  96473. export class LinesMesh extends Mesh {
  96474. /**
  96475. * If vertex color should be applied to the mesh
  96476. */
  96477. readonly useVertexColor?: boolean | undefined;
  96478. /**
  96479. * If vertex alpha should be applied to the mesh
  96480. */
  96481. readonly useVertexAlpha?: boolean | undefined;
  96482. /**
  96483. * Color of the line (Default: White)
  96484. */
  96485. color: Color3;
  96486. /**
  96487. * Alpha of the line (Default: 1)
  96488. */
  96489. alpha: number;
  96490. /**
  96491. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96492. * This margin is expressed in world space coordinates, so its value may vary.
  96493. * Default value is 0.1
  96494. */
  96495. intersectionThreshold: number;
  96496. private _colorShader;
  96497. private color4;
  96498. /**
  96499. * Creates a new LinesMesh
  96500. * @param name defines the name
  96501. * @param scene defines the hosting scene
  96502. * @param parent defines the parent mesh if any
  96503. * @param source defines the optional source LinesMesh used to clone data from
  96504. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96505. * When false, achieved by calling a clone(), also passing False.
  96506. * This will make creation of children, recursive.
  96507. * @param useVertexColor defines if this LinesMesh supports vertex color
  96508. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96509. */
  96510. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96511. /**
  96512. * If vertex color should be applied to the mesh
  96513. */
  96514. useVertexColor?: boolean | undefined,
  96515. /**
  96516. * If vertex alpha should be applied to the mesh
  96517. */
  96518. useVertexAlpha?: boolean | undefined);
  96519. private _addClipPlaneDefine;
  96520. private _removeClipPlaneDefine;
  96521. isReady(): boolean;
  96522. /**
  96523. * Returns the string "LineMesh"
  96524. */
  96525. getClassName(): string;
  96526. /**
  96527. * @hidden
  96528. */
  96529. get material(): Material;
  96530. /**
  96531. * @hidden
  96532. */
  96533. set material(value: Material);
  96534. /**
  96535. * @hidden
  96536. */
  96537. get checkCollisions(): boolean;
  96538. /** @hidden */
  96539. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96540. /** @hidden */
  96541. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96542. /**
  96543. * Disposes of the line mesh
  96544. * @param doNotRecurse If children should be disposed
  96545. */
  96546. dispose(doNotRecurse?: boolean): void;
  96547. /**
  96548. * Returns a new LineMesh object cloned from the current one.
  96549. */
  96550. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96551. /**
  96552. * Creates a new InstancedLinesMesh object from the mesh model.
  96553. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96554. * @param name defines the name of the new instance
  96555. * @returns a new InstancedLinesMesh
  96556. */
  96557. createInstance(name: string): InstancedLinesMesh;
  96558. }
  96559. /**
  96560. * Creates an instance based on a source LinesMesh
  96561. */
  96562. export class InstancedLinesMesh extends InstancedMesh {
  96563. /**
  96564. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96565. * This margin is expressed in world space coordinates, so its value may vary.
  96566. * Initilized with the intersectionThreshold value of the source LinesMesh
  96567. */
  96568. intersectionThreshold: number;
  96569. constructor(name: string, source: LinesMesh);
  96570. /**
  96571. * Returns the string "InstancedLinesMesh".
  96572. */
  96573. getClassName(): string;
  96574. }
  96575. }
  96576. declare module BABYLON {
  96577. /** @hidden */
  96578. export var linePixelShader: {
  96579. name: string;
  96580. shader: string;
  96581. };
  96582. }
  96583. declare module BABYLON {
  96584. /** @hidden */
  96585. export var lineVertexShader: {
  96586. name: string;
  96587. shader: string;
  96588. };
  96589. }
  96590. declare module BABYLON {
  96591. interface Scene {
  96592. /** @hidden */
  96593. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96594. }
  96595. interface AbstractMesh {
  96596. /**
  96597. * Gets the edgesRenderer associated with the mesh
  96598. */
  96599. edgesRenderer: Nullable<EdgesRenderer>;
  96600. }
  96601. interface LinesMesh {
  96602. /**
  96603. * Enables the edge rendering mode on the mesh.
  96604. * This mode makes the mesh edges visible
  96605. * @param epsilon defines the maximal distance between two angles to detect a face
  96606. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96607. * @returns the currentAbstractMesh
  96608. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96609. */
  96610. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96611. }
  96612. interface InstancedLinesMesh {
  96613. /**
  96614. * Enables the edge rendering mode on the mesh.
  96615. * This mode makes the mesh edges visible
  96616. * @param epsilon defines the maximal distance between two angles to detect a face
  96617. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96618. * @returns the current InstancedLinesMesh
  96619. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96620. */
  96621. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96622. }
  96623. /**
  96624. * Defines the minimum contract an Edges renderer should follow.
  96625. */
  96626. export interface IEdgesRenderer extends IDisposable {
  96627. /**
  96628. * Gets or sets a boolean indicating if the edgesRenderer is active
  96629. */
  96630. isEnabled: boolean;
  96631. /**
  96632. * Renders the edges of the attached mesh,
  96633. */
  96634. render(): void;
  96635. /**
  96636. * Checks wether or not the edges renderer is ready to render.
  96637. * @return true if ready, otherwise false.
  96638. */
  96639. isReady(): boolean;
  96640. /**
  96641. * List of instances to render in case the source mesh has instances
  96642. */
  96643. customInstances: SmartArray<Matrix>;
  96644. }
  96645. /**
  96646. * Defines the additional options of the edges renderer
  96647. */
  96648. export interface IEdgesRendererOptions {
  96649. /**
  96650. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96651. * If not defined, the default value is true
  96652. */
  96653. useAlternateEdgeFinder?: boolean;
  96654. /**
  96655. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96656. * If not defined, the default value is true.
  96657. * 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)
  96658. * This option is used only if useAlternateEdgeFinder = true
  96659. */
  96660. useFastVertexMerger?: boolean;
  96661. /**
  96662. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96663. * The default value is 1e-6
  96664. * This option is used only if useAlternateEdgeFinder = true
  96665. */
  96666. epsilonVertexMerge?: number;
  96667. /**
  96668. * 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
  96669. * 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.
  96670. * This option is used only if useAlternateEdgeFinder = true
  96671. */
  96672. applyTessellation?: boolean;
  96673. /**
  96674. * 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
  96675. * The default value is 1e-6
  96676. * This option is used only if useAlternateEdgeFinder = true
  96677. */
  96678. epsilonVertexAligned?: number;
  96679. }
  96680. /**
  96681. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96682. */
  96683. export class EdgesRenderer implements IEdgesRenderer {
  96684. /**
  96685. * Define the size of the edges with an orthographic camera
  96686. */
  96687. edgesWidthScalerForOrthographic: number;
  96688. /**
  96689. * Define the size of the edges with a perspective camera
  96690. */
  96691. edgesWidthScalerForPerspective: number;
  96692. protected _source: AbstractMesh;
  96693. protected _linesPositions: number[];
  96694. protected _linesNormals: number[];
  96695. protected _linesIndices: number[];
  96696. protected _epsilon: number;
  96697. protected _indicesCount: number;
  96698. protected _lineShader: ShaderMaterial;
  96699. protected _ib: DataBuffer;
  96700. protected _buffers: {
  96701. [key: string]: Nullable<VertexBuffer>;
  96702. };
  96703. protected _buffersForInstances: {
  96704. [key: string]: Nullable<VertexBuffer>;
  96705. };
  96706. protected _checkVerticesInsteadOfIndices: boolean;
  96707. protected _options: Nullable<IEdgesRendererOptions>;
  96708. private _meshRebuildObserver;
  96709. private _meshDisposeObserver;
  96710. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96711. isEnabled: boolean;
  96712. /**
  96713. * List of instances to render in case the source mesh has instances
  96714. */
  96715. customInstances: SmartArray<Matrix>;
  96716. private static GetShader;
  96717. /**
  96718. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96719. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96720. * @param source Mesh used to create edges
  96721. * @param epsilon sum of angles in adjacency to check for edge
  96722. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96723. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96724. * @param options The options to apply when generating the edges
  96725. */
  96726. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96727. protected _prepareRessources(): void;
  96728. /** @hidden */
  96729. _rebuild(): void;
  96730. /**
  96731. * Releases the required resources for the edges renderer
  96732. */
  96733. dispose(): void;
  96734. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96735. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96736. /**
  96737. * Checks if the pair of p0 and p1 is en edge
  96738. * @param faceIndex
  96739. * @param edge
  96740. * @param faceNormals
  96741. * @param p0
  96742. * @param p1
  96743. * @private
  96744. */
  96745. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96746. /**
  96747. * push line into the position, normal and index buffer
  96748. * @protected
  96749. */
  96750. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96751. /**
  96752. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96753. */
  96754. private _tessellateTriangle;
  96755. private _generateEdgesLinesAlternate;
  96756. /**
  96757. * Generates lines edges from adjacencjes
  96758. * @private
  96759. */
  96760. _generateEdgesLines(): void;
  96761. /**
  96762. * Checks wether or not the edges renderer is ready to render.
  96763. * @return true if ready, otherwise false.
  96764. */
  96765. isReady(): boolean;
  96766. /**
  96767. * Renders the edges of the attached mesh,
  96768. */
  96769. render(): void;
  96770. }
  96771. /**
  96772. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96773. */
  96774. export class LineEdgesRenderer extends EdgesRenderer {
  96775. /**
  96776. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96777. * @param source LineMesh used to generate edges
  96778. * @param epsilon not important (specified angle for edge detection)
  96779. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96780. */
  96781. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96782. /**
  96783. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96784. */
  96785. _generateEdgesLines(): void;
  96786. }
  96787. }
  96788. declare module BABYLON {
  96789. /**
  96790. * This represents the object necessary to create a rendering group.
  96791. * This is exclusively used and created by the rendering manager.
  96792. * To modify the behavior, you use the available helpers in your scene or meshes.
  96793. * @hidden
  96794. */
  96795. export class RenderingGroup {
  96796. index: number;
  96797. private static _zeroVector;
  96798. private _scene;
  96799. private _opaqueSubMeshes;
  96800. private _transparentSubMeshes;
  96801. private _alphaTestSubMeshes;
  96802. private _depthOnlySubMeshes;
  96803. private _particleSystems;
  96804. private _spriteManagers;
  96805. private _opaqueSortCompareFn;
  96806. private _alphaTestSortCompareFn;
  96807. private _transparentSortCompareFn;
  96808. private _renderOpaque;
  96809. private _renderAlphaTest;
  96810. private _renderTransparent;
  96811. /** @hidden */
  96812. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96813. onBeforeTransparentRendering: () => void;
  96814. /**
  96815. * Set the opaque sort comparison function.
  96816. * If null the sub meshes will be render in the order they were created
  96817. */
  96818. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96819. /**
  96820. * Set the alpha test sort comparison function.
  96821. * If null the sub meshes will be render in the order they were created
  96822. */
  96823. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96824. /**
  96825. * Set the transparent sort comparison function.
  96826. * If null the sub meshes will be render in the order they were created
  96827. */
  96828. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96829. /**
  96830. * Creates a new rendering group.
  96831. * @param index The rendering group index
  96832. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96833. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96834. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96835. */
  96836. 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>);
  96837. /**
  96838. * Render all the sub meshes contained in the group.
  96839. * @param customRenderFunction Used to override the default render behaviour of the group.
  96840. * @returns true if rendered some submeshes.
  96841. */
  96842. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96843. /**
  96844. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96845. * @param subMeshes The submeshes to render
  96846. */
  96847. private renderOpaqueSorted;
  96848. /**
  96849. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96850. * @param subMeshes The submeshes to render
  96851. */
  96852. private renderAlphaTestSorted;
  96853. /**
  96854. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96855. * @param subMeshes The submeshes to render
  96856. */
  96857. private renderTransparentSorted;
  96858. /**
  96859. * Renders the submeshes in a specified order.
  96860. * @param subMeshes The submeshes to sort before render
  96861. * @param sortCompareFn The comparison function use to sort
  96862. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96863. * @param transparent Specifies to activate blending if true
  96864. */
  96865. private static renderSorted;
  96866. /**
  96867. * Renders the submeshes in the order they were dispatched (no sort applied).
  96868. * @param subMeshes The submeshes to render
  96869. */
  96870. private static renderUnsorted;
  96871. /**
  96872. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96873. * are rendered back to front if in the same alpha index.
  96874. *
  96875. * @param a The first submesh
  96876. * @param b The second submesh
  96877. * @returns The result of the comparison
  96878. */
  96879. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96880. /**
  96881. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96882. * are rendered back to front.
  96883. *
  96884. * @param a The first submesh
  96885. * @param b The second submesh
  96886. * @returns The result of the comparison
  96887. */
  96888. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96889. /**
  96890. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96891. * are rendered front to back (prevent overdraw).
  96892. *
  96893. * @param a The first submesh
  96894. * @param b The second submesh
  96895. * @returns The result of the comparison
  96896. */
  96897. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96898. /**
  96899. * Resets the different lists of submeshes to prepare a new frame.
  96900. */
  96901. prepare(): void;
  96902. dispose(): void;
  96903. /**
  96904. * Inserts the submesh in its correct queue depending on its material.
  96905. * @param subMesh The submesh to dispatch
  96906. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96907. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96908. */
  96909. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96910. dispatchSprites(spriteManager: ISpriteManager): void;
  96911. dispatchParticles(particleSystem: IParticleSystem): void;
  96912. private _renderParticles;
  96913. private _renderSprites;
  96914. }
  96915. }
  96916. declare module BABYLON {
  96917. /**
  96918. * Interface describing the different options available in the rendering manager
  96919. * regarding Auto Clear between groups.
  96920. */
  96921. export interface IRenderingManagerAutoClearSetup {
  96922. /**
  96923. * Defines whether or not autoclear is enable.
  96924. */
  96925. autoClear: boolean;
  96926. /**
  96927. * Defines whether or not to autoclear the depth buffer.
  96928. */
  96929. depth: boolean;
  96930. /**
  96931. * Defines whether or not to autoclear the stencil buffer.
  96932. */
  96933. stencil: boolean;
  96934. }
  96935. /**
  96936. * This class is used by the onRenderingGroupObservable
  96937. */
  96938. export class RenderingGroupInfo {
  96939. /**
  96940. * The Scene that being rendered
  96941. */
  96942. scene: Scene;
  96943. /**
  96944. * The camera currently used for the rendering pass
  96945. */
  96946. camera: Nullable<Camera>;
  96947. /**
  96948. * The ID of the renderingGroup being processed
  96949. */
  96950. renderingGroupId: number;
  96951. }
  96952. /**
  96953. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96954. * It is enable to manage the different groups as well as the different necessary sort functions.
  96955. * This should not be used directly aside of the few static configurations
  96956. */
  96957. export class RenderingManager {
  96958. /**
  96959. * The max id used for rendering groups (not included)
  96960. */
  96961. static MAX_RENDERINGGROUPS: number;
  96962. /**
  96963. * The min id used for rendering groups (included)
  96964. */
  96965. static MIN_RENDERINGGROUPS: number;
  96966. /**
  96967. * Used to globally prevent autoclearing scenes.
  96968. */
  96969. static AUTOCLEAR: boolean;
  96970. /**
  96971. * @hidden
  96972. */
  96973. _useSceneAutoClearSetup: boolean;
  96974. private _scene;
  96975. private _renderingGroups;
  96976. private _depthStencilBufferAlreadyCleaned;
  96977. private _autoClearDepthStencil;
  96978. private _customOpaqueSortCompareFn;
  96979. private _customAlphaTestSortCompareFn;
  96980. private _customTransparentSortCompareFn;
  96981. private _renderingGroupInfo;
  96982. /**
  96983. * Instantiates a new rendering group for a particular scene
  96984. * @param scene Defines the scene the groups belongs to
  96985. */
  96986. constructor(scene: Scene);
  96987. private _clearDepthStencilBuffer;
  96988. /**
  96989. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96990. * @hidden
  96991. */
  96992. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96993. /**
  96994. * Resets the different information of the group to prepare a new frame
  96995. * @hidden
  96996. */
  96997. reset(): void;
  96998. /**
  96999. * Dispose and release the group and its associated resources.
  97000. * @hidden
  97001. */
  97002. dispose(): void;
  97003. /**
  97004. * Clear the info related to rendering groups preventing retention points during dispose.
  97005. */
  97006. freeRenderingGroups(): void;
  97007. private _prepareRenderingGroup;
  97008. /**
  97009. * Add a sprite manager to the rendering manager in order to render it this frame.
  97010. * @param spriteManager Define the sprite manager to render
  97011. */
  97012. dispatchSprites(spriteManager: ISpriteManager): void;
  97013. /**
  97014. * Add a particle system to the rendering manager in order to render it this frame.
  97015. * @param particleSystem Define the particle system to render
  97016. */
  97017. dispatchParticles(particleSystem: IParticleSystem): void;
  97018. /**
  97019. * Add a submesh to the manager in order to render it this frame
  97020. * @param subMesh The submesh to dispatch
  97021. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97022. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97023. */
  97024. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97025. /**
  97026. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97027. * This allowed control for front to back rendering or reversly depending of the special needs.
  97028. *
  97029. * @param renderingGroupId The rendering group id corresponding to its index
  97030. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97031. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97032. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97033. */
  97034. 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;
  97035. /**
  97036. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97037. *
  97038. * @param renderingGroupId The rendering group id corresponding to its index
  97039. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97040. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97041. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97042. */
  97043. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97044. /**
  97045. * Gets the current auto clear configuration for one rendering group of the rendering
  97046. * manager.
  97047. * @param index the rendering group index to get the information for
  97048. * @returns The auto clear setup for the requested rendering group
  97049. */
  97050. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97051. }
  97052. }
  97053. declare module BABYLON {
  97054. /**
  97055. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97056. */
  97057. export interface ICustomShaderOptions {
  97058. /**
  97059. * Gets or sets the custom shader name to use
  97060. */
  97061. shaderName: string;
  97062. /**
  97063. * The list of attribute names used in the shader
  97064. */
  97065. attributes?: string[];
  97066. /**
  97067. * The list of unifrom names used in the shader
  97068. */
  97069. uniforms?: string[];
  97070. /**
  97071. * The list of sampler names used in the shader
  97072. */
  97073. samplers?: string[];
  97074. /**
  97075. * The list of defines used in the shader
  97076. */
  97077. defines?: string[];
  97078. }
  97079. /**
  97080. * Interface to implement to create a shadow generator compatible with BJS.
  97081. */
  97082. export interface IShadowGenerator {
  97083. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97084. id: string;
  97085. /**
  97086. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97087. * @returns The render target texture if present otherwise, null
  97088. */
  97089. getShadowMap(): Nullable<RenderTargetTexture>;
  97090. /**
  97091. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97092. * @param subMesh The submesh we want to render in the shadow map
  97093. * @param useInstances Defines wether will draw in the map using instances
  97094. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97095. * @returns true if ready otherwise, false
  97096. */
  97097. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97098. /**
  97099. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97100. * @param defines Defines of the material we want to update
  97101. * @param lightIndex Index of the light in the enabled light list of the material
  97102. */
  97103. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97104. /**
  97105. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97106. * defined in the generator but impacting the effect).
  97107. * It implies the unifroms available on the materials are the standard BJS ones.
  97108. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97109. * @param effect The effect we are binfing the information for
  97110. */
  97111. bindShadowLight(lightIndex: string, effect: Effect): void;
  97112. /**
  97113. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97114. * (eq to shadow prjection matrix * light transform matrix)
  97115. * @returns The transform matrix used to create the shadow map
  97116. */
  97117. getTransformMatrix(): Matrix;
  97118. /**
  97119. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97120. * Cube and 2D textures for instance.
  97121. */
  97122. recreateShadowMap(): void;
  97123. /**
  97124. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97125. * @param onCompiled Callback triggered at the and of the effects compilation
  97126. * @param options Sets of optional options forcing the compilation with different modes
  97127. */
  97128. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97129. useInstances: boolean;
  97130. }>): void;
  97131. /**
  97132. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97133. * @param options Sets of optional options forcing the compilation with different modes
  97134. * @returns A promise that resolves when the compilation completes
  97135. */
  97136. forceCompilationAsync(options?: Partial<{
  97137. useInstances: boolean;
  97138. }>): Promise<void>;
  97139. /**
  97140. * Serializes the shadow generator setup to a json object.
  97141. * @returns The serialized JSON object
  97142. */
  97143. serialize(): any;
  97144. /**
  97145. * Disposes the Shadow map and related Textures and effects.
  97146. */
  97147. dispose(): void;
  97148. }
  97149. /**
  97150. * Default implementation IShadowGenerator.
  97151. * This is the main object responsible of generating shadows in the framework.
  97152. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97153. */
  97154. export class ShadowGenerator implements IShadowGenerator {
  97155. /**
  97156. * Name of the shadow generator class
  97157. */
  97158. static CLASSNAME: string;
  97159. /**
  97160. * Shadow generator mode None: no filtering applied.
  97161. */
  97162. static readonly FILTER_NONE: number;
  97163. /**
  97164. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97165. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97166. */
  97167. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97168. /**
  97169. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97170. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97171. */
  97172. static readonly FILTER_POISSONSAMPLING: number;
  97173. /**
  97174. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97175. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97176. */
  97177. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97178. /**
  97179. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97180. * edge artifacts on steep falloff.
  97181. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97182. */
  97183. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97184. /**
  97185. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97186. * edge artifacts on steep falloff.
  97187. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97188. */
  97189. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97190. /**
  97191. * Shadow generator mode PCF: Percentage Closer Filtering
  97192. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97193. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97194. */
  97195. static readonly FILTER_PCF: number;
  97196. /**
  97197. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97198. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97199. * Contact Hardening
  97200. */
  97201. static readonly FILTER_PCSS: number;
  97202. /**
  97203. * Reserved for PCF and PCSS
  97204. * Highest Quality.
  97205. *
  97206. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97207. *
  97208. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97209. */
  97210. static readonly QUALITY_HIGH: number;
  97211. /**
  97212. * Reserved for PCF and PCSS
  97213. * Good tradeoff for quality/perf cross devices
  97214. *
  97215. * Execute PCF on a 3*3 kernel.
  97216. *
  97217. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97218. */
  97219. static readonly QUALITY_MEDIUM: number;
  97220. /**
  97221. * Reserved for PCF and PCSS
  97222. * The lowest quality but the fastest.
  97223. *
  97224. * Execute PCF on a 1*1 kernel.
  97225. *
  97226. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97227. */
  97228. static readonly QUALITY_LOW: number;
  97229. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97230. id: string;
  97231. /** Gets or sets the custom shader name to use */
  97232. customShaderOptions: ICustomShaderOptions;
  97233. /**
  97234. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97235. */
  97236. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97237. /**
  97238. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97239. */
  97240. onAfterShadowMapRenderObservable: Observable<Effect>;
  97241. /**
  97242. * Observable triggered before a mesh is rendered in the shadow map.
  97243. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97244. */
  97245. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97246. /**
  97247. * Observable triggered after a mesh is rendered in the shadow map.
  97248. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97249. */
  97250. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97251. protected _bias: number;
  97252. /**
  97253. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97254. */
  97255. get bias(): number;
  97256. /**
  97257. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97258. */
  97259. set bias(bias: number);
  97260. protected _normalBias: number;
  97261. /**
  97262. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97263. */
  97264. get normalBias(): number;
  97265. /**
  97266. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97267. */
  97268. set normalBias(normalBias: number);
  97269. protected _blurBoxOffset: number;
  97270. /**
  97271. * Gets the blur box offset: offset applied during the blur pass.
  97272. * Only useful if useKernelBlur = false
  97273. */
  97274. get blurBoxOffset(): number;
  97275. /**
  97276. * Sets the blur box offset: offset applied during the blur pass.
  97277. * Only useful if useKernelBlur = false
  97278. */
  97279. set blurBoxOffset(value: number);
  97280. protected _blurScale: number;
  97281. /**
  97282. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97283. * 2 means half of the size.
  97284. */
  97285. get blurScale(): number;
  97286. /**
  97287. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97288. * 2 means half of the size.
  97289. */
  97290. set blurScale(value: number);
  97291. protected _blurKernel: number;
  97292. /**
  97293. * Gets the blur kernel: kernel size of the blur pass.
  97294. * Only useful if useKernelBlur = true
  97295. */
  97296. get blurKernel(): number;
  97297. /**
  97298. * Sets the blur kernel: kernel size of the blur pass.
  97299. * Only useful if useKernelBlur = true
  97300. */
  97301. set blurKernel(value: number);
  97302. protected _useKernelBlur: boolean;
  97303. /**
  97304. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97305. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97306. */
  97307. get useKernelBlur(): boolean;
  97308. /**
  97309. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97310. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97311. */
  97312. set useKernelBlur(value: boolean);
  97313. protected _depthScale: number;
  97314. /**
  97315. * Gets the depth scale used in ESM mode.
  97316. */
  97317. get depthScale(): number;
  97318. /**
  97319. * Sets the depth scale used in ESM mode.
  97320. * This can override the scale stored on the light.
  97321. */
  97322. set depthScale(value: number);
  97323. protected _validateFilter(filter: number): number;
  97324. protected _filter: number;
  97325. /**
  97326. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97327. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97328. */
  97329. get filter(): number;
  97330. /**
  97331. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97332. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97333. */
  97334. set filter(value: number);
  97335. /**
  97336. * Gets if the current filter is set to Poisson Sampling.
  97337. */
  97338. get usePoissonSampling(): boolean;
  97339. /**
  97340. * Sets the current filter to Poisson Sampling.
  97341. */
  97342. set usePoissonSampling(value: boolean);
  97343. /**
  97344. * Gets if the current filter is set to ESM.
  97345. */
  97346. get useExponentialShadowMap(): boolean;
  97347. /**
  97348. * Sets the current filter is to ESM.
  97349. */
  97350. set useExponentialShadowMap(value: boolean);
  97351. /**
  97352. * Gets if the current filter is set to filtered ESM.
  97353. */
  97354. get useBlurExponentialShadowMap(): boolean;
  97355. /**
  97356. * Gets if the current filter is set to filtered ESM.
  97357. */
  97358. set useBlurExponentialShadowMap(value: boolean);
  97359. /**
  97360. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97361. * exponential to prevent steep falloff artifacts).
  97362. */
  97363. get useCloseExponentialShadowMap(): boolean;
  97364. /**
  97365. * Sets the current filter to "close ESM" (using the inverse of the
  97366. * exponential to prevent steep falloff artifacts).
  97367. */
  97368. set useCloseExponentialShadowMap(value: boolean);
  97369. /**
  97370. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97371. * exponential to prevent steep falloff artifacts).
  97372. */
  97373. get useBlurCloseExponentialShadowMap(): boolean;
  97374. /**
  97375. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97376. * exponential to prevent steep falloff artifacts).
  97377. */
  97378. set useBlurCloseExponentialShadowMap(value: boolean);
  97379. /**
  97380. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97381. */
  97382. get usePercentageCloserFiltering(): boolean;
  97383. /**
  97384. * Sets the current filter to "PCF" (percentage closer filtering).
  97385. */
  97386. set usePercentageCloserFiltering(value: boolean);
  97387. protected _filteringQuality: number;
  97388. /**
  97389. * Gets the PCF or PCSS Quality.
  97390. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97391. */
  97392. get filteringQuality(): number;
  97393. /**
  97394. * Sets the PCF or PCSS Quality.
  97395. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97396. */
  97397. set filteringQuality(filteringQuality: number);
  97398. /**
  97399. * Gets if the current filter is set to "PCSS" (contact hardening).
  97400. */
  97401. get useContactHardeningShadow(): boolean;
  97402. /**
  97403. * Sets the current filter to "PCSS" (contact hardening).
  97404. */
  97405. set useContactHardeningShadow(value: boolean);
  97406. protected _contactHardeningLightSizeUVRatio: number;
  97407. /**
  97408. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97409. * Using a ratio helps keeping shape stability independently of the map size.
  97410. *
  97411. * It does not account for the light projection as it was having too much
  97412. * instability during the light setup or during light position changes.
  97413. *
  97414. * Only valid if useContactHardeningShadow is true.
  97415. */
  97416. get contactHardeningLightSizeUVRatio(): number;
  97417. /**
  97418. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97419. * Using a ratio helps keeping shape stability independently of the map size.
  97420. *
  97421. * It does not account for the light projection as it was having too much
  97422. * instability during the light setup or during light position changes.
  97423. *
  97424. * Only valid if useContactHardeningShadow is true.
  97425. */
  97426. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97427. protected _darkness: number;
  97428. /** Gets or sets the actual darkness of a shadow */
  97429. get darkness(): number;
  97430. set darkness(value: number);
  97431. /**
  97432. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97433. * 0 means strongest and 1 would means no shadow.
  97434. * @returns the darkness.
  97435. */
  97436. getDarkness(): number;
  97437. /**
  97438. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97439. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97440. * @returns the shadow generator allowing fluent coding.
  97441. */
  97442. setDarkness(darkness: number): ShadowGenerator;
  97443. protected _transparencyShadow: boolean;
  97444. /** Gets or sets the ability to have transparent shadow */
  97445. get transparencyShadow(): boolean;
  97446. set transparencyShadow(value: boolean);
  97447. /**
  97448. * Sets the ability to have transparent shadow (boolean).
  97449. * @param transparent True if transparent else False
  97450. * @returns the shadow generator allowing fluent coding
  97451. */
  97452. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97453. /**
  97454. * Enables or disables shadows with varying strength based on the transparency
  97455. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97456. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97457. * mesh.visibility * alphaTexture.a
  97458. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97459. */
  97460. enableSoftTransparentShadow: boolean;
  97461. protected _shadowMap: Nullable<RenderTargetTexture>;
  97462. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97463. /**
  97464. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97465. * @returns The render target texture if present otherwise, null
  97466. */
  97467. getShadowMap(): Nullable<RenderTargetTexture>;
  97468. /**
  97469. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97470. * @returns The render target texture if the shadow map is present otherwise, null
  97471. */
  97472. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97473. /**
  97474. * Gets the class name of that object
  97475. * @returns "ShadowGenerator"
  97476. */
  97477. getClassName(): string;
  97478. /**
  97479. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97480. * @param mesh Mesh to add
  97481. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97482. * @returns the Shadow Generator itself
  97483. */
  97484. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97485. /**
  97486. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97487. * @param mesh Mesh to remove
  97488. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97489. * @returns the Shadow Generator itself
  97490. */
  97491. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97492. /**
  97493. * Controls the extent to which the shadows fade out at the edge of the frustum
  97494. */
  97495. frustumEdgeFalloff: number;
  97496. protected _light: IShadowLight;
  97497. /**
  97498. * Returns the associated light object.
  97499. * @returns the light generating the shadow
  97500. */
  97501. getLight(): IShadowLight;
  97502. /**
  97503. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97504. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97505. * It might on the other hand introduce peter panning.
  97506. */
  97507. forceBackFacesOnly: boolean;
  97508. protected _scene: Scene;
  97509. protected _lightDirection: Vector3;
  97510. protected _effect: Effect;
  97511. protected _viewMatrix: Matrix;
  97512. protected _projectionMatrix: Matrix;
  97513. protected _transformMatrix: Matrix;
  97514. protected _cachedPosition: Vector3;
  97515. protected _cachedDirection: Vector3;
  97516. protected _cachedDefines: string;
  97517. protected _currentRenderID: number;
  97518. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97519. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97520. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97521. protected _blurPostProcesses: PostProcess[];
  97522. protected _mapSize: number;
  97523. protected _currentFaceIndex: number;
  97524. protected _currentFaceIndexCache: number;
  97525. protected _textureType: number;
  97526. protected _defaultTextureMatrix: Matrix;
  97527. protected _storedUniqueId: Nullable<number>;
  97528. /** @hidden */
  97529. static _SceneComponentInitialization: (scene: Scene) => void;
  97530. /**
  97531. * Creates a ShadowGenerator object.
  97532. * A ShadowGenerator is the required tool to use the shadows.
  97533. * Each light casting shadows needs to use its own ShadowGenerator.
  97534. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97535. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97536. * @param light The light object generating the shadows.
  97537. * @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.
  97538. */
  97539. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97540. protected _initializeGenerator(): void;
  97541. protected _createTargetRenderTexture(): void;
  97542. protected _initializeShadowMap(): void;
  97543. protected _initializeBlurRTTAndPostProcesses(): void;
  97544. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97545. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97546. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97547. protected _applyFilterValues(): void;
  97548. /**
  97549. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97550. * @param onCompiled Callback triggered at the and of the effects compilation
  97551. * @param options Sets of optional options forcing the compilation with different modes
  97552. */
  97553. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97554. useInstances: boolean;
  97555. }>): void;
  97556. /**
  97557. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97558. * @param options Sets of optional options forcing the compilation with different modes
  97559. * @returns A promise that resolves when the compilation completes
  97560. */
  97561. forceCompilationAsync(options?: Partial<{
  97562. useInstances: boolean;
  97563. }>): Promise<void>;
  97564. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97565. private _prepareShadowDefines;
  97566. /**
  97567. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97568. * @param subMesh The submesh we want to render in the shadow map
  97569. * @param useInstances Defines wether will draw in the map using instances
  97570. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97571. * @returns true if ready otherwise, false
  97572. */
  97573. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97574. /**
  97575. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97576. * @param defines Defines of the material we want to update
  97577. * @param lightIndex Index of the light in the enabled light list of the material
  97578. */
  97579. prepareDefines(defines: any, lightIndex: number): void;
  97580. /**
  97581. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97582. * defined in the generator but impacting the effect).
  97583. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97584. * @param effect The effect we are binfing the information for
  97585. */
  97586. bindShadowLight(lightIndex: string, effect: Effect): void;
  97587. /**
  97588. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97589. * (eq to shadow prjection matrix * light transform matrix)
  97590. * @returns The transform matrix used to create the shadow map
  97591. */
  97592. getTransformMatrix(): Matrix;
  97593. /**
  97594. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97595. * Cube and 2D textures for instance.
  97596. */
  97597. recreateShadowMap(): void;
  97598. protected _disposeBlurPostProcesses(): void;
  97599. protected _disposeRTTandPostProcesses(): void;
  97600. /**
  97601. * Disposes the ShadowGenerator.
  97602. * Returns nothing.
  97603. */
  97604. dispose(): void;
  97605. /**
  97606. * Serializes the shadow generator setup to a json object.
  97607. * @returns The serialized JSON object
  97608. */
  97609. serialize(): any;
  97610. /**
  97611. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97612. * @param parsedShadowGenerator The JSON object to parse
  97613. * @param scene The scene to create the shadow map for
  97614. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97615. * @returns The parsed shadow generator
  97616. */
  97617. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97618. }
  97619. }
  97620. declare module BABYLON {
  97621. /**
  97622. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97623. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97624. * 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.
  97625. */
  97626. export abstract class Light extends Node {
  97627. /**
  97628. * Falloff Default: light is falling off following the material specification:
  97629. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97630. */
  97631. static readonly FALLOFF_DEFAULT: number;
  97632. /**
  97633. * Falloff Physical: light is falling off following the inverse squared distance law.
  97634. */
  97635. static readonly FALLOFF_PHYSICAL: number;
  97636. /**
  97637. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97638. * to enhance interoperability with other engines.
  97639. */
  97640. static readonly FALLOFF_GLTF: number;
  97641. /**
  97642. * Falloff Standard: light is falling off like in the standard material
  97643. * to enhance interoperability with other materials.
  97644. */
  97645. static readonly FALLOFF_STANDARD: number;
  97646. /**
  97647. * If every light affecting the material is in this lightmapMode,
  97648. * material.lightmapTexture adds or multiplies
  97649. * (depends on material.useLightmapAsShadowmap)
  97650. * after every other light calculations.
  97651. */
  97652. static readonly LIGHTMAP_DEFAULT: number;
  97653. /**
  97654. * material.lightmapTexture as only diffuse lighting from this light
  97655. * adds only specular lighting from this light
  97656. * adds dynamic shadows
  97657. */
  97658. static readonly LIGHTMAP_SPECULAR: number;
  97659. /**
  97660. * material.lightmapTexture as only lighting
  97661. * no light calculation from this light
  97662. * only adds dynamic shadows from this light
  97663. */
  97664. static readonly LIGHTMAP_SHADOWSONLY: number;
  97665. /**
  97666. * Each light type uses the default quantity according to its type:
  97667. * point/spot lights use luminous intensity
  97668. * directional lights use illuminance
  97669. */
  97670. static readonly INTENSITYMODE_AUTOMATIC: number;
  97671. /**
  97672. * lumen (lm)
  97673. */
  97674. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97675. /**
  97676. * candela (lm/sr)
  97677. */
  97678. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97679. /**
  97680. * lux (lm/m^2)
  97681. */
  97682. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97683. /**
  97684. * nit (cd/m^2)
  97685. */
  97686. static readonly INTENSITYMODE_LUMINANCE: number;
  97687. /**
  97688. * Light type const id of the point light.
  97689. */
  97690. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97691. /**
  97692. * Light type const id of the directional light.
  97693. */
  97694. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97695. /**
  97696. * Light type const id of the spot light.
  97697. */
  97698. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97699. /**
  97700. * Light type const id of the hemispheric light.
  97701. */
  97702. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97703. /**
  97704. * Diffuse gives the basic color to an object.
  97705. */
  97706. diffuse: Color3;
  97707. /**
  97708. * Specular produces a highlight color on an object.
  97709. * Note: This is note affecting PBR materials.
  97710. */
  97711. specular: Color3;
  97712. /**
  97713. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97714. * falling off base on range or angle.
  97715. * This can be set to any values in Light.FALLOFF_x.
  97716. *
  97717. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97718. * other types of materials.
  97719. */
  97720. falloffType: number;
  97721. /**
  97722. * Strength of the light.
  97723. * Note: By default it is define in the framework own unit.
  97724. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97725. */
  97726. intensity: number;
  97727. private _range;
  97728. protected _inverseSquaredRange: number;
  97729. /**
  97730. * Defines how far from the source the light is impacting in scene units.
  97731. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97732. */
  97733. get range(): number;
  97734. /**
  97735. * Defines how far from the source the light is impacting in scene units.
  97736. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97737. */
  97738. set range(value: number);
  97739. /**
  97740. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97741. * of light.
  97742. */
  97743. private _photometricScale;
  97744. private _intensityMode;
  97745. /**
  97746. * Gets the photometric scale used to interpret the intensity.
  97747. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97748. */
  97749. get intensityMode(): number;
  97750. /**
  97751. * Sets the photometric scale used to interpret the intensity.
  97752. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97753. */
  97754. set intensityMode(value: number);
  97755. private _radius;
  97756. /**
  97757. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97758. */
  97759. get radius(): number;
  97760. /**
  97761. * sets the light radius used by PBR Materials to simulate soft area lights.
  97762. */
  97763. set radius(value: number);
  97764. private _renderPriority;
  97765. /**
  97766. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97767. * exceeding the number allowed of the materials.
  97768. */
  97769. renderPriority: number;
  97770. private _shadowEnabled;
  97771. /**
  97772. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97773. * the current shadow generator.
  97774. */
  97775. get shadowEnabled(): boolean;
  97776. /**
  97777. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97778. * the current shadow generator.
  97779. */
  97780. set shadowEnabled(value: boolean);
  97781. private _includedOnlyMeshes;
  97782. /**
  97783. * Gets the only meshes impacted by this light.
  97784. */
  97785. get includedOnlyMeshes(): AbstractMesh[];
  97786. /**
  97787. * Sets the only meshes impacted by this light.
  97788. */
  97789. set includedOnlyMeshes(value: AbstractMesh[]);
  97790. private _excludedMeshes;
  97791. /**
  97792. * Gets the meshes not impacted by this light.
  97793. */
  97794. get excludedMeshes(): AbstractMesh[];
  97795. /**
  97796. * Sets the meshes not impacted by this light.
  97797. */
  97798. set excludedMeshes(value: AbstractMesh[]);
  97799. private _excludeWithLayerMask;
  97800. /**
  97801. * Gets the layer id use to find what meshes are not impacted by the light.
  97802. * Inactive if 0
  97803. */
  97804. get excludeWithLayerMask(): number;
  97805. /**
  97806. * Sets the layer id use to find what meshes are not impacted by the light.
  97807. * Inactive if 0
  97808. */
  97809. set excludeWithLayerMask(value: number);
  97810. private _includeOnlyWithLayerMask;
  97811. /**
  97812. * Gets the layer id use to find what meshes are impacted by the light.
  97813. * Inactive if 0
  97814. */
  97815. get includeOnlyWithLayerMask(): number;
  97816. /**
  97817. * Sets the layer id use to find what meshes are impacted by the light.
  97818. * Inactive if 0
  97819. */
  97820. set includeOnlyWithLayerMask(value: number);
  97821. private _lightmapMode;
  97822. /**
  97823. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97824. */
  97825. get lightmapMode(): number;
  97826. /**
  97827. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97828. */
  97829. set lightmapMode(value: number);
  97830. /**
  97831. * Shadow generator associted to the light.
  97832. * @hidden Internal use only.
  97833. */
  97834. _shadowGenerator: Nullable<IShadowGenerator>;
  97835. /**
  97836. * @hidden Internal use only.
  97837. */
  97838. _excludedMeshesIds: string[];
  97839. /**
  97840. * @hidden Internal use only.
  97841. */
  97842. _includedOnlyMeshesIds: string[];
  97843. /**
  97844. * The current light unifom buffer.
  97845. * @hidden Internal use only.
  97846. */
  97847. _uniformBuffer: UniformBuffer;
  97848. /** @hidden */
  97849. _renderId: number;
  97850. /**
  97851. * Creates a Light object in the scene.
  97852. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97853. * @param name The firendly name of the light
  97854. * @param scene The scene the light belongs too
  97855. */
  97856. constructor(name: string, scene: Scene);
  97857. protected abstract _buildUniformLayout(): void;
  97858. /**
  97859. * Sets the passed Effect "effect" with the Light information.
  97860. * @param effect The effect to update
  97861. * @param lightIndex The index of the light in the effect to update
  97862. * @returns The light
  97863. */
  97864. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97865. /**
  97866. * Sets the passed Effect "effect" with the Light textures.
  97867. * @param effect The effect to update
  97868. * @param lightIndex The index of the light in the effect to update
  97869. * @returns The light
  97870. */
  97871. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97872. /**
  97873. * Binds the lights information from the scene to the effect for the given mesh.
  97874. * @param lightIndex Light index
  97875. * @param scene The scene where the light belongs to
  97876. * @param effect The effect we are binding the data to
  97877. * @param useSpecular Defines if specular is supported
  97878. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97879. */
  97880. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97881. /**
  97882. * Sets the passed Effect "effect" with the Light information.
  97883. * @param effect The effect to update
  97884. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97885. * @returns The light
  97886. */
  97887. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97888. /**
  97889. * Returns the string "Light".
  97890. * @returns the class name
  97891. */
  97892. getClassName(): string;
  97893. /** @hidden */
  97894. readonly _isLight: boolean;
  97895. /**
  97896. * Converts the light information to a readable string for debug purpose.
  97897. * @param fullDetails Supports for multiple levels of logging within scene loading
  97898. * @returns the human readable light info
  97899. */
  97900. toString(fullDetails?: boolean): string;
  97901. /** @hidden */
  97902. protected _syncParentEnabledState(): void;
  97903. /**
  97904. * Set the enabled state of this node.
  97905. * @param value - the new enabled state
  97906. */
  97907. setEnabled(value: boolean): void;
  97908. /**
  97909. * Returns the Light associated shadow generator if any.
  97910. * @return the associated shadow generator.
  97911. */
  97912. getShadowGenerator(): Nullable<IShadowGenerator>;
  97913. /**
  97914. * Returns a Vector3, the absolute light position in the World.
  97915. * @returns the world space position of the light
  97916. */
  97917. getAbsolutePosition(): Vector3;
  97918. /**
  97919. * Specifies if the light will affect the passed mesh.
  97920. * @param mesh The mesh to test against the light
  97921. * @return true the mesh is affected otherwise, false.
  97922. */
  97923. canAffectMesh(mesh: AbstractMesh): boolean;
  97924. /**
  97925. * Sort function to order lights for rendering.
  97926. * @param a First Light object to compare to second.
  97927. * @param b Second Light object to compare first.
  97928. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97929. */
  97930. static CompareLightsPriority(a: Light, b: Light): number;
  97931. /**
  97932. * Releases resources associated with this node.
  97933. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97934. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97935. */
  97936. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97937. /**
  97938. * Returns the light type ID (integer).
  97939. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97940. */
  97941. getTypeID(): number;
  97942. /**
  97943. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97944. * @returns the scaled intensity in intensity mode unit
  97945. */
  97946. getScaledIntensity(): number;
  97947. /**
  97948. * Returns a new Light object, named "name", from the current one.
  97949. * @param name The name of the cloned light
  97950. * @param newParent The parent of this light, if it has one
  97951. * @returns the new created light
  97952. */
  97953. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97954. /**
  97955. * Serializes the current light into a Serialization object.
  97956. * @returns the serialized object.
  97957. */
  97958. serialize(): any;
  97959. /**
  97960. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97961. * This new light is named "name" and added to the passed scene.
  97962. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97963. * @param name The friendly name of the light
  97964. * @param scene The scene the new light will belong to
  97965. * @returns the constructor function
  97966. */
  97967. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97968. /**
  97969. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97970. * @param parsedLight The JSON representation of the light
  97971. * @param scene The scene to create the parsed light in
  97972. * @returns the created light after parsing
  97973. */
  97974. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97975. private _hookArrayForExcluded;
  97976. private _hookArrayForIncludedOnly;
  97977. private _resyncMeshes;
  97978. /**
  97979. * Forces the meshes to update their light related information in their rendering used effects
  97980. * @hidden Internal Use Only
  97981. */
  97982. _markMeshesAsLightDirty(): void;
  97983. /**
  97984. * Recomputes the cached photometric scale if needed.
  97985. */
  97986. private _computePhotometricScale;
  97987. /**
  97988. * Returns the Photometric Scale according to the light type and intensity mode.
  97989. */
  97990. private _getPhotometricScale;
  97991. /**
  97992. * Reorder the light in the scene according to their defined priority.
  97993. * @hidden Internal Use Only
  97994. */
  97995. _reorderLightsInScene(): void;
  97996. /**
  97997. * Prepares the list of defines specific to the light type.
  97998. * @param defines the list of defines
  97999. * @param lightIndex defines the index of the light for the effect
  98000. */
  98001. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98002. }
  98003. }
  98004. declare module BABYLON {
  98005. /**
  98006. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  98007. * This is the base of the follow, arc rotate cameras and Free camera
  98008. * @see https://doc.babylonjs.com/features/cameras
  98009. */
  98010. export class TargetCamera extends Camera {
  98011. private static _RigCamTransformMatrix;
  98012. private static _TargetTransformMatrix;
  98013. private static _TargetFocalPoint;
  98014. private _tmpUpVector;
  98015. private _tmpTargetVector;
  98016. /**
  98017. * Define the current direction the camera is moving to
  98018. */
  98019. cameraDirection: Vector3;
  98020. /**
  98021. * Define the current rotation the camera is rotating to
  98022. */
  98023. cameraRotation: Vector2;
  98024. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98025. ignoreParentScaling: boolean;
  98026. /**
  98027. * When set, the up vector of the camera will be updated by the rotation of the camera
  98028. */
  98029. updateUpVectorFromRotation: boolean;
  98030. private _tmpQuaternion;
  98031. /**
  98032. * Define the current rotation of the camera
  98033. */
  98034. rotation: Vector3;
  98035. /**
  98036. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98037. */
  98038. rotationQuaternion: Quaternion;
  98039. /**
  98040. * Define the current speed of the camera
  98041. */
  98042. speed: number;
  98043. /**
  98044. * Add constraint to the camera to prevent it to move freely in all directions and
  98045. * around all axis.
  98046. */
  98047. noRotationConstraint: boolean;
  98048. /**
  98049. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98050. * panning
  98051. */
  98052. invertRotation: boolean;
  98053. /**
  98054. * Speed multiplier for inverse camera panning
  98055. */
  98056. inverseRotationSpeed: number;
  98057. /**
  98058. * Define the current target of the camera as an object or a position.
  98059. */
  98060. lockedTarget: any;
  98061. /** @hidden */
  98062. _currentTarget: Vector3;
  98063. /** @hidden */
  98064. _initialFocalDistance: number;
  98065. /** @hidden */
  98066. _viewMatrix: Matrix;
  98067. /** @hidden */
  98068. _camMatrix: Matrix;
  98069. /** @hidden */
  98070. _cameraTransformMatrix: Matrix;
  98071. /** @hidden */
  98072. _cameraRotationMatrix: Matrix;
  98073. /** @hidden */
  98074. _referencePoint: Vector3;
  98075. /** @hidden */
  98076. _transformedReferencePoint: Vector3;
  98077. /** @hidden */
  98078. _reset: () => void;
  98079. private _defaultUp;
  98080. /**
  98081. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98082. * This is the base of the follow, arc rotate cameras and Free camera
  98083. * @see https://doc.babylonjs.com/features/cameras
  98084. * @param name Defines the name of the camera in the scene
  98085. * @param position Defines the start position of the camera in the scene
  98086. * @param scene Defines the scene the camera belongs to
  98087. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98088. */
  98089. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98090. /**
  98091. * Gets the position in front of the camera at a given distance.
  98092. * @param distance The distance from the camera we want the position to be
  98093. * @returns the position
  98094. */
  98095. getFrontPosition(distance: number): Vector3;
  98096. /** @hidden */
  98097. _getLockedTargetPosition(): Nullable<Vector3>;
  98098. private _storedPosition;
  98099. private _storedRotation;
  98100. private _storedRotationQuaternion;
  98101. /**
  98102. * Store current camera state of the camera (fov, position, rotation, etc..)
  98103. * @returns the camera
  98104. */
  98105. storeState(): Camera;
  98106. /**
  98107. * Restored camera state. You must call storeState() first
  98108. * @returns whether it was successful or not
  98109. * @hidden
  98110. */
  98111. _restoreStateValues(): boolean;
  98112. /** @hidden */
  98113. _initCache(): void;
  98114. /** @hidden */
  98115. _updateCache(ignoreParentClass?: boolean): void;
  98116. /** @hidden */
  98117. _isSynchronizedViewMatrix(): boolean;
  98118. /** @hidden */
  98119. _computeLocalCameraSpeed(): number;
  98120. /**
  98121. * Defines the target the camera should look at.
  98122. * @param target Defines the new target as a Vector or a mesh
  98123. */
  98124. setTarget(target: Vector3): void;
  98125. /**
  98126. * Defines the target point of the camera.
  98127. * The camera looks towards it form the radius distance.
  98128. */
  98129. get target(): Vector3;
  98130. set target(value: Vector3);
  98131. /**
  98132. * Return the current target position of the camera. This value is expressed in local space.
  98133. * @returns the target position
  98134. */
  98135. getTarget(): Vector3;
  98136. /** @hidden */
  98137. _decideIfNeedsToMove(): boolean;
  98138. /** @hidden */
  98139. _updatePosition(): void;
  98140. /** @hidden */
  98141. _checkInputs(): void;
  98142. protected _updateCameraRotationMatrix(): void;
  98143. /**
  98144. * 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)
  98145. * @returns the current camera
  98146. */
  98147. private _rotateUpVectorWithCameraRotationMatrix;
  98148. private _cachedRotationZ;
  98149. private _cachedQuaternionRotationZ;
  98150. /** @hidden */
  98151. _getViewMatrix(): Matrix;
  98152. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98153. /**
  98154. * @hidden
  98155. */
  98156. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98157. /**
  98158. * @hidden
  98159. */
  98160. _updateRigCameras(): void;
  98161. private _getRigCamPositionAndTarget;
  98162. /**
  98163. * Gets the current object class name.
  98164. * @return the class name
  98165. */
  98166. getClassName(): string;
  98167. }
  98168. }
  98169. declare module BABYLON {
  98170. /**
  98171. * Gather the list of keyboard event types as constants.
  98172. */
  98173. export class KeyboardEventTypes {
  98174. /**
  98175. * The keydown event is fired when a key becomes active (pressed).
  98176. */
  98177. static readonly KEYDOWN: number;
  98178. /**
  98179. * The keyup event is fired when a key has been released.
  98180. */
  98181. static readonly KEYUP: number;
  98182. }
  98183. /**
  98184. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98185. */
  98186. export class KeyboardInfo {
  98187. /**
  98188. * Defines the type of event (KeyboardEventTypes)
  98189. */
  98190. type: number;
  98191. /**
  98192. * Defines the related dom event
  98193. */
  98194. event: KeyboardEvent;
  98195. /**
  98196. * Instantiates a new keyboard info.
  98197. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98198. * @param type Defines the type of event (KeyboardEventTypes)
  98199. * @param event Defines the related dom event
  98200. */
  98201. constructor(
  98202. /**
  98203. * Defines the type of event (KeyboardEventTypes)
  98204. */
  98205. type: number,
  98206. /**
  98207. * Defines the related dom event
  98208. */
  98209. event: KeyboardEvent);
  98210. }
  98211. /**
  98212. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98213. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98214. */
  98215. export class KeyboardInfoPre extends KeyboardInfo {
  98216. /**
  98217. * Defines the type of event (KeyboardEventTypes)
  98218. */
  98219. type: number;
  98220. /**
  98221. * Defines the related dom event
  98222. */
  98223. event: KeyboardEvent;
  98224. /**
  98225. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98226. */
  98227. skipOnPointerObservable: boolean;
  98228. /**
  98229. * Instantiates a new keyboard pre info.
  98230. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98231. * @param type Defines the type of event (KeyboardEventTypes)
  98232. * @param event Defines the related dom event
  98233. */
  98234. constructor(
  98235. /**
  98236. * Defines the type of event (KeyboardEventTypes)
  98237. */
  98238. type: number,
  98239. /**
  98240. * Defines the related dom event
  98241. */
  98242. event: KeyboardEvent);
  98243. }
  98244. }
  98245. declare module BABYLON {
  98246. /**
  98247. * Manage the keyboard inputs to control the movement of a free camera.
  98248. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98249. */
  98250. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98251. /**
  98252. * Defines the camera the input is attached to.
  98253. */
  98254. camera: FreeCamera;
  98255. /**
  98256. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98257. */
  98258. keysUp: number[];
  98259. /**
  98260. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98261. */
  98262. keysUpward: number[];
  98263. /**
  98264. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98265. */
  98266. keysDown: number[];
  98267. /**
  98268. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98269. */
  98270. keysDownward: number[];
  98271. /**
  98272. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98273. */
  98274. keysLeft: number[];
  98275. /**
  98276. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98277. */
  98278. keysRight: number[];
  98279. private _keys;
  98280. private _onCanvasBlurObserver;
  98281. private _onKeyboardObserver;
  98282. private _engine;
  98283. private _scene;
  98284. /**
  98285. * Attach the input controls to a specific dom element to get the input from.
  98286. * @param element Defines the element the controls should be listened from
  98287. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98288. */
  98289. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98290. /**
  98291. * Detach the current controls from the specified dom element.
  98292. * @param element Defines the element to stop listening the inputs from
  98293. */
  98294. detachControl(element: Nullable<HTMLElement>): void;
  98295. /**
  98296. * Update the current camera state depending on the inputs that have been used this frame.
  98297. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98298. */
  98299. checkInputs(): void;
  98300. /**
  98301. * Gets the class name of the current intput.
  98302. * @returns the class name
  98303. */
  98304. getClassName(): string;
  98305. /** @hidden */
  98306. _onLostFocus(): void;
  98307. /**
  98308. * Get the friendly name associated with the input class.
  98309. * @returns the input friendly name
  98310. */
  98311. getSimpleName(): string;
  98312. }
  98313. }
  98314. declare module BABYLON {
  98315. /**
  98316. * Gather the list of pointer event types as constants.
  98317. */
  98318. export class PointerEventTypes {
  98319. /**
  98320. * 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.
  98321. */
  98322. static readonly POINTERDOWN: number;
  98323. /**
  98324. * The pointerup event is fired when a pointer is no longer active.
  98325. */
  98326. static readonly POINTERUP: number;
  98327. /**
  98328. * The pointermove event is fired when a pointer changes coordinates.
  98329. */
  98330. static readonly POINTERMOVE: number;
  98331. /**
  98332. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98333. */
  98334. static readonly POINTERWHEEL: number;
  98335. /**
  98336. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98337. */
  98338. static readonly POINTERPICK: number;
  98339. /**
  98340. * The pointertap event is fired when a the object has been touched and released without drag.
  98341. */
  98342. static readonly POINTERTAP: number;
  98343. /**
  98344. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98345. */
  98346. static readonly POINTERDOUBLETAP: number;
  98347. }
  98348. /**
  98349. * Base class of pointer info types.
  98350. */
  98351. export class PointerInfoBase {
  98352. /**
  98353. * Defines the type of event (PointerEventTypes)
  98354. */
  98355. type: number;
  98356. /**
  98357. * Defines the related dom event
  98358. */
  98359. event: PointerEvent | MouseWheelEvent;
  98360. /**
  98361. * Instantiates the base class of pointers info.
  98362. * @param type Defines the type of event (PointerEventTypes)
  98363. * @param event Defines the related dom event
  98364. */
  98365. constructor(
  98366. /**
  98367. * Defines the type of event (PointerEventTypes)
  98368. */
  98369. type: number,
  98370. /**
  98371. * Defines the related dom event
  98372. */
  98373. event: PointerEvent | MouseWheelEvent);
  98374. }
  98375. /**
  98376. * This class is used to store pointer related info for the onPrePointerObservable event.
  98377. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98378. */
  98379. export class PointerInfoPre extends PointerInfoBase {
  98380. /**
  98381. * Ray from a pointer if availible (eg. 6dof controller)
  98382. */
  98383. ray: Nullable<Ray>;
  98384. /**
  98385. * Defines the local position of the pointer on the canvas.
  98386. */
  98387. localPosition: Vector2;
  98388. /**
  98389. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98390. */
  98391. skipOnPointerObservable: boolean;
  98392. /**
  98393. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98394. * @param type Defines the type of event (PointerEventTypes)
  98395. * @param event Defines the related dom event
  98396. * @param localX Defines the local x coordinates of the pointer when the event occured
  98397. * @param localY Defines the local y coordinates of the pointer when the event occured
  98398. */
  98399. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98400. }
  98401. /**
  98402. * This type contains all the data related to a pointer event in Babylon.js.
  98403. * 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.
  98404. */
  98405. export class PointerInfo extends PointerInfoBase {
  98406. /**
  98407. * Defines the picking info associated to the info (if any)\
  98408. */
  98409. pickInfo: Nullable<PickingInfo>;
  98410. /**
  98411. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98412. * @param type Defines the type of event (PointerEventTypes)
  98413. * @param event Defines the related dom event
  98414. * @param pickInfo Defines the picking info associated to the info (if any)\
  98415. */
  98416. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98417. /**
  98418. * Defines the picking info associated to the info (if any)\
  98419. */
  98420. pickInfo: Nullable<PickingInfo>);
  98421. }
  98422. /**
  98423. * Data relating to a touch event on the screen.
  98424. */
  98425. export interface PointerTouch {
  98426. /**
  98427. * X coordinate of touch.
  98428. */
  98429. x: number;
  98430. /**
  98431. * Y coordinate of touch.
  98432. */
  98433. y: number;
  98434. /**
  98435. * Id of touch. Unique for each finger.
  98436. */
  98437. pointerId: number;
  98438. /**
  98439. * Event type passed from DOM.
  98440. */
  98441. type: any;
  98442. }
  98443. }
  98444. declare module BABYLON {
  98445. /**
  98446. * Manage the mouse inputs to control the movement of a free camera.
  98447. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98448. */
  98449. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98450. /**
  98451. * Define if touch is enabled in the mouse input
  98452. */
  98453. touchEnabled: boolean;
  98454. /**
  98455. * Defines the camera the input is attached to.
  98456. */
  98457. camera: FreeCamera;
  98458. /**
  98459. * Defines the buttons associated with the input to handle camera move.
  98460. */
  98461. buttons: number[];
  98462. /**
  98463. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98464. */
  98465. angularSensibility: number;
  98466. private _pointerInput;
  98467. private _onMouseMove;
  98468. private _observer;
  98469. private previousPosition;
  98470. /**
  98471. * Observable for when a pointer move event occurs containing the move offset
  98472. */
  98473. onPointerMovedObservable: Observable<{
  98474. offsetX: number;
  98475. offsetY: number;
  98476. }>;
  98477. /**
  98478. * @hidden
  98479. * If the camera should be rotated automatically based on pointer movement
  98480. */
  98481. _allowCameraRotation: boolean;
  98482. /**
  98483. * Manage the mouse inputs to control the movement of a free camera.
  98484. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98485. * @param touchEnabled Defines if touch is enabled or not
  98486. */
  98487. constructor(
  98488. /**
  98489. * Define if touch is enabled in the mouse input
  98490. */
  98491. touchEnabled?: boolean);
  98492. /**
  98493. * Attach the input controls to a specific dom element to get the input from.
  98494. * @param element Defines the element the controls should be listened from
  98495. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98496. */
  98497. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98498. /**
  98499. * Called on JS contextmenu event.
  98500. * Override this method to provide functionality.
  98501. */
  98502. protected onContextMenu(evt: PointerEvent): void;
  98503. /**
  98504. * Detach the current controls from the specified dom element.
  98505. * @param element Defines the element to stop listening the inputs from
  98506. */
  98507. detachControl(element: Nullable<HTMLElement>): void;
  98508. /**
  98509. * Gets the class name of the current intput.
  98510. * @returns the class name
  98511. */
  98512. getClassName(): string;
  98513. /**
  98514. * Get the friendly name associated with the input class.
  98515. * @returns the input friendly name
  98516. */
  98517. getSimpleName(): string;
  98518. }
  98519. }
  98520. declare module BABYLON {
  98521. /**
  98522. * Manage the touch inputs to control the movement of a free camera.
  98523. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98524. */
  98525. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98526. /**
  98527. * Define if mouse events can be treated as touch events
  98528. */
  98529. allowMouse: boolean;
  98530. /**
  98531. * Defines the camera the input is attached to.
  98532. */
  98533. camera: FreeCamera;
  98534. /**
  98535. * Defines the touch sensibility for rotation.
  98536. * The higher the faster.
  98537. */
  98538. touchAngularSensibility: number;
  98539. /**
  98540. * Defines the touch sensibility for move.
  98541. * The higher the faster.
  98542. */
  98543. touchMoveSensibility: number;
  98544. private _offsetX;
  98545. private _offsetY;
  98546. private _pointerPressed;
  98547. private _pointerInput;
  98548. private _observer;
  98549. private _onLostFocus;
  98550. /**
  98551. * Manage the touch inputs to control the movement of a free camera.
  98552. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98553. * @param allowMouse Defines if mouse events can be treated as touch events
  98554. */
  98555. constructor(
  98556. /**
  98557. * Define if mouse events can be treated as touch events
  98558. */
  98559. allowMouse?: boolean);
  98560. /**
  98561. * Attach the input controls to a specific dom element to get the input from.
  98562. * @param element Defines the element the controls should be listened from
  98563. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98564. */
  98565. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98566. /**
  98567. * Detach the current controls from the specified dom element.
  98568. * @param element Defines the element to stop listening the inputs from
  98569. */
  98570. detachControl(element: Nullable<HTMLElement>): void;
  98571. /**
  98572. * Update the current camera state depending on the inputs that have been used this frame.
  98573. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98574. */
  98575. checkInputs(): void;
  98576. /**
  98577. * Gets the class name of the current intput.
  98578. * @returns the class name
  98579. */
  98580. getClassName(): string;
  98581. /**
  98582. * Get the friendly name associated with the input class.
  98583. * @returns the input friendly name
  98584. */
  98585. getSimpleName(): string;
  98586. }
  98587. }
  98588. declare module BABYLON {
  98589. /**
  98590. * Default Inputs manager for the FreeCamera.
  98591. * It groups all the default supported inputs for ease of use.
  98592. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98593. */
  98594. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98595. /**
  98596. * @hidden
  98597. */
  98598. _mouseInput: Nullable<FreeCameraMouseInput>;
  98599. /**
  98600. * Instantiates a new FreeCameraInputsManager.
  98601. * @param camera Defines the camera the inputs belong to
  98602. */
  98603. constructor(camera: FreeCamera);
  98604. /**
  98605. * Add keyboard input support to the input manager.
  98606. * @returns the current input manager
  98607. */
  98608. addKeyboard(): FreeCameraInputsManager;
  98609. /**
  98610. * Add mouse input support to the input manager.
  98611. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98612. * @returns the current input manager
  98613. */
  98614. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98615. /**
  98616. * Removes the mouse input support from the manager
  98617. * @returns the current input manager
  98618. */
  98619. removeMouse(): FreeCameraInputsManager;
  98620. /**
  98621. * Add touch input support to the input manager.
  98622. * @returns the current input manager
  98623. */
  98624. addTouch(): FreeCameraInputsManager;
  98625. /**
  98626. * Remove all attached input methods from a camera
  98627. */
  98628. clear(): void;
  98629. }
  98630. }
  98631. declare module BABYLON {
  98632. /**
  98633. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98634. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98635. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98636. */
  98637. export class FreeCamera extends TargetCamera {
  98638. /**
  98639. * Define the collision ellipsoid of the camera.
  98640. * This is helpful to simulate a camera body like the player body around the camera
  98641. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98642. */
  98643. ellipsoid: Vector3;
  98644. /**
  98645. * Define an offset for the position of the ellipsoid around the camera.
  98646. * This can be helpful to determine the center of the body near the gravity center of the body
  98647. * instead of its head.
  98648. */
  98649. ellipsoidOffset: Vector3;
  98650. /**
  98651. * Enable or disable collisions of the camera with the rest of the scene objects.
  98652. */
  98653. checkCollisions: boolean;
  98654. /**
  98655. * Enable or disable gravity on the camera.
  98656. */
  98657. applyGravity: boolean;
  98658. /**
  98659. * Define the input manager associated to the camera.
  98660. */
  98661. inputs: FreeCameraInputsManager;
  98662. /**
  98663. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98664. * Higher values reduce sensitivity.
  98665. */
  98666. get angularSensibility(): number;
  98667. /**
  98668. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98669. * Higher values reduce sensitivity.
  98670. */
  98671. set angularSensibility(value: number);
  98672. /**
  98673. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98674. */
  98675. get keysUp(): number[];
  98676. set keysUp(value: number[]);
  98677. /**
  98678. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98679. */
  98680. get keysUpward(): number[];
  98681. set keysUpward(value: number[]);
  98682. /**
  98683. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98684. */
  98685. get keysDown(): number[];
  98686. set keysDown(value: number[]);
  98687. /**
  98688. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98689. */
  98690. get keysDownward(): number[];
  98691. set keysDownward(value: number[]);
  98692. /**
  98693. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98694. */
  98695. get keysLeft(): number[];
  98696. set keysLeft(value: number[]);
  98697. /**
  98698. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98699. */
  98700. get keysRight(): number[];
  98701. set keysRight(value: number[]);
  98702. /**
  98703. * Event raised when the camera collide with a mesh in the scene.
  98704. */
  98705. onCollide: (collidedMesh: AbstractMesh) => void;
  98706. private _collider;
  98707. private _needMoveForGravity;
  98708. private _oldPosition;
  98709. private _diffPosition;
  98710. private _newPosition;
  98711. /** @hidden */
  98712. _localDirection: Vector3;
  98713. /** @hidden */
  98714. _transformedDirection: Vector3;
  98715. /**
  98716. * Instantiates a Free Camera.
  98717. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98718. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98719. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98720. * @param name Define the name of the camera in the scene
  98721. * @param position Define the start position of the camera in the scene
  98722. * @param scene Define the scene the camera belongs to
  98723. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98724. */
  98725. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98726. /**
  98727. * Attached controls to the current camera.
  98728. * @param element Defines the element the controls should be listened from
  98729. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98730. */
  98731. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98732. /**
  98733. * Detach the current controls from the camera.
  98734. * The camera will stop reacting to inputs.
  98735. * @param element Defines the element to stop listening the inputs from
  98736. */
  98737. detachControl(element: HTMLElement): void;
  98738. private _collisionMask;
  98739. /**
  98740. * Define a collision mask to limit the list of object the camera can collide with
  98741. */
  98742. get collisionMask(): number;
  98743. set collisionMask(mask: number);
  98744. /** @hidden */
  98745. _collideWithWorld(displacement: Vector3): void;
  98746. private _onCollisionPositionChange;
  98747. /** @hidden */
  98748. _checkInputs(): void;
  98749. /** @hidden */
  98750. _decideIfNeedsToMove(): boolean;
  98751. /** @hidden */
  98752. _updatePosition(): void;
  98753. /**
  98754. * Destroy the camera and release the current resources hold by it.
  98755. */
  98756. dispose(): void;
  98757. /**
  98758. * Gets the current object class name.
  98759. * @return the class name
  98760. */
  98761. getClassName(): string;
  98762. }
  98763. }
  98764. declare module BABYLON {
  98765. /**
  98766. * Represents a gamepad control stick position
  98767. */
  98768. export class StickValues {
  98769. /**
  98770. * The x component of the control stick
  98771. */
  98772. x: number;
  98773. /**
  98774. * The y component of the control stick
  98775. */
  98776. y: number;
  98777. /**
  98778. * Initializes the gamepad x and y control stick values
  98779. * @param x The x component of the gamepad control stick value
  98780. * @param y The y component of the gamepad control stick value
  98781. */
  98782. constructor(
  98783. /**
  98784. * The x component of the control stick
  98785. */
  98786. x: number,
  98787. /**
  98788. * The y component of the control stick
  98789. */
  98790. y: number);
  98791. }
  98792. /**
  98793. * An interface which manages callbacks for gamepad button changes
  98794. */
  98795. export interface GamepadButtonChanges {
  98796. /**
  98797. * Called when a gamepad has been changed
  98798. */
  98799. changed: boolean;
  98800. /**
  98801. * Called when a gamepad press event has been triggered
  98802. */
  98803. pressChanged: boolean;
  98804. /**
  98805. * Called when a touch event has been triggered
  98806. */
  98807. touchChanged: boolean;
  98808. /**
  98809. * Called when a value has changed
  98810. */
  98811. valueChanged: boolean;
  98812. }
  98813. /**
  98814. * Represents a gamepad
  98815. */
  98816. export class Gamepad {
  98817. /**
  98818. * The id of the gamepad
  98819. */
  98820. id: string;
  98821. /**
  98822. * The index of the gamepad
  98823. */
  98824. index: number;
  98825. /**
  98826. * The browser gamepad
  98827. */
  98828. browserGamepad: any;
  98829. /**
  98830. * Specifies what type of gamepad this represents
  98831. */
  98832. type: number;
  98833. private _leftStick;
  98834. private _rightStick;
  98835. /** @hidden */
  98836. _isConnected: boolean;
  98837. private _leftStickAxisX;
  98838. private _leftStickAxisY;
  98839. private _rightStickAxisX;
  98840. private _rightStickAxisY;
  98841. /**
  98842. * Triggered when the left control stick has been changed
  98843. */
  98844. private _onleftstickchanged;
  98845. /**
  98846. * Triggered when the right control stick has been changed
  98847. */
  98848. private _onrightstickchanged;
  98849. /**
  98850. * Represents a gamepad controller
  98851. */
  98852. static GAMEPAD: number;
  98853. /**
  98854. * Represents a generic controller
  98855. */
  98856. static GENERIC: number;
  98857. /**
  98858. * Represents an XBox controller
  98859. */
  98860. static XBOX: number;
  98861. /**
  98862. * Represents a pose-enabled controller
  98863. */
  98864. static POSE_ENABLED: number;
  98865. /**
  98866. * Represents an Dual Shock controller
  98867. */
  98868. static DUALSHOCK: number;
  98869. /**
  98870. * Specifies whether the left control stick should be Y-inverted
  98871. */
  98872. protected _invertLeftStickY: boolean;
  98873. /**
  98874. * Specifies if the gamepad has been connected
  98875. */
  98876. get isConnected(): boolean;
  98877. /**
  98878. * Initializes the gamepad
  98879. * @param id The id of the gamepad
  98880. * @param index The index of the gamepad
  98881. * @param browserGamepad The browser gamepad
  98882. * @param leftStickX The x component of the left joystick
  98883. * @param leftStickY The y component of the left joystick
  98884. * @param rightStickX The x component of the right joystick
  98885. * @param rightStickY The y component of the right joystick
  98886. */
  98887. constructor(
  98888. /**
  98889. * The id of the gamepad
  98890. */
  98891. id: string,
  98892. /**
  98893. * The index of the gamepad
  98894. */
  98895. index: number,
  98896. /**
  98897. * The browser gamepad
  98898. */
  98899. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98900. /**
  98901. * Callback triggered when the left joystick has changed
  98902. * @param callback
  98903. */
  98904. onleftstickchanged(callback: (values: StickValues) => void): void;
  98905. /**
  98906. * Callback triggered when the right joystick has changed
  98907. * @param callback
  98908. */
  98909. onrightstickchanged(callback: (values: StickValues) => void): void;
  98910. /**
  98911. * Gets the left joystick
  98912. */
  98913. get leftStick(): StickValues;
  98914. /**
  98915. * Sets the left joystick values
  98916. */
  98917. set leftStick(newValues: StickValues);
  98918. /**
  98919. * Gets the right joystick
  98920. */
  98921. get rightStick(): StickValues;
  98922. /**
  98923. * Sets the right joystick value
  98924. */
  98925. set rightStick(newValues: StickValues);
  98926. /**
  98927. * Updates the gamepad joystick positions
  98928. */
  98929. update(): void;
  98930. /**
  98931. * Disposes the gamepad
  98932. */
  98933. dispose(): void;
  98934. }
  98935. /**
  98936. * Represents a generic gamepad
  98937. */
  98938. export class GenericPad extends Gamepad {
  98939. private _buttons;
  98940. private _onbuttondown;
  98941. private _onbuttonup;
  98942. /**
  98943. * Observable triggered when a button has been pressed
  98944. */
  98945. onButtonDownObservable: Observable<number>;
  98946. /**
  98947. * Observable triggered when a button has been released
  98948. */
  98949. onButtonUpObservable: Observable<number>;
  98950. /**
  98951. * Callback triggered when a button has been pressed
  98952. * @param callback Called when a button has been pressed
  98953. */
  98954. onbuttondown(callback: (buttonPressed: number) => void): void;
  98955. /**
  98956. * Callback triggered when a button has been released
  98957. * @param callback Called when a button has been released
  98958. */
  98959. onbuttonup(callback: (buttonReleased: number) => void): void;
  98960. /**
  98961. * Initializes the generic gamepad
  98962. * @param id The id of the generic gamepad
  98963. * @param index The index of the generic gamepad
  98964. * @param browserGamepad The browser gamepad
  98965. */
  98966. constructor(id: string, index: number, browserGamepad: any);
  98967. private _setButtonValue;
  98968. /**
  98969. * Updates the generic gamepad
  98970. */
  98971. update(): void;
  98972. /**
  98973. * Disposes the generic gamepad
  98974. */
  98975. dispose(): void;
  98976. }
  98977. }
  98978. declare module BABYLON {
  98979. /**
  98980. * Defines the types of pose enabled controllers that are supported
  98981. */
  98982. export enum PoseEnabledControllerType {
  98983. /**
  98984. * HTC Vive
  98985. */
  98986. VIVE = 0,
  98987. /**
  98988. * Oculus Rift
  98989. */
  98990. OCULUS = 1,
  98991. /**
  98992. * Windows mixed reality
  98993. */
  98994. WINDOWS = 2,
  98995. /**
  98996. * Samsung gear VR
  98997. */
  98998. GEAR_VR = 3,
  98999. /**
  99000. * Google Daydream
  99001. */
  99002. DAYDREAM = 4,
  99003. /**
  99004. * Generic
  99005. */
  99006. GENERIC = 5
  99007. }
  99008. /**
  99009. * Defines the MutableGamepadButton interface for the state of a gamepad button
  99010. */
  99011. export interface MutableGamepadButton {
  99012. /**
  99013. * Value of the button/trigger
  99014. */
  99015. value: number;
  99016. /**
  99017. * If the button/trigger is currently touched
  99018. */
  99019. touched: boolean;
  99020. /**
  99021. * If the button/trigger is currently pressed
  99022. */
  99023. pressed: boolean;
  99024. }
  99025. /**
  99026. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99027. * @hidden
  99028. */
  99029. export interface ExtendedGamepadButton extends GamepadButton {
  99030. /**
  99031. * If the button/trigger is currently pressed
  99032. */
  99033. readonly pressed: boolean;
  99034. /**
  99035. * If the button/trigger is currently touched
  99036. */
  99037. readonly touched: boolean;
  99038. /**
  99039. * Value of the button/trigger
  99040. */
  99041. readonly value: number;
  99042. }
  99043. /** @hidden */
  99044. export interface _GamePadFactory {
  99045. /**
  99046. * Returns whether or not the current gamepad can be created for this type of controller.
  99047. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99048. * @returns true if it can be created, otherwise false
  99049. */
  99050. canCreate(gamepadInfo: any): boolean;
  99051. /**
  99052. * Creates a new instance of the Gamepad.
  99053. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99054. * @returns the new gamepad instance
  99055. */
  99056. create(gamepadInfo: any): Gamepad;
  99057. }
  99058. /**
  99059. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99060. */
  99061. export class PoseEnabledControllerHelper {
  99062. /** @hidden */
  99063. static _ControllerFactories: _GamePadFactory[];
  99064. /** @hidden */
  99065. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99066. /**
  99067. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99068. * @param vrGamepad the gamepad to initialized
  99069. * @returns a vr controller of the type the gamepad identified as
  99070. */
  99071. static InitiateController(vrGamepad: any): Gamepad;
  99072. }
  99073. /**
  99074. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99075. */
  99076. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99077. /**
  99078. * If the controller is used in a webXR session
  99079. */
  99080. isXR: boolean;
  99081. private _deviceRoomPosition;
  99082. private _deviceRoomRotationQuaternion;
  99083. /**
  99084. * The device position in babylon space
  99085. */
  99086. devicePosition: Vector3;
  99087. /**
  99088. * The device rotation in babylon space
  99089. */
  99090. deviceRotationQuaternion: Quaternion;
  99091. /**
  99092. * The scale factor of the device in babylon space
  99093. */
  99094. deviceScaleFactor: number;
  99095. /**
  99096. * (Likely devicePosition should be used instead) The device position in its room space
  99097. */
  99098. position: Vector3;
  99099. /**
  99100. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99101. */
  99102. rotationQuaternion: Quaternion;
  99103. /**
  99104. * The type of controller (Eg. Windows mixed reality)
  99105. */
  99106. controllerType: PoseEnabledControllerType;
  99107. protected _calculatedPosition: Vector3;
  99108. private _calculatedRotation;
  99109. /**
  99110. * The raw pose from the device
  99111. */
  99112. rawPose: DevicePose;
  99113. private _trackPosition;
  99114. private _maxRotationDistFromHeadset;
  99115. private _draggedRoomRotation;
  99116. /**
  99117. * @hidden
  99118. */
  99119. _disableTrackPosition(fixedPosition: Vector3): void;
  99120. /**
  99121. * Internal, the mesh attached to the controller
  99122. * @hidden
  99123. */
  99124. _mesh: Nullable<AbstractMesh>;
  99125. private _poseControlledCamera;
  99126. private _leftHandSystemQuaternion;
  99127. /**
  99128. * Internal, matrix used to convert room space to babylon space
  99129. * @hidden
  99130. */
  99131. _deviceToWorld: Matrix;
  99132. /**
  99133. * Node to be used when casting a ray from the controller
  99134. * @hidden
  99135. */
  99136. _pointingPoseNode: Nullable<TransformNode>;
  99137. /**
  99138. * Name of the child mesh that can be used to cast a ray from the controller
  99139. */
  99140. static readonly POINTING_POSE: string;
  99141. /**
  99142. * Creates a new PoseEnabledController from a gamepad
  99143. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99144. */
  99145. constructor(browserGamepad: any);
  99146. private _workingMatrix;
  99147. /**
  99148. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99149. */
  99150. update(): void;
  99151. /**
  99152. * Updates only the pose device and mesh without doing any button event checking
  99153. */
  99154. protected _updatePoseAndMesh(): void;
  99155. /**
  99156. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99157. * @param poseData raw pose fromthe device
  99158. */
  99159. updateFromDevice(poseData: DevicePose): void;
  99160. /**
  99161. * @hidden
  99162. */
  99163. _meshAttachedObservable: Observable<AbstractMesh>;
  99164. /**
  99165. * Attaches a mesh to the controller
  99166. * @param mesh the mesh to be attached
  99167. */
  99168. attachToMesh(mesh: AbstractMesh): void;
  99169. /**
  99170. * Attaches the controllers mesh to a camera
  99171. * @param camera the camera the mesh should be attached to
  99172. */
  99173. attachToPoseControlledCamera(camera: TargetCamera): void;
  99174. /**
  99175. * Disposes of the controller
  99176. */
  99177. dispose(): void;
  99178. /**
  99179. * The mesh that is attached to the controller
  99180. */
  99181. get mesh(): Nullable<AbstractMesh>;
  99182. /**
  99183. * Gets the ray of the controller in the direction the controller is pointing
  99184. * @param length the length the resulting ray should be
  99185. * @returns a ray in the direction the controller is pointing
  99186. */
  99187. getForwardRay(length?: number): Ray;
  99188. }
  99189. }
  99190. declare module BABYLON {
  99191. /**
  99192. * Defines the WebVRController object that represents controllers tracked in 3D space
  99193. */
  99194. export abstract class WebVRController extends PoseEnabledController {
  99195. /**
  99196. * Internal, the default controller model for the controller
  99197. */
  99198. protected _defaultModel: Nullable<AbstractMesh>;
  99199. /**
  99200. * Fired when the trigger state has changed
  99201. */
  99202. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99203. /**
  99204. * Fired when the main button state has changed
  99205. */
  99206. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99207. /**
  99208. * Fired when the secondary button state has changed
  99209. */
  99210. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99211. /**
  99212. * Fired when the pad state has changed
  99213. */
  99214. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99215. /**
  99216. * Fired when controllers stick values have changed
  99217. */
  99218. onPadValuesChangedObservable: Observable<StickValues>;
  99219. /**
  99220. * Array of button availible on the controller
  99221. */
  99222. protected _buttons: Array<MutableGamepadButton>;
  99223. private _onButtonStateChange;
  99224. /**
  99225. * Fired when a controller button's state has changed
  99226. * @param callback the callback containing the button that was modified
  99227. */
  99228. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99229. /**
  99230. * X and Y axis corresponding to the controllers joystick
  99231. */
  99232. pad: StickValues;
  99233. /**
  99234. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99235. */
  99236. hand: string;
  99237. /**
  99238. * The default controller model for the controller
  99239. */
  99240. get defaultModel(): Nullable<AbstractMesh>;
  99241. /**
  99242. * Creates a new WebVRController from a gamepad
  99243. * @param vrGamepad the gamepad that the WebVRController should be created from
  99244. */
  99245. constructor(vrGamepad: any);
  99246. /**
  99247. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99248. */
  99249. update(): void;
  99250. /**
  99251. * Function to be called when a button is modified
  99252. */
  99253. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99254. /**
  99255. * Loads a mesh and attaches it to the controller
  99256. * @param scene the scene the mesh should be added to
  99257. * @param meshLoaded callback for when the mesh has been loaded
  99258. */
  99259. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99260. private _setButtonValue;
  99261. private _changes;
  99262. private _checkChanges;
  99263. /**
  99264. * Disposes of th webVRCOntroller
  99265. */
  99266. dispose(): void;
  99267. }
  99268. }
  99269. declare module BABYLON {
  99270. /**
  99271. * The HemisphericLight simulates the ambient environment light,
  99272. * so the passed direction is the light reflection direction, not the incoming direction.
  99273. */
  99274. export class HemisphericLight extends Light {
  99275. /**
  99276. * The groundColor is the light in the opposite direction to the one specified during creation.
  99277. * 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.
  99278. */
  99279. groundColor: Color3;
  99280. /**
  99281. * The light reflection direction, not the incoming direction.
  99282. */
  99283. direction: Vector3;
  99284. /**
  99285. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99286. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99287. * The HemisphericLight can't cast shadows.
  99288. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99289. * @param name The friendly name of the light
  99290. * @param direction The direction of the light reflection
  99291. * @param scene The scene the light belongs to
  99292. */
  99293. constructor(name: string, direction: Vector3, scene: Scene);
  99294. protected _buildUniformLayout(): void;
  99295. /**
  99296. * Returns the string "HemisphericLight".
  99297. * @return The class name
  99298. */
  99299. getClassName(): string;
  99300. /**
  99301. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99302. * Returns the updated direction.
  99303. * @param target The target the direction should point to
  99304. * @return The computed direction
  99305. */
  99306. setDirectionToTarget(target: Vector3): Vector3;
  99307. /**
  99308. * Returns the shadow generator associated to the light.
  99309. * @returns Always null for hemispheric lights because it does not support shadows.
  99310. */
  99311. getShadowGenerator(): Nullable<IShadowGenerator>;
  99312. /**
  99313. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99314. * @param effect The effect to update
  99315. * @param lightIndex The index of the light in the effect to update
  99316. * @returns The hemispheric light
  99317. */
  99318. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99319. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99320. /**
  99321. * Computes the world matrix of the node
  99322. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99323. * @param useWasUpdatedFlag defines a reserved property
  99324. * @returns the world matrix
  99325. */
  99326. computeWorldMatrix(): Matrix;
  99327. /**
  99328. * Returns the integer 3.
  99329. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99330. */
  99331. getTypeID(): number;
  99332. /**
  99333. * Prepares the list of defines specific to the light type.
  99334. * @param defines the list of defines
  99335. * @param lightIndex defines the index of the light for the effect
  99336. */
  99337. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99338. }
  99339. }
  99340. declare module BABYLON {
  99341. /** @hidden */
  99342. export var vrMultiviewToSingleviewPixelShader: {
  99343. name: string;
  99344. shader: string;
  99345. };
  99346. }
  99347. declare module BABYLON {
  99348. /**
  99349. * Renders to multiple views with a single draw call
  99350. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99351. */
  99352. export class MultiviewRenderTarget extends RenderTargetTexture {
  99353. /**
  99354. * Creates a multiview render target
  99355. * @param scene scene used with the render target
  99356. * @param size the size of the render target (used for each view)
  99357. */
  99358. constructor(scene: Scene, size?: number | {
  99359. width: number;
  99360. height: number;
  99361. } | {
  99362. ratio: number;
  99363. });
  99364. /**
  99365. * @hidden
  99366. * @param faceIndex the face index, if its a cube texture
  99367. */
  99368. _bindFrameBuffer(faceIndex?: number): void;
  99369. /**
  99370. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99371. * @returns the view count
  99372. */
  99373. getViewCount(): number;
  99374. }
  99375. }
  99376. declare module BABYLON {
  99377. interface Engine {
  99378. /**
  99379. * Creates a new multiview render target
  99380. * @param width defines the width of the texture
  99381. * @param height defines the height of the texture
  99382. * @returns the created multiview texture
  99383. */
  99384. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99385. /**
  99386. * Binds a multiview framebuffer to be drawn to
  99387. * @param multiviewTexture texture to bind
  99388. */
  99389. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99390. }
  99391. interface Camera {
  99392. /**
  99393. * @hidden
  99394. * 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)
  99395. */
  99396. _useMultiviewToSingleView: boolean;
  99397. /**
  99398. * @hidden
  99399. * 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)
  99400. */
  99401. _multiviewTexture: Nullable<RenderTargetTexture>;
  99402. /**
  99403. * @hidden
  99404. * ensures the multiview texture of the camera exists and has the specified width/height
  99405. * @param width height to set on the multiview texture
  99406. * @param height width to set on the multiview texture
  99407. */
  99408. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99409. }
  99410. interface Scene {
  99411. /** @hidden */
  99412. _transformMatrixR: Matrix;
  99413. /** @hidden */
  99414. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99415. /** @hidden */
  99416. _createMultiviewUbo(): void;
  99417. /** @hidden */
  99418. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99419. /** @hidden */
  99420. _renderMultiviewToSingleView(camera: Camera): void;
  99421. }
  99422. }
  99423. declare module BABYLON {
  99424. /**
  99425. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99426. * This will not be used for webXR as it supports displaying texture arrays directly
  99427. */
  99428. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99429. /**
  99430. * Gets a string identifying the name of the class
  99431. * @returns "VRMultiviewToSingleviewPostProcess" string
  99432. */
  99433. getClassName(): string;
  99434. /**
  99435. * Initializes a VRMultiviewToSingleview
  99436. * @param name name of the post process
  99437. * @param camera camera to be applied to
  99438. * @param scaleFactor scaling factor to the size of the output texture
  99439. */
  99440. constructor(name: string, camera: Camera, scaleFactor: number);
  99441. }
  99442. }
  99443. declare module BABYLON {
  99444. /**
  99445. * Interface used to define additional presentation attributes
  99446. */
  99447. export interface IVRPresentationAttributes {
  99448. /**
  99449. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99450. */
  99451. highRefreshRate: boolean;
  99452. /**
  99453. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99454. */
  99455. foveationLevel: number;
  99456. }
  99457. interface Engine {
  99458. /** @hidden */
  99459. _vrDisplay: any;
  99460. /** @hidden */
  99461. _vrSupported: boolean;
  99462. /** @hidden */
  99463. _oldSize: Size;
  99464. /** @hidden */
  99465. _oldHardwareScaleFactor: number;
  99466. /** @hidden */
  99467. _vrExclusivePointerMode: boolean;
  99468. /** @hidden */
  99469. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99470. /** @hidden */
  99471. _onVRDisplayPointerRestricted: () => void;
  99472. /** @hidden */
  99473. _onVRDisplayPointerUnrestricted: () => void;
  99474. /** @hidden */
  99475. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99476. /** @hidden */
  99477. _onVrDisplayDisconnect: Nullable<() => void>;
  99478. /** @hidden */
  99479. _onVrDisplayPresentChange: Nullable<() => void>;
  99480. /**
  99481. * Observable signaled when VR display mode changes
  99482. */
  99483. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99484. /**
  99485. * Observable signaled when VR request present is complete
  99486. */
  99487. onVRRequestPresentComplete: Observable<boolean>;
  99488. /**
  99489. * Observable signaled when VR request present starts
  99490. */
  99491. onVRRequestPresentStart: Observable<Engine>;
  99492. /**
  99493. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99494. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99495. */
  99496. isInVRExclusivePointerMode: boolean;
  99497. /**
  99498. * Gets a boolean indicating if a webVR device was detected
  99499. * @returns true if a webVR device was detected
  99500. */
  99501. isVRDevicePresent(): boolean;
  99502. /**
  99503. * Gets the current webVR device
  99504. * @returns the current webVR device (or null)
  99505. */
  99506. getVRDevice(): any;
  99507. /**
  99508. * Initializes a webVR display and starts listening to display change events
  99509. * The onVRDisplayChangedObservable will be notified upon these changes
  99510. * @returns A promise containing a VRDisplay and if vr is supported
  99511. */
  99512. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99513. /** @hidden */
  99514. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99515. /**
  99516. * Gets or sets the presentation attributes used to configure VR rendering
  99517. */
  99518. vrPresentationAttributes?: IVRPresentationAttributes;
  99519. /**
  99520. * Call this function to switch to webVR mode
  99521. * Will do nothing if webVR is not supported or if there is no webVR device
  99522. * @param options the webvr options provided to the camera. mainly used for multiview
  99523. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99524. */
  99525. enableVR(options: WebVROptions): void;
  99526. /** @hidden */
  99527. _onVRFullScreenTriggered(): void;
  99528. }
  99529. }
  99530. declare module BABYLON {
  99531. /**
  99532. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99533. * IMPORTANT!! The data is right-hand data.
  99534. * @export
  99535. * @interface DevicePose
  99536. */
  99537. export interface DevicePose {
  99538. /**
  99539. * The position of the device, values in array are [x,y,z].
  99540. */
  99541. readonly position: Nullable<Float32Array>;
  99542. /**
  99543. * The linearVelocity of the device, values in array are [x,y,z].
  99544. */
  99545. readonly linearVelocity: Nullable<Float32Array>;
  99546. /**
  99547. * The linearAcceleration of the device, values in array are [x,y,z].
  99548. */
  99549. readonly linearAcceleration: Nullable<Float32Array>;
  99550. /**
  99551. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99552. */
  99553. readonly orientation: Nullable<Float32Array>;
  99554. /**
  99555. * The angularVelocity of the device, values in array are [x,y,z].
  99556. */
  99557. readonly angularVelocity: Nullable<Float32Array>;
  99558. /**
  99559. * The angularAcceleration of the device, values in array are [x,y,z].
  99560. */
  99561. readonly angularAcceleration: Nullable<Float32Array>;
  99562. }
  99563. /**
  99564. * Interface representing a pose controlled object in Babylon.
  99565. * A pose controlled object has both regular pose values as well as pose values
  99566. * from an external device such as a VR head mounted display
  99567. */
  99568. export interface PoseControlled {
  99569. /**
  99570. * The position of the object in babylon space.
  99571. */
  99572. position: Vector3;
  99573. /**
  99574. * The rotation quaternion of the object in babylon space.
  99575. */
  99576. rotationQuaternion: Quaternion;
  99577. /**
  99578. * The position of the device in babylon space.
  99579. */
  99580. devicePosition?: Vector3;
  99581. /**
  99582. * The rotation quaternion of the device in babylon space.
  99583. */
  99584. deviceRotationQuaternion: Quaternion;
  99585. /**
  99586. * The raw pose coming from the device.
  99587. */
  99588. rawPose: Nullable<DevicePose>;
  99589. /**
  99590. * The scale of the device to be used when translating from device space to babylon space.
  99591. */
  99592. deviceScaleFactor: number;
  99593. /**
  99594. * Updates the poseControlled values based on the input device pose.
  99595. * @param poseData the pose data to update the object with
  99596. */
  99597. updateFromDevice(poseData: DevicePose): void;
  99598. }
  99599. /**
  99600. * Set of options to customize the webVRCamera
  99601. */
  99602. export interface WebVROptions {
  99603. /**
  99604. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99605. */
  99606. trackPosition?: boolean;
  99607. /**
  99608. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99609. */
  99610. positionScale?: number;
  99611. /**
  99612. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99613. */
  99614. displayName?: string;
  99615. /**
  99616. * Should the native controller meshes be initialized. (default: true)
  99617. */
  99618. controllerMeshes?: boolean;
  99619. /**
  99620. * Creating a default HemiLight only on controllers. (default: true)
  99621. */
  99622. defaultLightingOnControllers?: boolean;
  99623. /**
  99624. * If you don't want to use the default VR button of the helper. (default: false)
  99625. */
  99626. useCustomVRButton?: boolean;
  99627. /**
  99628. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99629. */
  99630. customVRButton?: HTMLButtonElement;
  99631. /**
  99632. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99633. */
  99634. rayLength?: number;
  99635. /**
  99636. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99637. */
  99638. defaultHeight?: number;
  99639. /**
  99640. * If multiview should be used if availible (default: false)
  99641. */
  99642. useMultiview?: boolean;
  99643. }
  99644. /**
  99645. * This represents a WebVR camera.
  99646. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99647. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99648. */
  99649. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99650. private webVROptions;
  99651. /**
  99652. * @hidden
  99653. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99654. */
  99655. _vrDevice: any;
  99656. /**
  99657. * The rawPose of the vrDevice.
  99658. */
  99659. rawPose: Nullable<DevicePose>;
  99660. private _onVREnabled;
  99661. private _specsVersion;
  99662. private _attached;
  99663. private _frameData;
  99664. protected _descendants: Array<Node>;
  99665. private _deviceRoomPosition;
  99666. /** @hidden */
  99667. _deviceRoomRotationQuaternion: Quaternion;
  99668. private _standingMatrix;
  99669. /**
  99670. * Represents device position in babylon space.
  99671. */
  99672. devicePosition: Vector3;
  99673. /**
  99674. * Represents device rotation in babylon space.
  99675. */
  99676. deviceRotationQuaternion: Quaternion;
  99677. /**
  99678. * The scale of the device to be used when translating from device space to babylon space.
  99679. */
  99680. deviceScaleFactor: number;
  99681. private _deviceToWorld;
  99682. private _worldToDevice;
  99683. /**
  99684. * References to the webVR controllers for the vrDevice.
  99685. */
  99686. controllers: Array<WebVRController>;
  99687. /**
  99688. * Emits an event when a controller is attached.
  99689. */
  99690. onControllersAttachedObservable: Observable<WebVRController[]>;
  99691. /**
  99692. * Emits an event when a controller's mesh has been loaded;
  99693. */
  99694. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99695. /**
  99696. * Emits an event when the HMD's pose has been updated.
  99697. */
  99698. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99699. private _poseSet;
  99700. /**
  99701. * If the rig cameras be used as parent instead of this camera.
  99702. */
  99703. rigParenting: boolean;
  99704. private _lightOnControllers;
  99705. private _defaultHeight?;
  99706. /**
  99707. * Instantiates a WebVRFreeCamera.
  99708. * @param name The name of the WebVRFreeCamera
  99709. * @param position The starting anchor position for the camera
  99710. * @param scene The scene the camera belongs to
  99711. * @param webVROptions a set of customizable options for the webVRCamera
  99712. */
  99713. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99714. /**
  99715. * Gets the device distance from the ground in meters.
  99716. * @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.
  99717. */
  99718. deviceDistanceToRoomGround(): number;
  99719. /**
  99720. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99721. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99722. */
  99723. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99724. /**
  99725. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99726. * @returns A promise with a boolean set to if the standing matrix is supported.
  99727. */
  99728. useStandingMatrixAsync(): Promise<boolean>;
  99729. /**
  99730. * Disposes the camera
  99731. */
  99732. dispose(): void;
  99733. /**
  99734. * Gets a vrController by name.
  99735. * @param name The name of the controller to retreive
  99736. * @returns the controller matching the name specified or null if not found
  99737. */
  99738. getControllerByName(name: string): Nullable<WebVRController>;
  99739. private _leftController;
  99740. /**
  99741. * The controller corresponding to the users left hand.
  99742. */
  99743. get leftController(): Nullable<WebVRController>;
  99744. private _rightController;
  99745. /**
  99746. * The controller corresponding to the users right hand.
  99747. */
  99748. get rightController(): Nullable<WebVRController>;
  99749. /**
  99750. * Casts a ray forward from the vrCamera's gaze.
  99751. * @param length Length of the ray (default: 100)
  99752. * @returns the ray corresponding to the gaze
  99753. */
  99754. getForwardRay(length?: number): Ray;
  99755. /**
  99756. * @hidden
  99757. * Updates the camera based on device's frame data
  99758. */
  99759. _checkInputs(): void;
  99760. /**
  99761. * Updates the poseControlled values based on the input device pose.
  99762. * @param poseData Pose coming from the device
  99763. */
  99764. updateFromDevice(poseData: DevicePose): void;
  99765. private _htmlElementAttached;
  99766. private _detachIfAttached;
  99767. /**
  99768. * WebVR's attach control will start broadcasting frames to the device.
  99769. * Note that in certain browsers (chrome for example) this function must be called
  99770. * within a user-interaction callback. Example:
  99771. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99772. *
  99773. * @param element html element to attach the vrDevice to
  99774. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99775. */
  99776. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99777. /**
  99778. * Detaches the camera from the html element and disables VR
  99779. *
  99780. * @param element html element to detach from
  99781. */
  99782. detachControl(element: HTMLElement): void;
  99783. /**
  99784. * @returns the name of this class
  99785. */
  99786. getClassName(): string;
  99787. /**
  99788. * Calls resetPose on the vrDisplay
  99789. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99790. */
  99791. resetToCurrentRotation(): void;
  99792. /**
  99793. * @hidden
  99794. * Updates the rig cameras (left and right eye)
  99795. */
  99796. _updateRigCameras(): void;
  99797. private _workingVector;
  99798. private _oneVector;
  99799. private _workingMatrix;
  99800. private updateCacheCalled;
  99801. private _correctPositionIfNotTrackPosition;
  99802. /**
  99803. * @hidden
  99804. * Updates the cached values of the camera
  99805. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99806. */
  99807. _updateCache(ignoreParentClass?: boolean): void;
  99808. /**
  99809. * @hidden
  99810. * Get current device position in babylon world
  99811. */
  99812. _computeDevicePosition(): void;
  99813. /**
  99814. * Updates the current device position and rotation in the babylon world
  99815. */
  99816. update(): void;
  99817. /**
  99818. * @hidden
  99819. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99820. * @returns an identity matrix
  99821. */
  99822. _getViewMatrix(): Matrix;
  99823. private _tmpMatrix;
  99824. /**
  99825. * This function is called by the two RIG cameras.
  99826. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99827. * @hidden
  99828. */
  99829. _getWebVRViewMatrix(): Matrix;
  99830. /** @hidden */
  99831. _getWebVRProjectionMatrix(): Matrix;
  99832. private _onGamepadConnectedObserver;
  99833. private _onGamepadDisconnectedObserver;
  99834. private _updateCacheWhenTrackingDisabledObserver;
  99835. /**
  99836. * Initializes the controllers and their meshes
  99837. */
  99838. initControllers(): void;
  99839. }
  99840. }
  99841. declare module BABYLON {
  99842. /**
  99843. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99844. *
  99845. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99846. *
  99847. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99848. */
  99849. export class MaterialHelper {
  99850. /**
  99851. * Bind the current view position to an effect.
  99852. * @param effect The effect to be bound
  99853. * @param scene The scene the eyes position is used from
  99854. * @param variableName name of the shader variable that will hold the eye position
  99855. */
  99856. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99857. /**
  99858. * Helps preparing the defines values about the UVs in used in the effect.
  99859. * UVs are shared as much as we can accross channels in the shaders.
  99860. * @param texture The texture we are preparing the UVs for
  99861. * @param defines The defines to update
  99862. * @param key The channel key "diffuse", "specular"... used in the shader
  99863. */
  99864. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99865. /**
  99866. * Binds a texture matrix value to its corrsponding uniform
  99867. * @param texture The texture to bind the matrix for
  99868. * @param uniformBuffer The uniform buffer receivin the data
  99869. * @param key The channel key "diffuse", "specular"... used in the shader
  99870. */
  99871. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99872. /**
  99873. * Gets the current status of the fog (should it be enabled?)
  99874. * @param mesh defines the mesh to evaluate for fog support
  99875. * @param scene defines the hosting scene
  99876. * @returns true if fog must be enabled
  99877. */
  99878. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99879. /**
  99880. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99881. * @param mesh defines the current mesh
  99882. * @param scene defines the current scene
  99883. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99884. * @param pointsCloud defines if point cloud rendering has to be turned on
  99885. * @param fogEnabled defines if fog has to be turned on
  99886. * @param alphaTest defines if alpha testing has to be turned on
  99887. * @param defines defines the current list of defines
  99888. */
  99889. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99890. /**
  99891. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99892. * @param scene defines the current scene
  99893. * @param engine defines the current engine
  99894. * @param defines specifies the list of active defines
  99895. * @param useInstances defines if instances have to be turned on
  99896. * @param useClipPlane defines if clip plane have to be turned on
  99897. * @param useInstances defines if instances have to be turned on
  99898. * @param useThinInstances defines if thin instances have to be turned on
  99899. */
  99900. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99901. /**
  99902. * Prepares the defines for bones
  99903. * @param mesh The mesh containing the geometry data we will draw
  99904. * @param defines The defines to update
  99905. */
  99906. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99907. /**
  99908. * Prepares the defines for morph targets
  99909. * @param mesh The mesh containing the geometry data we will draw
  99910. * @param defines The defines to update
  99911. */
  99912. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99913. /**
  99914. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99915. * @param mesh The mesh containing the geometry data we will draw
  99916. * @param defines The defines to update
  99917. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99918. * @param useBones Precise whether bones should be used or not (override mesh info)
  99919. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99920. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99921. * @returns false if defines are considered not dirty and have not been checked
  99922. */
  99923. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99924. /**
  99925. * Prepares the defines related to multiview
  99926. * @param scene The scene we are intending to draw
  99927. * @param defines The defines to update
  99928. */
  99929. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99930. /**
  99931. * Prepares the defines related to the prepass
  99932. * @param scene The scene we are intending to draw
  99933. * @param defines The defines to update
  99934. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99935. */
  99936. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99937. /**
  99938. * Prepares the defines related to the light information passed in parameter
  99939. * @param scene The scene we are intending to draw
  99940. * @param mesh The mesh the effect is compiling for
  99941. * @param light The light the effect is compiling for
  99942. * @param lightIndex The index of the light
  99943. * @param defines The defines to update
  99944. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99945. * @param state Defines the current state regarding what is needed (normals, etc...)
  99946. */
  99947. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99948. needNormals: boolean;
  99949. needRebuild: boolean;
  99950. shadowEnabled: boolean;
  99951. specularEnabled: boolean;
  99952. lightmapMode: boolean;
  99953. }): void;
  99954. /**
  99955. * Prepares the defines related to the light information passed in parameter
  99956. * @param scene The scene we are intending to draw
  99957. * @param mesh The mesh the effect is compiling for
  99958. * @param defines The defines to update
  99959. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99960. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99961. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99962. * @returns true if normals will be required for the rest of the effect
  99963. */
  99964. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99965. /**
  99966. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99967. * @param lightIndex defines the light index
  99968. * @param uniformsList The uniform list
  99969. * @param samplersList The sampler list
  99970. * @param projectedLightTexture defines if projected texture must be used
  99971. * @param uniformBuffersList defines an optional list of uniform buffers
  99972. */
  99973. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99974. /**
  99975. * Prepares the uniforms and samplers list to be used in the effect
  99976. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99977. * @param samplersList The sampler list
  99978. * @param defines The defines helping in the list generation
  99979. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99980. */
  99981. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99982. /**
  99983. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99984. * @param defines The defines to update while falling back
  99985. * @param fallbacks The authorized effect fallbacks
  99986. * @param maxSimultaneousLights The maximum number of lights allowed
  99987. * @param rank the current rank of the Effect
  99988. * @returns The newly affected rank
  99989. */
  99990. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99991. private static _TmpMorphInfluencers;
  99992. /**
  99993. * Prepares the list of attributes required for morph targets according to the effect defines.
  99994. * @param attribs The current list of supported attribs
  99995. * @param mesh The mesh to prepare the morph targets attributes for
  99996. * @param influencers The number of influencers
  99997. */
  99998. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99999. /**
  100000. * Prepares the list of attributes required for morph targets according to the effect defines.
  100001. * @param attribs The current list of supported attribs
  100002. * @param mesh The mesh to prepare the morph targets attributes for
  100003. * @param defines The current Defines of the effect
  100004. */
  100005. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  100006. /**
  100007. * Prepares the list of attributes required for bones according to the effect defines.
  100008. * @param attribs The current list of supported attribs
  100009. * @param mesh The mesh to prepare the bones attributes for
  100010. * @param defines The current Defines of the effect
  100011. * @param fallbacks The current efffect fallback strategy
  100012. */
  100013. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100014. /**
  100015. * Check and prepare the list of attributes required for instances according to the effect defines.
  100016. * @param attribs The current list of supported attribs
  100017. * @param defines The current MaterialDefines of the effect
  100018. */
  100019. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100020. /**
  100021. * Add the list of attributes required for instances to the attribs array.
  100022. * @param attribs The current list of supported attribs
  100023. */
  100024. static PushAttributesForInstances(attribs: string[]): void;
  100025. /**
  100026. * Binds the light information to the effect.
  100027. * @param light The light containing the generator
  100028. * @param effect The effect we are binding the data to
  100029. * @param lightIndex The light index in the effect used to render
  100030. */
  100031. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100032. /**
  100033. * Binds the lights information from the scene to the effect for the given mesh.
  100034. * @param light Light to bind
  100035. * @param lightIndex Light index
  100036. * @param scene The scene where the light belongs to
  100037. * @param effect The effect we are binding the data to
  100038. * @param useSpecular Defines if specular is supported
  100039. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100040. */
  100041. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100042. /**
  100043. * Binds the lights information from the scene to the effect for the given mesh.
  100044. * @param scene The scene the lights belongs to
  100045. * @param mesh The mesh we are binding the information to render
  100046. * @param effect The effect we are binding the data to
  100047. * @param defines The generated defines for the effect
  100048. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100049. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100050. */
  100051. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100052. private static _tempFogColor;
  100053. /**
  100054. * Binds the fog information from the scene to the effect for the given mesh.
  100055. * @param scene The scene the lights belongs to
  100056. * @param mesh The mesh we are binding the information to render
  100057. * @param effect The effect we are binding the data to
  100058. * @param linearSpace Defines if the fog effect is applied in linear space
  100059. */
  100060. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100061. /**
  100062. * Binds the bones information from the mesh to the effect.
  100063. * @param mesh The mesh we are binding the information to render
  100064. * @param effect The effect we are binding the data to
  100065. */
  100066. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100067. /**
  100068. * Binds the morph targets information from the mesh to the effect.
  100069. * @param abstractMesh The mesh we are binding the information to render
  100070. * @param effect The effect we are binding the data to
  100071. */
  100072. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100073. /**
  100074. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100075. * @param defines The generated defines used in the effect
  100076. * @param effect The effect we are binding the data to
  100077. * @param scene The scene we are willing to render with logarithmic scale for
  100078. */
  100079. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100080. /**
  100081. * Binds the clip plane information from the scene to the effect.
  100082. * @param scene The scene the clip plane information are extracted from
  100083. * @param effect The effect we are binding the data to
  100084. */
  100085. static BindClipPlane(effect: Effect, scene: Scene): void;
  100086. }
  100087. }
  100088. declare module BABYLON {
  100089. /**
  100090. * Block used to expose an input value
  100091. */
  100092. export class InputBlock extends NodeMaterialBlock {
  100093. private _mode;
  100094. private _associatedVariableName;
  100095. private _storedValue;
  100096. private _valueCallback;
  100097. private _type;
  100098. private _animationType;
  100099. /** Gets or set a value used to limit the range of float values */
  100100. min: number;
  100101. /** Gets or set a value used to limit the range of float values */
  100102. max: number;
  100103. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100104. isBoolean: boolean;
  100105. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100106. matrixMode: number;
  100107. /** @hidden */
  100108. _systemValue: Nullable<NodeMaterialSystemValues>;
  100109. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100110. visibleInInspector: boolean;
  100111. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100112. isConstant: boolean;
  100113. /** Gets or sets the group to use to display this block in the Inspector */
  100114. groupInInspector: string;
  100115. /** Gets an observable raised when the value is changed */
  100116. onValueChangedObservable: Observable<InputBlock>;
  100117. /**
  100118. * Gets or sets the connection point type (default is float)
  100119. */
  100120. get type(): NodeMaterialBlockConnectionPointTypes;
  100121. /**
  100122. * Creates a new InputBlock
  100123. * @param name defines the block name
  100124. * @param target defines the target of that block (Vertex by default)
  100125. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100126. */
  100127. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100128. /**
  100129. * Validates if a name is a reserve word.
  100130. * @param newName the new name to be given to the node.
  100131. * @returns false if the name is a reserve word, else true.
  100132. */
  100133. validateBlockName(newName: string): boolean;
  100134. /**
  100135. * Gets the output component
  100136. */
  100137. get output(): NodeMaterialConnectionPoint;
  100138. /**
  100139. * Set the source of this connection point to a vertex attribute
  100140. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100141. * @returns the current connection point
  100142. */
  100143. setAsAttribute(attributeName?: string): InputBlock;
  100144. /**
  100145. * Set the source of this connection point to a system value
  100146. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100147. * @returns the current connection point
  100148. */
  100149. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100150. /**
  100151. * Gets or sets the value of that point.
  100152. * Please note that this value will be ignored if valueCallback is defined
  100153. */
  100154. get value(): any;
  100155. set value(value: any);
  100156. /**
  100157. * Gets or sets a callback used to get the value of that point.
  100158. * Please note that setting this value will force the connection point to ignore the value property
  100159. */
  100160. get valueCallback(): () => any;
  100161. set valueCallback(value: () => any);
  100162. /**
  100163. * Gets or sets the associated variable name in the shader
  100164. */
  100165. get associatedVariableName(): string;
  100166. set associatedVariableName(value: string);
  100167. /** Gets or sets the type of animation applied to the input */
  100168. get animationType(): AnimatedInputBlockTypes;
  100169. set animationType(value: AnimatedInputBlockTypes);
  100170. /**
  100171. * Gets a boolean indicating that this connection point not defined yet
  100172. */
  100173. get isUndefined(): boolean;
  100174. /**
  100175. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100176. * In this case the connection point name must be the name of the uniform to use.
  100177. * Can only be set on inputs
  100178. */
  100179. get isUniform(): boolean;
  100180. set isUniform(value: boolean);
  100181. /**
  100182. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100183. * In this case the connection point name must be the name of the attribute to use
  100184. * Can only be set on inputs
  100185. */
  100186. get isAttribute(): boolean;
  100187. set isAttribute(value: boolean);
  100188. /**
  100189. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100190. * Can only be set on exit points
  100191. */
  100192. get isVarying(): boolean;
  100193. set isVarying(value: boolean);
  100194. /**
  100195. * Gets a boolean indicating that the current connection point is a system value
  100196. */
  100197. get isSystemValue(): boolean;
  100198. /**
  100199. * Gets or sets the current well known value or null if not defined as a system value
  100200. */
  100201. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100202. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100203. /**
  100204. * Gets the current class name
  100205. * @returns the class name
  100206. */
  100207. getClassName(): string;
  100208. /**
  100209. * Animate the input if animationType !== None
  100210. * @param scene defines the rendering scene
  100211. */
  100212. animate(scene: Scene): void;
  100213. private _emitDefine;
  100214. initialize(state: NodeMaterialBuildState): void;
  100215. /**
  100216. * Set the input block to its default value (based on its type)
  100217. */
  100218. setDefaultValue(): void;
  100219. private _emitConstant;
  100220. /** @hidden */
  100221. get _noContextSwitch(): boolean;
  100222. private _emit;
  100223. /** @hidden */
  100224. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100225. /** @hidden */
  100226. _transmit(effect: Effect, scene: Scene): void;
  100227. protected _buildBlock(state: NodeMaterialBuildState): void;
  100228. protected _dumpPropertiesCode(): string;
  100229. dispose(): void;
  100230. serialize(): any;
  100231. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100232. }
  100233. }
  100234. declare module BABYLON {
  100235. /**
  100236. * Enum used to define the compatibility state between two connection points
  100237. */
  100238. export enum NodeMaterialConnectionPointCompatibilityStates {
  100239. /** Points are compatibles */
  100240. Compatible = 0,
  100241. /** Points are incompatible because of their types */
  100242. TypeIncompatible = 1,
  100243. /** Points are incompatible because of their targets (vertex vs fragment) */
  100244. TargetIncompatible = 2
  100245. }
  100246. /**
  100247. * Defines the direction of a connection point
  100248. */
  100249. export enum NodeMaterialConnectionPointDirection {
  100250. /** Input */
  100251. Input = 0,
  100252. /** Output */
  100253. Output = 1
  100254. }
  100255. /**
  100256. * Defines a connection point for a block
  100257. */
  100258. export class NodeMaterialConnectionPoint {
  100259. /** @hidden */
  100260. _ownerBlock: NodeMaterialBlock;
  100261. /** @hidden */
  100262. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100263. private _endpoints;
  100264. private _associatedVariableName;
  100265. private _direction;
  100266. /** @hidden */
  100267. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100268. /** @hidden */
  100269. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100270. private _type;
  100271. /** @hidden */
  100272. _enforceAssociatedVariableName: boolean;
  100273. /** Gets the direction of the point */
  100274. get direction(): NodeMaterialConnectionPointDirection;
  100275. /** Indicates that this connection point needs dual validation before being connected to another point */
  100276. needDualDirectionValidation: boolean;
  100277. /**
  100278. * Gets or sets the additional types supported by this connection point
  100279. */
  100280. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100281. /**
  100282. * Gets or sets the additional types excluded by this connection point
  100283. */
  100284. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100285. /**
  100286. * Observable triggered when this point is connected
  100287. */
  100288. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100289. /**
  100290. * Gets or sets the associated variable name in the shader
  100291. */
  100292. get associatedVariableName(): string;
  100293. set associatedVariableName(value: string);
  100294. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100295. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100296. /**
  100297. * Gets or sets the connection point type (default is float)
  100298. */
  100299. get type(): NodeMaterialBlockConnectionPointTypes;
  100300. set type(value: NodeMaterialBlockConnectionPointTypes);
  100301. /**
  100302. * Gets or sets the connection point name
  100303. */
  100304. name: string;
  100305. /**
  100306. * Gets or sets the connection point name
  100307. */
  100308. displayName: string;
  100309. /**
  100310. * Gets or sets a boolean indicating that this connection point can be omitted
  100311. */
  100312. isOptional: boolean;
  100313. /**
  100314. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100315. */
  100316. isExposedOnFrame: boolean;
  100317. /**
  100318. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100319. */
  100320. define: string;
  100321. /** @hidden */
  100322. _prioritizeVertex: boolean;
  100323. private _target;
  100324. /** Gets or sets the target of that connection point */
  100325. get target(): NodeMaterialBlockTargets;
  100326. set target(value: NodeMaterialBlockTargets);
  100327. /**
  100328. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100329. */
  100330. get isConnected(): boolean;
  100331. /**
  100332. * Gets a boolean indicating that the current point is connected to an input block
  100333. */
  100334. get isConnectedToInputBlock(): boolean;
  100335. /**
  100336. * Gets a the connected input block (if any)
  100337. */
  100338. get connectInputBlock(): Nullable<InputBlock>;
  100339. /** Get the other side of the connection (if any) */
  100340. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100341. /** Get the block that owns this connection point */
  100342. get ownerBlock(): NodeMaterialBlock;
  100343. /** Get the block connected on the other side of this connection (if any) */
  100344. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100345. /** Get the block connected on the endpoints of this connection (if any) */
  100346. get connectedBlocks(): Array<NodeMaterialBlock>;
  100347. /** Gets the list of connected endpoints */
  100348. get endpoints(): NodeMaterialConnectionPoint[];
  100349. /** Gets a boolean indicating if that output point is connected to at least one input */
  100350. get hasEndpoints(): boolean;
  100351. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100352. get isConnectedInVertexShader(): boolean;
  100353. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100354. get isConnectedInFragmentShader(): boolean;
  100355. /**
  100356. * Creates a block suitable to be used as an input for this input point.
  100357. * If null is returned, a block based on the point type will be created.
  100358. * @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
  100359. */
  100360. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100361. /**
  100362. * Creates a new connection point
  100363. * @param name defines the connection point name
  100364. * @param ownerBlock defines the block hosting this connection point
  100365. * @param direction defines the direction of the connection point
  100366. */
  100367. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100368. /**
  100369. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100370. * @returns the class name
  100371. */
  100372. getClassName(): string;
  100373. /**
  100374. * Gets a boolean indicating if the current point can be connected to another point
  100375. * @param connectionPoint defines the other connection point
  100376. * @returns a boolean
  100377. */
  100378. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100379. /**
  100380. * Gets a number indicating if the current point can be connected to another point
  100381. * @param connectionPoint defines the other connection point
  100382. * @returns a number defining the compatibility state
  100383. */
  100384. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100385. /**
  100386. * Connect this point to another connection point
  100387. * @param connectionPoint defines the other connection point
  100388. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100389. * @returns the current connection point
  100390. */
  100391. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100392. /**
  100393. * Disconnect this point from one of his endpoint
  100394. * @param endpoint defines the other connection point
  100395. * @returns the current connection point
  100396. */
  100397. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100398. /**
  100399. * Serializes this point in a JSON representation
  100400. * @param isInput defines if the connection point is an input (default is true)
  100401. * @returns the serialized point object
  100402. */
  100403. serialize(isInput?: boolean): any;
  100404. /**
  100405. * Release resources
  100406. */
  100407. dispose(): void;
  100408. }
  100409. }
  100410. declare module BABYLON {
  100411. /**
  100412. * Enum used to define the material modes
  100413. */
  100414. export enum NodeMaterialModes {
  100415. /** Regular material */
  100416. Material = 0,
  100417. /** For post process */
  100418. PostProcess = 1,
  100419. /** For particle system */
  100420. Particle = 2
  100421. }
  100422. }
  100423. declare module BABYLON {
  100424. /**
  100425. * Block used to read a texture from a sampler
  100426. */
  100427. export class TextureBlock extends NodeMaterialBlock {
  100428. private _defineName;
  100429. private _linearDefineName;
  100430. private _gammaDefineName;
  100431. private _tempTextureRead;
  100432. private _samplerName;
  100433. private _transformedUVName;
  100434. private _textureTransformName;
  100435. private _textureInfoName;
  100436. private _mainUVName;
  100437. private _mainUVDefineName;
  100438. private _fragmentOnly;
  100439. /**
  100440. * Gets or sets the texture associated with the node
  100441. */
  100442. texture: Nullable<Texture>;
  100443. /**
  100444. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100445. */
  100446. convertToGammaSpace: boolean;
  100447. /**
  100448. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100449. */
  100450. convertToLinearSpace: boolean;
  100451. /**
  100452. * Create a new TextureBlock
  100453. * @param name defines the block name
  100454. */
  100455. constructor(name: string, fragmentOnly?: boolean);
  100456. /**
  100457. * Gets the current class name
  100458. * @returns the class name
  100459. */
  100460. getClassName(): string;
  100461. /**
  100462. * Gets the uv input component
  100463. */
  100464. get uv(): NodeMaterialConnectionPoint;
  100465. /**
  100466. * Gets the rgba output component
  100467. */
  100468. get rgba(): NodeMaterialConnectionPoint;
  100469. /**
  100470. * Gets the rgb output component
  100471. */
  100472. get rgb(): NodeMaterialConnectionPoint;
  100473. /**
  100474. * Gets the r output component
  100475. */
  100476. get r(): NodeMaterialConnectionPoint;
  100477. /**
  100478. * Gets the g output component
  100479. */
  100480. get g(): NodeMaterialConnectionPoint;
  100481. /**
  100482. * Gets the b output component
  100483. */
  100484. get b(): NodeMaterialConnectionPoint;
  100485. /**
  100486. * Gets the a output component
  100487. */
  100488. get a(): NodeMaterialConnectionPoint;
  100489. get target(): NodeMaterialBlockTargets;
  100490. autoConfigure(material: NodeMaterial): void;
  100491. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100492. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100493. isReady(): boolean;
  100494. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100495. private get _isMixed();
  100496. private _injectVertexCode;
  100497. private _writeTextureRead;
  100498. private _writeOutput;
  100499. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100500. protected _dumpPropertiesCode(): string;
  100501. serialize(): any;
  100502. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100503. }
  100504. }
  100505. declare module BABYLON {
  100506. /** @hidden */
  100507. export var reflectionFunction: {
  100508. name: string;
  100509. shader: string;
  100510. };
  100511. }
  100512. declare module BABYLON {
  100513. /**
  100514. * Base block used to read a reflection texture from a sampler
  100515. */
  100516. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100517. /** @hidden */
  100518. _define3DName: string;
  100519. /** @hidden */
  100520. _defineCubicName: string;
  100521. /** @hidden */
  100522. _defineExplicitName: string;
  100523. /** @hidden */
  100524. _defineProjectionName: string;
  100525. /** @hidden */
  100526. _defineLocalCubicName: string;
  100527. /** @hidden */
  100528. _defineSphericalName: string;
  100529. /** @hidden */
  100530. _definePlanarName: string;
  100531. /** @hidden */
  100532. _defineEquirectangularName: string;
  100533. /** @hidden */
  100534. _defineMirroredEquirectangularFixedName: string;
  100535. /** @hidden */
  100536. _defineEquirectangularFixedName: string;
  100537. /** @hidden */
  100538. _defineSkyboxName: string;
  100539. /** @hidden */
  100540. _defineOppositeZ: string;
  100541. /** @hidden */
  100542. _cubeSamplerName: string;
  100543. /** @hidden */
  100544. _2DSamplerName: string;
  100545. protected _positionUVWName: string;
  100546. protected _directionWName: string;
  100547. protected _reflectionVectorName: string;
  100548. /** @hidden */
  100549. _reflectionCoordsName: string;
  100550. /** @hidden */
  100551. _reflectionMatrixName: string;
  100552. protected _reflectionColorName: string;
  100553. /**
  100554. * Gets or sets the texture associated with the node
  100555. */
  100556. texture: Nullable<BaseTexture>;
  100557. /**
  100558. * Create a new ReflectionTextureBaseBlock
  100559. * @param name defines the block name
  100560. */
  100561. constructor(name: string);
  100562. /**
  100563. * Gets the current class name
  100564. * @returns the class name
  100565. */
  100566. getClassName(): string;
  100567. /**
  100568. * Gets the world position input component
  100569. */
  100570. abstract get position(): NodeMaterialConnectionPoint;
  100571. /**
  100572. * Gets the world position input component
  100573. */
  100574. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100575. /**
  100576. * Gets the world normal input component
  100577. */
  100578. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100579. /**
  100580. * Gets the world input component
  100581. */
  100582. abstract get world(): NodeMaterialConnectionPoint;
  100583. /**
  100584. * Gets the camera (or eye) position component
  100585. */
  100586. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100587. /**
  100588. * Gets the view input component
  100589. */
  100590. abstract get view(): NodeMaterialConnectionPoint;
  100591. protected _getTexture(): Nullable<BaseTexture>;
  100592. autoConfigure(material: NodeMaterial): void;
  100593. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100594. isReady(): boolean;
  100595. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100596. /**
  100597. * Gets the code to inject in the vertex shader
  100598. * @param state current state of the node material building
  100599. * @returns the shader code
  100600. */
  100601. handleVertexSide(state: NodeMaterialBuildState): string;
  100602. /**
  100603. * Handles the inits for the fragment code path
  100604. * @param state node material build state
  100605. */
  100606. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100607. /**
  100608. * Generates the reflection coords code for the fragment code path
  100609. * @param worldNormalVarName name of the world normal variable
  100610. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100611. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100612. * @returns the shader code
  100613. */
  100614. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100615. /**
  100616. * Generates the reflection color code for the fragment code path
  100617. * @param lodVarName name of the lod variable
  100618. * @param swizzleLookupTexture swizzle to use for the final color variable
  100619. * @returns the shader code
  100620. */
  100621. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100622. /**
  100623. * Generates the code corresponding to the connected output points
  100624. * @param state node material build state
  100625. * @param varName name of the variable to output
  100626. * @returns the shader code
  100627. */
  100628. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100629. protected _buildBlock(state: NodeMaterialBuildState): this;
  100630. protected _dumpPropertiesCode(): string;
  100631. serialize(): any;
  100632. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100633. }
  100634. }
  100635. declare module BABYLON {
  100636. /**
  100637. * Defines a connection point to be used for points with a custom object type
  100638. */
  100639. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100640. private _blockType;
  100641. private _blockName;
  100642. private _nameForCheking?;
  100643. /**
  100644. * Creates a new connection point
  100645. * @param name defines the connection point name
  100646. * @param ownerBlock defines the block hosting this connection point
  100647. * @param direction defines the direction of the connection point
  100648. */
  100649. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100650. /**
  100651. * Gets a number indicating if the current point can be connected to another point
  100652. * @param connectionPoint defines the other connection point
  100653. * @returns a number defining the compatibility state
  100654. */
  100655. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100656. /**
  100657. * Creates a block suitable to be used as an input for this input point.
  100658. * If null is returned, a block based on the point type will be created.
  100659. * @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
  100660. */
  100661. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100662. }
  100663. }
  100664. declare module BABYLON {
  100665. /**
  100666. * Enum defining the type of properties that can be edited in the property pages in the NME
  100667. */
  100668. export enum PropertyTypeForEdition {
  100669. /** property is a boolean */
  100670. Boolean = 0,
  100671. /** property is a float */
  100672. Float = 1,
  100673. /** property is a Vector2 */
  100674. Vector2 = 2,
  100675. /** property is a list of values */
  100676. List = 3
  100677. }
  100678. /**
  100679. * Interface that defines an option in a variable of type list
  100680. */
  100681. export interface IEditablePropertyListOption {
  100682. /** label of the option */
  100683. "label": string;
  100684. /** value of the option */
  100685. "value": number;
  100686. }
  100687. /**
  100688. * Interface that defines the options available for an editable property
  100689. */
  100690. export interface IEditablePropertyOption {
  100691. /** min value */
  100692. "min"?: number;
  100693. /** max value */
  100694. "max"?: number;
  100695. /** notifiers: indicates which actions to take when the property is changed */
  100696. "notifiers"?: {
  100697. /** the material should be rebuilt */
  100698. "rebuild"?: boolean;
  100699. /** the preview should be updated */
  100700. "update"?: boolean;
  100701. };
  100702. /** list of the options for a variable of type list */
  100703. "options"?: IEditablePropertyListOption[];
  100704. }
  100705. /**
  100706. * Interface that describes an editable property
  100707. */
  100708. export interface IPropertyDescriptionForEdition {
  100709. /** name of the property */
  100710. "propertyName": string;
  100711. /** display name of the property */
  100712. "displayName": string;
  100713. /** type of the property */
  100714. "type": PropertyTypeForEdition;
  100715. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100716. "groupName": string;
  100717. /** options for the property */
  100718. "options": IEditablePropertyOption;
  100719. }
  100720. /**
  100721. * Decorator that flags a property in a node material block as being editable
  100722. */
  100723. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100724. }
  100725. declare module BABYLON {
  100726. /**
  100727. * Block used to implement the refraction part of the sub surface module of the PBR material
  100728. */
  100729. export class RefractionBlock extends NodeMaterialBlock {
  100730. /** @hidden */
  100731. _define3DName: string;
  100732. /** @hidden */
  100733. _refractionMatrixName: string;
  100734. /** @hidden */
  100735. _defineLODRefractionAlpha: string;
  100736. /** @hidden */
  100737. _defineLinearSpecularRefraction: string;
  100738. /** @hidden */
  100739. _defineOppositeZ: string;
  100740. /** @hidden */
  100741. _cubeSamplerName: string;
  100742. /** @hidden */
  100743. _2DSamplerName: string;
  100744. /** @hidden */
  100745. _vRefractionMicrosurfaceInfosName: string;
  100746. /** @hidden */
  100747. _vRefractionInfosName: string;
  100748. private _scene;
  100749. /**
  100750. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100751. * Materials half opaque for instance using refraction could benefit from this control.
  100752. */
  100753. linkRefractionWithTransparency: boolean;
  100754. /**
  100755. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100756. */
  100757. invertRefractionY: boolean;
  100758. /**
  100759. * Gets or sets the texture associated with the node
  100760. */
  100761. texture: Nullable<BaseTexture>;
  100762. /**
  100763. * Create a new RefractionBlock
  100764. * @param name defines the block name
  100765. */
  100766. constructor(name: string);
  100767. /**
  100768. * Gets the current class name
  100769. * @returns the class name
  100770. */
  100771. getClassName(): string;
  100772. /**
  100773. * Gets the intensity input component
  100774. */
  100775. get intensity(): NodeMaterialConnectionPoint;
  100776. /**
  100777. * Gets the index of refraction input component
  100778. */
  100779. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100780. /**
  100781. * Gets the tint at distance input component
  100782. */
  100783. get tintAtDistance(): NodeMaterialConnectionPoint;
  100784. /**
  100785. * Gets the view input component
  100786. */
  100787. get view(): NodeMaterialConnectionPoint;
  100788. /**
  100789. * Gets the refraction object output component
  100790. */
  100791. get refraction(): NodeMaterialConnectionPoint;
  100792. /**
  100793. * Returns true if the block has a texture
  100794. */
  100795. get hasTexture(): boolean;
  100796. protected _getTexture(): Nullable<BaseTexture>;
  100797. autoConfigure(material: NodeMaterial): void;
  100798. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100799. isReady(): boolean;
  100800. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100801. /**
  100802. * Gets the main code of the block (fragment side)
  100803. * @param state current state of the node material building
  100804. * @returns the shader code
  100805. */
  100806. getCode(state: NodeMaterialBuildState): string;
  100807. protected _buildBlock(state: NodeMaterialBuildState): this;
  100808. protected _dumpPropertiesCode(): string;
  100809. serialize(): any;
  100810. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100811. }
  100812. }
  100813. declare module BABYLON {
  100814. /**
  100815. * Base block used as input for post process
  100816. */
  100817. export class CurrentScreenBlock extends NodeMaterialBlock {
  100818. private _samplerName;
  100819. private _linearDefineName;
  100820. private _gammaDefineName;
  100821. private _mainUVName;
  100822. private _tempTextureRead;
  100823. /**
  100824. * Gets or sets the texture associated with the node
  100825. */
  100826. texture: Nullable<BaseTexture>;
  100827. /**
  100828. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100829. */
  100830. convertToGammaSpace: boolean;
  100831. /**
  100832. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100833. */
  100834. convertToLinearSpace: boolean;
  100835. /**
  100836. * Create a new CurrentScreenBlock
  100837. * @param name defines the block name
  100838. */
  100839. constructor(name: string);
  100840. /**
  100841. * Gets the current class name
  100842. * @returns the class name
  100843. */
  100844. getClassName(): string;
  100845. /**
  100846. * Gets the uv input component
  100847. */
  100848. get uv(): NodeMaterialConnectionPoint;
  100849. /**
  100850. * Gets the rgba output component
  100851. */
  100852. get rgba(): NodeMaterialConnectionPoint;
  100853. /**
  100854. * Gets the rgb output component
  100855. */
  100856. get rgb(): NodeMaterialConnectionPoint;
  100857. /**
  100858. * Gets the r output component
  100859. */
  100860. get r(): NodeMaterialConnectionPoint;
  100861. /**
  100862. * Gets the g output component
  100863. */
  100864. get g(): NodeMaterialConnectionPoint;
  100865. /**
  100866. * Gets the b output component
  100867. */
  100868. get b(): NodeMaterialConnectionPoint;
  100869. /**
  100870. * Gets the a output component
  100871. */
  100872. get a(): NodeMaterialConnectionPoint;
  100873. /**
  100874. * Initialize the block and prepare the context for build
  100875. * @param state defines the state that will be used for the build
  100876. */
  100877. initialize(state: NodeMaterialBuildState): void;
  100878. get target(): NodeMaterialBlockTargets;
  100879. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100880. isReady(): boolean;
  100881. private _injectVertexCode;
  100882. private _writeTextureRead;
  100883. private _writeOutput;
  100884. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100885. serialize(): any;
  100886. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100887. }
  100888. }
  100889. declare module BABYLON {
  100890. /**
  100891. * Base block used for the particle texture
  100892. */
  100893. export class ParticleTextureBlock extends NodeMaterialBlock {
  100894. private _samplerName;
  100895. private _linearDefineName;
  100896. private _gammaDefineName;
  100897. private _tempTextureRead;
  100898. /**
  100899. * Gets or sets the texture associated with the node
  100900. */
  100901. texture: Nullable<BaseTexture>;
  100902. /**
  100903. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100904. */
  100905. convertToGammaSpace: boolean;
  100906. /**
  100907. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100908. */
  100909. convertToLinearSpace: boolean;
  100910. /**
  100911. * Create a new ParticleTextureBlock
  100912. * @param name defines the block name
  100913. */
  100914. constructor(name: string);
  100915. /**
  100916. * Gets the current class name
  100917. * @returns the class name
  100918. */
  100919. getClassName(): string;
  100920. /**
  100921. * Gets the uv input component
  100922. */
  100923. get uv(): NodeMaterialConnectionPoint;
  100924. /**
  100925. * Gets the rgba output component
  100926. */
  100927. get rgba(): NodeMaterialConnectionPoint;
  100928. /**
  100929. * Gets the rgb output component
  100930. */
  100931. get rgb(): NodeMaterialConnectionPoint;
  100932. /**
  100933. * Gets the r output component
  100934. */
  100935. get r(): NodeMaterialConnectionPoint;
  100936. /**
  100937. * Gets the g output component
  100938. */
  100939. get g(): NodeMaterialConnectionPoint;
  100940. /**
  100941. * Gets the b output component
  100942. */
  100943. get b(): NodeMaterialConnectionPoint;
  100944. /**
  100945. * Gets the a output component
  100946. */
  100947. get a(): NodeMaterialConnectionPoint;
  100948. /**
  100949. * Initialize the block and prepare the context for build
  100950. * @param state defines the state that will be used for the build
  100951. */
  100952. initialize(state: NodeMaterialBuildState): void;
  100953. autoConfigure(material: NodeMaterial): void;
  100954. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100955. isReady(): boolean;
  100956. private _writeOutput;
  100957. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100958. serialize(): any;
  100959. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100960. }
  100961. }
  100962. declare module BABYLON {
  100963. /**
  100964. * Class used to store shared data between 2 NodeMaterialBuildState
  100965. */
  100966. export class NodeMaterialBuildStateSharedData {
  100967. /**
  100968. * Gets the list of emitted varyings
  100969. */
  100970. temps: string[];
  100971. /**
  100972. * Gets the list of emitted varyings
  100973. */
  100974. varyings: string[];
  100975. /**
  100976. * Gets the varying declaration string
  100977. */
  100978. varyingDeclaration: string;
  100979. /**
  100980. * Input blocks
  100981. */
  100982. inputBlocks: InputBlock[];
  100983. /**
  100984. * Input blocks
  100985. */
  100986. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100987. /**
  100988. * Bindable blocks (Blocks that need to set data to the effect)
  100989. */
  100990. bindableBlocks: NodeMaterialBlock[];
  100991. /**
  100992. * List of blocks that can provide a compilation fallback
  100993. */
  100994. blocksWithFallbacks: NodeMaterialBlock[];
  100995. /**
  100996. * List of blocks that can provide a define update
  100997. */
  100998. blocksWithDefines: NodeMaterialBlock[];
  100999. /**
  101000. * List of blocks that can provide a repeatable content
  101001. */
  101002. repeatableContentBlocks: NodeMaterialBlock[];
  101003. /**
  101004. * List of blocks that can provide a dynamic list of uniforms
  101005. */
  101006. dynamicUniformBlocks: NodeMaterialBlock[];
  101007. /**
  101008. * List of blocks that can block the isReady function for the material
  101009. */
  101010. blockingBlocks: NodeMaterialBlock[];
  101011. /**
  101012. * Gets the list of animated inputs
  101013. */
  101014. animatedInputs: InputBlock[];
  101015. /**
  101016. * Build Id used to avoid multiple recompilations
  101017. */
  101018. buildId: number;
  101019. /** List of emitted variables */
  101020. variableNames: {
  101021. [key: string]: number;
  101022. };
  101023. /** List of emitted defines */
  101024. defineNames: {
  101025. [key: string]: number;
  101026. };
  101027. /** Should emit comments? */
  101028. emitComments: boolean;
  101029. /** Emit build activity */
  101030. verbose: boolean;
  101031. /** Gets or sets the hosting scene */
  101032. scene: Scene;
  101033. /**
  101034. * Gets the compilation hints emitted at compilation time
  101035. */
  101036. hints: {
  101037. needWorldViewMatrix: boolean;
  101038. needWorldViewProjectionMatrix: boolean;
  101039. needAlphaBlending: boolean;
  101040. needAlphaTesting: boolean;
  101041. };
  101042. /**
  101043. * List of compilation checks
  101044. */
  101045. checks: {
  101046. emitVertex: boolean;
  101047. emitFragment: boolean;
  101048. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101049. };
  101050. /**
  101051. * Is vertex program allowed to be empty?
  101052. */
  101053. allowEmptyVertexProgram: boolean;
  101054. /** Creates a new shared data */
  101055. constructor();
  101056. /**
  101057. * Emits console errors and exceptions if there is a failing check
  101058. */
  101059. emitErrors(): void;
  101060. }
  101061. }
  101062. declare module BABYLON {
  101063. /**
  101064. * Class used to store node based material build state
  101065. */
  101066. export class NodeMaterialBuildState {
  101067. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101068. supportUniformBuffers: boolean;
  101069. /**
  101070. * Gets the list of emitted attributes
  101071. */
  101072. attributes: string[];
  101073. /**
  101074. * Gets the list of emitted uniforms
  101075. */
  101076. uniforms: string[];
  101077. /**
  101078. * Gets the list of emitted constants
  101079. */
  101080. constants: string[];
  101081. /**
  101082. * Gets the list of emitted samplers
  101083. */
  101084. samplers: string[];
  101085. /**
  101086. * Gets the list of emitted functions
  101087. */
  101088. functions: {
  101089. [key: string]: string;
  101090. };
  101091. /**
  101092. * Gets the list of emitted extensions
  101093. */
  101094. extensions: {
  101095. [key: string]: string;
  101096. };
  101097. /**
  101098. * Gets the target of the compilation state
  101099. */
  101100. target: NodeMaterialBlockTargets;
  101101. /**
  101102. * Gets the list of emitted counters
  101103. */
  101104. counters: {
  101105. [key: string]: number;
  101106. };
  101107. /**
  101108. * Shared data between multiple NodeMaterialBuildState instances
  101109. */
  101110. sharedData: NodeMaterialBuildStateSharedData;
  101111. /** @hidden */
  101112. _vertexState: NodeMaterialBuildState;
  101113. /** @hidden */
  101114. _attributeDeclaration: string;
  101115. /** @hidden */
  101116. _uniformDeclaration: string;
  101117. /** @hidden */
  101118. _constantDeclaration: string;
  101119. /** @hidden */
  101120. _samplerDeclaration: string;
  101121. /** @hidden */
  101122. _varyingTransfer: string;
  101123. /** @hidden */
  101124. _injectAtEnd: string;
  101125. private _repeatableContentAnchorIndex;
  101126. /** @hidden */
  101127. _builtCompilationString: string;
  101128. /**
  101129. * Gets the emitted compilation strings
  101130. */
  101131. compilationString: string;
  101132. /**
  101133. * Finalize the compilation strings
  101134. * @param state defines the current compilation state
  101135. */
  101136. finalize(state: NodeMaterialBuildState): void;
  101137. /** @hidden */
  101138. get _repeatableContentAnchor(): string;
  101139. /** @hidden */
  101140. _getFreeVariableName(prefix: string): string;
  101141. /** @hidden */
  101142. _getFreeDefineName(prefix: string): string;
  101143. /** @hidden */
  101144. _excludeVariableName(name: string): void;
  101145. /** @hidden */
  101146. _emit2DSampler(name: string): void;
  101147. /** @hidden */
  101148. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101149. /** @hidden */
  101150. _emitExtension(name: string, extension: string, define?: string): void;
  101151. /** @hidden */
  101152. _emitFunction(name: string, code: string, comments: string): void;
  101153. /** @hidden */
  101154. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101155. replaceStrings?: {
  101156. search: RegExp;
  101157. replace: string;
  101158. }[];
  101159. repeatKey?: string;
  101160. }): string;
  101161. /** @hidden */
  101162. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101163. repeatKey?: string;
  101164. removeAttributes?: boolean;
  101165. removeUniforms?: boolean;
  101166. removeVaryings?: boolean;
  101167. removeIfDef?: boolean;
  101168. replaceStrings?: {
  101169. search: RegExp;
  101170. replace: string;
  101171. }[];
  101172. }, storeKey?: string): void;
  101173. /** @hidden */
  101174. _registerTempVariable(name: string): boolean;
  101175. /** @hidden */
  101176. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101177. /** @hidden */
  101178. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101179. /** @hidden */
  101180. _emitFloat(value: number): string;
  101181. }
  101182. }
  101183. declare module BABYLON {
  101184. /**
  101185. * Helper class used to generate session unique ID
  101186. */
  101187. export class UniqueIdGenerator {
  101188. private static _UniqueIdCounter;
  101189. /**
  101190. * Gets an unique (relatively to the current scene) Id
  101191. */
  101192. static get UniqueId(): number;
  101193. }
  101194. }
  101195. declare module BABYLON {
  101196. /**
  101197. * Defines a block that can be used inside a node based material
  101198. */
  101199. export class NodeMaterialBlock {
  101200. private _buildId;
  101201. private _buildTarget;
  101202. private _target;
  101203. private _isFinalMerger;
  101204. private _isInput;
  101205. private _name;
  101206. protected _isUnique: boolean;
  101207. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101208. inputsAreExclusive: boolean;
  101209. /** @hidden */
  101210. _codeVariableName: string;
  101211. /** @hidden */
  101212. _inputs: NodeMaterialConnectionPoint[];
  101213. /** @hidden */
  101214. _outputs: NodeMaterialConnectionPoint[];
  101215. /** @hidden */
  101216. _preparationId: number;
  101217. /**
  101218. * Gets the name of the block
  101219. */
  101220. get name(): string;
  101221. /**
  101222. * Sets the name of the block. Will check if the name is valid.
  101223. */
  101224. set name(newName: string);
  101225. /**
  101226. * Gets or sets the unique id of the node
  101227. */
  101228. uniqueId: number;
  101229. /**
  101230. * Gets or sets the comments associated with this block
  101231. */
  101232. comments: string;
  101233. /**
  101234. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101235. */
  101236. get isUnique(): boolean;
  101237. /**
  101238. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101239. */
  101240. get isFinalMerger(): boolean;
  101241. /**
  101242. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101243. */
  101244. get isInput(): boolean;
  101245. /**
  101246. * Gets or sets the build Id
  101247. */
  101248. get buildId(): number;
  101249. set buildId(value: number);
  101250. /**
  101251. * Gets or sets the target of the block
  101252. */
  101253. get target(): NodeMaterialBlockTargets;
  101254. set target(value: NodeMaterialBlockTargets);
  101255. /**
  101256. * Gets the list of input points
  101257. */
  101258. get inputs(): NodeMaterialConnectionPoint[];
  101259. /** Gets the list of output points */
  101260. get outputs(): NodeMaterialConnectionPoint[];
  101261. /**
  101262. * Find an input by its name
  101263. * @param name defines the name of the input to look for
  101264. * @returns the input or null if not found
  101265. */
  101266. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101267. /**
  101268. * Find an output by its name
  101269. * @param name defines the name of the outputto look for
  101270. * @returns the output or null if not found
  101271. */
  101272. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101273. /**
  101274. * Creates a new NodeMaterialBlock
  101275. * @param name defines the block name
  101276. * @param target defines the target of that block (Vertex by default)
  101277. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101278. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101279. */
  101280. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101281. /**
  101282. * Initialize the block and prepare the context for build
  101283. * @param state defines the state that will be used for the build
  101284. */
  101285. initialize(state: NodeMaterialBuildState): void;
  101286. /**
  101287. * Bind data to effect. Will only be called for blocks with isBindable === true
  101288. * @param effect defines the effect to bind data to
  101289. * @param nodeMaterial defines the hosting NodeMaterial
  101290. * @param mesh defines the mesh that will be rendered
  101291. * @param subMesh defines the submesh that will be rendered
  101292. */
  101293. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101294. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101295. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101296. protected _writeFloat(value: number): string;
  101297. /**
  101298. * Gets the current class name e.g. "NodeMaterialBlock"
  101299. * @returns the class name
  101300. */
  101301. getClassName(): string;
  101302. /**
  101303. * Register a new input. Must be called inside a block constructor
  101304. * @param name defines the connection point name
  101305. * @param type defines the connection point type
  101306. * @param isOptional defines a boolean indicating that this input can be omitted
  101307. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101308. * @param point an already created connection point. If not provided, create a new one
  101309. * @returns the current block
  101310. */
  101311. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101312. /**
  101313. * Register a new output. Must be called inside a block constructor
  101314. * @param name defines the connection point name
  101315. * @param type defines the connection point type
  101316. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101317. * @param point an already created connection point. If not provided, create a new one
  101318. * @returns the current block
  101319. */
  101320. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101321. /**
  101322. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101323. * @param forOutput defines an optional connection point to check compatibility with
  101324. * @returns the first available input or null
  101325. */
  101326. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101327. /**
  101328. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101329. * @param forBlock defines an optional block to check compatibility with
  101330. * @returns the first available input or null
  101331. */
  101332. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101333. /**
  101334. * Gets the sibling of the given output
  101335. * @param current defines the current output
  101336. * @returns the next output in the list or null
  101337. */
  101338. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101339. /**
  101340. * Connect current block with another block
  101341. * @param other defines the block to connect with
  101342. * @param options define the various options to help pick the right connections
  101343. * @returns the current block
  101344. */
  101345. connectTo(other: NodeMaterialBlock, options?: {
  101346. input?: string;
  101347. output?: string;
  101348. outputSwizzle?: string;
  101349. }): this | undefined;
  101350. protected _buildBlock(state: NodeMaterialBuildState): void;
  101351. /**
  101352. * Add uniforms, samplers and uniform buffers at compilation time
  101353. * @param state defines the state to update
  101354. * @param nodeMaterial defines the node material requesting the update
  101355. * @param defines defines the material defines to update
  101356. * @param uniformBuffers defines the list of uniform buffer names
  101357. */
  101358. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101359. /**
  101360. * Add potential fallbacks if shader compilation fails
  101361. * @param mesh defines the mesh to be rendered
  101362. * @param fallbacks defines the current prioritized list of fallbacks
  101363. */
  101364. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101365. /**
  101366. * Initialize defines for shader compilation
  101367. * @param mesh defines the mesh to be rendered
  101368. * @param nodeMaterial defines the node material requesting the update
  101369. * @param defines defines the material defines to update
  101370. * @param useInstances specifies that instances should be used
  101371. */
  101372. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101373. /**
  101374. * Update defines for shader compilation
  101375. * @param mesh defines the mesh to be rendered
  101376. * @param nodeMaterial defines the node material requesting the update
  101377. * @param defines defines the material defines to update
  101378. * @param useInstances specifies that instances should be used
  101379. * @param subMesh defines which submesh to render
  101380. */
  101381. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101382. /**
  101383. * Lets the block try to connect some inputs automatically
  101384. * @param material defines the hosting NodeMaterial
  101385. */
  101386. autoConfigure(material: NodeMaterial): void;
  101387. /**
  101388. * Function called when a block is declared as repeatable content generator
  101389. * @param vertexShaderState defines the current compilation state for the vertex shader
  101390. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101391. * @param mesh defines the mesh to be rendered
  101392. * @param defines defines the material defines to update
  101393. */
  101394. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101395. /**
  101396. * Checks if the block is ready
  101397. * @param mesh defines the mesh to be rendered
  101398. * @param nodeMaterial defines the node material requesting the update
  101399. * @param defines defines the material defines to update
  101400. * @param useInstances specifies that instances should be used
  101401. * @returns true if the block is ready
  101402. */
  101403. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101404. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101405. private _processBuild;
  101406. /**
  101407. * Validates the new name for the block node.
  101408. * @param newName the new name to be given to the node.
  101409. * @returns false if the name is a reserve word, else true.
  101410. */
  101411. validateBlockName(newName: string): boolean;
  101412. /**
  101413. * Compile the current node and generate the shader code
  101414. * @param state defines the current compilation state (uniforms, samplers, current string)
  101415. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101416. * @returns true if already built
  101417. */
  101418. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101419. protected _inputRename(name: string): string;
  101420. protected _outputRename(name: string): string;
  101421. protected _dumpPropertiesCode(): string;
  101422. /** @hidden */
  101423. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101424. /** @hidden */
  101425. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101426. /**
  101427. * Clone the current block to a new identical block
  101428. * @param scene defines the hosting scene
  101429. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101430. * @returns a copy of the current block
  101431. */
  101432. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101433. /**
  101434. * Serializes this block in a JSON representation
  101435. * @returns the serialized block object
  101436. */
  101437. serialize(): any;
  101438. /** @hidden */
  101439. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101440. private _deserializePortDisplayNamesAndExposedOnFrame;
  101441. /**
  101442. * Release resources
  101443. */
  101444. dispose(): void;
  101445. }
  101446. }
  101447. declare module BABYLON {
  101448. /**
  101449. * Base class of materials working in push mode in babylon JS
  101450. * @hidden
  101451. */
  101452. export class PushMaterial extends Material {
  101453. protected _activeEffect: Effect;
  101454. protected _normalMatrix: Matrix;
  101455. constructor(name: string, scene: Scene);
  101456. getEffect(): Effect;
  101457. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101458. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101459. /**
  101460. * Binds the given world matrix to the active effect
  101461. *
  101462. * @param world the matrix to bind
  101463. */
  101464. bindOnlyWorldMatrix(world: Matrix): void;
  101465. /**
  101466. * Binds the given normal matrix to the active effect
  101467. *
  101468. * @param normalMatrix the matrix to bind
  101469. */
  101470. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101471. bind(world: Matrix, mesh?: Mesh): void;
  101472. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101473. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101474. }
  101475. }
  101476. declare module BABYLON {
  101477. /**
  101478. * Root class for all node material optimizers
  101479. */
  101480. export class NodeMaterialOptimizer {
  101481. /**
  101482. * Function used to optimize a NodeMaterial graph
  101483. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101484. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101485. */
  101486. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101487. }
  101488. }
  101489. declare module BABYLON {
  101490. /**
  101491. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101492. */
  101493. export class TransformBlock extends NodeMaterialBlock {
  101494. /**
  101495. * Defines the value to use to complement W value to transform it to a Vector4
  101496. */
  101497. complementW: number;
  101498. /**
  101499. * Defines the value to use to complement z value to transform it to a Vector4
  101500. */
  101501. complementZ: number;
  101502. /**
  101503. * Creates a new TransformBlock
  101504. * @param name defines the block name
  101505. */
  101506. constructor(name: string);
  101507. /**
  101508. * Gets the current class name
  101509. * @returns the class name
  101510. */
  101511. getClassName(): string;
  101512. /**
  101513. * Gets the vector input
  101514. */
  101515. get vector(): NodeMaterialConnectionPoint;
  101516. /**
  101517. * Gets the output component
  101518. */
  101519. get output(): NodeMaterialConnectionPoint;
  101520. /**
  101521. * Gets the xyz output component
  101522. */
  101523. get xyz(): NodeMaterialConnectionPoint;
  101524. /**
  101525. * Gets the matrix transform input
  101526. */
  101527. get transform(): NodeMaterialConnectionPoint;
  101528. protected _buildBlock(state: NodeMaterialBuildState): this;
  101529. /**
  101530. * Update defines for shader compilation
  101531. * @param mesh defines the mesh to be rendered
  101532. * @param nodeMaterial defines the node material requesting the update
  101533. * @param defines defines the material defines to update
  101534. * @param useInstances specifies that instances should be used
  101535. * @param subMesh defines which submesh to render
  101536. */
  101537. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101538. serialize(): any;
  101539. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101540. protected _dumpPropertiesCode(): string;
  101541. }
  101542. }
  101543. declare module BABYLON {
  101544. /**
  101545. * Block used to output the vertex position
  101546. */
  101547. export class VertexOutputBlock extends NodeMaterialBlock {
  101548. /**
  101549. * Creates a new VertexOutputBlock
  101550. * @param name defines the block name
  101551. */
  101552. constructor(name: string);
  101553. /**
  101554. * Gets the current class name
  101555. * @returns the class name
  101556. */
  101557. getClassName(): string;
  101558. /**
  101559. * Gets the vector input component
  101560. */
  101561. get vector(): NodeMaterialConnectionPoint;
  101562. protected _buildBlock(state: NodeMaterialBuildState): this;
  101563. }
  101564. }
  101565. declare module BABYLON {
  101566. /**
  101567. * Block used to output the final color
  101568. */
  101569. export class FragmentOutputBlock extends NodeMaterialBlock {
  101570. /**
  101571. * Create a new FragmentOutputBlock
  101572. * @param name defines the block name
  101573. */
  101574. constructor(name: string);
  101575. /**
  101576. * Gets the current class name
  101577. * @returns the class name
  101578. */
  101579. getClassName(): string;
  101580. /**
  101581. * Gets the rgba input component
  101582. */
  101583. get rgba(): NodeMaterialConnectionPoint;
  101584. /**
  101585. * Gets the rgb input component
  101586. */
  101587. get rgb(): NodeMaterialConnectionPoint;
  101588. /**
  101589. * Gets the a input component
  101590. */
  101591. get a(): NodeMaterialConnectionPoint;
  101592. protected _buildBlock(state: NodeMaterialBuildState): this;
  101593. }
  101594. }
  101595. declare module BABYLON {
  101596. /**
  101597. * Block used for the particle ramp gradient section
  101598. */
  101599. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101600. /**
  101601. * Create a new ParticleRampGradientBlock
  101602. * @param name defines the block name
  101603. */
  101604. constructor(name: string);
  101605. /**
  101606. * Gets the current class name
  101607. * @returns the class name
  101608. */
  101609. getClassName(): string;
  101610. /**
  101611. * Gets the color input component
  101612. */
  101613. get color(): NodeMaterialConnectionPoint;
  101614. /**
  101615. * Gets the rampColor output component
  101616. */
  101617. get rampColor(): NodeMaterialConnectionPoint;
  101618. /**
  101619. * Initialize the block and prepare the context for build
  101620. * @param state defines the state that will be used for the build
  101621. */
  101622. initialize(state: NodeMaterialBuildState): void;
  101623. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101624. }
  101625. }
  101626. declare module BABYLON {
  101627. /**
  101628. * Block used for the particle blend multiply section
  101629. */
  101630. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101631. /**
  101632. * Create a new ParticleBlendMultiplyBlock
  101633. * @param name defines the block name
  101634. */
  101635. constructor(name: string);
  101636. /**
  101637. * Gets the current class name
  101638. * @returns the class name
  101639. */
  101640. getClassName(): string;
  101641. /**
  101642. * Gets the color input component
  101643. */
  101644. get color(): NodeMaterialConnectionPoint;
  101645. /**
  101646. * Gets the alphaTexture input component
  101647. */
  101648. get alphaTexture(): NodeMaterialConnectionPoint;
  101649. /**
  101650. * Gets the alphaColor input component
  101651. */
  101652. get alphaColor(): NodeMaterialConnectionPoint;
  101653. /**
  101654. * Gets the blendColor output component
  101655. */
  101656. get blendColor(): NodeMaterialConnectionPoint;
  101657. /**
  101658. * Initialize the block and prepare the context for build
  101659. * @param state defines the state that will be used for the build
  101660. */
  101661. initialize(state: NodeMaterialBuildState): void;
  101662. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101663. }
  101664. }
  101665. declare module BABYLON {
  101666. /**
  101667. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101668. */
  101669. export class VectorMergerBlock extends NodeMaterialBlock {
  101670. /**
  101671. * Create a new VectorMergerBlock
  101672. * @param name defines the block name
  101673. */
  101674. constructor(name: string);
  101675. /**
  101676. * Gets the current class name
  101677. * @returns the class name
  101678. */
  101679. getClassName(): string;
  101680. /**
  101681. * Gets the xyz component (input)
  101682. */
  101683. get xyzIn(): NodeMaterialConnectionPoint;
  101684. /**
  101685. * Gets the xy component (input)
  101686. */
  101687. get xyIn(): NodeMaterialConnectionPoint;
  101688. /**
  101689. * Gets the x component (input)
  101690. */
  101691. get x(): NodeMaterialConnectionPoint;
  101692. /**
  101693. * Gets the y component (input)
  101694. */
  101695. get y(): NodeMaterialConnectionPoint;
  101696. /**
  101697. * Gets the z component (input)
  101698. */
  101699. get z(): NodeMaterialConnectionPoint;
  101700. /**
  101701. * Gets the w component (input)
  101702. */
  101703. get w(): NodeMaterialConnectionPoint;
  101704. /**
  101705. * Gets the xyzw component (output)
  101706. */
  101707. get xyzw(): NodeMaterialConnectionPoint;
  101708. /**
  101709. * Gets the xyz component (output)
  101710. */
  101711. get xyzOut(): NodeMaterialConnectionPoint;
  101712. /**
  101713. * Gets the xy component (output)
  101714. */
  101715. get xyOut(): NodeMaterialConnectionPoint;
  101716. /**
  101717. * Gets the xy component (output)
  101718. * @deprecated Please use xyOut instead.
  101719. */
  101720. get xy(): NodeMaterialConnectionPoint;
  101721. /**
  101722. * Gets the xyz component (output)
  101723. * @deprecated Please use xyzOut instead.
  101724. */
  101725. get xyz(): NodeMaterialConnectionPoint;
  101726. protected _buildBlock(state: NodeMaterialBuildState): this;
  101727. }
  101728. }
  101729. declare module BABYLON {
  101730. /**
  101731. * Block used to remap a float from a range to a new one
  101732. */
  101733. export class RemapBlock extends NodeMaterialBlock {
  101734. /**
  101735. * Gets or sets the source range
  101736. */
  101737. sourceRange: Vector2;
  101738. /**
  101739. * Gets or sets the target range
  101740. */
  101741. targetRange: Vector2;
  101742. /**
  101743. * Creates a new RemapBlock
  101744. * @param name defines the block name
  101745. */
  101746. constructor(name: string);
  101747. /**
  101748. * Gets the current class name
  101749. * @returns the class name
  101750. */
  101751. getClassName(): string;
  101752. /**
  101753. * Gets the input component
  101754. */
  101755. get input(): NodeMaterialConnectionPoint;
  101756. /**
  101757. * Gets the source min input component
  101758. */
  101759. get sourceMin(): NodeMaterialConnectionPoint;
  101760. /**
  101761. * Gets the source max input component
  101762. */
  101763. get sourceMax(): NodeMaterialConnectionPoint;
  101764. /**
  101765. * Gets the target min input component
  101766. */
  101767. get targetMin(): NodeMaterialConnectionPoint;
  101768. /**
  101769. * Gets the target max input component
  101770. */
  101771. get targetMax(): NodeMaterialConnectionPoint;
  101772. /**
  101773. * Gets the output component
  101774. */
  101775. get output(): NodeMaterialConnectionPoint;
  101776. protected _buildBlock(state: NodeMaterialBuildState): this;
  101777. protected _dumpPropertiesCode(): string;
  101778. serialize(): any;
  101779. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101780. }
  101781. }
  101782. declare module BABYLON {
  101783. /**
  101784. * Block used to multiply 2 values
  101785. */
  101786. export class MultiplyBlock extends NodeMaterialBlock {
  101787. /**
  101788. * Creates a new MultiplyBlock
  101789. * @param name defines the block name
  101790. */
  101791. constructor(name: string);
  101792. /**
  101793. * Gets the current class name
  101794. * @returns the class name
  101795. */
  101796. getClassName(): string;
  101797. /**
  101798. * Gets the left operand input component
  101799. */
  101800. get left(): NodeMaterialConnectionPoint;
  101801. /**
  101802. * Gets the right operand input component
  101803. */
  101804. get right(): NodeMaterialConnectionPoint;
  101805. /**
  101806. * Gets the output component
  101807. */
  101808. get output(): NodeMaterialConnectionPoint;
  101809. protected _buildBlock(state: NodeMaterialBuildState): this;
  101810. }
  101811. }
  101812. declare module BABYLON {
  101813. /**
  101814. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101815. */
  101816. export class ColorSplitterBlock extends NodeMaterialBlock {
  101817. /**
  101818. * Create a new ColorSplitterBlock
  101819. * @param name defines the block name
  101820. */
  101821. constructor(name: string);
  101822. /**
  101823. * Gets the current class name
  101824. * @returns the class name
  101825. */
  101826. getClassName(): string;
  101827. /**
  101828. * Gets the rgba component (input)
  101829. */
  101830. get rgba(): NodeMaterialConnectionPoint;
  101831. /**
  101832. * Gets the rgb component (input)
  101833. */
  101834. get rgbIn(): NodeMaterialConnectionPoint;
  101835. /**
  101836. * Gets the rgb component (output)
  101837. */
  101838. get rgbOut(): NodeMaterialConnectionPoint;
  101839. /**
  101840. * Gets the r component (output)
  101841. */
  101842. get r(): NodeMaterialConnectionPoint;
  101843. /**
  101844. * Gets the g component (output)
  101845. */
  101846. get g(): NodeMaterialConnectionPoint;
  101847. /**
  101848. * Gets the b component (output)
  101849. */
  101850. get b(): NodeMaterialConnectionPoint;
  101851. /**
  101852. * Gets the a component (output)
  101853. */
  101854. get a(): NodeMaterialConnectionPoint;
  101855. protected _inputRename(name: string): string;
  101856. protected _outputRename(name: string): string;
  101857. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101858. }
  101859. }
  101860. declare module BABYLON {
  101861. /**
  101862. * Interface used to configure the node material editor
  101863. */
  101864. export interface INodeMaterialEditorOptions {
  101865. /** Define the URl to load node editor script */
  101866. editorURL?: string;
  101867. }
  101868. /** @hidden */
  101869. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101870. NORMAL: boolean;
  101871. TANGENT: boolean;
  101872. UV1: boolean;
  101873. /** BONES */
  101874. NUM_BONE_INFLUENCERS: number;
  101875. BonesPerMesh: number;
  101876. BONETEXTURE: boolean;
  101877. /** MORPH TARGETS */
  101878. MORPHTARGETS: boolean;
  101879. MORPHTARGETS_NORMAL: boolean;
  101880. MORPHTARGETS_TANGENT: boolean;
  101881. MORPHTARGETS_UV: boolean;
  101882. NUM_MORPH_INFLUENCERS: number;
  101883. /** IMAGE PROCESSING */
  101884. IMAGEPROCESSING: boolean;
  101885. VIGNETTE: boolean;
  101886. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101887. VIGNETTEBLENDMODEOPAQUE: boolean;
  101888. TONEMAPPING: boolean;
  101889. TONEMAPPING_ACES: boolean;
  101890. CONTRAST: boolean;
  101891. EXPOSURE: boolean;
  101892. COLORCURVES: boolean;
  101893. COLORGRADING: boolean;
  101894. COLORGRADING3D: boolean;
  101895. SAMPLER3DGREENDEPTH: boolean;
  101896. SAMPLER3DBGRMAP: boolean;
  101897. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101898. /** MISC. */
  101899. BUMPDIRECTUV: number;
  101900. constructor();
  101901. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101902. }
  101903. /**
  101904. * Class used to configure NodeMaterial
  101905. */
  101906. export interface INodeMaterialOptions {
  101907. /**
  101908. * Defines if blocks should emit comments
  101909. */
  101910. emitComments: boolean;
  101911. }
  101912. /**
  101913. * Class used to create a node based material built by assembling shader blocks
  101914. */
  101915. export class NodeMaterial extends PushMaterial {
  101916. private static _BuildIdGenerator;
  101917. private _options;
  101918. private _vertexCompilationState;
  101919. private _fragmentCompilationState;
  101920. private _sharedData;
  101921. private _buildId;
  101922. private _buildWasSuccessful;
  101923. private _cachedWorldViewMatrix;
  101924. private _cachedWorldViewProjectionMatrix;
  101925. private _optimizers;
  101926. private _animationFrame;
  101927. /** Define the Url to load node editor script */
  101928. static EditorURL: string;
  101929. /** Define the Url to load snippets */
  101930. static SnippetUrl: string;
  101931. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101932. static IgnoreTexturesAtLoadTime: boolean;
  101933. private BJSNODEMATERIALEDITOR;
  101934. /** Get the inspector from bundle or global */
  101935. private _getGlobalNodeMaterialEditor;
  101936. /**
  101937. * Snippet ID if the material was created from the snippet server
  101938. */
  101939. snippetId: string;
  101940. /**
  101941. * Gets or sets data used by visual editor
  101942. * @see https://nme.babylonjs.com
  101943. */
  101944. editorData: any;
  101945. /**
  101946. * 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)
  101947. */
  101948. ignoreAlpha: boolean;
  101949. /**
  101950. * Defines the maximum number of lights that can be used in the material
  101951. */
  101952. maxSimultaneousLights: number;
  101953. /**
  101954. * Observable raised when the material is built
  101955. */
  101956. onBuildObservable: Observable<NodeMaterial>;
  101957. /**
  101958. * Gets or sets the root nodes of the material vertex shader
  101959. */
  101960. _vertexOutputNodes: NodeMaterialBlock[];
  101961. /**
  101962. * Gets or sets the root nodes of the material fragment (pixel) shader
  101963. */
  101964. _fragmentOutputNodes: NodeMaterialBlock[];
  101965. /** Gets or sets options to control the node material overall behavior */
  101966. get options(): INodeMaterialOptions;
  101967. set options(options: INodeMaterialOptions);
  101968. /**
  101969. * Default configuration related to image processing available in the standard Material.
  101970. */
  101971. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101972. /**
  101973. * Gets the image processing configuration used either in this material.
  101974. */
  101975. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101976. /**
  101977. * Sets the Default image processing configuration used either in the this material.
  101978. *
  101979. * If sets to null, the scene one is in use.
  101980. */
  101981. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101982. /**
  101983. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101984. */
  101985. attachedBlocks: NodeMaterialBlock[];
  101986. /**
  101987. * Specifies the mode of the node material
  101988. * @hidden
  101989. */
  101990. _mode: NodeMaterialModes;
  101991. /**
  101992. * Gets the mode property
  101993. */
  101994. get mode(): NodeMaterialModes;
  101995. /**
  101996. * Create a new node based material
  101997. * @param name defines the material name
  101998. * @param scene defines the hosting scene
  101999. * @param options defines creation option
  102000. */
  102001. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  102002. /**
  102003. * Gets the current class name of the material e.g. "NodeMaterial"
  102004. * @returns the class name
  102005. */
  102006. getClassName(): string;
  102007. /**
  102008. * Keep track of the image processing observer to allow dispose and replace.
  102009. */
  102010. private _imageProcessingObserver;
  102011. /**
  102012. * Attaches a new image processing configuration to the Standard Material.
  102013. * @param configuration
  102014. */
  102015. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102016. /**
  102017. * Get a block by its name
  102018. * @param name defines the name of the block to retrieve
  102019. * @returns the required block or null if not found
  102020. */
  102021. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102022. /**
  102023. * Get a block by its name
  102024. * @param predicate defines the predicate used to find the good candidate
  102025. * @returns the required block or null if not found
  102026. */
  102027. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102028. /**
  102029. * Get an input block by its name
  102030. * @param predicate defines the predicate used to find the good candidate
  102031. * @returns the required input block or null if not found
  102032. */
  102033. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102034. /**
  102035. * Gets the list of input blocks attached to this material
  102036. * @returns an array of InputBlocks
  102037. */
  102038. getInputBlocks(): InputBlock[];
  102039. /**
  102040. * Adds a new optimizer to the list of optimizers
  102041. * @param optimizer defines the optimizers to add
  102042. * @returns the current material
  102043. */
  102044. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102045. /**
  102046. * Remove an optimizer from the list of optimizers
  102047. * @param optimizer defines the optimizers to remove
  102048. * @returns the current material
  102049. */
  102050. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102051. /**
  102052. * Add a new block to the list of output nodes
  102053. * @param node defines the node to add
  102054. * @returns the current material
  102055. */
  102056. addOutputNode(node: NodeMaterialBlock): this;
  102057. /**
  102058. * Remove a block from the list of root nodes
  102059. * @param node defines the node to remove
  102060. * @returns the current material
  102061. */
  102062. removeOutputNode(node: NodeMaterialBlock): this;
  102063. private _addVertexOutputNode;
  102064. private _removeVertexOutputNode;
  102065. private _addFragmentOutputNode;
  102066. private _removeFragmentOutputNode;
  102067. /**
  102068. * Specifies if the material will require alpha blending
  102069. * @returns a boolean specifying if alpha blending is needed
  102070. */
  102071. needAlphaBlending(): boolean;
  102072. /**
  102073. * Specifies if this material should be rendered in alpha test mode
  102074. * @returns a boolean specifying if an alpha test is needed.
  102075. */
  102076. needAlphaTesting(): boolean;
  102077. private _initializeBlock;
  102078. private _resetDualBlocks;
  102079. /**
  102080. * Remove a block from the current node material
  102081. * @param block defines the block to remove
  102082. */
  102083. removeBlock(block: NodeMaterialBlock): void;
  102084. /**
  102085. * Build the material and generates the inner effect
  102086. * @param verbose defines if the build should log activity
  102087. */
  102088. build(verbose?: boolean): void;
  102089. /**
  102090. * Runs an otpimization phase to try to improve the shader code
  102091. */
  102092. optimize(): void;
  102093. private _prepareDefinesForAttributes;
  102094. /**
  102095. * Create a post process from the material
  102096. * @param camera The camera to apply the render pass to.
  102097. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102098. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102099. * @param engine The engine which the post process will be applied. (default: current engine)
  102100. * @param reusable If the post process can be reused on the same frame. (default: false)
  102101. * @param textureType Type of textures used when performing the post process. (default: 0)
  102102. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102103. * @returns the post process created
  102104. */
  102105. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102106. /**
  102107. * Create the post process effect from the material
  102108. * @param postProcess The post process to create the effect for
  102109. */
  102110. createEffectForPostProcess(postProcess: PostProcess): void;
  102111. private _createEffectOrPostProcess;
  102112. private _createEffectForParticles;
  102113. /**
  102114. * Create the effect to be used as the custom effect for a particle system
  102115. * @param particleSystem Particle system to create the effect for
  102116. * @param onCompiled defines a function to call when the effect creation is successful
  102117. * @param onError defines a function to call when the effect creation has failed
  102118. */
  102119. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102120. private _processDefines;
  102121. /**
  102122. * Get if the submesh is ready to be used and all its information available.
  102123. * Child classes can use it to update shaders
  102124. * @param mesh defines the mesh to check
  102125. * @param subMesh defines which submesh to check
  102126. * @param useInstances specifies that instances should be used
  102127. * @returns a boolean indicating that the submesh is ready or not
  102128. */
  102129. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102130. /**
  102131. * Get a string representing the shaders built by the current node graph
  102132. */
  102133. get compiledShaders(): string;
  102134. /**
  102135. * Binds the world matrix to the material
  102136. * @param world defines the world transformation matrix
  102137. */
  102138. bindOnlyWorldMatrix(world: Matrix): void;
  102139. /**
  102140. * Binds the submesh to this material by preparing the effect and shader to draw
  102141. * @param world defines the world transformation matrix
  102142. * @param mesh defines the mesh containing the submesh
  102143. * @param subMesh defines the submesh to bind the material to
  102144. */
  102145. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102146. /**
  102147. * Gets the active textures from the material
  102148. * @returns an array of textures
  102149. */
  102150. getActiveTextures(): BaseTexture[];
  102151. /**
  102152. * Gets the list of texture blocks
  102153. * @returns an array of texture blocks
  102154. */
  102155. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102156. /**
  102157. * Specifies if the material uses a texture
  102158. * @param texture defines the texture to check against the material
  102159. * @returns a boolean specifying if the material uses the texture
  102160. */
  102161. hasTexture(texture: BaseTexture): boolean;
  102162. /**
  102163. * Disposes the material
  102164. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102165. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102166. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102167. */
  102168. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102169. /** Creates the node editor window. */
  102170. private _createNodeEditor;
  102171. /**
  102172. * Launch the node material editor
  102173. * @param config Define the configuration of the editor
  102174. * @return a promise fulfilled when the node editor is visible
  102175. */
  102176. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102177. /**
  102178. * Clear the current material
  102179. */
  102180. clear(): void;
  102181. /**
  102182. * Clear the current material and set it to a default state
  102183. */
  102184. setToDefault(): void;
  102185. /**
  102186. * Clear the current material and set it to a default state for post process
  102187. */
  102188. setToDefaultPostProcess(): void;
  102189. /**
  102190. * Clear the current material and set it to a default state for particle
  102191. */
  102192. setToDefaultParticle(): void;
  102193. /**
  102194. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102195. * @param url defines the url to load from
  102196. * @returns a promise that will fullfil when the material is fully loaded
  102197. */
  102198. loadAsync(url: string): Promise<void>;
  102199. private _gatherBlocks;
  102200. /**
  102201. * Generate a string containing the code declaration required to create an equivalent of this material
  102202. * @returns a string
  102203. */
  102204. generateCode(): string;
  102205. /**
  102206. * Serializes this material in a JSON representation
  102207. * @returns the serialized material object
  102208. */
  102209. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102210. private _restoreConnections;
  102211. /**
  102212. * Clear the current graph and load a new one from a serialization object
  102213. * @param source defines the JSON representation of the material
  102214. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102215. * @param merge defines whether or not the source must be merged or replace the current content
  102216. */
  102217. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102218. /**
  102219. * Makes a duplicate of the current material.
  102220. * @param name - name to use for the new material.
  102221. */
  102222. clone(name: string): NodeMaterial;
  102223. /**
  102224. * Creates a node material from parsed material data
  102225. * @param source defines the JSON representation of the material
  102226. * @param scene defines the hosting scene
  102227. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102228. * @returns a new node material
  102229. */
  102230. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102231. /**
  102232. * Creates a node material from a snippet saved in a remote file
  102233. * @param name defines the name of the material to create
  102234. * @param url defines the url to load from
  102235. * @param scene defines the hosting scene
  102236. * @returns a promise that will resolve to the new node material
  102237. */
  102238. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102239. /**
  102240. * Creates a node material from a snippet saved by the node material editor
  102241. * @param snippetId defines the snippet to load
  102242. * @param scene defines the hosting scene
  102243. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102244. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102245. * @returns a promise that will resolve to the new node material
  102246. */
  102247. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102248. /**
  102249. * Creates a new node material set to default basic configuration
  102250. * @param name defines the name of the material
  102251. * @param scene defines the hosting scene
  102252. * @returns a new NodeMaterial
  102253. */
  102254. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102255. }
  102256. }
  102257. declare module BABYLON {
  102258. /**
  102259. * Size options for a post process
  102260. */
  102261. export type PostProcessOptions = {
  102262. width: number;
  102263. height: number;
  102264. };
  102265. /**
  102266. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102267. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102268. */
  102269. export class PostProcess {
  102270. /**
  102271. * Gets or sets the unique id of the post process
  102272. */
  102273. uniqueId: number;
  102274. /** Name of the PostProcess. */
  102275. name: string;
  102276. /**
  102277. * Width of the texture to apply the post process on
  102278. */
  102279. width: number;
  102280. /**
  102281. * Height of the texture to apply the post process on
  102282. */
  102283. height: number;
  102284. /**
  102285. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102286. */
  102287. nodeMaterialSource: Nullable<NodeMaterial>;
  102288. /**
  102289. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102290. * @hidden
  102291. */
  102292. _outputTexture: Nullable<InternalTexture>;
  102293. /**
  102294. * Sampling mode used by the shader
  102295. * See https://doc.babylonjs.com/classes/3.1/texture
  102296. */
  102297. renderTargetSamplingMode: number;
  102298. /**
  102299. * Clear color to use when screen clearing
  102300. */
  102301. clearColor: Color4;
  102302. /**
  102303. * If the buffer needs to be cleared before applying the post process. (default: true)
  102304. * Should be set to false if shader will overwrite all previous pixels.
  102305. */
  102306. autoClear: boolean;
  102307. /**
  102308. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102309. */
  102310. alphaMode: number;
  102311. /**
  102312. * Sets the setAlphaBlendConstants of the babylon engine
  102313. */
  102314. alphaConstants: Color4;
  102315. /**
  102316. * Animations to be used for the post processing
  102317. */
  102318. animations: Animation[];
  102319. /**
  102320. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102321. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102322. */
  102323. enablePixelPerfectMode: boolean;
  102324. /**
  102325. * Force the postprocess to be applied without taking in account viewport
  102326. */
  102327. forceFullscreenViewport: boolean;
  102328. /**
  102329. * List of inspectable custom properties (used by the Inspector)
  102330. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102331. */
  102332. inspectableCustomProperties: IInspectable[];
  102333. /**
  102334. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102335. *
  102336. * | Value | Type | Description |
  102337. * | ----- | ----------------------------------- | ----------- |
  102338. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102339. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102340. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102341. *
  102342. */
  102343. scaleMode: number;
  102344. /**
  102345. * Force textures to be a power of two (default: false)
  102346. */
  102347. alwaysForcePOT: boolean;
  102348. private _samples;
  102349. /**
  102350. * Number of sample textures (default: 1)
  102351. */
  102352. get samples(): number;
  102353. set samples(n: number);
  102354. /**
  102355. * Modify the scale of the post process to be the same as the viewport (default: false)
  102356. */
  102357. adaptScaleToCurrentViewport: boolean;
  102358. private _camera;
  102359. protected _scene: Scene;
  102360. private _engine;
  102361. private _options;
  102362. private _reusable;
  102363. private _textureType;
  102364. private _textureFormat;
  102365. /**
  102366. * Smart array of input and output textures for the post process.
  102367. * @hidden
  102368. */
  102369. _textures: SmartArray<InternalTexture>;
  102370. /**
  102371. * The index in _textures that corresponds to the output texture.
  102372. * @hidden
  102373. */
  102374. _currentRenderTextureInd: number;
  102375. private _effect;
  102376. private _samplers;
  102377. private _fragmentUrl;
  102378. private _vertexUrl;
  102379. private _parameters;
  102380. private _scaleRatio;
  102381. protected _indexParameters: any;
  102382. private _shareOutputWithPostProcess;
  102383. private _texelSize;
  102384. private _forcedOutputTexture;
  102385. /**
  102386. * Returns the fragment url or shader name used in the post process.
  102387. * @returns the fragment url or name in the shader store.
  102388. */
  102389. getEffectName(): string;
  102390. /**
  102391. * An event triggered when the postprocess is activated.
  102392. */
  102393. onActivateObservable: Observable<Camera>;
  102394. private _onActivateObserver;
  102395. /**
  102396. * A function that is added to the onActivateObservable
  102397. */
  102398. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102399. /**
  102400. * An event triggered when the postprocess changes its size.
  102401. */
  102402. onSizeChangedObservable: Observable<PostProcess>;
  102403. private _onSizeChangedObserver;
  102404. /**
  102405. * A function that is added to the onSizeChangedObservable
  102406. */
  102407. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102408. /**
  102409. * An event triggered when the postprocess applies its effect.
  102410. */
  102411. onApplyObservable: Observable<Effect>;
  102412. private _onApplyObserver;
  102413. /**
  102414. * A function that is added to the onApplyObservable
  102415. */
  102416. set onApply(callback: (effect: Effect) => void);
  102417. /**
  102418. * An event triggered before rendering the postprocess
  102419. */
  102420. onBeforeRenderObservable: Observable<Effect>;
  102421. private _onBeforeRenderObserver;
  102422. /**
  102423. * A function that is added to the onBeforeRenderObservable
  102424. */
  102425. set onBeforeRender(callback: (effect: Effect) => void);
  102426. /**
  102427. * An event triggered after rendering the postprocess
  102428. */
  102429. onAfterRenderObservable: Observable<Effect>;
  102430. private _onAfterRenderObserver;
  102431. /**
  102432. * A function that is added to the onAfterRenderObservable
  102433. */
  102434. set onAfterRender(callback: (efect: Effect) => void);
  102435. /**
  102436. * 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
  102437. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102438. */
  102439. get inputTexture(): InternalTexture;
  102440. set inputTexture(value: InternalTexture);
  102441. /**
  102442. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102443. * the only way to unset it is to use this function to restore its internal state
  102444. */
  102445. restoreDefaultInputTexture(): void;
  102446. /**
  102447. * Gets the camera which post process is applied to.
  102448. * @returns The camera the post process is applied to.
  102449. */
  102450. getCamera(): Camera;
  102451. /**
  102452. * Gets the texel size of the postprocess.
  102453. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102454. */
  102455. get texelSize(): Vector2;
  102456. /**
  102457. * Creates a new instance PostProcess
  102458. * @param name The name of the PostProcess.
  102459. * @param fragmentUrl The url of the fragment shader to be used.
  102460. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102461. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102462. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102463. * @param camera The camera to apply the render pass to.
  102464. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102465. * @param engine The engine which the post process will be applied. (default: current engine)
  102466. * @param reusable If the post process can be reused on the same frame. (default: false)
  102467. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102468. * @param textureType Type of textures used when performing the post process. (default: 0)
  102469. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102470. * @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
  102471. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102472. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102473. */
  102474. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  102475. /**
  102476. * Gets a string identifying the name of the class
  102477. * @returns "PostProcess" string
  102478. */
  102479. getClassName(): string;
  102480. /**
  102481. * Gets the engine which this post process belongs to.
  102482. * @returns The engine the post process was enabled with.
  102483. */
  102484. getEngine(): Engine;
  102485. /**
  102486. * The effect that is created when initializing the post process.
  102487. * @returns The created effect corresponding the the postprocess.
  102488. */
  102489. getEffect(): Effect;
  102490. /**
  102491. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102492. * @param postProcess The post process to share the output with.
  102493. * @returns This post process.
  102494. */
  102495. shareOutputWith(postProcess: PostProcess): PostProcess;
  102496. /**
  102497. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102498. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102499. */
  102500. useOwnOutput(): void;
  102501. /**
  102502. * Updates the effect with the current post process compile time values and recompiles the shader.
  102503. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102504. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102505. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102506. * @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
  102507. * @param onCompiled Called when the shader has been compiled.
  102508. * @param onError Called if there is an error when compiling a shader.
  102509. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102510. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102511. */
  102512. 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;
  102513. /**
  102514. * The post process is reusable if it can be used multiple times within one frame.
  102515. * @returns If the post process is reusable
  102516. */
  102517. isReusable(): boolean;
  102518. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102519. markTextureDirty(): void;
  102520. /**
  102521. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102522. * 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.
  102523. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102524. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102525. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102526. * @returns The target texture that was bound to be written to.
  102527. */
  102528. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102529. /**
  102530. * If the post process is supported.
  102531. */
  102532. get isSupported(): boolean;
  102533. /**
  102534. * The aspect ratio of the output texture.
  102535. */
  102536. get aspectRatio(): number;
  102537. /**
  102538. * Get a value indicating if the post-process is ready to be used
  102539. * @returns true if the post-process is ready (shader is compiled)
  102540. */
  102541. isReady(): boolean;
  102542. /**
  102543. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102544. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102545. */
  102546. apply(): Nullable<Effect>;
  102547. private _disposeTextures;
  102548. /**
  102549. * Disposes the post process.
  102550. * @param camera The camera to dispose the post process on.
  102551. */
  102552. dispose(camera?: Camera): void;
  102553. /**
  102554. * Serializes the particle system to a JSON object
  102555. * @returns the JSON object
  102556. */
  102557. serialize(): any;
  102558. /**
  102559. * Creates a material from parsed material data
  102560. * @param parsedPostProcess defines parsed post process data
  102561. * @param scene defines the hosting scene
  102562. * @param rootUrl defines the root URL to use to load textures
  102563. * @returns a new post process
  102564. */
  102565. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102566. }
  102567. }
  102568. declare module BABYLON {
  102569. /** @hidden */
  102570. export var kernelBlurVaryingDeclaration: {
  102571. name: string;
  102572. shader: string;
  102573. };
  102574. }
  102575. declare module BABYLON {
  102576. /** @hidden */
  102577. export var kernelBlurFragment: {
  102578. name: string;
  102579. shader: string;
  102580. };
  102581. }
  102582. declare module BABYLON {
  102583. /** @hidden */
  102584. export var kernelBlurFragment2: {
  102585. name: string;
  102586. shader: string;
  102587. };
  102588. }
  102589. declare module BABYLON {
  102590. /** @hidden */
  102591. export var kernelBlurPixelShader: {
  102592. name: string;
  102593. shader: string;
  102594. };
  102595. }
  102596. declare module BABYLON {
  102597. /** @hidden */
  102598. export var kernelBlurVertex: {
  102599. name: string;
  102600. shader: string;
  102601. };
  102602. }
  102603. declare module BABYLON {
  102604. /** @hidden */
  102605. export var kernelBlurVertexShader: {
  102606. name: string;
  102607. shader: string;
  102608. };
  102609. }
  102610. declare module BABYLON {
  102611. /**
  102612. * The Blur Post Process which blurs an image based on a kernel and direction.
  102613. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102614. */
  102615. export class BlurPostProcess extends PostProcess {
  102616. private blockCompilation;
  102617. protected _kernel: number;
  102618. protected _idealKernel: number;
  102619. protected _packedFloat: boolean;
  102620. private _staticDefines;
  102621. /** The direction in which to blur the image. */
  102622. direction: Vector2;
  102623. /**
  102624. * Sets the length in pixels of the blur sample region
  102625. */
  102626. set kernel(v: number);
  102627. /**
  102628. * Gets the length in pixels of the blur sample region
  102629. */
  102630. get kernel(): number;
  102631. /**
  102632. * Sets wether or not the blur needs to unpack/repack floats
  102633. */
  102634. set packedFloat(v: boolean);
  102635. /**
  102636. * Gets wether or not the blur is unpacking/repacking floats
  102637. */
  102638. get packedFloat(): boolean;
  102639. /**
  102640. * Gets a string identifying the name of the class
  102641. * @returns "BlurPostProcess" string
  102642. */
  102643. getClassName(): string;
  102644. /**
  102645. * Creates a new instance BlurPostProcess
  102646. * @param name The name of the effect.
  102647. * @param direction The direction in which to blur the image.
  102648. * @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.
  102649. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102650. * @param camera The camera to apply the render pass to.
  102651. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102652. * @param engine The engine which the post process will be applied. (default: current engine)
  102653. * @param reusable If the post process can be reused on the same frame. (default: false)
  102654. * @param textureType Type of textures used when performing the post process. (default: 0)
  102655. * @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)
  102656. */
  102657. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  102658. /**
  102659. * Updates the effect with the current post process compile time values and recompiles the shader.
  102660. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102661. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102662. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102663. * @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
  102664. * @param onCompiled Called when the shader has been compiled.
  102665. * @param onError Called if there is an error when compiling a shader.
  102666. */
  102667. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102668. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102669. /**
  102670. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102671. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102672. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102673. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102674. * The gaps between physical kernels are compensated for in the weighting of the samples
  102675. * @param idealKernel Ideal blur kernel.
  102676. * @return Nearest best kernel.
  102677. */
  102678. protected _nearestBestKernel(idealKernel: number): number;
  102679. /**
  102680. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102681. * @param x The point on the Gaussian distribution to sample.
  102682. * @return the value of the Gaussian function at x.
  102683. */
  102684. protected _gaussianWeight(x: number): number;
  102685. /**
  102686. * Generates a string that can be used as a floating point number in GLSL.
  102687. * @param x Value to print.
  102688. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102689. * @return GLSL float string.
  102690. */
  102691. protected _glslFloat(x: number, decimalFigures?: number): string;
  102692. /** @hidden */
  102693. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102694. }
  102695. }
  102696. declare module BABYLON {
  102697. /**
  102698. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102699. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102700. * You can then easily use it as a reflectionTexture on a flat surface.
  102701. * In case the surface is not a plane, please consider relying on reflection probes.
  102702. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102703. */
  102704. export class MirrorTexture extends RenderTargetTexture {
  102705. private scene;
  102706. /**
  102707. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102708. * 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.
  102709. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102710. */
  102711. mirrorPlane: Plane;
  102712. /**
  102713. * Define the blur ratio used to blur the reflection if needed.
  102714. */
  102715. set blurRatio(value: number);
  102716. get blurRatio(): number;
  102717. /**
  102718. * Define the adaptive blur kernel used to blur the reflection if needed.
  102719. * This will autocompute the closest best match for the `blurKernel`
  102720. */
  102721. set adaptiveBlurKernel(value: number);
  102722. /**
  102723. * Define the blur kernel used to blur the reflection if needed.
  102724. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102725. */
  102726. set blurKernel(value: number);
  102727. /**
  102728. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102729. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102730. */
  102731. set blurKernelX(value: number);
  102732. get blurKernelX(): number;
  102733. /**
  102734. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102735. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102736. */
  102737. set blurKernelY(value: number);
  102738. get blurKernelY(): number;
  102739. private _autoComputeBlurKernel;
  102740. protected _onRatioRescale(): void;
  102741. private _updateGammaSpace;
  102742. private _imageProcessingConfigChangeObserver;
  102743. private _transformMatrix;
  102744. private _mirrorMatrix;
  102745. private _savedViewMatrix;
  102746. private _blurX;
  102747. private _blurY;
  102748. private _adaptiveBlurKernel;
  102749. private _blurKernelX;
  102750. private _blurKernelY;
  102751. private _blurRatio;
  102752. /**
  102753. * Instantiates a Mirror Texture.
  102754. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102755. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102756. * You can then easily use it as a reflectionTexture on a flat surface.
  102757. * In case the surface is not a plane, please consider relying on reflection probes.
  102758. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102759. * @param name
  102760. * @param size
  102761. * @param scene
  102762. * @param generateMipMaps
  102763. * @param type
  102764. * @param samplingMode
  102765. * @param generateDepthBuffer
  102766. */
  102767. constructor(name: string, size: number | {
  102768. width: number;
  102769. height: number;
  102770. } | {
  102771. ratio: number;
  102772. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102773. private _preparePostProcesses;
  102774. /**
  102775. * Clone the mirror texture.
  102776. * @returns the cloned texture
  102777. */
  102778. clone(): MirrorTexture;
  102779. /**
  102780. * Serialize the texture to a JSON representation you could use in Parse later on
  102781. * @returns the serialized JSON representation
  102782. */
  102783. serialize(): any;
  102784. /**
  102785. * Dispose the texture and release its associated resources.
  102786. */
  102787. dispose(): void;
  102788. }
  102789. }
  102790. declare module BABYLON {
  102791. /**
  102792. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102793. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102794. */
  102795. export class Texture extends BaseTexture {
  102796. /**
  102797. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102798. */
  102799. static SerializeBuffers: boolean;
  102800. /** @hidden */
  102801. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102802. /** @hidden */
  102803. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102804. /** @hidden */
  102805. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102806. /** nearest is mag = nearest and min = nearest and mip = linear */
  102807. static readonly NEAREST_SAMPLINGMODE: number;
  102808. /** nearest is mag = nearest and min = nearest and mip = linear */
  102809. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102810. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102811. static readonly BILINEAR_SAMPLINGMODE: number;
  102812. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102813. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102814. /** Trilinear is mag = linear and min = linear and mip = linear */
  102815. static readonly TRILINEAR_SAMPLINGMODE: number;
  102816. /** Trilinear is mag = linear and min = linear and mip = linear */
  102817. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102818. /** mag = nearest and min = nearest and mip = nearest */
  102819. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102820. /** mag = nearest and min = linear and mip = nearest */
  102821. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102822. /** mag = nearest and min = linear and mip = linear */
  102823. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102824. /** mag = nearest and min = linear and mip = none */
  102825. static readonly NEAREST_LINEAR: number;
  102826. /** mag = nearest and min = nearest and mip = none */
  102827. static readonly NEAREST_NEAREST: number;
  102828. /** mag = linear and min = nearest and mip = nearest */
  102829. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102830. /** mag = linear and min = nearest and mip = linear */
  102831. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102832. /** mag = linear and min = linear and mip = none */
  102833. static readonly LINEAR_LINEAR: number;
  102834. /** mag = linear and min = nearest and mip = none */
  102835. static readonly LINEAR_NEAREST: number;
  102836. /** Explicit coordinates mode */
  102837. static readonly EXPLICIT_MODE: number;
  102838. /** Spherical coordinates mode */
  102839. static readonly SPHERICAL_MODE: number;
  102840. /** Planar coordinates mode */
  102841. static readonly PLANAR_MODE: number;
  102842. /** Cubic coordinates mode */
  102843. static readonly CUBIC_MODE: number;
  102844. /** Projection coordinates mode */
  102845. static readonly PROJECTION_MODE: number;
  102846. /** Inverse Cubic coordinates mode */
  102847. static readonly SKYBOX_MODE: number;
  102848. /** Inverse Cubic coordinates mode */
  102849. static readonly INVCUBIC_MODE: number;
  102850. /** Equirectangular coordinates mode */
  102851. static readonly EQUIRECTANGULAR_MODE: number;
  102852. /** Equirectangular Fixed coordinates mode */
  102853. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102854. /** Equirectangular Fixed Mirrored coordinates mode */
  102855. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102856. /** Texture is not repeating outside of 0..1 UVs */
  102857. static readonly CLAMP_ADDRESSMODE: number;
  102858. /** Texture is repeating outside of 0..1 UVs */
  102859. static readonly WRAP_ADDRESSMODE: number;
  102860. /** Texture is repeating and mirrored */
  102861. static readonly MIRROR_ADDRESSMODE: number;
  102862. /**
  102863. * 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
  102864. */
  102865. static UseSerializedUrlIfAny: boolean;
  102866. /**
  102867. * Define the url of the texture.
  102868. */
  102869. url: Nullable<string>;
  102870. /**
  102871. * Define an offset on the texture to offset the u coordinates of the UVs
  102872. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102873. */
  102874. uOffset: number;
  102875. /**
  102876. * Define an offset on the texture to offset the v coordinates of the UVs
  102877. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102878. */
  102879. vOffset: number;
  102880. /**
  102881. * Define an offset on the texture to scale the u coordinates of the UVs
  102882. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102883. */
  102884. uScale: number;
  102885. /**
  102886. * Define an offset on the texture to scale the v coordinates of the UVs
  102887. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102888. */
  102889. vScale: number;
  102890. /**
  102891. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102892. * @see https://doc.babylonjs.com/how_to/more_materials
  102893. */
  102894. uAng: number;
  102895. /**
  102896. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102897. * @see https://doc.babylonjs.com/how_to/more_materials
  102898. */
  102899. vAng: number;
  102900. /**
  102901. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102902. * @see https://doc.babylonjs.com/how_to/more_materials
  102903. */
  102904. wAng: number;
  102905. /**
  102906. * Defines the center of rotation (U)
  102907. */
  102908. uRotationCenter: number;
  102909. /**
  102910. * Defines the center of rotation (V)
  102911. */
  102912. vRotationCenter: number;
  102913. /**
  102914. * Defines the center of rotation (W)
  102915. */
  102916. wRotationCenter: number;
  102917. /**
  102918. * Are mip maps generated for this texture or not.
  102919. */
  102920. get noMipmap(): boolean;
  102921. /**
  102922. * List of inspectable custom properties (used by the Inspector)
  102923. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102924. */
  102925. inspectableCustomProperties: Nullable<IInspectable[]>;
  102926. private _noMipmap;
  102927. /** @hidden */
  102928. _invertY: boolean;
  102929. private _rowGenerationMatrix;
  102930. private _cachedTextureMatrix;
  102931. private _projectionModeMatrix;
  102932. private _t0;
  102933. private _t1;
  102934. private _t2;
  102935. private _cachedUOffset;
  102936. private _cachedVOffset;
  102937. private _cachedUScale;
  102938. private _cachedVScale;
  102939. private _cachedUAng;
  102940. private _cachedVAng;
  102941. private _cachedWAng;
  102942. private _cachedProjectionMatrixId;
  102943. private _cachedCoordinatesMode;
  102944. /** @hidden */
  102945. protected _initialSamplingMode: number;
  102946. /** @hidden */
  102947. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102948. private _deleteBuffer;
  102949. protected _format: Nullable<number>;
  102950. private _delayedOnLoad;
  102951. private _delayedOnError;
  102952. private _mimeType?;
  102953. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  102954. get mimeType(): string | undefined;
  102955. /**
  102956. * Observable triggered once the texture has been loaded.
  102957. */
  102958. onLoadObservable: Observable<Texture>;
  102959. protected _isBlocking: boolean;
  102960. /**
  102961. * Is the texture preventing material to render while loading.
  102962. * If false, a default texture will be used instead of the loading one during the preparation step.
  102963. */
  102964. set isBlocking(value: boolean);
  102965. get isBlocking(): boolean;
  102966. /**
  102967. * Get the current sampling mode associated with the texture.
  102968. */
  102969. get samplingMode(): number;
  102970. /**
  102971. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102972. */
  102973. get invertY(): boolean;
  102974. /**
  102975. * Instantiates a new texture.
  102976. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102977. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102978. * @param url defines the url of the picture to load as a texture
  102979. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102980. * @param noMipmap defines if the texture will require mip maps or not
  102981. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102982. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102983. * @param onLoad defines a callback triggered when the texture has been loaded
  102984. * @param onError defines a callback triggered when an error occurred during the loading session
  102985. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102986. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102987. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102988. * @param mimeType defines an optional mime type information
  102989. */
  102990. 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);
  102991. /**
  102992. * Update the url (and optional buffer) of this texture if url was null during construction.
  102993. * @param url the url of the texture
  102994. * @param buffer the buffer of the texture (defaults to null)
  102995. * @param onLoad callback called when the texture is loaded (defaults to null)
  102996. */
  102997. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102998. /**
  102999. * Finish the loading sequence of a texture flagged as delayed load.
  103000. * @hidden
  103001. */
  103002. delayLoad(): void;
  103003. private _prepareRowForTextureGeneration;
  103004. /**
  103005. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  103006. * @returns the transform matrix of the texture.
  103007. */
  103008. getTextureMatrix(uBase?: number): Matrix;
  103009. /**
  103010. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  103011. * @returns The reflection texture transform
  103012. */
  103013. getReflectionTextureMatrix(): Matrix;
  103014. /**
  103015. * Clones the texture.
  103016. * @returns the cloned texture
  103017. */
  103018. clone(): Texture;
  103019. /**
  103020. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103021. * @returns The JSON representation of the texture
  103022. */
  103023. serialize(): any;
  103024. /**
  103025. * Get the current class name of the texture useful for serialization or dynamic coding.
  103026. * @returns "Texture"
  103027. */
  103028. getClassName(): string;
  103029. /**
  103030. * Dispose the texture and release its associated resources.
  103031. */
  103032. dispose(): void;
  103033. /**
  103034. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103035. * @param parsedTexture Define the JSON representation of the texture
  103036. * @param scene Define the scene the parsed texture should be instantiated in
  103037. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103038. * @returns The parsed texture if successful
  103039. */
  103040. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103041. /**
  103042. * Creates a texture from its base 64 representation.
  103043. * @param data Define the base64 payload without the data: prefix
  103044. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103045. * @param scene Define the scene the texture should belong to
  103046. * @param noMipmap Forces the texture to not create mip map information if true
  103047. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103048. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103049. * @param onLoad define a callback triggered when the texture has been loaded
  103050. * @param onError define a callback triggered when an error occurred during the loading session
  103051. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103052. * @returns the created texture
  103053. */
  103054. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103055. /**
  103056. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103057. * @param data Define the base64 payload without the data: prefix
  103058. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103059. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103060. * @param scene Define the scene the texture should belong to
  103061. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103062. * @param noMipmap Forces the texture to not create mip map information if true
  103063. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103064. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103065. * @param onLoad define a callback triggered when the texture has been loaded
  103066. * @param onError define a callback triggered when an error occurred during the loading session
  103067. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103068. * @returns the created texture
  103069. */
  103070. 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;
  103071. }
  103072. }
  103073. declare module BABYLON {
  103074. /**
  103075. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103076. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103077. */
  103078. export class PostProcessManager {
  103079. private _scene;
  103080. private _indexBuffer;
  103081. private _vertexBuffers;
  103082. /**
  103083. * Creates a new instance PostProcess
  103084. * @param scene The scene that the post process is associated with.
  103085. */
  103086. constructor(scene: Scene);
  103087. private _prepareBuffers;
  103088. private _buildIndexBuffer;
  103089. /**
  103090. * Rebuilds the vertex buffers of the manager.
  103091. * @hidden
  103092. */
  103093. _rebuild(): void;
  103094. /**
  103095. * Prepares a frame to be run through a post process.
  103096. * @param sourceTexture The input texture to the post procesess. (default: null)
  103097. * @param postProcesses An array of post processes to be run. (default: null)
  103098. * @returns True if the post processes were able to be run.
  103099. * @hidden
  103100. */
  103101. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103102. /**
  103103. * Manually render a set of post processes to a texture.
  103104. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103105. * @param postProcesses An array of post processes to be run.
  103106. * @param targetTexture The target texture to render to.
  103107. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103108. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103109. * @param lodLevel defines which lod of the texture to render to
  103110. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103111. */
  103112. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103113. /**
  103114. * Finalize the result of the output of the postprocesses.
  103115. * @param doNotPresent If true the result will not be displayed to the screen.
  103116. * @param targetTexture The target texture to render to.
  103117. * @param faceIndex The index of the face to bind the target texture to.
  103118. * @param postProcesses The array of post processes to render.
  103119. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103120. * @hidden
  103121. */
  103122. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103123. /**
  103124. * Disposes of the post process manager.
  103125. */
  103126. dispose(): void;
  103127. }
  103128. }
  103129. declare module BABYLON {
  103130. /**
  103131. * This Helps creating a texture that will be created from a camera in your scene.
  103132. * It is basically a dynamic texture that could be used to create special effects for instance.
  103133. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103134. */
  103135. export class RenderTargetTexture extends Texture {
  103136. /**
  103137. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103138. */
  103139. static readonly REFRESHRATE_RENDER_ONCE: number;
  103140. /**
  103141. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103142. */
  103143. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103144. /**
  103145. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103146. * the central point of your effect and can save a lot of performances.
  103147. */
  103148. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103149. /**
  103150. * Use this predicate to dynamically define the list of mesh you want to render.
  103151. * If set, the renderList property will be overwritten.
  103152. */
  103153. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103154. private _renderList;
  103155. /**
  103156. * Use this list to define the list of mesh you want to render.
  103157. */
  103158. get renderList(): Nullable<Array<AbstractMesh>>;
  103159. set renderList(value: Nullable<Array<AbstractMesh>>);
  103160. /**
  103161. * Use this function to overload the renderList array at rendering time.
  103162. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103163. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103164. * the cube (if the RTT is a cube, else layerOrFace=0).
  103165. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103166. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103167. * hold dummy elements!
  103168. */
  103169. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103170. private _hookArray;
  103171. /**
  103172. * Define if particles should be rendered in your texture.
  103173. */
  103174. renderParticles: boolean;
  103175. /**
  103176. * Define if sprites should be rendered in your texture.
  103177. */
  103178. renderSprites: boolean;
  103179. /**
  103180. * Define the camera used to render the texture.
  103181. */
  103182. activeCamera: Nullable<Camera>;
  103183. /**
  103184. * Override the mesh isReady function with your own one.
  103185. */
  103186. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103187. /**
  103188. * Override the render function of the texture with your own one.
  103189. */
  103190. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103191. /**
  103192. * Define if camera post processes should be use while rendering the texture.
  103193. */
  103194. useCameraPostProcesses: boolean;
  103195. /**
  103196. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103197. */
  103198. ignoreCameraViewport: boolean;
  103199. private _postProcessManager;
  103200. private _postProcesses;
  103201. private _resizeObserver;
  103202. /**
  103203. * An event triggered when the texture is unbind.
  103204. */
  103205. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103206. /**
  103207. * An event triggered when the texture is unbind.
  103208. */
  103209. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103210. private _onAfterUnbindObserver;
  103211. /**
  103212. * Set a after unbind callback in the texture.
  103213. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103214. */
  103215. set onAfterUnbind(callback: () => void);
  103216. /**
  103217. * An event triggered before rendering the texture
  103218. */
  103219. onBeforeRenderObservable: Observable<number>;
  103220. private _onBeforeRenderObserver;
  103221. /**
  103222. * Set a before render callback in the texture.
  103223. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103224. */
  103225. set onBeforeRender(callback: (faceIndex: number) => void);
  103226. /**
  103227. * An event triggered after rendering the texture
  103228. */
  103229. onAfterRenderObservable: Observable<number>;
  103230. private _onAfterRenderObserver;
  103231. /**
  103232. * Set a after render callback in the texture.
  103233. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103234. */
  103235. set onAfterRender(callback: (faceIndex: number) => void);
  103236. /**
  103237. * An event triggered after the texture clear
  103238. */
  103239. onClearObservable: Observable<Engine>;
  103240. private _onClearObserver;
  103241. /**
  103242. * Set a clear callback in the texture.
  103243. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103244. */
  103245. set onClear(callback: (Engine: Engine) => void);
  103246. /**
  103247. * An event triggered when the texture is resized.
  103248. */
  103249. onResizeObservable: Observable<RenderTargetTexture>;
  103250. /**
  103251. * Define the clear color of the Render Target if it should be different from the scene.
  103252. */
  103253. clearColor: Color4;
  103254. protected _size: number | {
  103255. width: number;
  103256. height: number;
  103257. layers?: number;
  103258. };
  103259. protected _initialSizeParameter: number | {
  103260. width: number;
  103261. height: number;
  103262. } | {
  103263. ratio: number;
  103264. };
  103265. protected _sizeRatio: Nullable<number>;
  103266. /** @hidden */
  103267. _generateMipMaps: boolean;
  103268. protected _renderingManager: RenderingManager;
  103269. /** @hidden */
  103270. _waitingRenderList?: string[];
  103271. protected _doNotChangeAspectRatio: boolean;
  103272. protected _currentRefreshId: number;
  103273. protected _refreshRate: number;
  103274. protected _textureMatrix: Matrix;
  103275. protected _samples: number;
  103276. protected _renderTargetOptions: RenderTargetCreationOptions;
  103277. /**
  103278. * Gets render target creation options that were used.
  103279. */
  103280. get renderTargetOptions(): RenderTargetCreationOptions;
  103281. protected _onRatioRescale(): void;
  103282. /**
  103283. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103284. * It must define where the camera used to render the texture is set
  103285. */
  103286. boundingBoxPosition: Vector3;
  103287. private _boundingBoxSize;
  103288. /**
  103289. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103290. * When defined, the cubemap will switch to local mode
  103291. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103292. * @example https://www.babylonjs-playground.com/#RNASML
  103293. */
  103294. set boundingBoxSize(value: Vector3);
  103295. get boundingBoxSize(): Vector3;
  103296. /**
  103297. * In case the RTT has been created with a depth texture, get the associated
  103298. * depth texture.
  103299. * Otherwise, return null.
  103300. */
  103301. get depthStencilTexture(): Nullable<InternalTexture>;
  103302. /**
  103303. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103304. * or used a shadow, depth texture...
  103305. * @param name The friendly name of the texture
  103306. * @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)
  103307. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103308. * @param generateMipMaps True if mip maps need to be generated after render.
  103309. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103310. * @param type The type of the buffer in the RTT (int, half float, float...)
  103311. * @param isCube True if a cube texture needs to be created
  103312. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103313. * @param generateDepthBuffer True to generate a depth buffer
  103314. * @param generateStencilBuffer True to generate a stencil buffer
  103315. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103316. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103317. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103318. */
  103319. constructor(name: string, size: number | {
  103320. width: number;
  103321. height: number;
  103322. layers?: number;
  103323. } | {
  103324. ratio: number;
  103325. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103326. /**
  103327. * Creates a depth stencil texture.
  103328. * This is only available in WebGL 2 or with the depth texture extension available.
  103329. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103330. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103331. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103332. */
  103333. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103334. private _processSizeParameter;
  103335. /**
  103336. * Define the number of samples to use in case of MSAA.
  103337. * It defaults to one meaning no MSAA has been enabled.
  103338. */
  103339. get samples(): number;
  103340. set samples(value: number);
  103341. /**
  103342. * Resets the refresh counter of the texture and start bak from scratch.
  103343. * Could be useful to regenerate the texture if it is setup to render only once.
  103344. */
  103345. resetRefreshCounter(): void;
  103346. /**
  103347. * Define the refresh rate of the texture or the rendering frequency.
  103348. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103349. */
  103350. get refreshRate(): number;
  103351. set refreshRate(value: number);
  103352. /**
  103353. * Adds a post process to the render target rendering passes.
  103354. * @param postProcess define the post process to add
  103355. */
  103356. addPostProcess(postProcess: PostProcess): void;
  103357. /**
  103358. * Clear all the post processes attached to the render target
  103359. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103360. */
  103361. clearPostProcesses(dispose?: boolean): void;
  103362. /**
  103363. * Remove one of the post process from the list of attached post processes to the texture
  103364. * @param postProcess define the post process to remove from the list
  103365. */
  103366. removePostProcess(postProcess: PostProcess): void;
  103367. /** @hidden */
  103368. _shouldRender(): boolean;
  103369. /**
  103370. * Gets the actual render size of the texture.
  103371. * @returns the width of the render size
  103372. */
  103373. getRenderSize(): number;
  103374. /**
  103375. * Gets the actual render width of the texture.
  103376. * @returns the width of the render size
  103377. */
  103378. getRenderWidth(): number;
  103379. /**
  103380. * Gets the actual render height of the texture.
  103381. * @returns the height of the render size
  103382. */
  103383. getRenderHeight(): number;
  103384. /**
  103385. * Gets the actual number of layers of the texture.
  103386. * @returns the number of layers
  103387. */
  103388. getRenderLayers(): number;
  103389. /**
  103390. * Get if the texture can be rescaled or not.
  103391. */
  103392. get canRescale(): boolean;
  103393. /**
  103394. * Resize the texture using a ratio.
  103395. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103396. */
  103397. scale(ratio: number): void;
  103398. /**
  103399. * Get the texture reflection matrix used to rotate/transform the reflection.
  103400. * @returns the reflection matrix
  103401. */
  103402. getReflectionTextureMatrix(): Matrix;
  103403. /**
  103404. * Resize the texture to a new desired size.
  103405. * Be carrefull as it will recreate all the data in the new texture.
  103406. * @param size Define the new size. It can be:
  103407. * - a number for squared texture,
  103408. * - an object containing { width: number, height: number }
  103409. * - or an object containing a ratio { ratio: number }
  103410. */
  103411. resize(size: number | {
  103412. width: number;
  103413. height: number;
  103414. } | {
  103415. ratio: number;
  103416. }): void;
  103417. private _defaultRenderListPrepared;
  103418. /**
  103419. * Renders all the objects from the render list into the texture.
  103420. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103421. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103422. */
  103423. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103424. private _bestReflectionRenderTargetDimension;
  103425. private _prepareRenderingManager;
  103426. /**
  103427. * @hidden
  103428. * @param faceIndex face index to bind to if this is a cubetexture
  103429. * @param layer defines the index of the texture to bind in the array
  103430. */
  103431. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103432. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103433. private renderToTarget;
  103434. /**
  103435. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103436. * This allowed control for front to back rendering or reversly depending of the special needs.
  103437. *
  103438. * @param renderingGroupId The rendering group id corresponding to its index
  103439. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103440. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103441. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103442. */
  103443. 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;
  103444. /**
  103445. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103446. *
  103447. * @param renderingGroupId The rendering group id corresponding to its index
  103448. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103449. */
  103450. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103451. /**
  103452. * Clones the texture.
  103453. * @returns the cloned texture
  103454. */
  103455. clone(): RenderTargetTexture;
  103456. /**
  103457. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103458. * @returns The JSON representation of the texture
  103459. */
  103460. serialize(): any;
  103461. /**
  103462. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103463. */
  103464. disposeFramebufferObjects(): void;
  103465. /**
  103466. * Dispose the texture and release its associated resources.
  103467. */
  103468. dispose(): void;
  103469. /** @hidden */
  103470. _rebuild(): void;
  103471. /**
  103472. * Clear the info related to rendering groups preventing retention point in material dispose.
  103473. */
  103474. freeRenderingGroups(): void;
  103475. /**
  103476. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103477. * @returns the view count
  103478. */
  103479. getViewCount(): number;
  103480. }
  103481. }
  103482. declare module BABYLON {
  103483. /**
  103484. * Class used to manipulate GUIDs
  103485. */
  103486. export class GUID {
  103487. /**
  103488. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103489. * Be aware Math.random() could cause collisions, but:
  103490. * "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"
  103491. * @returns a pseudo random id
  103492. */
  103493. static RandomId(): string;
  103494. }
  103495. }
  103496. declare module BABYLON {
  103497. /**
  103498. * Options to be used when creating a shadow depth material
  103499. */
  103500. export interface IIOptionShadowDepthMaterial {
  103501. /** Variables in the vertex shader code that need to have their names remapped.
  103502. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103503. * "var_name" should be either: worldPos or vNormalW
  103504. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103505. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103506. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103507. */
  103508. remappedVariables?: string[];
  103509. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103510. standalone?: boolean;
  103511. }
  103512. /**
  103513. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103514. */
  103515. export class ShadowDepthWrapper {
  103516. private _scene;
  103517. private _options?;
  103518. private _baseMaterial;
  103519. private _onEffectCreatedObserver;
  103520. private _subMeshToEffect;
  103521. private _subMeshToDepthEffect;
  103522. private _meshes;
  103523. /** @hidden */
  103524. _matriceNames: any;
  103525. /** Gets the standalone status of the wrapper */
  103526. get standalone(): boolean;
  103527. /** Gets the base material the wrapper is built upon */
  103528. get baseMaterial(): Material;
  103529. /**
  103530. * Instantiate a new shadow depth wrapper.
  103531. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103532. * generate the shadow depth map. For more information, please refer to the documentation:
  103533. * https://doc.babylonjs.com/babylon101/shadows
  103534. * @param baseMaterial Material to wrap
  103535. * @param scene Define the scene the material belongs to
  103536. * @param options Options used to create the wrapper
  103537. */
  103538. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103539. /**
  103540. * Gets the effect to use to generate the depth map
  103541. * @param subMesh subMesh to get the effect for
  103542. * @param shadowGenerator shadow generator to get the effect for
  103543. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103544. */
  103545. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103546. /**
  103547. * Specifies that the submesh is ready to be used for depth rendering
  103548. * @param subMesh submesh to check
  103549. * @param defines the list of defines to take into account when checking the effect
  103550. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103551. * @param useInstances specifies that instances should be used
  103552. * @returns a boolean indicating that the submesh is ready or not
  103553. */
  103554. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103555. /**
  103556. * Disposes the resources
  103557. */
  103558. dispose(): void;
  103559. private _makeEffect;
  103560. }
  103561. }
  103562. declare module BABYLON {
  103563. interface ThinEngine {
  103564. /**
  103565. * Unbind a list of render target textures from the webGL context
  103566. * This is used only when drawBuffer extension or webGL2 are active
  103567. * @param textures defines the render target textures to unbind
  103568. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103569. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103570. */
  103571. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103572. /**
  103573. * Create a multi render target texture
  103574. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103575. * @param size defines the size of the texture
  103576. * @param options defines the creation options
  103577. * @returns the cube texture as an InternalTexture
  103578. */
  103579. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103580. /**
  103581. * Update the sample count for a given multiple render target texture
  103582. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103583. * @param textures defines the textures to update
  103584. * @param samples defines the sample count to set
  103585. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103586. */
  103587. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103588. /**
  103589. * Select a subsets of attachments to draw to.
  103590. * @param attachments gl attachments
  103591. */
  103592. bindAttachments(attachments: number[]): void;
  103593. }
  103594. }
  103595. declare module BABYLON {
  103596. /**
  103597. * Creation options of the multi render target texture.
  103598. */
  103599. export interface IMultiRenderTargetOptions {
  103600. /**
  103601. * Define if the texture needs to create mip maps after render.
  103602. */
  103603. generateMipMaps?: boolean;
  103604. /**
  103605. * Define the types of all the draw buffers we want to create
  103606. */
  103607. types?: number[];
  103608. /**
  103609. * Define the sampling modes of all the draw buffers we want to create
  103610. */
  103611. samplingModes?: number[];
  103612. /**
  103613. * Define if a depth buffer is required
  103614. */
  103615. generateDepthBuffer?: boolean;
  103616. /**
  103617. * Define if a stencil buffer is required
  103618. */
  103619. generateStencilBuffer?: boolean;
  103620. /**
  103621. * Define if a depth texture is required instead of a depth buffer
  103622. */
  103623. generateDepthTexture?: boolean;
  103624. /**
  103625. * Define the number of desired draw buffers
  103626. */
  103627. textureCount?: number;
  103628. /**
  103629. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103630. */
  103631. doNotChangeAspectRatio?: boolean;
  103632. /**
  103633. * Define the default type of the buffers we are creating
  103634. */
  103635. defaultType?: number;
  103636. }
  103637. /**
  103638. * A multi render target, like a render target provides the ability to render to a texture.
  103639. * Unlike the render target, it can render to several draw buffers in one draw.
  103640. * This is specially interesting in deferred rendering or for any effects requiring more than
  103641. * just one color from a single pass.
  103642. */
  103643. export class MultiRenderTarget extends RenderTargetTexture {
  103644. private _internalTextures;
  103645. private _textures;
  103646. private _multiRenderTargetOptions;
  103647. private _count;
  103648. /**
  103649. * Get if draw buffers are currently supported by the used hardware and browser.
  103650. */
  103651. get isSupported(): boolean;
  103652. /**
  103653. * Get the list of textures generated by the multi render target.
  103654. */
  103655. get textures(): Texture[];
  103656. /**
  103657. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103658. */
  103659. get count(): number;
  103660. /**
  103661. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103662. */
  103663. get depthTexture(): Texture;
  103664. /**
  103665. * Set the wrapping mode on U of all the textures we are rendering to.
  103666. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103667. */
  103668. set wrapU(wrap: number);
  103669. /**
  103670. * Set the wrapping mode on V of all the textures we are rendering to.
  103671. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103672. */
  103673. set wrapV(wrap: number);
  103674. /**
  103675. * Instantiate a new multi render target texture.
  103676. * A multi render target, like a render target provides the ability to render to a texture.
  103677. * Unlike the render target, it can render to several draw buffers in one draw.
  103678. * This is specially interesting in deferred rendering or for any effects requiring more than
  103679. * just one color from a single pass.
  103680. * @param name Define the name of the texture
  103681. * @param size Define the size of the buffers to render to
  103682. * @param count Define the number of target we are rendering into
  103683. * @param scene Define the scene the texture belongs to
  103684. * @param options Define the options used to create the multi render target
  103685. */
  103686. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103687. /** @hidden */
  103688. _rebuild(): void;
  103689. private _createInternalTextures;
  103690. private _createTextures;
  103691. /**
  103692. * Define the number of samples used if MSAA is enabled.
  103693. */
  103694. get samples(): number;
  103695. set samples(value: number);
  103696. /**
  103697. * Resize all the textures in the multi render target.
  103698. * Be carrefull as it will recreate all the data in the new texture.
  103699. * @param size Define the new size
  103700. */
  103701. resize(size: any): void;
  103702. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103703. /**
  103704. * Dispose the render targets and their associated resources
  103705. */
  103706. dispose(): void;
  103707. /**
  103708. * Release all the underlying texture used as draw buffers.
  103709. */
  103710. releaseInternalTextures(): void;
  103711. }
  103712. }
  103713. declare module BABYLON {
  103714. /** @hidden */
  103715. export var imageProcessingPixelShader: {
  103716. name: string;
  103717. shader: string;
  103718. };
  103719. }
  103720. declare module BABYLON {
  103721. /**
  103722. * ImageProcessingPostProcess
  103723. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103724. */
  103725. export class ImageProcessingPostProcess extends PostProcess {
  103726. /**
  103727. * Default configuration related to image processing available in the PBR Material.
  103728. */
  103729. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103730. /**
  103731. * Gets the image processing configuration used either in this material.
  103732. */
  103733. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103734. /**
  103735. * Sets the Default image processing configuration used either in the this material.
  103736. *
  103737. * If sets to null, the scene one is in use.
  103738. */
  103739. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103740. /**
  103741. * Keep track of the image processing observer to allow dispose and replace.
  103742. */
  103743. private _imageProcessingObserver;
  103744. /**
  103745. * Attaches a new image processing configuration to the PBR Material.
  103746. * @param configuration
  103747. */
  103748. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103749. /**
  103750. * If the post process is supported.
  103751. */
  103752. get isSupported(): boolean;
  103753. /**
  103754. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103755. */
  103756. get colorCurves(): Nullable<ColorCurves>;
  103757. /**
  103758. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103759. */
  103760. set colorCurves(value: Nullable<ColorCurves>);
  103761. /**
  103762. * Gets wether the color curves effect is enabled.
  103763. */
  103764. get colorCurvesEnabled(): boolean;
  103765. /**
  103766. * Sets wether the color curves effect is enabled.
  103767. */
  103768. set colorCurvesEnabled(value: boolean);
  103769. /**
  103770. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103771. */
  103772. get colorGradingTexture(): Nullable<BaseTexture>;
  103773. /**
  103774. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103775. */
  103776. set colorGradingTexture(value: Nullable<BaseTexture>);
  103777. /**
  103778. * Gets wether the color grading effect is enabled.
  103779. */
  103780. get colorGradingEnabled(): boolean;
  103781. /**
  103782. * Gets wether the color grading effect is enabled.
  103783. */
  103784. set colorGradingEnabled(value: boolean);
  103785. /**
  103786. * Gets exposure used in the effect.
  103787. */
  103788. get exposure(): number;
  103789. /**
  103790. * Sets exposure used in the effect.
  103791. */
  103792. set exposure(value: number);
  103793. /**
  103794. * Gets wether tonemapping is enabled or not.
  103795. */
  103796. get toneMappingEnabled(): boolean;
  103797. /**
  103798. * Sets wether tonemapping is enabled or not
  103799. */
  103800. set toneMappingEnabled(value: boolean);
  103801. /**
  103802. * Gets the type of tone mapping effect.
  103803. */
  103804. get toneMappingType(): number;
  103805. /**
  103806. * Sets the type of tone mapping effect.
  103807. */
  103808. set toneMappingType(value: number);
  103809. /**
  103810. * Gets contrast used in the effect.
  103811. */
  103812. get contrast(): number;
  103813. /**
  103814. * Sets contrast used in the effect.
  103815. */
  103816. set contrast(value: number);
  103817. /**
  103818. * Gets Vignette stretch size.
  103819. */
  103820. get vignetteStretch(): number;
  103821. /**
  103822. * Sets Vignette stretch size.
  103823. */
  103824. set vignetteStretch(value: number);
  103825. /**
  103826. * Gets Vignette centre X Offset.
  103827. */
  103828. get vignetteCentreX(): number;
  103829. /**
  103830. * Sets Vignette centre X Offset.
  103831. */
  103832. set vignetteCentreX(value: number);
  103833. /**
  103834. * Gets Vignette centre Y Offset.
  103835. */
  103836. get vignetteCentreY(): number;
  103837. /**
  103838. * Sets Vignette centre Y Offset.
  103839. */
  103840. set vignetteCentreY(value: number);
  103841. /**
  103842. * Gets Vignette weight or intensity of the vignette effect.
  103843. */
  103844. get vignetteWeight(): number;
  103845. /**
  103846. * Sets Vignette weight or intensity of the vignette effect.
  103847. */
  103848. set vignetteWeight(value: number);
  103849. /**
  103850. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103851. * if vignetteEnabled is set to true.
  103852. */
  103853. get vignetteColor(): Color4;
  103854. /**
  103855. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103856. * if vignetteEnabled is set to true.
  103857. */
  103858. set vignetteColor(value: Color4);
  103859. /**
  103860. * Gets Camera field of view used by the Vignette effect.
  103861. */
  103862. get vignetteCameraFov(): number;
  103863. /**
  103864. * Sets Camera field of view used by the Vignette effect.
  103865. */
  103866. set vignetteCameraFov(value: number);
  103867. /**
  103868. * Gets the vignette blend mode allowing different kind of effect.
  103869. */
  103870. get vignetteBlendMode(): number;
  103871. /**
  103872. * Sets the vignette blend mode allowing different kind of effect.
  103873. */
  103874. set vignetteBlendMode(value: number);
  103875. /**
  103876. * Gets wether the vignette effect is enabled.
  103877. */
  103878. get vignetteEnabled(): boolean;
  103879. /**
  103880. * Sets wether the vignette effect is enabled.
  103881. */
  103882. set vignetteEnabled(value: boolean);
  103883. private _fromLinearSpace;
  103884. /**
  103885. * Gets wether the input of the processing is in Gamma or Linear Space.
  103886. */
  103887. get fromLinearSpace(): boolean;
  103888. /**
  103889. * Sets wether the input of the processing is in Gamma or Linear Space.
  103890. */
  103891. set fromLinearSpace(value: boolean);
  103892. /**
  103893. * Defines cache preventing GC.
  103894. */
  103895. private _defines;
  103896. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103897. /**
  103898. * "ImageProcessingPostProcess"
  103899. * @returns "ImageProcessingPostProcess"
  103900. */
  103901. getClassName(): string;
  103902. /**
  103903. * @hidden
  103904. */
  103905. _updateParameters(): void;
  103906. dispose(camera?: Camera): void;
  103907. }
  103908. }
  103909. declare module BABYLON {
  103910. /** @hidden */
  103911. export var fibonacci: {
  103912. name: string;
  103913. shader: string;
  103914. };
  103915. }
  103916. declare module BABYLON {
  103917. /** @hidden */
  103918. export var subSurfaceScatteringFunctions: {
  103919. name: string;
  103920. shader: string;
  103921. };
  103922. }
  103923. declare module BABYLON {
  103924. /** @hidden */
  103925. export var diffusionProfile: {
  103926. name: string;
  103927. shader: string;
  103928. };
  103929. }
  103930. declare module BABYLON {
  103931. /** @hidden */
  103932. export var subSurfaceScatteringPixelShader: {
  103933. name: string;
  103934. shader: string;
  103935. };
  103936. }
  103937. declare module BABYLON {
  103938. /**
  103939. * Sub surface scattering post process
  103940. */
  103941. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103942. /**
  103943. * Gets a string identifying the name of the class
  103944. * @returns "SubSurfaceScatteringPostProcess" string
  103945. */
  103946. getClassName(): string;
  103947. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103948. }
  103949. }
  103950. declare module BABYLON {
  103951. /**
  103952. * Interface for defining prepass effects in the prepass post-process pipeline
  103953. */
  103954. export interface PrePassEffectConfiguration {
  103955. /**
  103956. * Post process to attach for this effect
  103957. */
  103958. postProcess: PostProcess;
  103959. /**
  103960. * Is the effect enabled
  103961. */
  103962. enabled: boolean;
  103963. /**
  103964. * Disposes the effect configuration
  103965. */
  103966. dispose(): void;
  103967. /**
  103968. * Disposes the effect configuration
  103969. */
  103970. createPostProcess: () => PostProcess;
  103971. }
  103972. }
  103973. declare module BABYLON {
  103974. /**
  103975. * Contains all parameters needed for the prepass to perform
  103976. * screen space subsurface scattering
  103977. */
  103978. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103979. private _ssDiffusionS;
  103980. private _ssFilterRadii;
  103981. private _ssDiffusionD;
  103982. /**
  103983. * Post process to attach for screen space subsurface scattering
  103984. */
  103985. postProcess: SubSurfaceScatteringPostProcess;
  103986. /**
  103987. * Diffusion profile color for subsurface scattering
  103988. */
  103989. get ssDiffusionS(): number[];
  103990. /**
  103991. * Diffusion profile max color channel value for subsurface scattering
  103992. */
  103993. get ssDiffusionD(): number[];
  103994. /**
  103995. * Diffusion profile filter radius for subsurface scattering
  103996. */
  103997. get ssFilterRadii(): number[];
  103998. /**
  103999. * Is subsurface enabled
  104000. */
  104001. enabled: boolean;
  104002. /**
  104003. * Diffusion profile colors for subsurface scattering
  104004. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  104005. * See ...
  104006. * Note that you can only store up to 5 of them
  104007. */
  104008. ssDiffusionProfileColors: Color3[];
  104009. /**
  104010. * Defines the ratio real world => scene units.
  104011. * Used for subsurface scattering
  104012. */
  104013. metersPerUnit: number;
  104014. private _scene;
  104015. /**
  104016. * Builds a subsurface configuration object
  104017. * @param scene The scene
  104018. */
  104019. constructor(scene: Scene);
  104020. /**
  104021. * Adds a new diffusion profile.
  104022. * Useful for more realistic subsurface scattering on diverse materials.
  104023. * @param color The color of the diffusion profile. Should be the average color of the material.
  104024. * @return The index of the diffusion profile for the material subsurface configuration
  104025. */
  104026. addDiffusionProfile(color: Color3): number;
  104027. /**
  104028. * Creates the sss post process
  104029. * @return The created post process
  104030. */
  104031. createPostProcess(): SubSurfaceScatteringPostProcess;
  104032. /**
  104033. * Deletes all diffusion profiles.
  104034. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104035. */
  104036. clearAllDiffusionProfiles(): void;
  104037. /**
  104038. * Disposes this object
  104039. */
  104040. dispose(): void;
  104041. /**
  104042. * @hidden
  104043. * https://zero-radiance.github.io/post/sampling-diffusion/
  104044. *
  104045. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104046. * ------------------------------------------------------------------------------------
  104047. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104048. * PDF[r, phi, s] = r * R[r, phi, s]
  104049. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104050. * ------------------------------------------------------------------------------------
  104051. * We importance sample the color channel with the widest scattering distance.
  104052. */
  104053. getDiffusionProfileParameters(color: Color3): number;
  104054. /**
  104055. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104056. * 'u' is the random number (the value of the CDF): [0, 1).
  104057. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104058. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104059. */
  104060. private _sampleBurleyDiffusionProfile;
  104061. }
  104062. }
  104063. declare module BABYLON {
  104064. /**
  104065. * Renders a pre pass of the scene
  104066. * This means every mesh in the scene will be rendered to a render target texture
  104067. * And then this texture will be composited to the rendering canvas with post processes
  104068. * It is necessary for effects like subsurface scattering or deferred shading
  104069. */
  104070. export class PrePassRenderer {
  104071. /** @hidden */
  104072. static _SceneComponentInitialization: (scene: Scene) => void;
  104073. private _scene;
  104074. private _engine;
  104075. private _isDirty;
  104076. /**
  104077. * Number of textures in the multi render target texture where the scene is directly rendered
  104078. */
  104079. readonly mrtCount: number;
  104080. /**
  104081. * The render target where the scene is directly rendered
  104082. */
  104083. prePassRT: MultiRenderTarget;
  104084. private _mrtTypes;
  104085. private _multiRenderAttachments;
  104086. private _defaultAttachments;
  104087. private _clearAttachments;
  104088. private _postProcesses;
  104089. private readonly _clearColor;
  104090. /**
  104091. * Image processing post process for composition
  104092. */
  104093. imageProcessingPostProcess: ImageProcessingPostProcess;
  104094. /**
  104095. * Configuration for sub surface scattering post process
  104096. */
  104097. subSurfaceConfiguration: SubSurfaceConfiguration;
  104098. /**
  104099. * Should materials render their geometry on the MRT
  104100. */
  104101. materialsShouldRenderGeometry: boolean;
  104102. /**
  104103. * Should materials render the irradiance information on the MRT
  104104. */
  104105. materialsShouldRenderIrradiance: boolean;
  104106. private _enabled;
  104107. /**
  104108. * Indicates if the prepass is enabled
  104109. */
  104110. get enabled(): boolean;
  104111. /**
  104112. * How many samples are used for MSAA of the scene render target
  104113. */
  104114. get samples(): number;
  104115. set samples(n: number);
  104116. /**
  104117. * Instanciates a prepass renderer
  104118. * @param scene The scene
  104119. */
  104120. constructor(scene: Scene);
  104121. private _initializeAttachments;
  104122. private _createCompositionEffect;
  104123. /**
  104124. * Indicates if rendering a prepass is supported
  104125. */
  104126. get isSupported(): boolean;
  104127. /**
  104128. * Sets the proper output textures to draw in the engine.
  104129. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104130. */
  104131. bindAttachmentsForEffect(effect: Effect): void;
  104132. /**
  104133. * @hidden
  104134. */
  104135. _beforeCameraDraw(): void;
  104136. /**
  104137. * @hidden
  104138. */
  104139. _afterCameraDraw(): void;
  104140. private _checkRTSize;
  104141. private _bindFrameBuffer;
  104142. /**
  104143. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104144. */
  104145. clear(): void;
  104146. private _setState;
  104147. private _enable;
  104148. private _disable;
  104149. private _resetPostProcessChain;
  104150. private _bindPostProcessChain;
  104151. /**
  104152. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104153. */
  104154. markAsDirty(): void;
  104155. private _update;
  104156. /**
  104157. * Disposes the prepass renderer.
  104158. */
  104159. dispose(): void;
  104160. }
  104161. }
  104162. declare module BABYLON {
  104163. /**
  104164. * Options for compiling materials.
  104165. */
  104166. export interface IMaterialCompilationOptions {
  104167. /**
  104168. * Defines whether clip planes are enabled.
  104169. */
  104170. clipPlane: boolean;
  104171. /**
  104172. * Defines whether instances are enabled.
  104173. */
  104174. useInstances: boolean;
  104175. }
  104176. /**
  104177. * Options passed when calling customShaderNameResolve
  104178. */
  104179. export interface ICustomShaderNameResolveOptions {
  104180. /**
  104181. * 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
  104182. */
  104183. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104184. }
  104185. /**
  104186. * Base class for the main features of a material in Babylon.js
  104187. */
  104188. export class Material implements IAnimatable {
  104189. /**
  104190. * Returns the triangle fill mode
  104191. */
  104192. static readonly TriangleFillMode: number;
  104193. /**
  104194. * Returns the wireframe mode
  104195. */
  104196. static readonly WireFrameFillMode: number;
  104197. /**
  104198. * Returns the point fill mode
  104199. */
  104200. static readonly PointFillMode: number;
  104201. /**
  104202. * Returns the point list draw mode
  104203. */
  104204. static readonly PointListDrawMode: number;
  104205. /**
  104206. * Returns the line list draw mode
  104207. */
  104208. static readonly LineListDrawMode: number;
  104209. /**
  104210. * Returns the line loop draw mode
  104211. */
  104212. static readonly LineLoopDrawMode: number;
  104213. /**
  104214. * Returns the line strip draw mode
  104215. */
  104216. static readonly LineStripDrawMode: number;
  104217. /**
  104218. * Returns the triangle strip draw mode
  104219. */
  104220. static readonly TriangleStripDrawMode: number;
  104221. /**
  104222. * Returns the triangle fan draw mode
  104223. */
  104224. static readonly TriangleFanDrawMode: number;
  104225. /**
  104226. * Stores the clock-wise side orientation
  104227. */
  104228. static readonly ClockWiseSideOrientation: number;
  104229. /**
  104230. * Stores the counter clock-wise side orientation
  104231. */
  104232. static readonly CounterClockWiseSideOrientation: number;
  104233. /**
  104234. * The dirty texture flag value
  104235. */
  104236. static readonly TextureDirtyFlag: number;
  104237. /**
  104238. * The dirty light flag value
  104239. */
  104240. static readonly LightDirtyFlag: number;
  104241. /**
  104242. * The dirty fresnel flag value
  104243. */
  104244. static readonly FresnelDirtyFlag: number;
  104245. /**
  104246. * The dirty attribute flag value
  104247. */
  104248. static readonly AttributesDirtyFlag: number;
  104249. /**
  104250. * The dirty misc flag value
  104251. */
  104252. static readonly MiscDirtyFlag: number;
  104253. /**
  104254. * The all dirty flag value
  104255. */
  104256. static readonly AllDirtyFlag: number;
  104257. /**
  104258. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104259. */
  104260. static readonly MATERIAL_OPAQUE: number;
  104261. /**
  104262. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104263. */
  104264. static readonly MATERIAL_ALPHATEST: number;
  104265. /**
  104266. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104267. */
  104268. static readonly MATERIAL_ALPHABLEND: number;
  104269. /**
  104270. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104271. * They are also discarded below the alpha cutoff threshold to improve performances.
  104272. */
  104273. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104274. /**
  104275. * The Whiteout method is used to blend normals.
  104276. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104277. */
  104278. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104279. /**
  104280. * The Reoriented Normal Mapping method is used to blend normals.
  104281. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104282. */
  104283. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104284. /**
  104285. * Custom callback helping to override the default shader used in the material.
  104286. */
  104287. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104288. /**
  104289. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104290. */
  104291. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104292. /**
  104293. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104294. * This means that the material can keep using a previous shader while a new one is being compiled.
  104295. * This is mostly used when shader parallel compilation is supported (true by default)
  104296. */
  104297. allowShaderHotSwapping: boolean;
  104298. /**
  104299. * The ID of the material
  104300. */
  104301. id: string;
  104302. /**
  104303. * Gets or sets the unique id of the material
  104304. */
  104305. uniqueId: number;
  104306. /**
  104307. * The name of the material
  104308. */
  104309. name: string;
  104310. /**
  104311. * Gets or sets user defined metadata
  104312. */
  104313. metadata: any;
  104314. /**
  104315. * For internal use only. Please do not use.
  104316. */
  104317. reservedDataStore: any;
  104318. /**
  104319. * Specifies if the ready state should be checked on each call
  104320. */
  104321. checkReadyOnEveryCall: boolean;
  104322. /**
  104323. * Specifies if the ready state should be checked once
  104324. */
  104325. checkReadyOnlyOnce: boolean;
  104326. /**
  104327. * The state of the material
  104328. */
  104329. state: string;
  104330. /**
  104331. * If the material can be rendered to several textures with MRT extension
  104332. */
  104333. get canRenderToMRT(): boolean;
  104334. /**
  104335. * The alpha value of the material
  104336. */
  104337. protected _alpha: number;
  104338. /**
  104339. * List of inspectable custom properties (used by the Inspector)
  104340. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104341. */
  104342. inspectableCustomProperties: IInspectable[];
  104343. /**
  104344. * Sets the alpha value of the material
  104345. */
  104346. set alpha(value: number);
  104347. /**
  104348. * Gets the alpha value of the material
  104349. */
  104350. get alpha(): number;
  104351. /**
  104352. * Specifies if back face culling is enabled
  104353. */
  104354. protected _backFaceCulling: boolean;
  104355. /**
  104356. * Sets the back-face culling state
  104357. */
  104358. set backFaceCulling(value: boolean);
  104359. /**
  104360. * Gets the back-face culling state
  104361. */
  104362. get backFaceCulling(): boolean;
  104363. /**
  104364. * Stores the value for side orientation
  104365. */
  104366. sideOrientation: number;
  104367. /**
  104368. * Callback triggered when the material is compiled
  104369. */
  104370. onCompiled: Nullable<(effect: Effect) => void>;
  104371. /**
  104372. * Callback triggered when an error occurs
  104373. */
  104374. onError: Nullable<(effect: Effect, errors: string) => void>;
  104375. /**
  104376. * Callback triggered to get the render target textures
  104377. */
  104378. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104379. /**
  104380. * Gets a boolean indicating that current material needs to register RTT
  104381. */
  104382. get hasRenderTargetTextures(): boolean;
  104383. /**
  104384. * Specifies if the material should be serialized
  104385. */
  104386. doNotSerialize: boolean;
  104387. /**
  104388. * @hidden
  104389. */
  104390. _storeEffectOnSubMeshes: boolean;
  104391. /**
  104392. * Stores the animations for the material
  104393. */
  104394. animations: Nullable<Array<Animation>>;
  104395. /**
  104396. * An event triggered when the material is disposed
  104397. */
  104398. onDisposeObservable: Observable<Material>;
  104399. /**
  104400. * An observer which watches for dispose events
  104401. */
  104402. private _onDisposeObserver;
  104403. private _onUnBindObservable;
  104404. /**
  104405. * Called during a dispose event
  104406. */
  104407. set onDispose(callback: () => void);
  104408. private _onBindObservable;
  104409. /**
  104410. * An event triggered when the material is bound
  104411. */
  104412. get onBindObservable(): Observable<AbstractMesh>;
  104413. /**
  104414. * An observer which watches for bind events
  104415. */
  104416. private _onBindObserver;
  104417. /**
  104418. * Called during a bind event
  104419. */
  104420. set onBind(callback: (Mesh: AbstractMesh) => void);
  104421. /**
  104422. * An event triggered when the material is unbound
  104423. */
  104424. get onUnBindObservable(): Observable<Material>;
  104425. protected _onEffectCreatedObservable: Nullable<Observable<{
  104426. effect: Effect;
  104427. subMesh: Nullable<SubMesh>;
  104428. }>>;
  104429. /**
  104430. * An event triggered when the effect is (re)created
  104431. */
  104432. get onEffectCreatedObservable(): Observable<{
  104433. effect: Effect;
  104434. subMesh: Nullable<SubMesh>;
  104435. }>;
  104436. /**
  104437. * Stores the value of the alpha mode
  104438. */
  104439. private _alphaMode;
  104440. /**
  104441. * Sets the value of the alpha mode.
  104442. *
  104443. * | Value | Type | Description |
  104444. * | --- | --- | --- |
  104445. * | 0 | ALPHA_DISABLE | |
  104446. * | 1 | ALPHA_ADD | |
  104447. * | 2 | ALPHA_COMBINE | |
  104448. * | 3 | ALPHA_SUBTRACT | |
  104449. * | 4 | ALPHA_MULTIPLY | |
  104450. * | 5 | ALPHA_MAXIMIZED | |
  104451. * | 6 | ALPHA_ONEONE | |
  104452. * | 7 | ALPHA_PREMULTIPLIED | |
  104453. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104454. * | 9 | ALPHA_INTERPOLATE | |
  104455. * | 10 | ALPHA_SCREENMODE | |
  104456. *
  104457. */
  104458. set alphaMode(value: number);
  104459. /**
  104460. * Gets the value of the alpha mode
  104461. */
  104462. get alphaMode(): number;
  104463. /**
  104464. * Stores the state of the need depth pre-pass value
  104465. */
  104466. private _needDepthPrePass;
  104467. /**
  104468. * Sets the need depth pre-pass value
  104469. */
  104470. set needDepthPrePass(value: boolean);
  104471. /**
  104472. * Gets the depth pre-pass value
  104473. */
  104474. get needDepthPrePass(): boolean;
  104475. /**
  104476. * Specifies if depth writing should be disabled
  104477. */
  104478. disableDepthWrite: boolean;
  104479. /**
  104480. * Specifies if color writing should be disabled
  104481. */
  104482. disableColorWrite: boolean;
  104483. /**
  104484. * Specifies if depth writing should be forced
  104485. */
  104486. forceDepthWrite: boolean;
  104487. /**
  104488. * Specifies the depth function that should be used. 0 means the default engine function
  104489. */
  104490. depthFunction: number;
  104491. /**
  104492. * Specifies if there should be a separate pass for culling
  104493. */
  104494. separateCullingPass: boolean;
  104495. /**
  104496. * Stores the state specifing if fog should be enabled
  104497. */
  104498. private _fogEnabled;
  104499. /**
  104500. * Sets the state for enabling fog
  104501. */
  104502. set fogEnabled(value: boolean);
  104503. /**
  104504. * Gets the value of the fog enabled state
  104505. */
  104506. get fogEnabled(): boolean;
  104507. /**
  104508. * Stores the size of points
  104509. */
  104510. pointSize: number;
  104511. /**
  104512. * Stores the z offset value
  104513. */
  104514. zOffset: number;
  104515. get wireframe(): boolean;
  104516. /**
  104517. * Sets the state of wireframe mode
  104518. */
  104519. set wireframe(value: boolean);
  104520. /**
  104521. * Gets the value specifying if point clouds are enabled
  104522. */
  104523. get pointsCloud(): boolean;
  104524. /**
  104525. * Sets the state of point cloud mode
  104526. */
  104527. set pointsCloud(value: boolean);
  104528. /**
  104529. * Gets the material fill mode
  104530. */
  104531. get fillMode(): number;
  104532. /**
  104533. * Sets the material fill mode
  104534. */
  104535. set fillMode(value: number);
  104536. /**
  104537. * @hidden
  104538. * Stores the effects for the material
  104539. */
  104540. _effect: Nullable<Effect>;
  104541. /**
  104542. * Specifies if uniform buffers should be used
  104543. */
  104544. private _useUBO;
  104545. /**
  104546. * Stores a reference to the scene
  104547. */
  104548. private _scene;
  104549. /**
  104550. * Stores the fill mode state
  104551. */
  104552. private _fillMode;
  104553. /**
  104554. * Specifies if the depth write state should be cached
  104555. */
  104556. private _cachedDepthWriteState;
  104557. /**
  104558. * Specifies if the color write state should be cached
  104559. */
  104560. private _cachedColorWriteState;
  104561. /**
  104562. * Specifies if the depth function state should be cached
  104563. */
  104564. private _cachedDepthFunctionState;
  104565. /**
  104566. * Stores the uniform buffer
  104567. */
  104568. protected _uniformBuffer: UniformBuffer;
  104569. /** @hidden */
  104570. _indexInSceneMaterialArray: number;
  104571. /** @hidden */
  104572. meshMap: Nullable<{
  104573. [id: string]: AbstractMesh | undefined;
  104574. }>;
  104575. /**
  104576. * Creates a material instance
  104577. * @param name defines the name of the material
  104578. * @param scene defines the scene to reference
  104579. * @param doNotAdd specifies if the material should be added to the scene
  104580. */
  104581. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104582. /**
  104583. * Returns a string representation of the current material
  104584. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104585. * @returns a string with material information
  104586. */
  104587. toString(fullDetails?: boolean): string;
  104588. /**
  104589. * Gets the class name of the material
  104590. * @returns a string with the class name of the material
  104591. */
  104592. getClassName(): string;
  104593. /**
  104594. * Specifies if updates for the material been locked
  104595. */
  104596. get isFrozen(): boolean;
  104597. /**
  104598. * Locks updates for the material
  104599. */
  104600. freeze(): void;
  104601. /**
  104602. * Unlocks updates for the material
  104603. */
  104604. unfreeze(): void;
  104605. /**
  104606. * Specifies if the material is ready to be used
  104607. * @param mesh defines the mesh to check
  104608. * @param useInstances specifies if instances should be used
  104609. * @returns a boolean indicating if the material is ready to be used
  104610. */
  104611. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104612. /**
  104613. * Specifies that the submesh is ready to be used
  104614. * @param mesh defines the mesh to check
  104615. * @param subMesh defines which submesh to check
  104616. * @param useInstances specifies that instances should be used
  104617. * @returns a boolean indicating that the submesh is ready or not
  104618. */
  104619. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104620. /**
  104621. * Returns the material effect
  104622. * @returns the effect associated with the material
  104623. */
  104624. getEffect(): Nullable<Effect>;
  104625. /**
  104626. * Returns the current scene
  104627. * @returns a Scene
  104628. */
  104629. getScene(): Scene;
  104630. /**
  104631. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104632. */
  104633. protected _forceAlphaTest: boolean;
  104634. /**
  104635. * The transparency mode of the material.
  104636. */
  104637. protected _transparencyMode: Nullable<number>;
  104638. /**
  104639. * Gets the current transparency mode.
  104640. */
  104641. get transparencyMode(): Nullable<number>;
  104642. /**
  104643. * Sets the transparency mode of the material.
  104644. *
  104645. * | Value | Type | Description |
  104646. * | ----- | ----------------------------------- | ----------- |
  104647. * | 0 | OPAQUE | |
  104648. * | 1 | ALPHATEST | |
  104649. * | 2 | ALPHABLEND | |
  104650. * | 3 | ALPHATESTANDBLEND | |
  104651. *
  104652. */
  104653. set transparencyMode(value: Nullable<number>);
  104654. /**
  104655. * Returns true if alpha blending should be disabled.
  104656. */
  104657. protected get _disableAlphaBlending(): boolean;
  104658. /**
  104659. * Specifies whether or not this material should be rendered in alpha blend mode.
  104660. * @returns a boolean specifying if alpha blending is needed
  104661. */
  104662. needAlphaBlending(): boolean;
  104663. /**
  104664. * Specifies if the mesh will require alpha blending
  104665. * @param mesh defines the mesh to check
  104666. * @returns a boolean specifying if alpha blending is needed for the mesh
  104667. */
  104668. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104669. /**
  104670. * Specifies whether or not this material should be rendered in alpha test mode.
  104671. * @returns a boolean specifying if an alpha test is needed.
  104672. */
  104673. needAlphaTesting(): boolean;
  104674. /**
  104675. * Specifies if material alpha testing should be turned on for the mesh
  104676. * @param mesh defines the mesh to check
  104677. */
  104678. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104679. /**
  104680. * Gets the texture used for the alpha test
  104681. * @returns the texture to use for alpha testing
  104682. */
  104683. getAlphaTestTexture(): Nullable<BaseTexture>;
  104684. /**
  104685. * Marks the material to indicate that it needs to be re-calculated
  104686. */
  104687. markDirty(): void;
  104688. /** @hidden */
  104689. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104690. /**
  104691. * Binds the material to the mesh
  104692. * @param world defines the world transformation matrix
  104693. * @param mesh defines the mesh to bind the material to
  104694. */
  104695. bind(world: Matrix, mesh?: Mesh): void;
  104696. /**
  104697. * Binds the submesh to the material
  104698. * @param world defines the world transformation matrix
  104699. * @param mesh defines the mesh containing the submesh
  104700. * @param subMesh defines the submesh to bind the material to
  104701. */
  104702. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104703. /**
  104704. * Binds the world matrix to the material
  104705. * @param world defines the world transformation matrix
  104706. */
  104707. bindOnlyWorldMatrix(world: Matrix): void;
  104708. /**
  104709. * Binds the scene's uniform buffer to the effect.
  104710. * @param effect defines the effect to bind to the scene uniform buffer
  104711. * @param sceneUbo defines the uniform buffer storing scene data
  104712. */
  104713. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104714. /**
  104715. * Binds the view matrix to the effect
  104716. * @param effect defines the effect to bind the view matrix to
  104717. */
  104718. bindView(effect: Effect): void;
  104719. /**
  104720. * Binds the view projection matrix to the effect
  104721. * @param effect defines the effect to bind the view projection matrix to
  104722. */
  104723. bindViewProjection(effect: Effect): void;
  104724. /**
  104725. * Processes to execute after binding the material to a mesh
  104726. * @param mesh defines the rendered mesh
  104727. */
  104728. protected _afterBind(mesh?: Mesh): void;
  104729. /**
  104730. * Unbinds the material from the mesh
  104731. */
  104732. unbind(): void;
  104733. /**
  104734. * Gets the active textures from the material
  104735. * @returns an array of textures
  104736. */
  104737. getActiveTextures(): BaseTexture[];
  104738. /**
  104739. * Specifies if the material uses a texture
  104740. * @param texture defines the texture to check against the material
  104741. * @returns a boolean specifying if the material uses the texture
  104742. */
  104743. hasTexture(texture: BaseTexture): boolean;
  104744. /**
  104745. * Makes a duplicate of the material, and gives it a new name
  104746. * @param name defines the new name for the duplicated material
  104747. * @returns the cloned material
  104748. */
  104749. clone(name: string): Nullable<Material>;
  104750. /**
  104751. * Gets the meshes bound to the material
  104752. * @returns an array of meshes bound to the material
  104753. */
  104754. getBindedMeshes(): AbstractMesh[];
  104755. /**
  104756. * Force shader compilation
  104757. * @param mesh defines the mesh associated with this material
  104758. * @param onCompiled defines a function to execute once the material is compiled
  104759. * @param options defines the options to configure the compilation
  104760. * @param onError defines a function to execute if the material fails compiling
  104761. */
  104762. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104763. /**
  104764. * Force shader compilation
  104765. * @param mesh defines the mesh that will use this material
  104766. * @param options defines additional options for compiling the shaders
  104767. * @returns a promise that resolves when the compilation completes
  104768. */
  104769. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104770. private static readonly _AllDirtyCallBack;
  104771. private static readonly _ImageProcessingDirtyCallBack;
  104772. private static readonly _TextureDirtyCallBack;
  104773. private static readonly _FresnelDirtyCallBack;
  104774. private static readonly _MiscDirtyCallBack;
  104775. private static readonly _LightsDirtyCallBack;
  104776. private static readonly _AttributeDirtyCallBack;
  104777. private static _FresnelAndMiscDirtyCallBack;
  104778. private static _TextureAndMiscDirtyCallBack;
  104779. private static readonly _DirtyCallbackArray;
  104780. private static readonly _RunDirtyCallBacks;
  104781. /**
  104782. * Marks a define in the material to indicate that it needs to be re-computed
  104783. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104784. */
  104785. markAsDirty(flag: number): void;
  104786. /**
  104787. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104788. * @param func defines a function which checks material defines against the submeshes
  104789. */
  104790. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104791. /**
  104792. * Indicates that the scene should check if the rendering now needs a prepass
  104793. */
  104794. protected _markScenePrePassDirty(): void;
  104795. /**
  104796. * Indicates that we need to re-calculated for all submeshes
  104797. */
  104798. protected _markAllSubMeshesAsAllDirty(): void;
  104799. /**
  104800. * Indicates that image processing needs to be re-calculated for all submeshes
  104801. */
  104802. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104803. /**
  104804. * Indicates that textures need to be re-calculated for all submeshes
  104805. */
  104806. protected _markAllSubMeshesAsTexturesDirty(): void;
  104807. /**
  104808. * Indicates that fresnel needs to be re-calculated for all submeshes
  104809. */
  104810. protected _markAllSubMeshesAsFresnelDirty(): void;
  104811. /**
  104812. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104813. */
  104814. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104815. /**
  104816. * Indicates that lights need to be re-calculated for all submeshes
  104817. */
  104818. protected _markAllSubMeshesAsLightsDirty(): void;
  104819. /**
  104820. * Indicates that attributes need to be re-calculated for all submeshes
  104821. */
  104822. protected _markAllSubMeshesAsAttributesDirty(): void;
  104823. /**
  104824. * Indicates that misc needs to be re-calculated for all submeshes
  104825. */
  104826. protected _markAllSubMeshesAsMiscDirty(): void;
  104827. /**
  104828. * Indicates that textures and misc need to be re-calculated for all submeshes
  104829. */
  104830. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104831. /**
  104832. * Sets the required values to the prepass renderer.
  104833. * @param prePassRenderer defines the prepass renderer to setup.
  104834. * @returns true if the pre pass is needed.
  104835. */
  104836. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104837. /**
  104838. * Disposes the material
  104839. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104840. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104841. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104842. */
  104843. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104844. /** @hidden */
  104845. private releaseVertexArrayObject;
  104846. /**
  104847. * Serializes this material
  104848. * @returns the serialized material object
  104849. */
  104850. serialize(): any;
  104851. /**
  104852. * Creates a material from parsed material data
  104853. * @param parsedMaterial defines parsed material data
  104854. * @param scene defines the hosting scene
  104855. * @param rootUrl defines the root URL to use to load textures
  104856. * @returns a new material
  104857. */
  104858. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104859. }
  104860. }
  104861. declare module BABYLON {
  104862. /**
  104863. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104864. * separate meshes. This can be use to improve performances.
  104865. * @see https://doc.babylonjs.com/how_to/multi_materials
  104866. */
  104867. export class MultiMaterial extends Material {
  104868. private _subMaterials;
  104869. /**
  104870. * Gets or Sets the list of Materials used within the multi material.
  104871. * They need to be ordered according to the submeshes order in the associated mesh
  104872. */
  104873. get subMaterials(): Nullable<Material>[];
  104874. set subMaterials(value: Nullable<Material>[]);
  104875. /**
  104876. * Function used to align with Node.getChildren()
  104877. * @returns the list of Materials used within the multi material
  104878. */
  104879. getChildren(): Nullable<Material>[];
  104880. /**
  104881. * Instantiates a new Multi Material
  104882. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104883. * separate meshes. This can be use to improve performances.
  104884. * @see https://doc.babylonjs.com/how_to/multi_materials
  104885. * @param name Define the name in the scene
  104886. * @param scene Define the scene the material belongs to
  104887. */
  104888. constructor(name: string, scene: Scene);
  104889. private _hookArray;
  104890. /**
  104891. * Get one of the submaterial by its index in the submaterials array
  104892. * @param index The index to look the sub material at
  104893. * @returns The Material if the index has been defined
  104894. */
  104895. getSubMaterial(index: number): Nullable<Material>;
  104896. /**
  104897. * Get the list of active textures for the whole sub materials list.
  104898. * @returns All the textures that will be used during the rendering
  104899. */
  104900. getActiveTextures(): BaseTexture[];
  104901. /**
  104902. * Gets the current class name of the material e.g. "MultiMaterial"
  104903. * Mainly use in serialization.
  104904. * @returns the class name
  104905. */
  104906. getClassName(): string;
  104907. /**
  104908. * Checks if the material is ready to render the requested sub mesh
  104909. * @param mesh Define the mesh the submesh belongs to
  104910. * @param subMesh Define the sub mesh to look readyness for
  104911. * @param useInstances Define whether or not the material is used with instances
  104912. * @returns true if ready, otherwise false
  104913. */
  104914. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104915. /**
  104916. * Clones the current material and its related sub materials
  104917. * @param name Define the name of the newly cloned material
  104918. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104919. * @returns the cloned material
  104920. */
  104921. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104922. /**
  104923. * Serializes the materials into a JSON representation.
  104924. * @returns the JSON representation
  104925. */
  104926. serialize(): any;
  104927. /**
  104928. * Dispose the material and release its associated resources
  104929. * @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)
  104930. * @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)
  104931. * @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)
  104932. */
  104933. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104934. /**
  104935. * Creates a MultiMaterial from parsed MultiMaterial data.
  104936. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104937. * @param scene defines the hosting scene
  104938. * @returns a new MultiMaterial
  104939. */
  104940. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104941. }
  104942. }
  104943. declare module BABYLON {
  104944. /**
  104945. * Defines a subdivision inside a mesh
  104946. */
  104947. export class SubMesh implements ICullable {
  104948. /** the material index to use */
  104949. materialIndex: number;
  104950. /** vertex index start */
  104951. verticesStart: number;
  104952. /** vertices count */
  104953. verticesCount: number;
  104954. /** index start */
  104955. indexStart: number;
  104956. /** indices count */
  104957. indexCount: number;
  104958. /** @hidden */
  104959. _materialDefines: Nullable<MaterialDefines>;
  104960. /** @hidden */
  104961. _materialEffect: Nullable<Effect>;
  104962. /** @hidden */
  104963. _effectOverride: Nullable<Effect>;
  104964. /**
  104965. * Gets material defines used by the effect associated to the sub mesh
  104966. */
  104967. get materialDefines(): Nullable<MaterialDefines>;
  104968. /**
  104969. * Sets material defines used by the effect associated to the sub mesh
  104970. */
  104971. set materialDefines(defines: Nullable<MaterialDefines>);
  104972. /**
  104973. * Gets associated effect
  104974. */
  104975. get effect(): Nullable<Effect>;
  104976. /**
  104977. * Sets associated effect (effect used to render this submesh)
  104978. * @param effect defines the effect to associate with
  104979. * @param defines defines the set of defines used to compile this effect
  104980. */
  104981. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104982. /** @hidden */
  104983. _linesIndexCount: number;
  104984. private _mesh;
  104985. private _renderingMesh;
  104986. private _boundingInfo;
  104987. private _linesIndexBuffer;
  104988. /** @hidden */
  104989. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104990. /** @hidden */
  104991. _trianglePlanes: Plane[];
  104992. /** @hidden */
  104993. _lastColliderTransformMatrix: Nullable<Matrix>;
  104994. /** @hidden */
  104995. _renderId: number;
  104996. /** @hidden */
  104997. _alphaIndex: number;
  104998. /** @hidden */
  104999. _distanceToCamera: number;
  105000. /** @hidden */
  105001. _id: number;
  105002. private _currentMaterial;
  105003. /**
  105004. * Add a new submesh to a mesh
  105005. * @param materialIndex defines the material index to use
  105006. * @param verticesStart defines vertex index start
  105007. * @param verticesCount defines vertices count
  105008. * @param indexStart defines index start
  105009. * @param indexCount defines indices count
  105010. * @param mesh defines the parent mesh
  105011. * @param renderingMesh defines an optional rendering mesh
  105012. * @param createBoundingBox defines if bounding box should be created for this submesh
  105013. * @returns the new submesh
  105014. */
  105015. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105016. /**
  105017. * Creates a new submesh
  105018. * @param materialIndex defines the material index to use
  105019. * @param verticesStart defines vertex index start
  105020. * @param verticesCount defines vertices count
  105021. * @param indexStart defines index start
  105022. * @param indexCount defines indices count
  105023. * @param mesh defines the parent mesh
  105024. * @param renderingMesh defines an optional rendering mesh
  105025. * @param createBoundingBox defines if bounding box should be created for this submesh
  105026. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105027. */
  105028. constructor(
  105029. /** the material index to use */
  105030. materialIndex: number,
  105031. /** vertex index start */
  105032. verticesStart: number,
  105033. /** vertices count */
  105034. verticesCount: number,
  105035. /** index start */
  105036. indexStart: number,
  105037. /** indices count */
  105038. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105039. /**
  105040. * Returns true if this submesh covers the entire parent mesh
  105041. * @ignorenaming
  105042. */
  105043. get IsGlobal(): boolean;
  105044. /**
  105045. * Returns the submesh BoudingInfo object
  105046. * @returns current bounding info (or mesh's one if the submesh is global)
  105047. */
  105048. getBoundingInfo(): BoundingInfo;
  105049. /**
  105050. * Sets the submesh BoundingInfo
  105051. * @param boundingInfo defines the new bounding info to use
  105052. * @returns the SubMesh
  105053. */
  105054. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105055. /**
  105056. * Returns the mesh of the current submesh
  105057. * @return the parent mesh
  105058. */
  105059. getMesh(): AbstractMesh;
  105060. /**
  105061. * Returns the rendering mesh of the submesh
  105062. * @returns the rendering mesh (could be different from parent mesh)
  105063. */
  105064. getRenderingMesh(): Mesh;
  105065. /**
  105066. * Returns the replacement mesh of the submesh
  105067. * @returns the replacement mesh (could be different from parent mesh)
  105068. */
  105069. getReplacementMesh(): Nullable<AbstractMesh>;
  105070. /**
  105071. * Returns the effective mesh of the submesh
  105072. * @returns the effective mesh (could be different from parent mesh)
  105073. */
  105074. getEffectiveMesh(): AbstractMesh;
  105075. /**
  105076. * Returns the submesh material
  105077. * @returns null or the current material
  105078. */
  105079. getMaterial(): Nullable<Material>;
  105080. private _IsMultiMaterial;
  105081. /**
  105082. * Sets a new updated BoundingInfo object to the submesh
  105083. * @param data defines an optional position array to use to determine the bounding info
  105084. * @returns the SubMesh
  105085. */
  105086. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105087. /** @hidden */
  105088. _checkCollision(collider: Collider): boolean;
  105089. /**
  105090. * Updates the submesh BoundingInfo
  105091. * @param world defines the world matrix to use to update the bounding info
  105092. * @returns the submesh
  105093. */
  105094. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105095. /**
  105096. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105097. * @param frustumPlanes defines the frustum planes
  105098. * @returns true if the submesh is intersecting with the frustum
  105099. */
  105100. isInFrustum(frustumPlanes: Plane[]): boolean;
  105101. /**
  105102. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105103. * @param frustumPlanes defines the frustum planes
  105104. * @returns true if the submesh is inside the frustum
  105105. */
  105106. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105107. /**
  105108. * Renders the submesh
  105109. * @param enableAlphaMode defines if alpha needs to be used
  105110. * @returns the submesh
  105111. */
  105112. render(enableAlphaMode: boolean): SubMesh;
  105113. /**
  105114. * @hidden
  105115. */
  105116. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105117. /**
  105118. * Checks if the submesh intersects with a ray
  105119. * @param ray defines the ray to test
  105120. * @returns true is the passed ray intersects the submesh bounding box
  105121. */
  105122. canIntersects(ray: Ray): boolean;
  105123. /**
  105124. * Intersects current submesh with a ray
  105125. * @param ray defines the ray to test
  105126. * @param positions defines mesh's positions array
  105127. * @param indices defines mesh's indices array
  105128. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105129. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105130. * @returns intersection info or null if no intersection
  105131. */
  105132. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105133. /** @hidden */
  105134. private _intersectLines;
  105135. /** @hidden */
  105136. private _intersectUnIndexedLines;
  105137. /** @hidden */
  105138. private _intersectTriangles;
  105139. /** @hidden */
  105140. private _intersectUnIndexedTriangles;
  105141. /** @hidden */
  105142. _rebuild(): void;
  105143. /**
  105144. * Creates a new submesh from the passed mesh
  105145. * @param newMesh defines the new hosting mesh
  105146. * @param newRenderingMesh defines an optional rendering mesh
  105147. * @returns the new submesh
  105148. */
  105149. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105150. /**
  105151. * Release associated resources
  105152. */
  105153. dispose(): void;
  105154. /**
  105155. * Gets the class name
  105156. * @returns the string "SubMesh".
  105157. */
  105158. getClassName(): string;
  105159. /**
  105160. * Creates a new submesh from indices data
  105161. * @param materialIndex the index of the main mesh material
  105162. * @param startIndex the index where to start the copy in the mesh indices array
  105163. * @param indexCount the number of indices to copy then from the startIndex
  105164. * @param mesh the main mesh to create the submesh from
  105165. * @param renderingMesh the optional rendering mesh
  105166. * @returns a new submesh
  105167. */
  105168. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105169. }
  105170. }
  105171. declare module BABYLON {
  105172. /**
  105173. * Class used to represent data loading progression
  105174. */
  105175. export class SceneLoaderFlags {
  105176. private static _ForceFullSceneLoadingForIncremental;
  105177. private static _ShowLoadingScreen;
  105178. private static _CleanBoneMatrixWeights;
  105179. private static _loggingLevel;
  105180. /**
  105181. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105182. */
  105183. static get ForceFullSceneLoadingForIncremental(): boolean;
  105184. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105185. /**
  105186. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105187. */
  105188. static get ShowLoadingScreen(): boolean;
  105189. static set ShowLoadingScreen(value: boolean);
  105190. /**
  105191. * Defines the current logging level (while loading the scene)
  105192. * @ignorenaming
  105193. */
  105194. static get loggingLevel(): number;
  105195. static set loggingLevel(value: number);
  105196. /**
  105197. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105198. */
  105199. static get CleanBoneMatrixWeights(): boolean;
  105200. static set CleanBoneMatrixWeights(value: boolean);
  105201. }
  105202. }
  105203. declare module BABYLON {
  105204. /**
  105205. * Class used to store geometry data (vertex buffers + index buffer)
  105206. */
  105207. export class Geometry implements IGetSetVerticesData {
  105208. /**
  105209. * Gets or sets the ID of the geometry
  105210. */
  105211. id: string;
  105212. /**
  105213. * Gets or sets the unique ID of the geometry
  105214. */
  105215. uniqueId: number;
  105216. /**
  105217. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105218. */
  105219. delayLoadState: number;
  105220. /**
  105221. * Gets the file containing the data to load when running in delay load state
  105222. */
  105223. delayLoadingFile: Nullable<string>;
  105224. /**
  105225. * Callback called when the geometry is updated
  105226. */
  105227. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105228. private _scene;
  105229. private _engine;
  105230. private _meshes;
  105231. private _totalVertices;
  105232. /** @hidden */
  105233. _indices: IndicesArray;
  105234. /** @hidden */
  105235. _vertexBuffers: {
  105236. [key: string]: VertexBuffer;
  105237. };
  105238. private _isDisposed;
  105239. private _extend;
  105240. private _boundingBias;
  105241. /** @hidden */
  105242. _delayInfo: Array<string>;
  105243. private _indexBuffer;
  105244. private _indexBufferIsUpdatable;
  105245. /** @hidden */
  105246. _boundingInfo: Nullable<BoundingInfo>;
  105247. /** @hidden */
  105248. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105249. /** @hidden */
  105250. _softwareSkinningFrameId: number;
  105251. private _vertexArrayObjects;
  105252. private _updatable;
  105253. /** @hidden */
  105254. _positions: Nullable<Vector3[]>;
  105255. /**
  105256. * 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
  105257. */
  105258. get boundingBias(): Vector2;
  105259. /**
  105260. * 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
  105261. */
  105262. set boundingBias(value: Vector2);
  105263. /**
  105264. * Static function used to attach a new empty geometry to a mesh
  105265. * @param mesh defines the mesh to attach the geometry to
  105266. * @returns the new Geometry
  105267. */
  105268. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105269. /** Get the list of meshes using this geometry */
  105270. get meshes(): Mesh[];
  105271. /**
  105272. * 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
  105273. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105274. */
  105275. useBoundingInfoFromGeometry: boolean;
  105276. /**
  105277. * Creates a new geometry
  105278. * @param id defines the unique ID
  105279. * @param scene defines the hosting scene
  105280. * @param vertexData defines the VertexData used to get geometry data
  105281. * @param updatable defines if geometry must be updatable (false by default)
  105282. * @param mesh defines the mesh that will be associated with the geometry
  105283. */
  105284. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105285. /**
  105286. * Gets the current extend of the geometry
  105287. */
  105288. get extend(): {
  105289. minimum: Vector3;
  105290. maximum: Vector3;
  105291. };
  105292. /**
  105293. * Gets the hosting scene
  105294. * @returns the hosting Scene
  105295. */
  105296. getScene(): Scene;
  105297. /**
  105298. * Gets the hosting engine
  105299. * @returns the hosting Engine
  105300. */
  105301. getEngine(): Engine;
  105302. /**
  105303. * Defines if the geometry is ready to use
  105304. * @returns true if the geometry is ready to be used
  105305. */
  105306. isReady(): boolean;
  105307. /**
  105308. * Gets a value indicating that the geometry should not be serialized
  105309. */
  105310. get doNotSerialize(): boolean;
  105311. /** @hidden */
  105312. _rebuild(): void;
  105313. /**
  105314. * Affects all geometry data in one call
  105315. * @param vertexData defines the geometry data
  105316. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105317. */
  105318. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105319. /**
  105320. * Set specific vertex data
  105321. * @param kind defines the data kind (Position, normal, etc...)
  105322. * @param data defines the vertex data to use
  105323. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105324. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105325. */
  105326. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105327. /**
  105328. * Removes a specific vertex data
  105329. * @param kind defines the data kind (Position, normal, etc...)
  105330. */
  105331. removeVerticesData(kind: string): void;
  105332. /**
  105333. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105334. * @param buffer defines the vertex buffer to use
  105335. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105336. */
  105337. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105338. /**
  105339. * Update a specific vertex buffer
  105340. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105341. * It will do nothing if the buffer is not updatable
  105342. * @param kind defines the data kind (Position, normal, etc...)
  105343. * @param data defines the data to use
  105344. * @param offset defines the offset in the target buffer where to store the data
  105345. * @param useBytes set to true if the offset is in bytes
  105346. */
  105347. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105348. /**
  105349. * Update a specific vertex buffer
  105350. * This function will create a new buffer if the current one is not updatable
  105351. * @param kind defines the data kind (Position, normal, etc...)
  105352. * @param data defines the data to use
  105353. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105354. */
  105355. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105356. private _updateBoundingInfo;
  105357. /** @hidden */
  105358. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105359. /**
  105360. * Gets total number of vertices
  105361. * @returns the total number of vertices
  105362. */
  105363. getTotalVertices(): number;
  105364. /**
  105365. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105366. * @param kind defines the data kind (Position, normal, etc...)
  105367. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105368. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105369. * @returns a float array containing vertex data
  105370. */
  105371. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105372. /**
  105373. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105374. * @param kind defines the data kind (Position, normal, etc...)
  105375. * @returns true if the vertex buffer with the specified kind is updatable
  105376. */
  105377. isVertexBufferUpdatable(kind: string): boolean;
  105378. /**
  105379. * Gets a specific vertex buffer
  105380. * @param kind defines the data kind (Position, normal, etc...)
  105381. * @returns a VertexBuffer
  105382. */
  105383. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105384. /**
  105385. * Returns all vertex buffers
  105386. * @return an object holding all vertex buffers indexed by kind
  105387. */
  105388. getVertexBuffers(): Nullable<{
  105389. [key: string]: VertexBuffer;
  105390. }>;
  105391. /**
  105392. * Gets a boolean indicating if specific vertex buffer is present
  105393. * @param kind defines the data kind (Position, normal, etc...)
  105394. * @returns true if data is present
  105395. */
  105396. isVerticesDataPresent(kind: string): boolean;
  105397. /**
  105398. * Gets a list of all attached data kinds (Position, normal, etc...)
  105399. * @returns a list of string containing all kinds
  105400. */
  105401. getVerticesDataKinds(): string[];
  105402. /**
  105403. * Update index buffer
  105404. * @param indices defines the indices to store in the index buffer
  105405. * @param offset defines the offset in the target buffer where to store the data
  105406. * @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)
  105407. */
  105408. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105409. /**
  105410. * Creates a new index buffer
  105411. * @param indices defines the indices to store in the index buffer
  105412. * @param totalVertices defines the total number of vertices (could be null)
  105413. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105414. */
  105415. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105416. /**
  105417. * Return the total number of indices
  105418. * @returns the total number of indices
  105419. */
  105420. getTotalIndices(): number;
  105421. /**
  105422. * Gets the index buffer array
  105423. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105424. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105425. * @returns the index buffer array
  105426. */
  105427. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105428. /**
  105429. * Gets the index buffer
  105430. * @return the index buffer
  105431. */
  105432. getIndexBuffer(): Nullable<DataBuffer>;
  105433. /** @hidden */
  105434. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105435. /**
  105436. * Release the associated resources for a specific mesh
  105437. * @param mesh defines the source mesh
  105438. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105439. */
  105440. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105441. /**
  105442. * Apply current geometry to a given mesh
  105443. * @param mesh defines the mesh to apply geometry to
  105444. */
  105445. applyToMesh(mesh: Mesh): void;
  105446. private _updateExtend;
  105447. private _applyToMesh;
  105448. private notifyUpdate;
  105449. /**
  105450. * Load the geometry if it was flagged as delay loaded
  105451. * @param scene defines the hosting scene
  105452. * @param onLoaded defines a callback called when the geometry is loaded
  105453. */
  105454. load(scene: Scene, onLoaded?: () => void): void;
  105455. private _queueLoad;
  105456. /**
  105457. * Invert the geometry to move from a right handed system to a left handed one.
  105458. */
  105459. toLeftHanded(): void;
  105460. /** @hidden */
  105461. _resetPointsArrayCache(): void;
  105462. /** @hidden */
  105463. _generatePointsArray(): boolean;
  105464. /**
  105465. * Gets a value indicating if the geometry is disposed
  105466. * @returns true if the geometry was disposed
  105467. */
  105468. isDisposed(): boolean;
  105469. private _disposeVertexArrayObjects;
  105470. /**
  105471. * Free all associated resources
  105472. */
  105473. dispose(): void;
  105474. /**
  105475. * Clone the current geometry into a new geometry
  105476. * @param id defines the unique ID of the new geometry
  105477. * @returns a new geometry object
  105478. */
  105479. copy(id: string): Geometry;
  105480. /**
  105481. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105482. * @return a JSON representation of the current geometry data (without the vertices data)
  105483. */
  105484. serialize(): any;
  105485. private toNumberArray;
  105486. /**
  105487. * Serialize all vertices data into a JSON oject
  105488. * @returns a JSON representation of the current geometry data
  105489. */
  105490. serializeVerticeData(): any;
  105491. /**
  105492. * Extracts a clone of a mesh geometry
  105493. * @param mesh defines the source mesh
  105494. * @param id defines the unique ID of the new geometry object
  105495. * @returns the new geometry object
  105496. */
  105497. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105498. /**
  105499. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105500. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105501. * Be aware Math.random() could cause collisions, but:
  105502. * "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"
  105503. * @returns a string containing a new GUID
  105504. */
  105505. static RandomId(): string;
  105506. /** @hidden */
  105507. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105508. private static _CleanMatricesWeights;
  105509. /**
  105510. * Create a new geometry from persisted data (Using .babylon file format)
  105511. * @param parsedVertexData defines the persisted data
  105512. * @param scene defines the hosting scene
  105513. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105514. * @returns the new geometry object
  105515. */
  105516. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105517. }
  105518. }
  105519. declare module BABYLON {
  105520. /**
  105521. * Define an interface for all classes that will get and set the data on vertices
  105522. */
  105523. export interface IGetSetVerticesData {
  105524. /**
  105525. * Gets a boolean indicating if specific vertex data is present
  105526. * @param kind defines the vertex data kind to use
  105527. * @returns true is data kind is present
  105528. */
  105529. isVerticesDataPresent(kind: string): boolean;
  105530. /**
  105531. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105532. * @param kind defines the data kind (Position, normal, etc...)
  105533. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105534. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105535. * @returns a float array containing vertex data
  105536. */
  105537. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105538. /**
  105539. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105540. * @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.
  105541. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105542. * @returns the indices array or an empty array if the mesh has no geometry
  105543. */
  105544. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105545. /**
  105546. * Set specific vertex data
  105547. * @param kind defines the data kind (Position, normal, etc...)
  105548. * @param data defines the vertex data to use
  105549. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105550. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105551. */
  105552. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105553. /**
  105554. * Update a specific associated vertex buffer
  105555. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105556. * - VertexBuffer.PositionKind
  105557. * - VertexBuffer.UVKind
  105558. * - VertexBuffer.UV2Kind
  105559. * - VertexBuffer.UV3Kind
  105560. * - VertexBuffer.UV4Kind
  105561. * - VertexBuffer.UV5Kind
  105562. * - VertexBuffer.UV6Kind
  105563. * - VertexBuffer.ColorKind
  105564. * - VertexBuffer.MatricesIndicesKind
  105565. * - VertexBuffer.MatricesIndicesExtraKind
  105566. * - VertexBuffer.MatricesWeightsKind
  105567. * - VertexBuffer.MatricesWeightsExtraKind
  105568. * @param data defines the data source
  105569. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105570. * @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)
  105571. */
  105572. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105573. /**
  105574. * Creates a new index buffer
  105575. * @param indices defines the indices to store in the index buffer
  105576. * @param totalVertices defines the total number of vertices (could be null)
  105577. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105578. */
  105579. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105580. }
  105581. /**
  105582. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105583. */
  105584. export class VertexData {
  105585. /**
  105586. * Mesh side orientation : usually the external or front surface
  105587. */
  105588. static readonly FRONTSIDE: number;
  105589. /**
  105590. * Mesh side orientation : usually the internal or back surface
  105591. */
  105592. static readonly BACKSIDE: number;
  105593. /**
  105594. * Mesh side orientation : both internal and external or front and back surfaces
  105595. */
  105596. static readonly DOUBLESIDE: number;
  105597. /**
  105598. * Mesh side orientation : by default, `FRONTSIDE`
  105599. */
  105600. static readonly DEFAULTSIDE: number;
  105601. /**
  105602. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105603. */
  105604. positions: Nullable<FloatArray>;
  105605. /**
  105606. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105607. */
  105608. normals: Nullable<FloatArray>;
  105609. /**
  105610. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105611. */
  105612. tangents: Nullable<FloatArray>;
  105613. /**
  105614. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105615. */
  105616. uvs: Nullable<FloatArray>;
  105617. /**
  105618. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105619. */
  105620. uvs2: Nullable<FloatArray>;
  105621. /**
  105622. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105623. */
  105624. uvs3: Nullable<FloatArray>;
  105625. /**
  105626. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105627. */
  105628. uvs4: Nullable<FloatArray>;
  105629. /**
  105630. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105631. */
  105632. uvs5: Nullable<FloatArray>;
  105633. /**
  105634. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105635. */
  105636. uvs6: Nullable<FloatArray>;
  105637. /**
  105638. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105639. */
  105640. colors: Nullable<FloatArray>;
  105641. /**
  105642. * 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).
  105643. */
  105644. matricesIndices: Nullable<FloatArray>;
  105645. /**
  105646. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105647. */
  105648. matricesWeights: Nullable<FloatArray>;
  105649. /**
  105650. * An array extending the number of possible indices
  105651. */
  105652. matricesIndicesExtra: Nullable<FloatArray>;
  105653. /**
  105654. * An array extending the number of possible weights when the number of indices is extended
  105655. */
  105656. matricesWeightsExtra: Nullable<FloatArray>;
  105657. /**
  105658. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105659. */
  105660. indices: Nullable<IndicesArray>;
  105661. /**
  105662. * Uses the passed data array to set the set the values for the specified kind of data
  105663. * @param data a linear array of floating numbers
  105664. * @param kind the type of data that is being set, eg positions, colors etc
  105665. */
  105666. set(data: FloatArray, kind: string): void;
  105667. /**
  105668. * Associates the vertexData to the passed Mesh.
  105669. * Sets it as updatable or not (default `false`)
  105670. * @param mesh the mesh the vertexData is applied to
  105671. * @param updatable when used and having the value true allows new data to update the vertexData
  105672. * @returns the VertexData
  105673. */
  105674. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105675. /**
  105676. * Associates the vertexData to the passed Geometry.
  105677. * Sets it as updatable or not (default `false`)
  105678. * @param geometry the geometry the vertexData is applied to
  105679. * @param updatable when used and having the value true allows new data to update the vertexData
  105680. * @returns VertexData
  105681. */
  105682. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105683. /**
  105684. * Updates the associated mesh
  105685. * @param mesh the mesh to be updated
  105686. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105687. * @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
  105688. * @returns VertexData
  105689. */
  105690. updateMesh(mesh: Mesh): VertexData;
  105691. /**
  105692. * Updates the associated geometry
  105693. * @param geometry the geometry to be updated
  105694. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105695. * @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
  105696. * @returns VertexData.
  105697. */
  105698. updateGeometry(geometry: Geometry): VertexData;
  105699. private _applyTo;
  105700. private _update;
  105701. /**
  105702. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105703. * @param matrix the transforming matrix
  105704. * @returns the VertexData
  105705. */
  105706. transform(matrix: Matrix): VertexData;
  105707. /**
  105708. * Merges the passed VertexData into the current one
  105709. * @param other the VertexData to be merged into the current one
  105710. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105711. * @returns the modified VertexData
  105712. */
  105713. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105714. private _mergeElement;
  105715. private _validate;
  105716. /**
  105717. * Serializes the VertexData
  105718. * @returns a serialized object
  105719. */
  105720. serialize(): any;
  105721. /**
  105722. * Extracts the vertexData from a mesh
  105723. * @param mesh the mesh from which to extract the VertexData
  105724. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105725. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105726. * @returns the object VertexData associated to the passed mesh
  105727. */
  105728. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105729. /**
  105730. * Extracts the vertexData from the geometry
  105731. * @param geometry the geometry from which to extract the VertexData
  105732. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105733. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105734. * @returns the object VertexData associated to the passed mesh
  105735. */
  105736. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105737. private static _ExtractFrom;
  105738. /**
  105739. * Creates the VertexData for a Ribbon
  105740. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105741. * * pathArray array of paths, each of which an array of successive Vector3
  105742. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105743. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105744. * * 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
  105745. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105746. * * 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)
  105747. * * 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)
  105748. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105749. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105750. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105751. * @returns the VertexData of the ribbon
  105752. */
  105753. static CreateRibbon(options: {
  105754. pathArray: Vector3[][];
  105755. closeArray?: boolean;
  105756. closePath?: boolean;
  105757. offset?: number;
  105758. sideOrientation?: number;
  105759. frontUVs?: Vector4;
  105760. backUVs?: Vector4;
  105761. invertUV?: boolean;
  105762. uvs?: Vector2[];
  105763. colors?: Color4[];
  105764. }): VertexData;
  105765. /**
  105766. * Creates the VertexData for a box
  105767. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105768. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105769. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105770. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105771. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105772. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105773. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105774. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105775. * * 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)
  105776. * * 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)
  105777. * @returns the VertexData of the box
  105778. */
  105779. static CreateBox(options: {
  105780. size?: number;
  105781. width?: number;
  105782. height?: number;
  105783. depth?: number;
  105784. faceUV?: Vector4[];
  105785. faceColors?: Color4[];
  105786. sideOrientation?: number;
  105787. frontUVs?: Vector4;
  105788. backUVs?: Vector4;
  105789. }): VertexData;
  105790. /**
  105791. * Creates the VertexData for a tiled box
  105792. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105793. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105794. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105795. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105796. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105797. * @returns the VertexData of the box
  105798. */
  105799. static CreateTiledBox(options: {
  105800. pattern?: number;
  105801. width?: number;
  105802. height?: number;
  105803. depth?: number;
  105804. tileSize?: number;
  105805. tileWidth?: number;
  105806. tileHeight?: number;
  105807. alignHorizontal?: number;
  105808. alignVertical?: number;
  105809. faceUV?: Vector4[];
  105810. faceColors?: Color4[];
  105811. sideOrientation?: number;
  105812. }): VertexData;
  105813. /**
  105814. * Creates the VertexData for a tiled plane
  105815. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105816. * * pattern a limited pattern arrangement depending on the number
  105817. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105818. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105819. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105820. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105821. * * 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)
  105822. * * 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)
  105823. * @returns the VertexData of the tiled plane
  105824. */
  105825. static CreateTiledPlane(options: {
  105826. pattern?: number;
  105827. tileSize?: number;
  105828. tileWidth?: number;
  105829. tileHeight?: number;
  105830. size?: number;
  105831. width?: number;
  105832. height?: number;
  105833. alignHorizontal?: number;
  105834. alignVertical?: number;
  105835. sideOrientation?: number;
  105836. frontUVs?: Vector4;
  105837. backUVs?: Vector4;
  105838. }): VertexData;
  105839. /**
  105840. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105841. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105842. * * segments sets the number of horizontal strips optional, default 32
  105843. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105844. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105845. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105846. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105847. * * 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
  105848. * * 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
  105849. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105850. * * 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)
  105851. * * 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)
  105852. * @returns the VertexData of the ellipsoid
  105853. */
  105854. static CreateSphere(options: {
  105855. segments?: number;
  105856. diameter?: number;
  105857. diameterX?: number;
  105858. diameterY?: number;
  105859. diameterZ?: number;
  105860. arc?: number;
  105861. slice?: number;
  105862. sideOrientation?: number;
  105863. frontUVs?: Vector4;
  105864. backUVs?: Vector4;
  105865. }): VertexData;
  105866. /**
  105867. * Creates the VertexData for a cylinder, cone or prism
  105868. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105869. * * height sets the height (y direction) of the cylinder, optional, default 2
  105870. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105871. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105872. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105873. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105874. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105875. * * 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
  105876. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105877. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105878. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105879. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105880. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105881. * * 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)
  105882. * * 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)
  105883. * @returns the VertexData of the cylinder, cone or prism
  105884. */
  105885. static CreateCylinder(options: {
  105886. height?: number;
  105887. diameterTop?: number;
  105888. diameterBottom?: number;
  105889. diameter?: number;
  105890. tessellation?: number;
  105891. subdivisions?: number;
  105892. arc?: number;
  105893. faceColors?: Color4[];
  105894. faceUV?: Vector4[];
  105895. hasRings?: boolean;
  105896. enclose?: boolean;
  105897. sideOrientation?: number;
  105898. frontUVs?: Vector4;
  105899. backUVs?: Vector4;
  105900. }): VertexData;
  105901. /**
  105902. * Creates the VertexData for a torus
  105903. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105904. * * diameter the diameter of the torus, optional default 1
  105905. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105906. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105907. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105908. * * 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)
  105909. * * 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)
  105910. * @returns the VertexData of the torus
  105911. */
  105912. static CreateTorus(options: {
  105913. diameter?: number;
  105914. thickness?: number;
  105915. tessellation?: number;
  105916. sideOrientation?: number;
  105917. frontUVs?: Vector4;
  105918. backUVs?: Vector4;
  105919. }): VertexData;
  105920. /**
  105921. * Creates the VertexData of the LineSystem
  105922. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105923. * - lines an array of lines, each line being an array of successive Vector3
  105924. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105925. * @returns the VertexData of the LineSystem
  105926. */
  105927. static CreateLineSystem(options: {
  105928. lines: Vector3[][];
  105929. colors?: Nullable<Color4[][]>;
  105930. }): VertexData;
  105931. /**
  105932. * Create the VertexData for a DashedLines
  105933. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105934. * - points an array successive Vector3
  105935. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105936. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105937. * - dashNb the intended total number of dashes, optional, default 200
  105938. * @returns the VertexData for the DashedLines
  105939. */
  105940. static CreateDashedLines(options: {
  105941. points: Vector3[];
  105942. dashSize?: number;
  105943. gapSize?: number;
  105944. dashNb?: number;
  105945. }): VertexData;
  105946. /**
  105947. * Creates the VertexData for a Ground
  105948. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105949. * - width the width (x direction) of the ground, optional, default 1
  105950. * - height the height (z direction) of the ground, optional, default 1
  105951. * - subdivisions the number of subdivisions per side, optional, default 1
  105952. * @returns the VertexData of the Ground
  105953. */
  105954. static CreateGround(options: {
  105955. width?: number;
  105956. height?: number;
  105957. subdivisions?: number;
  105958. subdivisionsX?: number;
  105959. subdivisionsY?: number;
  105960. }): VertexData;
  105961. /**
  105962. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105963. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105964. * * xmin the ground minimum X coordinate, optional, default -1
  105965. * * zmin the ground minimum Z coordinate, optional, default -1
  105966. * * xmax the ground maximum X coordinate, optional, default 1
  105967. * * zmax the ground maximum Z coordinate, optional, default 1
  105968. * * 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}
  105969. * * 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}
  105970. * @returns the VertexData of the TiledGround
  105971. */
  105972. static CreateTiledGround(options: {
  105973. xmin: number;
  105974. zmin: number;
  105975. xmax: number;
  105976. zmax: number;
  105977. subdivisions?: {
  105978. w: number;
  105979. h: number;
  105980. };
  105981. precision?: {
  105982. w: number;
  105983. h: number;
  105984. };
  105985. }): VertexData;
  105986. /**
  105987. * Creates the VertexData of the Ground designed from a heightmap
  105988. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105989. * * width the width (x direction) of the ground
  105990. * * height the height (z direction) of the ground
  105991. * * subdivisions the number of subdivisions per side
  105992. * * minHeight the minimum altitude on the ground, optional, default 0
  105993. * * maxHeight the maximum altitude on the ground, optional default 1
  105994. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105995. * * buffer the array holding the image color data
  105996. * * bufferWidth the width of image
  105997. * * bufferHeight the height of image
  105998. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105999. * @returns the VertexData of the Ground designed from a heightmap
  106000. */
  106001. static CreateGroundFromHeightMap(options: {
  106002. width: number;
  106003. height: number;
  106004. subdivisions: number;
  106005. minHeight: number;
  106006. maxHeight: number;
  106007. colorFilter: Color3;
  106008. buffer: Uint8Array;
  106009. bufferWidth: number;
  106010. bufferHeight: number;
  106011. alphaFilter: number;
  106012. }): VertexData;
  106013. /**
  106014. * Creates the VertexData for a Plane
  106015. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106016. * * size sets the width and height of the plane to the value of size, optional default 1
  106017. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106018. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106019. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106020. * * 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)
  106021. * * 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)
  106022. * @returns the VertexData of the box
  106023. */
  106024. static CreatePlane(options: {
  106025. size?: number;
  106026. width?: number;
  106027. height?: number;
  106028. sideOrientation?: number;
  106029. frontUVs?: Vector4;
  106030. backUVs?: Vector4;
  106031. }): VertexData;
  106032. /**
  106033. * Creates the VertexData of the Disc or regular Polygon
  106034. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106035. * * radius the radius of the disc, optional default 0.5
  106036. * * tessellation the number of polygon sides, optional, default 64
  106037. * * 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
  106038. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106039. * * 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)
  106040. * * 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)
  106041. * @returns the VertexData of the box
  106042. */
  106043. static CreateDisc(options: {
  106044. radius?: number;
  106045. tessellation?: number;
  106046. arc?: number;
  106047. sideOrientation?: number;
  106048. frontUVs?: Vector4;
  106049. backUVs?: Vector4;
  106050. }): VertexData;
  106051. /**
  106052. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106053. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106054. * @param polygon a mesh built from polygonTriangulation.build()
  106055. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106056. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106057. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106058. * @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)
  106059. * @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)
  106060. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106061. * @returns the VertexData of the Polygon
  106062. */
  106063. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106064. /**
  106065. * Creates the VertexData of the IcoSphere
  106066. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106067. * * radius the radius of the IcoSphere, optional default 1
  106068. * * radiusX allows stretching in the x direction, optional, default radius
  106069. * * radiusY allows stretching in the y direction, optional, default radius
  106070. * * radiusZ allows stretching in the z direction, optional, default radius
  106071. * * flat when true creates a flat shaded mesh, optional, default true
  106072. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106073. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106074. * * 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)
  106075. * * 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)
  106076. * @returns the VertexData of the IcoSphere
  106077. */
  106078. static CreateIcoSphere(options: {
  106079. radius?: number;
  106080. radiusX?: number;
  106081. radiusY?: number;
  106082. radiusZ?: number;
  106083. flat?: boolean;
  106084. subdivisions?: number;
  106085. sideOrientation?: number;
  106086. frontUVs?: Vector4;
  106087. backUVs?: Vector4;
  106088. }): VertexData;
  106089. /**
  106090. * Creates the VertexData for a Polyhedron
  106091. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106092. * * type provided types are:
  106093. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106094. * * 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)
  106095. * * size the size of the IcoSphere, optional default 1
  106096. * * sizeX allows stretching in the x direction, optional, default size
  106097. * * sizeY allows stretching in the y direction, optional, default size
  106098. * * sizeZ allows stretching in the z direction, optional, default size
  106099. * * 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
  106100. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106101. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106102. * * flat when true creates a flat shaded mesh, optional, default true
  106103. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106104. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106105. * * 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)
  106106. * * 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)
  106107. * @returns the VertexData of the Polyhedron
  106108. */
  106109. static CreatePolyhedron(options: {
  106110. type?: number;
  106111. size?: number;
  106112. sizeX?: number;
  106113. sizeY?: number;
  106114. sizeZ?: number;
  106115. custom?: any;
  106116. faceUV?: Vector4[];
  106117. faceColors?: Color4[];
  106118. flat?: boolean;
  106119. sideOrientation?: number;
  106120. frontUVs?: Vector4;
  106121. backUVs?: Vector4;
  106122. }): VertexData;
  106123. /**
  106124. * Creates the VertexData for a TorusKnot
  106125. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106126. * * radius the radius of the torus knot, optional, default 2
  106127. * * tube the thickness of the tube, optional, default 0.5
  106128. * * radialSegments the number of sides on each tube segments, optional, default 32
  106129. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106130. * * p the number of windings around the z axis, optional, default 2
  106131. * * q the number of windings around the x axis, optional, default 3
  106132. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106133. * * 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)
  106134. * * 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)
  106135. * @returns the VertexData of the Torus Knot
  106136. */
  106137. static CreateTorusKnot(options: {
  106138. radius?: number;
  106139. tube?: number;
  106140. radialSegments?: number;
  106141. tubularSegments?: number;
  106142. p?: number;
  106143. q?: number;
  106144. sideOrientation?: number;
  106145. frontUVs?: Vector4;
  106146. backUVs?: Vector4;
  106147. }): VertexData;
  106148. /**
  106149. * Compute normals for given positions and indices
  106150. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106151. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106152. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106153. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106154. * * facetNormals : optional array of facet normals (vector3)
  106155. * * facetPositions : optional array of facet positions (vector3)
  106156. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106157. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106158. * * bInfo : optional bounding info, required for facetPartitioning computation
  106159. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106160. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106161. * * useRightHandedSystem: optional boolean to for right handed system computation
  106162. * * depthSort : optional boolean to enable the facet depth sort computation
  106163. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106164. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106165. */
  106166. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106167. facetNormals?: any;
  106168. facetPositions?: any;
  106169. facetPartitioning?: any;
  106170. ratio?: number;
  106171. bInfo?: any;
  106172. bbSize?: Vector3;
  106173. subDiv?: any;
  106174. useRightHandedSystem?: boolean;
  106175. depthSort?: boolean;
  106176. distanceTo?: Vector3;
  106177. depthSortedFacets?: any;
  106178. }): void;
  106179. /** @hidden */
  106180. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106181. /**
  106182. * Applies VertexData created from the imported parameters to the geometry
  106183. * @param parsedVertexData the parsed data from an imported file
  106184. * @param geometry the geometry to apply the VertexData to
  106185. */
  106186. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106187. }
  106188. }
  106189. declare module BABYLON {
  106190. /**
  106191. * Defines a target to use with MorphTargetManager
  106192. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106193. */
  106194. export class MorphTarget implements IAnimatable {
  106195. /** defines the name of the target */
  106196. name: string;
  106197. /**
  106198. * Gets or sets the list of animations
  106199. */
  106200. animations: Animation[];
  106201. private _scene;
  106202. private _positions;
  106203. private _normals;
  106204. private _tangents;
  106205. private _uvs;
  106206. private _influence;
  106207. private _uniqueId;
  106208. /**
  106209. * Observable raised when the influence changes
  106210. */
  106211. onInfluenceChanged: Observable<boolean>;
  106212. /** @hidden */
  106213. _onDataLayoutChanged: Observable<void>;
  106214. /**
  106215. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106216. */
  106217. get influence(): number;
  106218. set influence(influence: number);
  106219. /**
  106220. * Gets or sets the id of the morph Target
  106221. */
  106222. id: string;
  106223. private _animationPropertiesOverride;
  106224. /**
  106225. * Gets or sets the animation properties override
  106226. */
  106227. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106228. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106229. /**
  106230. * Creates a new MorphTarget
  106231. * @param name defines the name of the target
  106232. * @param influence defines the influence to use
  106233. * @param scene defines the scene the morphtarget belongs to
  106234. */
  106235. constructor(
  106236. /** defines the name of the target */
  106237. name: string, influence?: number, scene?: Nullable<Scene>);
  106238. /**
  106239. * Gets the unique ID of this manager
  106240. */
  106241. get uniqueId(): number;
  106242. /**
  106243. * Gets a boolean defining if the target contains position data
  106244. */
  106245. get hasPositions(): boolean;
  106246. /**
  106247. * Gets a boolean defining if the target contains normal data
  106248. */
  106249. get hasNormals(): boolean;
  106250. /**
  106251. * Gets a boolean defining if the target contains tangent data
  106252. */
  106253. get hasTangents(): boolean;
  106254. /**
  106255. * Gets a boolean defining if the target contains texture coordinates data
  106256. */
  106257. get hasUVs(): boolean;
  106258. /**
  106259. * Affects position data to this target
  106260. * @param data defines the position data to use
  106261. */
  106262. setPositions(data: Nullable<FloatArray>): void;
  106263. /**
  106264. * Gets the position data stored in this target
  106265. * @returns a FloatArray containing the position data (or null if not present)
  106266. */
  106267. getPositions(): Nullable<FloatArray>;
  106268. /**
  106269. * Affects normal data to this target
  106270. * @param data defines the normal data to use
  106271. */
  106272. setNormals(data: Nullable<FloatArray>): void;
  106273. /**
  106274. * Gets the normal data stored in this target
  106275. * @returns a FloatArray containing the normal data (or null if not present)
  106276. */
  106277. getNormals(): Nullable<FloatArray>;
  106278. /**
  106279. * Affects tangent data to this target
  106280. * @param data defines the tangent data to use
  106281. */
  106282. setTangents(data: Nullable<FloatArray>): void;
  106283. /**
  106284. * Gets the tangent data stored in this target
  106285. * @returns a FloatArray containing the tangent data (or null if not present)
  106286. */
  106287. getTangents(): Nullable<FloatArray>;
  106288. /**
  106289. * Affects texture coordinates data to this target
  106290. * @param data defines the texture coordinates data to use
  106291. */
  106292. setUVs(data: Nullable<FloatArray>): void;
  106293. /**
  106294. * Gets the texture coordinates data stored in this target
  106295. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106296. */
  106297. getUVs(): Nullable<FloatArray>;
  106298. /**
  106299. * Clone the current target
  106300. * @returns a new MorphTarget
  106301. */
  106302. clone(): MorphTarget;
  106303. /**
  106304. * Serializes the current target into a Serialization object
  106305. * @returns the serialized object
  106306. */
  106307. serialize(): any;
  106308. /**
  106309. * Returns the string "MorphTarget"
  106310. * @returns "MorphTarget"
  106311. */
  106312. getClassName(): string;
  106313. /**
  106314. * Creates a new target from serialized data
  106315. * @param serializationObject defines the serialized data to use
  106316. * @returns a new MorphTarget
  106317. */
  106318. static Parse(serializationObject: any): MorphTarget;
  106319. /**
  106320. * Creates a MorphTarget from mesh data
  106321. * @param mesh defines the source mesh
  106322. * @param name defines the name to use for the new target
  106323. * @param influence defines the influence to attach to the target
  106324. * @returns a new MorphTarget
  106325. */
  106326. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106327. }
  106328. }
  106329. declare module BABYLON {
  106330. /**
  106331. * This class is used to deform meshes using morphing between different targets
  106332. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106333. */
  106334. export class MorphTargetManager {
  106335. private _targets;
  106336. private _targetInfluenceChangedObservers;
  106337. private _targetDataLayoutChangedObservers;
  106338. private _activeTargets;
  106339. private _scene;
  106340. private _influences;
  106341. private _supportsNormals;
  106342. private _supportsTangents;
  106343. private _supportsUVs;
  106344. private _vertexCount;
  106345. private _uniqueId;
  106346. private _tempInfluences;
  106347. /**
  106348. * Gets or sets a boolean indicating if normals must be morphed
  106349. */
  106350. enableNormalMorphing: boolean;
  106351. /**
  106352. * Gets or sets a boolean indicating if tangents must be morphed
  106353. */
  106354. enableTangentMorphing: boolean;
  106355. /**
  106356. * Gets or sets a boolean indicating if UV must be morphed
  106357. */
  106358. enableUVMorphing: boolean;
  106359. /**
  106360. * Creates a new MorphTargetManager
  106361. * @param scene defines the current scene
  106362. */
  106363. constructor(scene?: Nullable<Scene>);
  106364. /**
  106365. * Gets the unique ID of this manager
  106366. */
  106367. get uniqueId(): number;
  106368. /**
  106369. * Gets the number of vertices handled by this manager
  106370. */
  106371. get vertexCount(): number;
  106372. /**
  106373. * Gets a boolean indicating if this manager supports morphing of normals
  106374. */
  106375. get supportsNormals(): boolean;
  106376. /**
  106377. * Gets a boolean indicating if this manager supports morphing of tangents
  106378. */
  106379. get supportsTangents(): boolean;
  106380. /**
  106381. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106382. */
  106383. get supportsUVs(): boolean;
  106384. /**
  106385. * Gets the number of targets stored in this manager
  106386. */
  106387. get numTargets(): number;
  106388. /**
  106389. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106390. */
  106391. get numInfluencers(): number;
  106392. /**
  106393. * Gets the list of influences (one per target)
  106394. */
  106395. get influences(): Float32Array;
  106396. /**
  106397. * Gets the active target at specified index. An active target is a target with an influence > 0
  106398. * @param index defines the index to check
  106399. * @returns the requested target
  106400. */
  106401. getActiveTarget(index: number): MorphTarget;
  106402. /**
  106403. * Gets the target at specified index
  106404. * @param index defines the index to check
  106405. * @returns the requested target
  106406. */
  106407. getTarget(index: number): MorphTarget;
  106408. /**
  106409. * Add a new target to this manager
  106410. * @param target defines the target to add
  106411. */
  106412. addTarget(target: MorphTarget): void;
  106413. /**
  106414. * Removes a target from the manager
  106415. * @param target defines the target to remove
  106416. */
  106417. removeTarget(target: MorphTarget): void;
  106418. /**
  106419. * Clone the current manager
  106420. * @returns a new MorphTargetManager
  106421. */
  106422. clone(): MorphTargetManager;
  106423. /**
  106424. * Serializes the current manager into a Serialization object
  106425. * @returns the serialized object
  106426. */
  106427. serialize(): any;
  106428. private _syncActiveTargets;
  106429. /**
  106430. * Syncrhonize the targets with all the meshes using this morph target manager
  106431. */
  106432. synchronize(): void;
  106433. /**
  106434. * Creates a new MorphTargetManager from serialized data
  106435. * @param serializationObject defines the serialized data
  106436. * @param scene defines the hosting scene
  106437. * @returns the new MorphTargetManager
  106438. */
  106439. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106440. }
  106441. }
  106442. declare module BABYLON {
  106443. /**
  106444. * Class used to represent a specific level of detail of a mesh
  106445. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106446. */
  106447. export class MeshLODLevel {
  106448. /** Defines the distance where this level should start being displayed */
  106449. distance: number;
  106450. /** Defines the mesh to use to render this level */
  106451. mesh: Nullable<Mesh>;
  106452. /**
  106453. * Creates a new LOD level
  106454. * @param distance defines the distance where this level should star being displayed
  106455. * @param mesh defines the mesh to use to render this level
  106456. */
  106457. constructor(
  106458. /** Defines the distance where this level should start being displayed */
  106459. distance: number,
  106460. /** Defines the mesh to use to render this level */
  106461. mesh: Nullable<Mesh>);
  106462. }
  106463. }
  106464. declare module BABYLON {
  106465. /**
  106466. * Helper class used to generate a canvas to manipulate images
  106467. */
  106468. export class CanvasGenerator {
  106469. /**
  106470. * Create a new canvas (or offscreen canvas depending on the context)
  106471. * @param width defines the expected width
  106472. * @param height defines the expected height
  106473. * @return a new canvas or offscreen canvas
  106474. */
  106475. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106476. }
  106477. }
  106478. declare module BABYLON {
  106479. /**
  106480. * Mesh representing the gorund
  106481. */
  106482. export class GroundMesh extends Mesh {
  106483. /** If octree should be generated */
  106484. generateOctree: boolean;
  106485. private _heightQuads;
  106486. /** @hidden */
  106487. _subdivisionsX: number;
  106488. /** @hidden */
  106489. _subdivisionsY: number;
  106490. /** @hidden */
  106491. _width: number;
  106492. /** @hidden */
  106493. _height: number;
  106494. /** @hidden */
  106495. _minX: number;
  106496. /** @hidden */
  106497. _maxX: number;
  106498. /** @hidden */
  106499. _minZ: number;
  106500. /** @hidden */
  106501. _maxZ: number;
  106502. constructor(name: string, scene: Scene);
  106503. /**
  106504. * "GroundMesh"
  106505. * @returns "GroundMesh"
  106506. */
  106507. getClassName(): string;
  106508. /**
  106509. * The minimum of x and y subdivisions
  106510. */
  106511. get subdivisions(): number;
  106512. /**
  106513. * X subdivisions
  106514. */
  106515. get subdivisionsX(): number;
  106516. /**
  106517. * Y subdivisions
  106518. */
  106519. get subdivisionsY(): number;
  106520. /**
  106521. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106522. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106523. * @param chunksCount the number of subdivisions for x and y
  106524. * @param octreeBlocksSize (Default: 32)
  106525. */
  106526. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106527. /**
  106528. * Returns a height (y) value in the Worl system :
  106529. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106530. * @param x x coordinate
  106531. * @param z z coordinate
  106532. * @returns the ground y position if (x, z) are outside the ground surface.
  106533. */
  106534. getHeightAtCoordinates(x: number, z: number): number;
  106535. /**
  106536. * Returns a normalized vector (Vector3) orthogonal to the ground
  106537. * at the ground coordinates (x, z) expressed in the World system.
  106538. * @param x x coordinate
  106539. * @param z z coordinate
  106540. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106541. */
  106542. getNormalAtCoordinates(x: number, z: number): Vector3;
  106543. /**
  106544. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106545. * at the ground coordinates (x, z) expressed in the World system.
  106546. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106547. * @param x x coordinate
  106548. * @param z z coordinate
  106549. * @param ref vector to store the result
  106550. * @returns the GroundMesh.
  106551. */
  106552. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106553. /**
  106554. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106555. * if the ground has been updated.
  106556. * This can be used in the render loop.
  106557. * @returns the GroundMesh.
  106558. */
  106559. updateCoordinateHeights(): GroundMesh;
  106560. private _getFacetAt;
  106561. private _initHeightQuads;
  106562. private _computeHeightQuads;
  106563. /**
  106564. * Serializes this ground mesh
  106565. * @param serializationObject object to write serialization to
  106566. */
  106567. serialize(serializationObject: any): void;
  106568. /**
  106569. * Parses a serialized ground mesh
  106570. * @param parsedMesh the serialized mesh
  106571. * @param scene the scene to create the ground mesh in
  106572. * @returns the created ground mesh
  106573. */
  106574. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106575. }
  106576. }
  106577. declare module BABYLON {
  106578. /**
  106579. * Interface for Physics-Joint data
  106580. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106581. */
  106582. export interface PhysicsJointData {
  106583. /**
  106584. * The main pivot of the joint
  106585. */
  106586. mainPivot?: Vector3;
  106587. /**
  106588. * The connected pivot of the joint
  106589. */
  106590. connectedPivot?: Vector3;
  106591. /**
  106592. * The main axis of the joint
  106593. */
  106594. mainAxis?: Vector3;
  106595. /**
  106596. * The connected axis of the joint
  106597. */
  106598. connectedAxis?: Vector3;
  106599. /**
  106600. * The collision of the joint
  106601. */
  106602. collision?: boolean;
  106603. /**
  106604. * Native Oimo/Cannon/Energy data
  106605. */
  106606. nativeParams?: any;
  106607. }
  106608. /**
  106609. * This is a holder class for the physics joint created by the physics plugin
  106610. * It holds a set of functions to control the underlying joint
  106611. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106612. */
  106613. export class PhysicsJoint {
  106614. /**
  106615. * The type of the physics joint
  106616. */
  106617. type: number;
  106618. /**
  106619. * The data for the physics joint
  106620. */
  106621. jointData: PhysicsJointData;
  106622. private _physicsJoint;
  106623. protected _physicsPlugin: IPhysicsEnginePlugin;
  106624. /**
  106625. * Initializes the physics joint
  106626. * @param type The type of the physics joint
  106627. * @param jointData The data for the physics joint
  106628. */
  106629. constructor(
  106630. /**
  106631. * The type of the physics joint
  106632. */
  106633. type: number,
  106634. /**
  106635. * The data for the physics joint
  106636. */
  106637. jointData: PhysicsJointData);
  106638. /**
  106639. * Gets the physics joint
  106640. */
  106641. get physicsJoint(): any;
  106642. /**
  106643. * Sets the physics joint
  106644. */
  106645. set physicsJoint(newJoint: any);
  106646. /**
  106647. * Sets the physics plugin
  106648. */
  106649. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106650. /**
  106651. * Execute a function that is physics-plugin specific.
  106652. * @param {Function} func the function that will be executed.
  106653. * It accepts two parameters: the physics world and the physics joint
  106654. */
  106655. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106656. /**
  106657. * Distance-Joint type
  106658. */
  106659. static DistanceJoint: number;
  106660. /**
  106661. * Hinge-Joint type
  106662. */
  106663. static HingeJoint: number;
  106664. /**
  106665. * Ball-and-Socket joint type
  106666. */
  106667. static BallAndSocketJoint: number;
  106668. /**
  106669. * Wheel-Joint type
  106670. */
  106671. static WheelJoint: number;
  106672. /**
  106673. * Slider-Joint type
  106674. */
  106675. static SliderJoint: number;
  106676. /**
  106677. * Prismatic-Joint type
  106678. */
  106679. static PrismaticJoint: number;
  106680. /**
  106681. * Universal-Joint type
  106682. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106683. */
  106684. static UniversalJoint: number;
  106685. /**
  106686. * Hinge-Joint 2 type
  106687. */
  106688. static Hinge2Joint: number;
  106689. /**
  106690. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106691. */
  106692. static PointToPointJoint: number;
  106693. /**
  106694. * Spring-Joint type
  106695. */
  106696. static SpringJoint: number;
  106697. /**
  106698. * Lock-Joint type
  106699. */
  106700. static LockJoint: number;
  106701. }
  106702. /**
  106703. * A class representing a physics distance joint
  106704. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106705. */
  106706. export class DistanceJoint extends PhysicsJoint {
  106707. /**
  106708. *
  106709. * @param jointData The data for the Distance-Joint
  106710. */
  106711. constructor(jointData: DistanceJointData);
  106712. /**
  106713. * Update the predefined distance.
  106714. * @param maxDistance The maximum preferred distance
  106715. * @param minDistance The minimum preferred distance
  106716. */
  106717. updateDistance(maxDistance: number, minDistance?: number): void;
  106718. }
  106719. /**
  106720. * Represents a Motor-Enabled Joint
  106721. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106722. */
  106723. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106724. /**
  106725. * Initializes the Motor-Enabled Joint
  106726. * @param type The type of the joint
  106727. * @param jointData The physica joint data for the joint
  106728. */
  106729. constructor(type: number, jointData: PhysicsJointData);
  106730. /**
  106731. * Set the motor values.
  106732. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106733. * @param force the force to apply
  106734. * @param maxForce max force for this motor.
  106735. */
  106736. setMotor(force?: number, maxForce?: number): void;
  106737. /**
  106738. * Set the motor's limits.
  106739. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106740. * @param upperLimit The upper limit of the motor
  106741. * @param lowerLimit The lower limit of the motor
  106742. */
  106743. setLimit(upperLimit: number, lowerLimit?: number): void;
  106744. }
  106745. /**
  106746. * This class represents a single physics Hinge-Joint
  106747. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106748. */
  106749. export class HingeJoint extends MotorEnabledJoint {
  106750. /**
  106751. * Initializes the Hinge-Joint
  106752. * @param jointData The joint data for the Hinge-Joint
  106753. */
  106754. constructor(jointData: PhysicsJointData);
  106755. /**
  106756. * Set the motor values.
  106757. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106758. * @param {number} force the force to apply
  106759. * @param {number} maxForce max force for this motor.
  106760. */
  106761. setMotor(force?: number, maxForce?: number): void;
  106762. /**
  106763. * Set the motor's limits.
  106764. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106765. * @param upperLimit The upper limit of the motor
  106766. * @param lowerLimit The lower limit of the motor
  106767. */
  106768. setLimit(upperLimit: number, lowerLimit?: number): void;
  106769. }
  106770. /**
  106771. * This class represents a dual hinge physics joint (same as wheel joint)
  106772. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106773. */
  106774. export class Hinge2Joint extends MotorEnabledJoint {
  106775. /**
  106776. * Initializes the Hinge2-Joint
  106777. * @param jointData The joint data for the Hinge2-Joint
  106778. */
  106779. constructor(jointData: PhysicsJointData);
  106780. /**
  106781. * Set the motor values.
  106782. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106783. * @param {number} targetSpeed the speed the motor is to reach
  106784. * @param {number} maxForce max force for this motor.
  106785. * @param {motorIndex} the motor's index, 0 or 1.
  106786. */
  106787. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106788. /**
  106789. * Set the motor limits.
  106790. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106791. * @param {number} upperLimit the upper limit
  106792. * @param {number} lowerLimit lower limit
  106793. * @param {motorIndex} the motor's index, 0 or 1.
  106794. */
  106795. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106796. }
  106797. /**
  106798. * Interface for a motor enabled joint
  106799. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106800. */
  106801. export interface IMotorEnabledJoint {
  106802. /**
  106803. * Physics joint
  106804. */
  106805. physicsJoint: any;
  106806. /**
  106807. * Sets the motor of the motor-enabled joint
  106808. * @param force The force of the motor
  106809. * @param maxForce The maximum force of the motor
  106810. * @param motorIndex The index of the motor
  106811. */
  106812. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106813. /**
  106814. * Sets the limit of the motor
  106815. * @param upperLimit The upper limit of the motor
  106816. * @param lowerLimit The lower limit of the motor
  106817. * @param motorIndex The index of the motor
  106818. */
  106819. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106820. }
  106821. /**
  106822. * Joint data for a Distance-Joint
  106823. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106824. */
  106825. export interface DistanceJointData extends PhysicsJointData {
  106826. /**
  106827. * Max distance the 2 joint objects can be apart
  106828. */
  106829. maxDistance: number;
  106830. }
  106831. /**
  106832. * Joint data from a spring joint
  106833. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106834. */
  106835. export interface SpringJointData extends PhysicsJointData {
  106836. /**
  106837. * Length of the spring
  106838. */
  106839. length: number;
  106840. /**
  106841. * Stiffness of the spring
  106842. */
  106843. stiffness: number;
  106844. /**
  106845. * Damping of the spring
  106846. */
  106847. damping: number;
  106848. /** this callback will be called when applying the force to the impostors. */
  106849. forceApplicationCallback: () => void;
  106850. }
  106851. }
  106852. declare module BABYLON {
  106853. /**
  106854. * Holds the data for the raycast result
  106855. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106856. */
  106857. export class PhysicsRaycastResult {
  106858. private _hasHit;
  106859. private _hitDistance;
  106860. private _hitNormalWorld;
  106861. private _hitPointWorld;
  106862. private _rayFromWorld;
  106863. private _rayToWorld;
  106864. /**
  106865. * Gets if there was a hit
  106866. */
  106867. get hasHit(): boolean;
  106868. /**
  106869. * Gets the distance from the hit
  106870. */
  106871. get hitDistance(): number;
  106872. /**
  106873. * Gets the hit normal/direction in the world
  106874. */
  106875. get hitNormalWorld(): Vector3;
  106876. /**
  106877. * Gets the hit point in the world
  106878. */
  106879. get hitPointWorld(): Vector3;
  106880. /**
  106881. * Gets the ray "start point" of the ray in the world
  106882. */
  106883. get rayFromWorld(): Vector3;
  106884. /**
  106885. * Gets the ray "end point" of the ray in the world
  106886. */
  106887. get rayToWorld(): Vector3;
  106888. /**
  106889. * Sets the hit data (normal & point in world space)
  106890. * @param hitNormalWorld defines the normal in world space
  106891. * @param hitPointWorld defines the point in world space
  106892. */
  106893. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106894. /**
  106895. * Sets the distance from the start point to the hit point
  106896. * @param distance
  106897. */
  106898. setHitDistance(distance: number): void;
  106899. /**
  106900. * Calculates the distance manually
  106901. */
  106902. calculateHitDistance(): void;
  106903. /**
  106904. * Resets all the values to default
  106905. * @param from The from point on world space
  106906. * @param to The to point on world space
  106907. */
  106908. reset(from?: Vector3, to?: Vector3): void;
  106909. }
  106910. /**
  106911. * Interface for the size containing width and height
  106912. */
  106913. interface IXYZ {
  106914. /**
  106915. * X
  106916. */
  106917. x: number;
  106918. /**
  106919. * Y
  106920. */
  106921. y: number;
  106922. /**
  106923. * Z
  106924. */
  106925. z: number;
  106926. }
  106927. }
  106928. declare module BABYLON {
  106929. /**
  106930. * Interface used to describe a physics joint
  106931. */
  106932. export interface PhysicsImpostorJoint {
  106933. /** Defines the main impostor to which the joint is linked */
  106934. mainImpostor: PhysicsImpostor;
  106935. /** Defines the impostor that is connected to the main impostor using this joint */
  106936. connectedImpostor: PhysicsImpostor;
  106937. /** Defines the joint itself */
  106938. joint: PhysicsJoint;
  106939. }
  106940. /** @hidden */
  106941. export interface IPhysicsEnginePlugin {
  106942. world: any;
  106943. name: string;
  106944. setGravity(gravity: Vector3): void;
  106945. setTimeStep(timeStep: number): void;
  106946. getTimeStep(): number;
  106947. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106948. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106949. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106950. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106951. removePhysicsBody(impostor: PhysicsImpostor): void;
  106952. generateJoint(joint: PhysicsImpostorJoint): void;
  106953. removeJoint(joint: PhysicsImpostorJoint): void;
  106954. isSupported(): boolean;
  106955. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106956. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106957. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106958. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106959. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106960. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106961. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106962. getBodyMass(impostor: PhysicsImpostor): number;
  106963. getBodyFriction(impostor: PhysicsImpostor): number;
  106964. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106965. getBodyRestitution(impostor: PhysicsImpostor): number;
  106966. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106967. getBodyPressure?(impostor: PhysicsImpostor): number;
  106968. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106969. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106970. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106971. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106972. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106973. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106974. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106975. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106976. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106977. sleepBody(impostor: PhysicsImpostor): void;
  106978. wakeUpBody(impostor: PhysicsImpostor): void;
  106979. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106980. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106981. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106982. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106983. getRadius(impostor: PhysicsImpostor): number;
  106984. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106985. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106986. dispose(): void;
  106987. }
  106988. /**
  106989. * Interface used to define a physics engine
  106990. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106991. */
  106992. export interface IPhysicsEngine {
  106993. /**
  106994. * Gets the gravity vector used by the simulation
  106995. */
  106996. gravity: Vector3;
  106997. /**
  106998. * Sets the gravity vector used by the simulation
  106999. * @param gravity defines the gravity vector to use
  107000. */
  107001. setGravity(gravity: Vector3): void;
  107002. /**
  107003. * Set the time step of the physics engine.
  107004. * Default is 1/60.
  107005. * To slow it down, enter 1/600 for example.
  107006. * To speed it up, 1/30
  107007. * @param newTimeStep the new timestep to apply to this world.
  107008. */
  107009. setTimeStep(newTimeStep: number): void;
  107010. /**
  107011. * Get the time step of the physics engine.
  107012. * @returns the current time step
  107013. */
  107014. getTimeStep(): number;
  107015. /**
  107016. * Set the sub time step of the physics engine.
  107017. * Default is 0 meaning there is no sub steps
  107018. * To increase physics resolution precision, set a small value (like 1 ms)
  107019. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107020. */
  107021. setSubTimeStep(subTimeStep: number): void;
  107022. /**
  107023. * Get the sub time step of the physics engine.
  107024. * @returns the current sub time step
  107025. */
  107026. getSubTimeStep(): number;
  107027. /**
  107028. * Release all resources
  107029. */
  107030. dispose(): void;
  107031. /**
  107032. * Gets the name of the current physics plugin
  107033. * @returns the name of the plugin
  107034. */
  107035. getPhysicsPluginName(): string;
  107036. /**
  107037. * Adding a new impostor for the impostor tracking.
  107038. * This will be done by the impostor itself.
  107039. * @param impostor the impostor to add
  107040. */
  107041. addImpostor(impostor: PhysicsImpostor): void;
  107042. /**
  107043. * Remove an impostor from the engine.
  107044. * This impostor and its mesh will not longer be updated by the physics engine.
  107045. * @param impostor the impostor to remove
  107046. */
  107047. removeImpostor(impostor: PhysicsImpostor): void;
  107048. /**
  107049. * Add a joint to the physics engine
  107050. * @param mainImpostor defines the main impostor to which the joint is added.
  107051. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107052. * @param joint defines the joint that will connect both impostors.
  107053. */
  107054. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107055. /**
  107056. * Removes a joint from the simulation
  107057. * @param mainImpostor defines the impostor used with the joint
  107058. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107059. * @param joint defines the joint to remove
  107060. */
  107061. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107062. /**
  107063. * Gets the current plugin used to run the simulation
  107064. * @returns current plugin
  107065. */
  107066. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107067. /**
  107068. * Gets the list of physic impostors
  107069. * @returns an array of PhysicsImpostor
  107070. */
  107071. getImpostors(): Array<PhysicsImpostor>;
  107072. /**
  107073. * Gets the impostor for a physics enabled object
  107074. * @param object defines the object impersonated by the impostor
  107075. * @returns the PhysicsImpostor or null if not found
  107076. */
  107077. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107078. /**
  107079. * Gets the impostor for a physics body object
  107080. * @param body defines physics body used by the impostor
  107081. * @returns the PhysicsImpostor or null if not found
  107082. */
  107083. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107084. /**
  107085. * Does a raycast in the physics world
  107086. * @param from when should the ray start?
  107087. * @param to when should the ray end?
  107088. * @returns PhysicsRaycastResult
  107089. */
  107090. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107091. /**
  107092. * Called by the scene. No need to call it.
  107093. * @param delta defines the timespam between frames
  107094. */
  107095. _step(delta: number): void;
  107096. }
  107097. }
  107098. declare module BABYLON {
  107099. /**
  107100. * The interface for the physics imposter parameters
  107101. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107102. */
  107103. export interface PhysicsImpostorParameters {
  107104. /**
  107105. * The mass of the physics imposter
  107106. */
  107107. mass: number;
  107108. /**
  107109. * The friction of the physics imposter
  107110. */
  107111. friction?: number;
  107112. /**
  107113. * The coefficient of restitution of the physics imposter
  107114. */
  107115. restitution?: number;
  107116. /**
  107117. * The native options of the physics imposter
  107118. */
  107119. nativeOptions?: any;
  107120. /**
  107121. * Specifies if the parent should be ignored
  107122. */
  107123. ignoreParent?: boolean;
  107124. /**
  107125. * Specifies if bi-directional transformations should be disabled
  107126. */
  107127. disableBidirectionalTransformation?: boolean;
  107128. /**
  107129. * The pressure inside the physics imposter, soft object only
  107130. */
  107131. pressure?: number;
  107132. /**
  107133. * The stiffness the physics imposter, soft object only
  107134. */
  107135. stiffness?: number;
  107136. /**
  107137. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107138. */
  107139. velocityIterations?: number;
  107140. /**
  107141. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107142. */
  107143. positionIterations?: number;
  107144. /**
  107145. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107146. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107147. * Add to fix multiple points
  107148. */
  107149. fixedPoints?: number;
  107150. /**
  107151. * The collision margin around a soft object
  107152. */
  107153. margin?: number;
  107154. /**
  107155. * The collision margin around a soft object
  107156. */
  107157. damping?: number;
  107158. /**
  107159. * The path for a rope based on an extrusion
  107160. */
  107161. path?: any;
  107162. /**
  107163. * The shape of an extrusion used for a rope based on an extrusion
  107164. */
  107165. shape?: any;
  107166. }
  107167. /**
  107168. * Interface for a physics-enabled object
  107169. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107170. */
  107171. export interface IPhysicsEnabledObject {
  107172. /**
  107173. * The position of the physics-enabled object
  107174. */
  107175. position: Vector3;
  107176. /**
  107177. * The rotation of the physics-enabled object
  107178. */
  107179. rotationQuaternion: Nullable<Quaternion>;
  107180. /**
  107181. * The scale of the physics-enabled object
  107182. */
  107183. scaling: Vector3;
  107184. /**
  107185. * The rotation of the physics-enabled object
  107186. */
  107187. rotation?: Vector3;
  107188. /**
  107189. * The parent of the physics-enabled object
  107190. */
  107191. parent?: any;
  107192. /**
  107193. * The bounding info of the physics-enabled object
  107194. * @returns The bounding info of the physics-enabled object
  107195. */
  107196. getBoundingInfo(): BoundingInfo;
  107197. /**
  107198. * Computes the world matrix
  107199. * @param force Specifies if the world matrix should be computed by force
  107200. * @returns A world matrix
  107201. */
  107202. computeWorldMatrix(force: boolean): Matrix;
  107203. /**
  107204. * Gets the world matrix
  107205. * @returns A world matrix
  107206. */
  107207. getWorldMatrix?(): Matrix;
  107208. /**
  107209. * Gets the child meshes
  107210. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107211. * @returns An array of abstract meshes
  107212. */
  107213. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107214. /**
  107215. * Gets the vertex data
  107216. * @param kind The type of vertex data
  107217. * @returns A nullable array of numbers, or a float32 array
  107218. */
  107219. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107220. /**
  107221. * Gets the indices from the mesh
  107222. * @returns A nullable array of index arrays
  107223. */
  107224. getIndices?(): Nullable<IndicesArray>;
  107225. /**
  107226. * Gets the scene from the mesh
  107227. * @returns the indices array or null
  107228. */
  107229. getScene?(): Scene;
  107230. /**
  107231. * Gets the absolute position from the mesh
  107232. * @returns the absolute position
  107233. */
  107234. getAbsolutePosition(): Vector3;
  107235. /**
  107236. * Gets the absolute pivot point from the mesh
  107237. * @returns the absolute pivot point
  107238. */
  107239. getAbsolutePivotPoint(): Vector3;
  107240. /**
  107241. * Rotates the mesh
  107242. * @param axis The axis of rotation
  107243. * @param amount The amount of rotation
  107244. * @param space The space of the rotation
  107245. * @returns The rotation transform node
  107246. */
  107247. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107248. /**
  107249. * Translates the mesh
  107250. * @param axis The axis of translation
  107251. * @param distance The distance of translation
  107252. * @param space The space of the translation
  107253. * @returns The transform node
  107254. */
  107255. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107256. /**
  107257. * Sets the absolute position of the mesh
  107258. * @param absolutePosition The absolute position of the mesh
  107259. * @returns The transform node
  107260. */
  107261. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107262. /**
  107263. * Gets the class name of the mesh
  107264. * @returns The class name
  107265. */
  107266. getClassName(): string;
  107267. }
  107268. /**
  107269. * Represents a physics imposter
  107270. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107271. */
  107272. export class PhysicsImpostor {
  107273. /**
  107274. * The physics-enabled object used as the physics imposter
  107275. */
  107276. object: IPhysicsEnabledObject;
  107277. /**
  107278. * The type of the physics imposter
  107279. */
  107280. type: number;
  107281. private _options;
  107282. private _scene?;
  107283. /**
  107284. * The default object size of the imposter
  107285. */
  107286. static DEFAULT_OBJECT_SIZE: Vector3;
  107287. /**
  107288. * The identity quaternion of the imposter
  107289. */
  107290. static IDENTITY_QUATERNION: Quaternion;
  107291. /** @hidden */
  107292. _pluginData: any;
  107293. private _physicsEngine;
  107294. private _physicsBody;
  107295. private _bodyUpdateRequired;
  107296. private _onBeforePhysicsStepCallbacks;
  107297. private _onAfterPhysicsStepCallbacks;
  107298. /** @hidden */
  107299. _onPhysicsCollideCallbacks: Array<{
  107300. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107301. otherImpostors: Array<PhysicsImpostor>;
  107302. }>;
  107303. private _deltaPosition;
  107304. private _deltaRotation;
  107305. private _deltaRotationConjugated;
  107306. /** @hidden */
  107307. _isFromLine: boolean;
  107308. private _parent;
  107309. private _isDisposed;
  107310. private static _tmpVecs;
  107311. private static _tmpQuat;
  107312. /**
  107313. * Specifies if the physics imposter is disposed
  107314. */
  107315. get isDisposed(): boolean;
  107316. /**
  107317. * Gets the mass of the physics imposter
  107318. */
  107319. get mass(): number;
  107320. set mass(value: number);
  107321. /**
  107322. * Gets the coefficient of friction
  107323. */
  107324. get friction(): number;
  107325. /**
  107326. * Sets the coefficient of friction
  107327. */
  107328. set friction(value: number);
  107329. /**
  107330. * Gets the coefficient of restitution
  107331. */
  107332. get restitution(): number;
  107333. /**
  107334. * Sets the coefficient of restitution
  107335. */
  107336. set restitution(value: number);
  107337. /**
  107338. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107339. */
  107340. get pressure(): number;
  107341. /**
  107342. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107343. */
  107344. set pressure(value: number);
  107345. /**
  107346. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107347. */
  107348. get stiffness(): number;
  107349. /**
  107350. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107351. */
  107352. set stiffness(value: number);
  107353. /**
  107354. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107355. */
  107356. get velocityIterations(): number;
  107357. /**
  107358. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107359. */
  107360. set velocityIterations(value: number);
  107361. /**
  107362. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107363. */
  107364. get positionIterations(): number;
  107365. /**
  107366. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107367. */
  107368. set positionIterations(value: number);
  107369. /**
  107370. * The unique id of the physics imposter
  107371. * set by the physics engine when adding this impostor to the array
  107372. */
  107373. uniqueId: number;
  107374. /**
  107375. * @hidden
  107376. */
  107377. soft: boolean;
  107378. /**
  107379. * @hidden
  107380. */
  107381. segments: number;
  107382. private _joints;
  107383. /**
  107384. * Initializes the physics imposter
  107385. * @param object The physics-enabled object used as the physics imposter
  107386. * @param type The type of the physics imposter
  107387. * @param _options The options for the physics imposter
  107388. * @param _scene The Babylon scene
  107389. */
  107390. constructor(
  107391. /**
  107392. * The physics-enabled object used as the physics imposter
  107393. */
  107394. object: IPhysicsEnabledObject,
  107395. /**
  107396. * The type of the physics imposter
  107397. */
  107398. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107399. /**
  107400. * This function will completly initialize this impostor.
  107401. * It will create a new body - but only if this mesh has no parent.
  107402. * If it has, this impostor will not be used other than to define the impostor
  107403. * of the child mesh.
  107404. * @hidden
  107405. */
  107406. _init(): void;
  107407. private _getPhysicsParent;
  107408. /**
  107409. * Should a new body be generated.
  107410. * @returns boolean specifying if body initialization is required
  107411. */
  107412. isBodyInitRequired(): boolean;
  107413. /**
  107414. * Sets the updated scaling
  107415. * @param updated Specifies if the scaling is updated
  107416. */
  107417. setScalingUpdated(): void;
  107418. /**
  107419. * Force a regeneration of this or the parent's impostor's body.
  107420. * Use under cautious - This will remove all joints already implemented.
  107421. */
  107422. forceUpdate(): void;
  107423. /**
  107424. * Gets the body that holds this impostor. Either its own, or its parent.
  107425. */
  107426. get physicsBody(): any;
  107427. /**
  107428. * Get the parent of the physics imposter
  107429. * @returns Physics imposter or null
  107430. */
  107431. get parent(): Nullable<PhysicsImpostor>;
  107432. /**
  107433. * Sets the parent of the physics imposter
  107434. */
  107435. set parent(value: Nullable<PhysicsImpostor>);
  107436. /**
  107437. * Set the physics body. Used mainly by the physics engine/plugin
  107438. */
  107439. set physicsBody(physicsBody: any);
  107440. /**
  107441. * Resets the update flags
  107442. */
  107443. resetUpdateFlags(): void;
  107444. /**
  107445. * Gets the object extend size
  107446. * @returns the object extend size
  107447. */
  107448. getObjectExtendSize(): Vector3;
  107449. /**
  107450. * Gets the object center
  107451. * @returns The object center
  107452. */
  107453. getObjectCenter(): Vector3;
  107454. /**
  107455. * Get a specific parameter from the options parameters
  107456. * @param paramName The object parameter name
  107457. * @returns The object parameter
  107458. */
  107459. getParam(paramName: string): any;
  107460. /**
  107461. * Sets a specific parameter in the options given to the physics plugin
  107462. * @param paramName The parameter name
  107463. * @param value The value of the parameter
  107464. */
  107465. setParam(paramName: string, value: number): void;
  107466. /**
  107467. * Specifically change the body's mass option. Won't recreate the physics body object
  107468. * @param mass The mass of the physics imposter
  107469. */
  107470. setMass(mass: number): void;
  107471. /**
  107472. * Gets the linear velocity
  107473. * @returns linear velocity or null
  107474. */
  107475. getLinearVelocity(): Nullable<Vector3>;
  107476. /**
  107477. * Sets the linear velocity
  107478. * @param velocity linear velocity or null
  107479. */
  107480. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107481. /**
  107482. * Gets the angular velocity
  107483. * @returns angular velocity or null
  107484. */
  107485. getAngularVelocity(): Nullable<Vector3>;
  107486. /**
  107487. * Sets the angular velocity
  107488. * @param velocity The velocity or null
  107489. */
  107490. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107491. /**
  107492. * Execute a function with the physics plugin native code
  107493. * Provide a function the will have two variables - the world object and the physics body object
  107494. * @param func The function to execute with the physics plugin native code
  107495. */
  107496. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107497. /**
  107498. * Register a function that will be executed before the physics world is stepping forward
  107499. * @param func The function to execute before the physics world is stepped forward
  107500. */
  107501. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107502. /**
  107503. * Unregister a function that will be executed before the physics world is stepping forward
  107504. * @param func The function to execute before the physics world is stepped forward
  107505. */
  107506. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107507. /**
  107508. * Register a function that will be executed after the physics step
  107509. * @param func The function to execute after physics step
  107510. */
  107511. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107512. /**
  107513. * Unregisters a function that will be executed after the physics step
  107514. * @param func The function to execute after physics step
  107515. */
  107516. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107517. /**
  107518. * register a function that will be executed when this impostor collides against a different body
  107519. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107520. * @param func Callback that is executed on collision
  107521. */
  107522. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107523. /**
  107524. * Unregisters the physics imposter on contact
  107525. * @param collideAgainst The physics object to collide against
  107526. * @param func Callback to execute on collision
  107527. */
  107528. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107529. private _tmpQuat;
  107530. private _tmpQuat2;
  107531. /**
  107532. * Get the parent rotation
  107533. * @returns The parent rotation
  107534. */
  107535. getParentsRotation(): Quaternion;
  107536. /**
  107537. * this function is executed by the physics engine.
  107538. */
  107539. beforeStep: () => void;
  107540. /**
  107541. * this function is executed by the physics engine
  107542. */
  107543. afterStep: () => void;
  107544. /**
  107545. * Legacy collision detection event support
  107546. */
  107547. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107548. /**
  107549. * event and body object due to cannon's event-based architecture.
  107550. */
  107551. onCollide: (e: {
  107552. body: any;
  107553. }) => void;
  107554. /**
  107555. * Apply a force
  107556. * @param force The force to apply
  107557. * @param contactPoint The contact point for the force
  107558. * @returns The physics imposter
  107559. */
  107560. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107561. /**
  107562. * Apply an impulse
  107563. * @param force The impulse force
  107564. * @param contactPoint The contact point for the impulse force
  107565. * @returns The physics imposter
  107566. */
  107567. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107568. /**
  107569. * A help function to create a joint
  107570. * @param otherImpostor A physics imposter used to create a joint
  107571. * @param jointType The type of joint
  107572. * @param jointData The data for the joint
  107573. * @returns The physics imposter
  107574. */
  107575. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107576. /**
  107577. * Add a joint to this impostor with a different impostor
  107578. * @param otherImpostor A physics imposter used to add a joint
  107579. * @param joint The joint to add
  107580. * @returns The physics imposter
  107581. */
  107582. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107583. /**
  107584. * Add an anchor to a cloth impostor
  107585. * @param otherImpostor rigid impostor to anchor to
  107586. * @param width ratio across width from 0 to 1
  107587. * @param height ratio up height from 0 to 1
  107588. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107589. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107590. * @returns impostor the soft imposter
  107591. */
  107592. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107593. /**
  107594. * Add a hook to a rope impostor
  107595. * @param otherImpostor rigid impostor to anchor to
  107596. * @param length ratio across rope from 0 to 1
  107597. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107598. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107599. * @returns impostor the rope imposter
  107600. */
  107601. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107602. /**
  107603. * Will keep this body still, in a sleep mode.
  107604. * @returns the physics imposter
  107605. */
  107606. sleep(): PhysicsImpostor;
  107607. /**
  107608. * Wake the body up.
  107609. * @returns The physics imposter
  107610. */
  107611. wakeUp(): PhysicsImpostor;
  107612. /**
  107613. * Clones the physics imposter
  107614. * @param newObject The physics imposter clones to this physics-enabled object
  107615. * @returns A nullable physics imposter
  107616. */
  107617. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107618. /**
  107619. * Disposes the physics imposter
  107620. */
  107621. dispose(): void;
  107622. /**
  107623. * Sets the delta position
  107624. * @param position The delta position amount
  107625. */
  107626. setDeltaPosition(position: Vector3): void;
  107627. /**
  107628. * Sets the delta rotation
  107629. * @param rotation The delta rotation amount
  107630. */
  107631. setDeltaRotation(rotation: Quaternion): void;
  107632. /**
  107633. * Gets the box size of the physics imposter and stores the result in the input parameter
  107634. * @param result Stores the box size
  107635. * @returns The physics imposter
  107636. */
  107637. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107638. /**
  107639. * Gets the radius of the physics imposter
  107640. * @returns Radius of the physics imposter
  107641. */
  107642. getRadius(): number;
  107643. /**
  107644. * Sync a bone with this impostor
  107645. * @param bone The bone to sync to the impostor.
  107646. * @param boneMesh The mesh that the bone is influencing.
  107647. * @param jointPivot The pivot of the joint / bone in local space.
  107648. * @param distToJoint Optional distance from the impostor to the joint.
  107649. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107650. */
  107651. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107652. /**
  107653. * Sync impostor to a bone
  107654. * @param bone The bone that the impostor will be synced to.
  107655. * @param boneMesh The mesh that the bone is influencing.
  107656. * @param jointPivot The pivot of the joint / bone in local space.
  107657. * @param distToJoint Optional distance from the impostor to the joint.
  107658. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107659. * @param boneAxis Optional vector3 axis the bone is aligned with
  107660. */
  107661. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107662. /**
  107663. * No-Imposter type
  107664. */
  107665. static NoImpostor: number;
  107666. /**
  107667. * Sphere-Imposter type
  107668. */
  107669. static SphereImpostor: number;
  107670. /**
  107671. * Box-Imposter type
  107672. */
  107673. static BoxImpostor: number;
  107674. /**
  107675. * Plane-Imposter type
  107676. */
  107677. static PlaneImpostor: number;
  107678. /**
  107679. * Mesh-imposter type
  107680. */
  107681. static MeshImpostor: number;
  107682. /**
  107683. * Capsule-Impostor type (Ammo.js plugin only)
  107684. */
  107685. static CapsuleImpostor: number;
  107686. /**
  107687. * Cylinder-Imposter type
  107688. */
  107689. static CylinderImpostor: number;
  107690. /**
  107691. * Particle-Imposter type
  107692. */
  107693. static ParticleImpostor: number;
  107694. /**
  107695. * Heightmap-Imposter type
  107696. */
  107697. static HeightmapImpostor: number;
  107698. /**
  107699. * ConvexHull-Impostor type (Ammo.js plugin only)
  107700. */
  107701. static ConvexHullImpostor: number;
  107702. /**
  107703. * Custom-Imposter type (Ammo.js plugin only)
  107704. */
  107705. static CustomImpostor: number;
  107706. /**
  107707. * Rope-Imposter type
  107708. */
  107709. static RopeImpostor: number;
  107710. /**
  107711. * Cloth-Imposter type
  107712. */
  107713. static ClothImpostor: number;
  107714. /**
  107715. * Softbody-Imposter type
  107716. */
  107717. static SoftbodyImpostor: number;
  107718. }
  107719. }
  107720. declare module BABYLON {
  107721. /**
  107722. * @hidden
  107723. **/
  107724. export class _CreationDataStorage {
  107725. closePath?: boolean;
  107726. closeArray?: boolean;
  107727. idx: number[];
  107728. dashSize: number;
  107729. gapSize: number;
  107730. path3D: Path3D;
  107731. pathArray: Vector3[][];
  107732. arc: number;
  107733. radius: number;
  107734. cap: number;
  107735. tessellation: number;
  107736. }
  107737. /**
  107738. * @hidden
  107739. **/
  107740. class _InstanceDataStorage {
  107741. visibleInstances: any;
  107742. batchCache: _InstancesBatch;
  107743. instancesBufferSize: number;
  107744. instancesBuffer: Nullable<Buffer>;
  107745. instancesData: Float32Array;
  107746. overridenInstanceCount: number;
  107747. isFrozen: boolean;
  107748. previousBatch: Nullable<_InstancesBatch>;
  107749. hardwareInstancedRendering: boolean;
  107750. sideOrientation: number;
  107751. manualUpdate: boolean;
  107752. }
  107753. /**
  107754. * @hidden
  107755. **/
  107756. export class _InstancesBatch {
  107757. mustReturn: boolean;
  107758. visibleInstances: Nullable<InstancedMesh[]>[];
  107759. renderSelf: boolean[];
  107760. hardwareInstancedRendering: boolean[];
  107761. }
  107762. /**
  107763. * @hidden
  107764. **/
  107765. class _ThinInstanceDataStorage {
  107766. instancesCount: number;
  107767. matrixBuffer: Nullable<Buffer>;
  107768. matrixBufferSize: number;
  107769. matrixData: Nullable<Float32Array>;
  107770. boundingVectors: Array<Vector3>;
  107771. worldMatrices: Nullable<Matrix[]>;
  107772. }
  107773. /**
  107774. * Class used to represent renderable models
  107775. */
  107776. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107777. /**
  107778. * Mesh side orientation : usually the external or front surface
  107779. */
  107780. static readonly FRONTSIDE: number;
  107781. /**
  107782. * Mesh side orientation : usually the internal or back surface
  107783. */
  107784. static readonly BACKSIDE: number;
  107785. /**
  107786. * Mesh side orientation : both internal and external or front and back surfaces
  107787. */
  107788. static readonly DOUBLESIDE: number;
  107789. /**
  107790. * Mesh side orientation : by default, `FRONTSIDE`
  107791. */
  107792. static readonly DEFAULTSIDE: number;
  107793. /**
  107794. * Mesh cap setting : no cap
  107795. */
  107796. static readonly NO_CAP: number;
  107797. /**
  107798. * Mesh cap setting : one cap at the beginning of the mesh
  107799. */
  107800. static readonly CAP_START: number;
  107801. /**
  107802. * Mesh cap setting : one cap at the end of the mesh
  107803. */
  107804. static readonly CAP_END: number;
  107805. /**
  107806. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107807. */
  107808. static readonly CAP_ALL: number;
  107809. /**
  107810. * Mesh pattern setting : no flip or rotate
  107811. */
  107812. static readonly NO_FLIP: number;
  107813. /**
  107814. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107815. */
  107816. static readonly FLIP_TILE: number;
  107817. /**
  107818. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107819. */
  107820. static readonly ROTATE_TILE: number;
  107821. /**
  107822. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107823. */
  107824. static readonly FLIP_ROW: number;
  107825. /**
  107826. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107827. */
  107828. static readonly ROTATE_ROW: number;
  107829. /**
  107830. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107831. */
  107832. static readonly FLIP_N_ROTATE_TILE: number;
  107833. /**
  107834. * Mesh pattern setting : rotate pattern and rotate
  107835. */
  107836. static readonly FLIP_N_ROTATE_ROW: number;
  107837. /**
  107838. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107839. */
  107840. static readonly CENTER: number;
  107841. /**
  107842. * Mesh tile positioning : part tiles on left
  107843. */
  107844. static readonly LEFT: number;
  107845. /**
  107846. * Mesh tile positioning : part tiles on right
  107847. */
  107848. static readonly RIGHT: number;
  107849. /**
  107850. * Mesh tile positioning : part tiles on top
  107851. */
  107852. static readonly TOP: number;
  107853. /**
  107854. * Mesh tile positioning : part tiles on bottom
  107855. */
  107856. static readonly BOTTOM: number;
  107857. /**
  107858. * Gets the default side orientation.
  107859. * @param orientation the orientation to value to attempt to get
  107860. * @returns the default orientation
  107861. * @hidden
  107862. */
  107863. static _GetDefaultSideOrientation(orientation?: number): number;
  107864. private _internalMeshDataInfo;
  107865. get computeBonesUsingShaders(): boolean;
  107866. set computeBonesUsingShaders(value: boolean);
  107867. /**
  107868. * An event triggered before rendering the mesh
  107869. */
  107870. get onBeforeRenderObservable(): Observable<Mesh>;
  107871. /**
  107872. * An event triggered before binding the mesh
  107873. */
  107874. get onBeforeBindObservable(): Observable<Mesh>;
  107875. /**
  107876. * An event triggered after rendering the mesh
  107877. */
  107878. get onAfterRenderObservable(): Observable<Mesh>;
  107879. /**
  107880. * An event triggered before drawing the mesh
  107881. */
  107882. get onBeforeDrawObservable(): Observable<Mesh>;
  107883. private _onBeforeDrawObserver;
  107884. /**
  107885. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107886. */
  107887. set onBeforeDraw(callback: () => void);
  107888. get hasInstances(): boolean;
  107889. get hasThinInstances(): boolean;
  107890. /**
  107891. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107892. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107893. */
  107894. delayLoadState: number;
  107895. /**
  107896. * Gets the list of instances created from this mesh
  107897. * it is not supposed to be modified manually.
  107898. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107899. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107900. */
  107901. instances: InstancedMesh[];
  107902. /**
  107903. * Gets the file containing delay loading data for this mesh
  107904. */
  107905. delayLoadingFile: string;
  107906. /** @hidden */
  107907. _binaryInfo: any;
  107908. /**
  107909. * User defined function used to change how LOD level selection is done
  107910. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107911. */
  107912. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107913. /**
  107914. * Gets or sets the morph target manager
  107915. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107916. */
  107917. get morphTargetManager(): Nullable<MorphTargetManager>;
  107918. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107919. /** @hidden */
  107920. _creationDataStorage: Nullable<_CreationDataStorage>;
  107921. /** @hidden */
  107922. _geometry: Nullable<Geometry>;
  107923. /** @hidden */
  107924. _delayInfo: Array<string>;
  107925. /** @hidden */
  107926. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107927. /** @hidden */
  107928. _instanceDataStorage: _InstanceDataStorage;
  107929. /** @hidden */
  107930. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107931. private _effectiveMaterial;
  107932. /** @hidden */
  107933. _shouldGenerateFlatShading: boolean;
  107934. /** @hidden */
  107935. _originalBuilderSideOrientation: number;
  107936. /**
  107937. * Use this property to change the original side orientation defined at construction time
  107938. */
  107939. overrideMaterialSideOrientation: Nullable<number>;
  107940. /**
  107941. * Gets the source mesh (the one used to clone this one from)
  107942. */
  107943. get source(): Nullable<Mesh>;
  107944. /**
  107945. * Gets the list of clones of this mesh
  107946. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  107947. * Note that useClonedMeshMap=true is the default setting
  107948. */
  107949. get cloneMeshMap(): Nullable<{
  107950. [id: string]: Mesh | undefined;
  107951. }>;
  107952. /**
  107953. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107954. */
  107955. get isUnIndexed(): boolean;
  107956. set isUnIndexed(value: boolean);
  107957. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107958. get worldMatrixInstancedBuffer(): Float32Array;
  107959. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107960. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107961. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107962. /**
  107963. * @constructor
  107964. * @param name The value used by scene.getMeshByName() to do a lookup.
  107965. * @param scene The scene to add this mesh to.
  107966. * @param parent The parent of this mesh, if it has one
  107967. * @param source An optional Mesh from which geometry is shared, cloned.
  107968. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107969. * When false, achieved by calling a clone(), also passing False.
  107970. * This will make creation of children, recursive.
  107971. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107972. */
  107973. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107974. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107975. doNotInstantiate: boolean;
  107976. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107977. /**
  107978. * Gets the class name
  107979. * @returns the string "Mesh".
  107980. */
  107981. getClassName(): string;
  107982. /** @hidden */
  107983. get _isMesh(): boolean;
  107984. /**
  107985. * Returns a description of this mesh
  107986. * @param fullDetails define if full details about this mesh must be used
  107987. * @returns a descriptive string representing this mesh
  107988. */
  107989. toString(fullDetails?: boolean): string;
  107990. /** @hidden */
  107991. _unBindEffect(): void;
  107992. /**
  107993. * Gets a boolean indicating if this mesh has LOD
  107994. */
  107995. get hasLODLevels(): boolean;
  107996. /**
  107997. * Gets the list of MeshLODLevel associated with the current mesh
  107998. * @returns an array of MeshLODLevel
  107999. */
  108000. getLODLevels(): MeshLODLevel[];
  108001. private _sortLODLevels;
  108002. /**
  108003. * Add a mesh as LOD level triggered at the given distance.
  108004. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108005. * @param distance The distance from the center of the object to show this level
  108006. * @param mesh The mesh to be added as LOD level (can be null)
  108007. * @return This mesh (for chaining)
  108008. */
  108009. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  108010. /**
  108011. * Returns the LOD level mesh at the passed distance or null if not found.
  108012. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108013. * @param distance The distance from the center of the object to show this level
  108014. * @returns a Mesh or `null`
  108015. */
  108016. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108017. /**
  108018. * Remove a mesh from the LOD array
  108019. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108020. * @param mesh defines the mesh to be removed
  108021. * @return This mesh (for chaining)
  108022. */
  108023. removeLODLevel(mesh: Mesh): Mesh;
  108024. /**
  108025. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108026. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108027. * @param camera defines the camera to use to compute distance
  108028. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108029. * @return This mesh (for chaining)
  108030. */
  108031. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108032. /**
  108033. * Gets the mesh internal Geometry object
  108034. */
  108035. get geometry(): Nullable<Geometry>;
  108036. /**
  108037. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108038. * @returns the total number of vertices
  108039. */
  108040. getTotalVertices(): number;
  108041. /**
  108042. * Returns the content of an associated vertex buffer
  108043. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108044. * - VertexBuffer.PositionKind
  108045. * - VertexBuffer.UVKind
  108046. * - VertexBuffer.UV2Kind
  108047. * - VertexBuffer.UV3Kind
  108048. * - VertexBuffer.UV4Kind
  108049. * - VertexBuffer.UV5Kind
  108050. * - VertexBuffer.UV6Kind
  108051. * - VertexBuffer.ColorKind
  108052. * - VertexBuffer.MatricesIndicesKind
  108053. * - VertexBuffer.MatricesIndicesExtraKind
  108054. * - VertexBuffer.MatricesWeightsKind
  108055. * - VertexBuffer.MatricesWeightsExtraKind
  108056. * @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
  108057. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108058. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108059. */
  108060. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108061. /**
  108062. * Returns the mesh VertexBuffer object from the requested `kind`
  108063. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108064. * - VertexBuffer.PositionKind
  108065. * - VertexBuffer.NormalKind
  108066. * - VertexBuffer.UVKind
  108067. * - VertexBuffer.UV2Kind
  108068. * - VertexBuffer.UV3Kind
  108069. * - VertexBuffer.UV4Kind
  108070. * - VertexBuffer.UV5Kind
  108071. * - VertexBuffer.UV6Kind
  108072. * - VertexBuffer.ColorKind
  108073. * - VertexBuffer.MatricesIndicesKind
  108074. * - VertexBuffer.MatricesIndicesExtraKind
  108075. * - VertexBuffer.MatricesWeightsKind
  108076. * - VertexBuffer.MatricesWeightsExtraKind
  108077. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108078. */
  108079. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108080. /**
  108081. * Tests if a specific vertex buffer is associated with this mesh
  108082. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108083. * - VertexBuffer.PositionKind
  108084. * - VertexBuffer.NormalKind
  108085. * - VertexBuffer.UVKind
  108086. * - VertexBuffer.UV2Kind
  108087. * - VertexBuffer.UV3Kind
  108088. * - VertexBuffer.UV4Kind
  108089. * - VertexBuffer.UV5Kind
  108090. * - VertexBuffer.UV6Kind
  108091. * - VertexBuffer.ColorKind
  108092. * - VertexBuffer.MatricesIndicesKind
  108093. * - VertexBuffer.MatricesIndicesExtraKind
  108094. * - VertexBuffer.MatricesWeightsKind
  108095. * - VertexBuffer.MatricesWeightsExtraKind
  108096. * @returns a boolean
  108097. */
  108098. isVerticesDataPresent(kind: string): boolean;
  108099. /**
  108100. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108101. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108102. * - VertexBuffer.PositionKind
  108103. * - VertexBuffer.UVKind
  108104. * - VertexBuffer.UV2Kind
  108105. * - VertexBuffer.UV3Kind
  108106. * - VertexBuffer.UV4Kind
  108107. * - VertexBuffer.UV5Kind
  108108. * - VertexBuffer.UV6Kind
  108109. * - VertexBuffer.ColorKind
  108110. * - VertexBuffer.MatricesIndicesKind
  108111. * - VertexBuffer.MatricesIndicesExtraKind
  108112. * - VertexBuffer.MatricesWeightsKind
  108113. * - VertexBuffer.MatricesWeightsExtraKind
  108114. * @returns a boolean
  108115. */
  108116. isVertexBufferUpdatable(kind: string): boolean;
  108117. /**
  108118. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108119. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108120. * - VertexBuffer.PositionKind
  108121. * - VertexBuffer.NormalKind
  108122. * - VertexBuffer.UVKind
  108123. * - VertexBuffer.UV2Kind
  108124. * - VertexBuffer.UV3Kind
  108125. * - VertexBuffer.UV4Kind
  108126. * - VertexBuffer.UV5Kind
  108127. * - VertexBuffer.UV6Kind
  108128. * - VertexBuffer.ColorKind
  108129. * - VertexBuffer.MatricesIndicesKind
  108130. * - VertexBuffer.MatricesIndicesExtraKind
  108131. * - VertexBuffer.MatricesWeightsKind
  108132. * - VertexBuffer.MatricesWeightsExtraKind
  108133. * @returns an array of strings
  108134. */
  108135. getVerticesDataKinds(): string[];
  108136. /**
  108137. * Returns a positive integer : the total number of indices in this mesh geometry.
  108138. * @returns the numner of indices or zero if the mesh has no geometry.
  108139. */
  108140. getTotalIndices(): number;
  108141. /**
  108142. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108143. * @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.
  108144. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108145. * @returns the indices array or an empty array if the mesh has no geometry
  108146. */
  108147. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108148. get isBlocked(): boolean;
  108149. /**
  108150. * Determine if the current mesh is ready to be rendered
  108151. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108152. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108153. * @returns true if all associated assets are ready (material, textures, shaders)
  108154. */
  108155. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108156. /**
  108157. * 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.
  108158. */
  108159. get areNormalsFrozen(): boolean;
  108160. /**
  108161. * 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.
  108162. * @returns the current mesh
  108163. */
  108164. freezeNormals(): Mesh;
  108165. /**
  108166. * 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
  108167. * @returns the current mesh
  108168. */
  108169. unfreezeNormals(): Mesh;
  108170. /**
  108171. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108172. */
  108173. set overridenInstanceCount(count: number);
  108174. /** @hidden */
  108175. _preActivate(): Mesh;
  108176. /** @hidden */
  108177. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108178. /** @hidden */
  108179. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108180. protected _afterComputeWorldMatrix(): void;
  108181. /** @hidden */
  108182. _postActivate(): void;
  108183. /**
  108184. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108185. * This means the mesh underlying bounding box and sphere are recomputed.
  108186. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108187. * @returns the current mesh
  108188. */
  108189. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108190. /** @hidden */
  108191. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108192. /**
  108193. * This function will subdivide the mesh into multiple submeshes
  108194. * @param count defines the expected number of submeshes
  108195. */
  108196. subdivide(count: number): void;
  108197. /**
  108198. * Copy a FloatArray into a specific associated vertex buffer
  108199. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108200. * - VertexBuffer.PositionKind
  108201. * - VertexBuffer.UVKind
  108202. * - VertexBuffer.UV2Kind
  108203. * - VertexBuffer.UV3Kind
  108204. * - VertexBuffer.UV4Kind
  108205. * - VertexBuffer.UV5Kind
  108206. * - VertexBuffer.UV6Kind
  108207. * - VertexBuffer.ColorKind
  108208. * - VertexBuffer.MatricesIndicesKind
  108209. * - VertexBuffer.MatricesIndicesExtraKind
  108210. * - VertexBuffer.MatricesWeightsKind
  108211. * - VertexBuffer.MatricesWeightsExtraKind
  108212. * @param data defines the data source
  108213. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108214. * @param stride defines the data stride size (can be null)
  108215. * @returns the current mesh
  108216. */
  108217. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108218. /**
  108219. * Delete a vertex buffer associated with this mesh
  108220. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108221. * - VertexBuffer.PositionKind
  108222. * - VertexBuffer.UVKind
  108223. * - VertexBuffer.UV2Kind
  108224. * - VertexBuffer.UV3Kind
  108225. * - VertexBuffer.UV4Kind
  108226. * - VertexBuffer.UV5Kind
  108227. * - VertexBuffer.UV6Kind
  108228. * - VertexBuffer.ColorKind
  108229. * - VertexBuffer.MatricesIndicesKind
  108230. * - VertexBuffer.MatricesIndicesExtraKind
  108231. * - VertexBuffer.MatricesWeightsKind
  108232. * - VertexBuffer.MatricesWeightsExtraKind
  108233. */
  108234. removeVerticesData(kind: string): void;
  108235. /**
  108236. * Flags an associated vertex buffer as updatable
  108237. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108238. * - VertexBuffer.PositionKind
  108239. * - VertexBuffer.UVKind
  108240. * - VertexBuffer.UV2Kind
  108241. * - VertexBuffer.UV3Kind
  108242. * - VertexBuffer.UV4Kind
  108243. * - VertexBuffer.UV5Kind
  108244. * - VertexBuffer.UV6Kind
  108245. * - VertexBuffer.ColorKind
  108246. * - VertexBuffer.MatricesIndicesKind
  108247. * - VertexBuffer.MatricesIndicesExtraKind
  108248. * - VertexBuffer.MatricesWeightsKind
  108249. * - VertexBuffer.MatricesWeightsExtraKind
  108250. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108251. */
  108252. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108253. /**
  108254. * Sets the mesh global Vertex Buffer
  108255. * @param buffer defines the buffer to use
  108256. * @returns the current mesh
  108257. */
  108258. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108259. /**
  108260. * Update a specific associated vertex buffer
  108261. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108262. * - VertexBuffer.PositionKind
  108263. * - VertexBuffer.UVKind
  108264. * - VertexBuffer.UV2Kind
  108265. * - VertexBuffer.UV3Kind
  108266. * - VertexBuffer.UV4Kind
  108267. * - VertexBuffer.UV5Kind
  108268. * - VertexBuffer.UV6Kind
  108269. * - VertexBuffer.ColorKind
  108270. * - VertexBuffer.MatricesIndicesKind
  108271. * - VertexBuffer.MatricesIndicesExtraKind
  108272. * - VertexBuffer.MatricesWeightsKind
  108273. * - VertexBuffer.MatricesWeightsExtraKind
  108274. * @param data defines the data source
  108275. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108276. * @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)
  108277. * @returns the current mesh
  108278. */
  108279. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108280. /**
  108281. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108282. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108283. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108284. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108285. * @returns the current mesh
  108286. */
  108287. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108288. /**
  108289. * Creates a un-shared specific occurence of the geometry for the mesh.
  108290. * @returns the current mesh
  108291. */
  108292. makeGeometryUnique(): Mesh;
  108293. /**
  108294. * Set the index buffer of this mesh
  108295. * @param indices defines the source data
  108296. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108297. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108298. * @returns the current mesh
  108299. */
  108300. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108301. /**
  108302. * Update the current index buffer
  108303. * @param indices defines the source data
  108304. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108305. * @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)
  108306. * @returns the current mesh
  108307. */
  108308. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108309. /**
  108310. * Invert the geometry to move from a right handed system to a left handed one.
  108311. * @returns the current mesh
  108312. */
  108313. toLeftHanded(): Mesh;
  108314. /** @hidden */
  108315. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108316. /** @hidden */
  108317. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108318. /**
  108319. * Registers for this mesh a javascript function called just before the rendering process
  108320. * @param func defines the function to call before rendering this mesh
  108321. * @returns the current mesh
  108322. */
  108323. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108324. /**
  108325. * Disposes a previously registered javascript function called before the rendering
  108326. * @param func defines the function to remove
  108327. * @returns the current mesh
  108328. */
  108329. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108330. /**
  108331. * Registers for this mesh a javascript function called just after the rendering is complete
  108332. * @param func defines the function to call after rendering this mesh
  108333. * @returns the current mesh
  108334. */
  108335. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108336. /**
  108337. * Disposes a previously registered javascript function called after the rendering.
  108338. * @param func defines the function to remove
  108339. * @returns the current mesh
  108340. */
  108341. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108342. /** @hidden */
  108343. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108344. /** @hidden */
  108345. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108346. /** @hidden */
  108347. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108348. /** @hidden */
  108349. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108350. /** @hidden */
  108351. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108352. /** @hidden */
  108353. _rebuild(): void;
  108354. /** @hidden */
  108355. _freeze(): void;
  108356. /** @hidden */
  108357. _unFreeze(): void;
  108358. /**
  108359. * 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
  108360. * @param subMesh defines the subMesh to render
  108361. * @param enableAlphaMode defines if alpha mode can be changed
  108362. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108363. * @returns the current mesh
  108364. */
  108365. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108366. private _onBeforeDraw;
  108367. /**
  108368. * Renormalize the mesh and patch it up if there are no weights
  108369. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108370. * However in the case of zero weights then we set just a single influence to 1.
  108371. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108372. */
  108373. cleanMatrixWeights(): void;
  108374. private normalizeSkinFourWeights;
  108375. private normalizeSkinWeightsAndExtra;
  108376. /**
  108377. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108378. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108379. * the user know there was an issue with importing the mesh
  108380. * @returns a validation object with skinned, valid and report string
  108381. */
  108382. validateSkinning(): {
  108383. skinned: boolean;
  108384. valid: boolean;
  108385. report: string;
  108386. };
  108387. /** @hidden */
  108388. _checkDelayState(): Mesh;
  108389. private _queueLoad;
  108390. /**
  108391. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108392. * A mesh is in the frustum if its bounding box intersects the frustum
  108393. * @param frustumPlanes defines the frustum to test
  108394. * @returns true if the mesh is in the frustum planes
  108395. */
  108396. isInFrustum(frustumPlanes: Plane[]): boolean;
  108397. /**
  108398. * Sets the mesh material by the material or multiMaterial `id` property
  108399. * @param id is a string identifying the material or the multiMaterial
  108400. * @returns the current mesh
  108401. */
  108402. setMaterialByID(id: string): Mesh;
  108403. /**
  108404. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108405. * @returns an array of IAnimatable
  108406. */
  108407. getAnimatables(): IAnimatable[];
  108408. /**
  108409. * Modifies the mesh geometry according to the passed transformation matrix.
  108410. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108411. * The mesh normals are modified using the same transformation.
  108412. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108413. * @param transform defines the transform matrix to use
  108414. * @see https://doc.babylonjs.com/resources/baking_transformations
  108415. * @returns the current mesh
  108416. */
  108417. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108418. /**
  108419. * Modifies the mesh geometry according to its own current World Matrix.
  108420. * The mesh World Matrix is then reset.
  108421. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108422. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108423. * @see https://doc.babylonjs.com/resources/baking_transformations
  108424. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108425. * @returns the current mesh
  108426. */
  108427. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108428. /** @hidden */
  108429. get _positions(): Nullable<Vector3[]>;
  108430. /** @hidden */
  108431. _resetPointsArrayCache(): Mesh;
  108432. /** @hidden */
  108433. _generatePointsArray(): boolean;
  108434. /**
  108435. * Returns a new Mesh object generated from the current mesh properties.
  108436. * This method must not get confused with createInstance()
  108437. * @param name is a string, the name given to the new mesh
  108438. * @param newParent can be any Node object (default `null`)
  108439. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108440. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108441. * @returns a new mesh
  108442. */
  108443. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108444. /**
  108445. * Releases resources associated with this mesh.
  108446. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108447. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108448. */
  108449. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108450. /** @hidden */
  108451. _disposeInstanceSpecificData(): void;
  108452. /** @hidden */
  108453. _disposeThinInstanceSpecificData(): void;
  108454. /**
  108455. * Modifies the mesh geometry according to a displacement map.
  108456. * 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.
  108457. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108458. * @param url is a string, the URL from the image file is to be downloaded.
  108459. * @param minHeight is the lower limit of the displacement.
  108460. * @param maxHeight is the upper limit of the displacement.
  108461. * @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.
  108462. * @param uvOffset is an optional vector2 used to offset UV.
  108463. * @param uvScale is an optional vector2 used to scale UV.
  108464. * @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.
  108465. * @returns the Mesh.
  108466. */
  108467. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108468. /**
  108469. * Modifies the mesh geometry according to a displacementMap buffer.
  108470. * 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.
  108471. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108472. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108473. * @param heightMapWidth is the width of the buffer image.
  108474. * @param heightMapHeight is the height of the buffer image.
  108475. * @param minHeight is the lower limit of the displacement.
  108476. * @param maxHeight is the upper limit of the displacement.
  108477. * @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.
  108478. * @param uvOffset is an optional vector2 used to offset UV.
  108479. * @param uvScale is an optional vector2 used to scale UV.
  108480. * @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.
  108481. * @returns the Mesh.
  108482. */
  108483. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108484. /**
  108485. * Modify the mesh to get a flat shading rendering.
  108486. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108487. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108488. * @returns current mesh
  108489. */
  108490. convertToFlatShadedMesh(): Mesh;
  108491. /**
  108492. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108493. * In other words, more vertices, no more indices and a single bigger VBO.
  108494. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108495. * @returns current mesh
  108496. */
  108497. convertToUnIndexedMesh(): Mesh;
  108498. /**
  108499. * Inverses facet orientations.
  108500. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108501. * @param flipNormals will also inverts the normals
  108502. * @returns current mesh
  108503. */
  108504. flipFaces(flipNormals?: boolean): Mesh;
  108505. /**
  108506. * Increase the number of facets and hence vertices in a mesh
  108507. * Vertex normals are interpolated from existing vertex normals
  108508. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108509. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108510. */
  108511. increaseVertices(numberPerEdge: number): void;
  108512. /**
  108513. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108514. * This will undo any application of covertToFlatShadedMesh
  108515. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108516. */
  108517. forceSharedVertices(): void;
  108518. /** @hidden */
  108519. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108520. /** @hidden */
  108521. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108522. /**
  108523. * Creates a new InstancedMesh object from the mesh model.
  108524. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108525. * @param name defines the name of the new instance
  108526. * @returns a new InstancedMesh
  108527. */
  108528. createInstance(name: string): InstancedMesh;
  108529. /**
  108530. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108531. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108532. * @returns the current mesh
  108533. */
  108534. synchronizeInstances(): Mesh;
  108535. /**
  108536. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108537. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108538. * This should be used together with the simplification to avoid disappearing triangles.
  108539. * @param successCallback an optional success callback to be called after the optimization finished.
  108540. * @returns the current mesh
  108541. */
  108542. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108543. /**
  108544. * Serialize current mesh
  108545. * @param serializationObject defines the object which will receive the serialization data
  108546. */
  108547. serialize(serializationObject: any): void;
  108548. /** @hidden */
  108549. _syncGeometryWithMorphTargetManager(): void;
  108550. /** @hidden */
  108551. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108552. /**
  108553. * Returns a new Mesh object parsed from the source provided.
  108554. * @param parsedMesh is the source
  108555. * @param scene defines the hosting scene
  108556. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108557. * @returns a new Mesh
  108558. */
  108559. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108560. /**
  108561. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108562. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108563. * @param name defines the name of the mesh to create
  108564. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108565. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108566. * @param closePath creates a seam between the first and the last points of each path of the path array
  108567. * @param offset is taken in account only if the `pathArray` is containing a single path
  108568. * @param scene defines the hosting scene
  108569. * @param updatable defines if the mesh must be flagged as updatable
  108570. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108571. * @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)
  108572. * @returns a new Mesh
  108573. */
  108574. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108575. /**
  108576. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108577. * @param name defines the name of the mesh to create
  108578. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108579. * @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
  108580. * @param scene defines the hosting scene
  108581. * @param updatable defines if the mesh must be flagged as updatable
  108582. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108583. * @returns a new Mesh
  108584. */
  108585. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108586. /**
  108587. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108588. * @param name defines the name of the mesh to create
  108589. * @param size sets the size (float) of each box side (default 1)
  108590. * @param scene defines the hosting scene
  108591. * @param updatable defines if the mesh must be flagged as updatable
  108592. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108593. * @returns a new Mesh
  108594. */
  108595. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108596. /**
  108597. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108598. * @param name defines the name of the mesh to create
  108599. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108600. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108601. * @param scene defines the hosting scene
  108602. * @param updatable defines if the mesh must be flagged as updatable
  108603. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108604. * @returns a new Mesh
  108605. */
  108606. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108607. /**
  108608. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108609. * @param name defines the name of the mesh to create
  108610. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108611. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108612. * @param scene defines the hosting scene
  108613. * @returns a new Mesh
  108614. */
  108615. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108616. /**
  108617. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108618. * @param name defines the name of the mesh to create
  108619. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108620. * @param diameterTop set the top cap diameter (floats, default 1)
  108621. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108622. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108623. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108624. * @param scene defines the hosting scene
  108625. * @param updatable defines if the mesh must be flagged as updatable
  108626. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108627. * @returns a new Mesh
  108628. */
  108629. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108630. /**
  108631. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108632. * @param name defines the name of the mesh to create
  108633. * @param diameter sets the diameter size (float) of the torus (default 1)
  108634. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108635. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108636. * @param scene defines the hosting scene
  108637. * @param updatable defines if the mesh must be flagged as updatable
  108638. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108639. * @returns a new Mesh
  108640. */
  108641. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108642. /**
  108643. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108644. * @param name defines the name of the mesh to create
  108645. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108646. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108647. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108648. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108649. * @param p the number of windings on X axis (positive integers, default 2)
  108650. * @param q the number of windings on Y axis (positive integers, default 3)
  108651. * @param scene defines the hosting scene
  108652. * @param updatable defines if the mesh must be flagged as updatable
  108653. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108654. * @returns a new Mesh
  108655. */
  108656. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108657. /**
  108658. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108659. * @param name defines the name of the mesh to create
  108660. * @param points is an array successive Vector3
  108661. * @param scene defines the hosting scene
  108662. * @param updatable defines if the mesh must be flagged as updatable
  108663. * @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).
  108664. * @returns a new Mesh
  108665. */
  108666. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108667. /**
  108668. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108669. * @param name defines the name of the mesh to create
  108670. * @param points is an array successive Vector3
  108671. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108672. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108673. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108674. * @param scene defines the hosting scene
  108675. * @param updatable defines if the mesh must be flagged as updatable
  108676. * @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)
  108677. * @returns a new Mesh
  108678. */
  108679. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108680. /**
  108681. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108682. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108683. * 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.
  108684. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108685. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108686. * Remember you can only change the shape positions, not their number when updating a polygon.
  108687. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108688. * @param name defines the name of the mesh to create
  108689. * @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
  108690. * @param scene defines the hosting scene
  108691. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108692. * @param updatable defines if the mesh must be flagged as updatable
  108693. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108694. * @param earcutInjection can be used to inject your own earcut reference
  108695. * @returns a new Mesh
  108696. */
  108697. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108698. /**
  108699. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108700. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108701. * @param name defines the name of the mesh to create
  108702. * @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
  108703. * @param depth defines the height of extrusion
  108704. * @param scene defines the hosting scene
  108705. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108706. * @param updatable defines if the mesh must be flagged as updatable
  108707. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108708. * @param earcutInjection can be used to inject your own earcut reference
  108709. * @returns a new Mesh
  108710. */
  108711. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108712. /**
  108713. * Creates an extruded shape mesh.
  108714. * 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
  108715. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108716. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108717. * @param name defines the name of the mesh to create
  108718. * @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
  108719. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108720. * @param scale is the value to scale the shape
  108721. * @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
  108722. * @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
  108723. * @param scene defines the hosting scene
  108724. * @param updatable defines if the mesh must be flagged as updatable
  108725. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108726. * @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)
  108727. * @returns a new Mesh
  108728. */
  108729. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108730. /**
  108731. * Creates an custom extruded shape mesh.
  108732. * The custom extrusion is a parametric shape.
  108733. * It has no predefined shape. Its final shape will depend on the input parameters.
  108734. * Please consider using the same method from the MeshBuilder class instead
  108735. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108736. * @param name defines the name of the mesh to create
  108737. * @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
  108738. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108739. * @param scaleFunction is a custom Javascript function called on each path point
  108740. * @param rotationFunction is a custom Javascript function called on each path point
  108741. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108742. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108743. * @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
  108744. * @param scene defines the hosting scene
  108745. * @param updatable defines if the mesh must be flagged as updatable
  108746. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108747. * @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)
  108748. * @returns a new Mesh
  108749. */
  108750. 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;
  108751. /**
  108752. * Creates lathe mesh.
  108753. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108754. * Please consider using the same method from the MeshBuilder class instead
  108755. * @param name defines the name of the mesh to create
  108756. * @param 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
  108757. * @param radius is the radius value of the lathe
  108758. * @param tessellation is the side number of the lathe.
  108759. * @param scene defines the hosting scene
  108760. * @param updatable defines if the mesh must be flagged as updatable
  108761. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108762. * @returns a new Mesh
  108763. */
  108764. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108765. /**
  108766. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108767. * @param name defines the name of the mesh to create
  108768. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108769. * @param scene defines the hosting scene
  108770. * @param updatable defines if the mesh must be flagged as updatable
  108771. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108772. * @returns a new Mesh
  108773. */
  108774. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108775. /**
  108776. * Creates a ground mesh.
  108777. * Please consider using the same method from the MeshBuilder class instead
  108778. * @param name defines the name of the mesh to create
  108779. * @param width set the width of the ground
  108780. * @param height set the height of the ground
  108781. * @param subdivisions sets the number of subdivisions per side
  108782. * @param scene defines the hosting scene
  108783. * @param updatable defines if the mesh must be flagged as updatable
  108784. * @returns a new Mesh
  108785. */
  108786. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108787. /**
  108788. * Creates a tiled ground mesh.
  108789. * Please consider using the same method from the MeshBuilder class instead
  108790. * @param name defines the name of the mesh to create
  108791. * @param xmin set the ground minimum X coordinate
  108792. * @param zmin set the ground minimum Y coordinate
  108793. * @param xmax set the ground maximum X coordinate
  108794. * @param zmax set the ground maximum Z coordinate
  108795. * @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
  108796. * @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
  108797. * @param scene defines the hosting scene
  108798. * @param updatable defines if the mesh must be flagged as updatable
  108799. * @returns a new Mesh
  108800. */
  108801. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108802. w: number;
  108803. h: number;
  108804. }, precision: {
  108805. w: number;
  108806. h: number;
  108807. }, scene: Scene, updatable?: boolean): Mesh;
  108808. /**
  108809. * Creates a ground mesh from a height map.
  108810. * Please consider using the same method from the MeshBuilder class instead
  108811. * @see https://doc.babylonjs.com/babylon101/height_map
  108812. * @param name defines the name of the mesh to create
  108813. * @param url sets the URL of the height map image resource
  108814. * @param width set the ground width size
  108815. * @param height set the ground height size
  108816. * @param subdivisions sets the number of subdivision per side
  108817. * @param minHeight is the minimum altitude on the ground
  108818. * @param maxHeight is the maximum altitude on the ground
  108819. * @param scene defines the hosting scene
  108820. * @param updatable defines if the mesh must be flagged as updatable
  108821. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108822. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108823. * @returns a new Mesh
  108824. */
  108825. 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;
  108826. /**
  108827. * Creates a tube mesh.
  108828. * The tube is a parametric shape.
  108829. * It has no predefined shape. Its final shape will depend on the input parameters.
  108830. * Please consider using the same method from the MeshBuilder class instead
  108831. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108832. * @param name defines the name of the mesh to create
  108833. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108834. * @param radius sets the tube radius size
  108835. * @param tessellation is the number of sides on the tubular surface
  108836. * @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
  108837. * @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
  108838. * @param scene defines the hosting scene
  108839. * @param updatable defines if the mesh must be flagged as updatable
  108840. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108841. * @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)
  108842. * @returns a new Mesh
  108843. */
  108844. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108845. (i: number, distance: number): number;
  108846. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108847. /**
  108848. * Creates a polyhedron mesh.
  108849. * Please consider using the same method from the MeshBuilder class instead.
  108850. * * 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
  108851. * * The parameter `size` (positive float, default 1) sets the polygon size
  108852. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108853. * * 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`
  108854. * * 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
  108855. * * 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)`)
  108856. * * 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
  108857. * * 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
  108858. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108859. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108860. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108861. * @param name defines the name of the mesh to create
  108862. * @param options defines the options used to create the mesh
  108863. * @param scene defines the hosting scene
  108864. * @returns a new Mesh
  108865. */
  108866. static CreatePolyhedron(name: string, options: {
  108867. type?: number;
  108868. size?: number;
  108869. sizeX?: number;
  108870. sizeY?: number;
  108871. sizeZ?: number;
  108872. custom?: any;
  108873. faceUV?: Vector4[];
  108874. faceColors?: Color4[];
  108875. updatable?: boolean;
  108876. sideOrientation?: number;
  108877. }, scene: Scene): Mesh;
  108878. /**
  108879. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108880. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108881. * * 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`)
  108882. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108883. * * 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
  108884. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108885. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108886. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108887. * @param name defines the name of the mesh
  108888. * @param options defines the options used to create the mesh
  108889. * @param scene defines the hosting scene
  108890. * @returns a new Mesh
  108891. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108892. */
  108893. static CreateIcoSphere(name: string, options: {
  108894. radius?: number;
  108895. flat?: boolean;
  108896. subdivisions?: number;
  108897. sideOrientation?: number;
  108898. updatable?: boolean;
  108899. }, scene: Scene): Mesh;
  108900. /**
  108901. * Creates a decal mesh.
  108902. * Please consider using the same method from the MeshBuilder class instead.
  108903. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108904. * @param name defines the name of the mesh
  108905. * @param sourceMesh defines the mesh receiving the decal
  108906. * @param position sets the position of the decal in world coordinates
  108907. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108908. * @param size sets the decal scaling
  108909. * @param angle sets the angle to rotate the decal
  108910. * @returns a new Mesh
  108911. */
  108912. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108913. /**
  108914. * Prepare internal position array for software CPU skinning
  108915. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108916. */
  108917. setPositionsForCPUSkinning(): Float32Array;
  108918. /**
  108919. * Prepare internal normal array for software CPU skinning
  108920. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108921. */
  108922. setNormalsForCPUSkinning(): Float32Array;
  108923. /**
  108924. * Updates the vertex buffer by applying transformation from the bones
  108925. * @param skeleton defines the skeleton to apply to current mesh
  108926. * @returns the current mesh
  108927. */
  108928. applySkeleton(skeleton: Skeleton): Mesh;
  108929. /**
  108930. * 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
  108931. * @param meshes defines the list of meshes to scan
  108932. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108933. */
  108934. static MinMax(meshes: AbstractMesh[]): {
  108935. min: Vector3;
  108936. max: Vector3;
  108937. };
  108938. /**
  108939. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108940. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108941. * @returns a vector3
  108942. */
  108943. static Center(meshesOrMinMaxVector: {
  108944. min: Vector3;
  108945. max: Vector3;
  108946. } | AbstractMesh[]): Vector3;
  108947. /**
  108948. * Merge the array of meshes into a single mesh for performance reasons.
  108949. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108950. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108951. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108952. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108953. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108954. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108955. * @returns a new mesh
  108956. */
  108957. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108958. /** @hidden */
  108959. addInstance(instance: InstancedMesh): void;
  108960. /** @hidden */
  108961. removeInstance(instance: InstancedMesh): void;
  108962. }
  108963. }
  108964. declare module BABYLON {
  108965. /**
  108966. * This is the base class of all the camera used in the application.
  108967. * @see https://doc.babylonjs.com/features/cameras
  108968. */
  108969. export class Camera extends Node {
  108970. /** @hidden */
  108971. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108972. /**
  108973. * This is the default projection mode used by the cameras.
  108974. * It helps recreating a feeling of perspective and better appreciate depth.
  108975. * This is the best way to simulate real life cameras.
  108976. */
  108977. static readonly PERSPECTIVE_CAMERA: number;
  108978. /**
  108979. * This helps creating camera with an orthographic mode.
  108980. * 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.
  108981. */
  108982. static readonly ORTHOGRAPHIC_CAMERA: number;
  108983. /**
  108984. * This is the default FOV mode for perspective cameras.
  108985. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108986. */
  108987. static readonly FOVMODE_VERTICAL_FIXED: number;
  108988. /**
  108989. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108990. */
  108991. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108992. /**
  108993. * This specifies ther is no need for a camera rig.
  108994. * Basically only one eye is rendered corresponding to the camera.
  108995. */
  108996. static readonly RIG_MODE_NONE: number;
  108997. /**
  108998. * Simulates a camera Rig with one blue eye and one red eye.
  108999. * This can be use with 3d blue and red glasses.
  109000. */
  109001. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  109002. /**
  109003. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  109004. */
  109005. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  109006. /**
  109007. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  109008. */
  109009. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  109010. /**
  109011. * Defines that both eyes of the camera will be rendered over under each other.
  109012. */
  109013. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109014. /**
  109015. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109016. */
  109017. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109018. /**
  109019. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109020. */
  109021. static readonly RIG_MODE_VR: number;
  109022. /**
  109023. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109024. */
  109025. static readonly RIG_MODE_WEBVR: number;
  109026. /**
  109027. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109028. */
  109029. static readonly RIG_MODE_CUSTOM: number;
  109030. /**
  109031. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109032. */
  109033. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109034. /**
  109035. * Define the input manager associated with the camera.
  109036. */
  109037. inputs: CameraInputsManager<Camera>;
  109038. /** @hidden */
  109039. _position: Vector3;
  109040. /**
  109041. * Define the current local position of the camera in the scene
  109042. */
  109043. get position(): Vector3;
  109044. set position(newPosition: Vector3);
  109045. protected _upVector: Vector3;
  109046. /**
  109047. * The vector the camera should consider as up.
  109048. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109049. */
  109050. set upVector(vec: Vector3);
  109051. get upVector(): Vector3;
  109052. /**
  109053. * Define the current limit on the left side for an orthographic camera
  109054. * In scene unit
  109055. */
  109056. orthoLeft: Nullable<number>;
  109057. /**
  109058. * Define the current limit on the right side for an orthographic camera
  109059. * In scene unit
  109060. */
  109061. orthoRight: Nullable<number>;
  109062. /**
  109063. * Define the current limit on the bottom side for an orthographic camera
  109064. * In scene unit
  109065. */
  109066. orthoBottom: Nullable<number>;
  109067. /**
  109068. * Define the current limit on the top side for an orthographic camera
  109069. * In scene unit
  109070. */
  109071. orthoTop: Nullable<number>;
  109072. /**
  109073. * Field Of View is set in Radians. (default is 0.8)
  109074. */
  109075. fov: number;
  109076. /**
  109077. * Define the minimum distance the camera can see from.
  109078. * This is important to note that the depth buffer are not infinite and the closer it starts
  109079. * the more your scene might encounter depth fighting issue.
  109080. */
  109081. minZ: number;
  109082. /**
  109083. * Define the maximum distance the camera can see to.
  109084. * This is important to note that the depth buffer are not infinite and the further it end
  109085. * the more your scene might encounter depth fighting issue.
  109086. */
  109087. maxZ: number;
  109088. /**
  109089. * Define the default inertia of the camera.
  109090. * This helps giving a smooth feeling to the camera movement.
  109091. */
  109092. inertia: number;
  109093. /**
  109094. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109095. */
  109096. mode: number;
  109097. /**
  109098. * Define whether the camera is intermediate.
  109099. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109100. */
  109101. isIntermediate: boolean;
  109102. /**
  109103. * Define the viewport of the camera.
  109104. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109105. */
  109106. viewport: Viewport;
  109107. /**
  109108. * Restricts the camera to viewing objects with the same layerMask.
  109109. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109110. */
  109111. layerMask: number;
  109112. /**
  109113. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109114. */
  109115. fovMode: number;
  109116. /**
  109117. * Rig mode of the camera.
  109118. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109119. * This is normally controlled byt the camera themselves as internal use.
  109120. */
  109121. cameraRigMode: number;
  109122. /**
  109123. * Defines the distance between both "eyes" in case of a RIG
  109124. */
  109125. interaxialDistance: number;
  109126. /**
  109127. * Defines if stereoscopic rendering is done side by side or over under.
  109128. */
  109129. isStereoscopicSideBySide: boolean;
  109130. /**
  109131. * 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
  109132. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109133. * else in the scene. (Eg. security camera)
  109134. *
  109135. * 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)
  109136. */
  109137. customRenderTargets: RenderTargetTexture[];
  109138. /**
  109139. * When set, the camera will render to this render target instead of the default canvas
  109140. *
  109141. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109142. */
  109143. outputRenderTarget: Nullable<RenderTargetTexture>;
  109144. /**
  109145. * Observable triggered when the camera view matrix has changed.
  109146. */
  109147. onViewMatrixChangedObservable: Observable<Camera>;
  109148. /**
  109149. * Observable triggered when the camera Projection matrix has changed.
  109150. */
  109151. onProjectionMatrixChangedObservable: Observable<Camera>;
  109152. /**
  109153. * Observable triggered when the inputs have been processed.
  109154. */
  109155. onAfterCheckInputsObservable: Observable<Camera>;
  109156. /**
  109157. * Observable triggered when reset has been called and applied to the camera.
  109158. */
  109159. onRestoreStateObservable: Observable<Camera>;
  109160. /**
  109161. * Is this camera a part of a rig system?
  109162. */
  109163. isRigCamera: boolean;
  109164. /**
  109165. * If isRigCamera set to true this will be set with the parent camera.
  109166. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109167. */
  109168. rigParent?: Camera;
  109169. /** @hidden */
  109170. _cameraRigParams: any;
  109171. /** @hidden */
  109172. _rigCameras: Camera[];
  109173. /** @hidden */
  109174. _rigPostProcess: Nullable<PostProcess>;
  109175. protected _webvrViewMatrix: Matrix;
  109176. /** @hidden */
  109177. _skipRendering: boolean;
  109178. /** @hidden */
  109179. _projectionMatrix: Matrix;
  109180. /** @hidden */
  109181. _postProcesses: Nullable<PostProcess>[];
  109182. /** @hidden */
  109183. _activeMeshes: SmartArray<AbstractMesh>;
  109184. protected _globalPosition: Vector3;
  109185. /** @hidden */
  109186. _computedViewMatrix: Matrix;
  109187. private _doNotComputeProjectionMatrix;
  109188. private _transformMatrix;
  109189. private _frustumPlanes;
  109190. private _refreshFrustumPlanes;
  109191. private _storedFov;
  109192. private _stateStored;
  109193. /**
  109194. * Instantiates a new camera object.
  109195. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109196. * @see https://doc.babylonjs.com/features/cameras
  109197. * @param name Defines the name of the camera in the scene
  109198. * @param position Defines the position of the camera
  109199. * @param scene Defines the scene the camera belongs too
  109200. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109201. */
  109202. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109203. /**
  109204. * Store current camera state (fov, position, etc..)
  109205. * @returns the camera
  109206. */
  109207. storeState(): Camera;
  109208. /**
  109209. * Restores the camera state values if it has been stored. You must call storeState() first
  109210. */
  109211. protected _restoreStateValues(): boolean;
  109212. /**
  109213. * Restored camera state. You must call storeState() first.
  109214. * @returns true if restored and false otherwise
  109215. */
  109216. restoreState(): boolean;
  109217. /**
  109218. * Gets the class name of the camera.
  109219. * @returns the class name
  109220. */
  109221. getClassName(): string;
  109222. /** @hidden */
  109223. readonly _isCamera: boolean;
  109224. /**
  109225. * Gets a string representation of the camera useful for debug purpose.
  109226. * @param fullDetails Defines that a more verboe level of logging is required
  109227. * @returns the string representation
  109228. */
  109229. toString(fullDetails?: boolean): string;
  109230. /**
  109231. * Gets the current world space position of the camera.
  109232. */
  109233. get globalPosition(): Vector3;
  109234. /**
  109235. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109236. * @returns the active meshe list
  109237. */
  109238. getActiveMeshes(): SmartArray<AbstractMesh>;
  109239. /**
  109240. * Check whether a mesh is part of the current active mesh list of the camera
  109241. * @param mesh Defines the mesh to check
  109242. * @returns true if active, false otherwise
  109243. */
  109244. isActiveMesh(mesh: Mesh): boolean;
  109245. /**
  109246. * Is this camera ready to be used/rendered
  109247. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109248. * @return true if the camera is ready
  109249. */
  109250. isReady(completeCheck?: boolean): boolean;
  109251. /** @hidden */
  109252. _initCache(): void;
  109253. /** @hidden */
  109254. _updateCache(ignoreParentClass?: boolean): void;
  109255. /** @hidden */
  109256. _isSynchronized(): boolean;
  109257. /** @hidden */
  109258. _isSynchronizedViewMatrix(): boolean;
  109259. /** @hidden */
  109260. _isSynchronizedProjectionMatrix(): boolean;
  109261. /**
  109262. * Attach the input controls to a specific dom element to get the input from.
  109263. * @param element Defines the element the controls should be listened from
  109264. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109265. */
  109266. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109267. /**
  109268. * Detach the current controls from the specified dom element.
  109269. * @param element Defines the element to stop listening the inputs from
  109270. */
  109271. detachControl(element: HTMLElement): void;
  109272. /**
  109273. * Update the camera state according to the different inputs gathered during the frame.
  109274. */
  109275. update(): void;
  109276. /** @hidden */
  109277. _checkInputs(): void;
  109278. /** @hidden */
  109279. get rigCameras(): Camera[];
  109280. /**
  109281. * Gets the post process used by the rig cameras
  109282. */
  109283. get rigPostProcess(): Nullable<PostProcess>;
  109284. /**
  109285. * Internal, gets the first post proces.
  109286. * @returns the first post process to be run on this camera.
  109287. */
  109288. _getFirstPostProcess(): Nullable<PostProcess>;
  109289. private _cascadePostProcessesToRigCams;
  109290. /**
  109291. * Attach a post process to the camera.
  109292. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109293. * @param postProcess The post process to attach to the camera
  109294. * @param insertAt The position of the post process in case several of them are in use in the scene
  109295. * @returns the position the post process has been inserted at
  109296. */
  109297. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109298. /**
  109299. * Detach a post process to the camera.
  109300. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109301. * @param postProcess The post process to detach from the camera
  109302. */
  109303. detachPostProcess(postProcess: PostProcess): void;
  109304. /**
  109305. * Gets the current world matrix of the camera
  109306. */
  109307. getWorldMatrix(): Matrix;
  109308. /** @hidden */
  109309. _getViewMatrix(): Matrix;
  109310. /**
  109311. * Gets the current view matrix of the camera.
  109312. * @param force forces the camera to recompute the matrix without looking at the cached state
  109313. * @returns the view matrix
  109314. */
  109315. getViewMatrix(force?: boolean): Matrix;
  109316. /**
  109317. * Freeze the projection matrix.
  109318. * It will prevent the cache check of the camera projection compute and can speed up perf
  109319. * if no parameter of the camera are meant to change
  109320. * @param projection Defines manually a projection if necessary
  109321. */
  109322. freezeProjectionMatrix(projection?: Matrix): void;
  109323. /**
  109324. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109325. */
  109326. unfreezeProjectionMatrix(): void;
  109327. /**
  109328. * Gets the current projection matrix of the camera.
  109329. * @param force forces the camera to recompute the matrix without looking at the cached state
  109330. * @returns the projection matrix
  109331. */
  109332. getProjectionMatrix(force?: boolean): Matrix;
  109333. /**
  109334. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109335. * @returns a Matrix
  109336. */
  109337. getTransformationMatrix(): Matrix;
  109338. private _updateFrustumPlanes;
  109339. /**
  109340. * Checks if a cullable object (mesh...) is in the camera frustum
  109341. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109342. * @param target The object to check
  109343. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109344. * @returns true if the object is in frustum otherwise false
  109345. */
  109346. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109347. /**
  109348. * Checks if a cullable object (mesh...) is in the camera frustum
  109349. * Unlike isInFrustum this cheks the full bounding box
  109350. * @param target The object to check
  109351. * @returns true if the object is in frustum otherwise false
  109352. */
  109353. isCompletelyInFrustum(target: ICullable): boolean;
  109354. /**
  109355. * Gets a ray in the forward direction from the camera.
  109356. * @param length Defines the length of the ray to create
  109357. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109358. * @param origin Defines the start point of the ray which defaults to the camera position
  109359. * @returns the forward ray
  109360. */
  109361. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109362. /**
  109363. * Gets a ray in the forward direction from the camera.
  109364. * @param refRay the ray to (re)use when setting the values
  109365. * @param length Defines the length of the ray to create
  109366. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109367. * @param origin Defines the start point of the ray which defaults to the camera position
  109368. * @returns the forward ray
  109369. */
  109370. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109371. /**
  109372. * Releases resources associated with this node.
  109373. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109374. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109375. */
  109376. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109377. /** @hidden */
  109378. _isLeftCamera: boolean;
  109379. /**
  109380. * Gets the left camera of a rig setup in case of Rigged Camera
  109381. */
  109382. get isLeftCamera(): boolean;
  109383. /** @hidden */
  109384. _isRightCamera: boolean;
  109385. /**
  109386. * Gets the right camera of a rig setup in case of Rigged Camera
  109387. */
  109388. get isRightCamera(): boolean;
  109389. /**
  109390. * Gets the left camera of a rig setup in case of Rigged Camera
  109391. */
  109392. get leftCamera(): Nullable<FreeCamera>;
  109393. /**
  109394. * Gets the right camera of a rig setup in case of Rigged Camera
  109395. */
  109396. get rightCamera(): Nullable<FreeCamera>;
  109397. /**
  109398. * Gets the left camera target of a rig setup in case of Rigged Camera
  109399. * @returns the target position
  109400. */
  109401. getLeftTarget(): Nullable<Vector3>;
  109402. /**
  109403. * Gets the right camera target of a rig setup in case of Rigged Camera
  109404. * @returns the target position
  109405. */
  109406. getRightTarget(): Nullable<Vector3>;
  109407. /**
  109408. * @hidden
  109409. */
  109410. setCameraRigMode(mode: number, rigParams: any): void;
  109411. /** @hidden */
  109412. static _setStereoscopicRigMode(camera: Camera): void;
  109413. /** @hidden */
  109414. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109415. /** @hidden */
  109416. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109417. /** @hidden */
  109418. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109419. /** @hidden */
  109420. _getVRProjectionMatrix(): Matrix;
  109421. protected _updateCameraRotationMatrix(): void;
  109422. protected _updateWebVRCameraRotationMatrix(): void;
  109423. /**
  109424. * This function MUST be overwritten by the different WebVR cameras available.
  109425. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109426. * @hidden
  109427. */
  109428. _getWebVRProjectionMatrix(): Matrix;
  109429. /**
  109430. * This function MUST be overwritten by the different WebVR cameras available.
  109431. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109432. * @hidden
  109433. */
  109434. _getWebVRViewMatrix(): Matrix;
  109435. /** @hidden */
  109436. setCameraRigParameter(name: string, value: any): void;
  109437. /**
  109438. * needs to be overridden by children so sub has required properties to be copied
  109439. * @hidden
  109440. */
  109441. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109442. /**
  109443. * May need to be overridden by children
  109444. * @hidden
  109445. */
  109446. _updateRigCameras(): void;
  109447. /** @hidden */
  109448. _setupInputs(): void;
  109449. /**
  109450. * Serialiaze the camera setup to a json represention
  109451. * @returns the JSON representation
  109452. */
  109453. serialize(): any;
  109454. /**
  109455. * Clones the current camera.
  109456. * @param name The cloned camera name
  109457. * @returns the cloned camera
  109458. */
  109459. clone(name: string): Camera;
  109460. /**
  109461. * Gets the direction of the camera relative to a given local axis.
  109462. * @param localAxis Defines the reference axis to provide a relative direction.
  109463. * @return the direction
  109464. */
  109465. getDirection(localAxis: Vector3): Vector3;
  109466. /**
  109467. * Returns the current camera absolute rotation
  109468. */
  109469. get absoluteRotation(): Quaternion;
  109470. /**
  109471. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109472. * @param localAxis Defines the reference axis to provide a relative direction.
  109473. * @param result Defines the vector to store the result in
  109474. */
  109475. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109476. /**
  109477. * Gets a camera constructor for a given camera type
  109478. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109479. * @param name The name of the camera the result will be able to instantiate
  109480. * @param scene The scene the result will construct the camera in
  109481. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109482. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109483. * @returns a factory method to construc the camera
  109484. */
  109485. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109486. /**
  109487. * Compute the world matrix of the camera.
  109488. * @returns the camera world matrix
  109489. */
  109490. computeWorldMatrix(): Matrix;
  109491. /**
  109492. * Parse a JSON and creates the camera from the parsed information
  109493. * @param parsedCamera The JSON to parse
  109494. * @param scene The scene to instantiate the camera in
  109495. * @returns the newly constructed camera
  109496. */
  109497. static Parse(parsedCamera: any, scene: Scene): Camera;
  109498. }
  109499. }
  109500. declare module BABYLON {
  109501. /**
  109502. * Class containing static functions to help procedurally build meshes
  109503. */
  109504. export class DiscBuilder {
  109505. /**
  109506. * Creates a plane polygonal mesh. By default, this is a disc
  109507. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109508. * * 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
  109509. * * 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
  109510. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109511. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109512. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109513. * @param name defines the name of the mesh
  109514. * @param options defines the options used to create the mesh
  109515. * @param scene defines the hosting scene
  109516. * @returns the plane polygonal mesh
  109517. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109518. */
  109519. static CreateDisc(name: string, options: {
  109520. radius?: number;
  109521. tessellation?: number;
  109522. arc?: number;
  109523. updatable?: boolean;
  109524. sideOrientation?: number;
  109525. frontUVs?: Vector4;
  109526. backUVs?: Vector4;
  109527. }, scene?: Nullable<Scene>): Mesh;
  109528. }
  109529. }
  109530. declare module BABYLON {
  109531. /**
  109532. * Options to be used when creating a FresnelParameters.
  109533. */
  109534. export type IFresnelParametersCreationOptions = {
  109535. /**
  109536. * Define the color used on edges (grazing angle)
  109537. */
  109538. leftColor?: Color3;
  109539. /**
  109540. * Define the color used on center
  109541. */
  109542. rightColor?: Color3;
  109543. /**
  109544. * Define bias applied to computed fresnel term
  109545. */
  109546. bias?: number;
  109547. /**
  109548. * Defined the power exponent applied to fresnel term
  109549. */
  109550. power?: number;
  109551. /**
  109552. * Define if the fresnel effect is enable or not.
  109553. */
  109554. isEnabled?: boolean;
  109555. };
  109556. /**
  109557. * Serialized format for FresnelParameters.
  109558. */
  109559. export type IFresnelParametersSerialized = {
  109560. /**
  109561. * Define the color used on edges (grazing angle) [as an array]
  109562. */
  109563. leftColor: number[];
  109564. /**
  109565. * Define the color used on center [as an array]
  109566. */
  109567. rightColor: number[];
  109568. /**
  109569. * Define bias applied to computed fresnel term
  109570. */
  109571. bias: number;
  109572. /**
  109573. * Defined the power exponent applied to fresnel term
  109574. */
  109575. power?: number;
  109576. /**
  109577. * Define if the fresnel effect is enable or not.
  109578. */
  109579. isEnabled: boolean;
  109580. };
  109581. /**
  109582. * This represents all the required information to add a fresnel effect on a material:
  109583. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109584. */
  109585. export class FresnelParameters {
  109586. private _isEnabled;
  109587. /**
  109588. * Define if the fresnel effect is enable or not.
  109589. */
  109590. get isEnabled(): boolean;
  109591. set isEnabled(value: boolean);
  109592. /**
  109593. * Define the color used on edges (grazing angle)
  109594. */
  109595. leftColor: Color3;
  109596. /**
  109597. * Define the color used on center
  109598. */
  109599. rightColor: Color3;
  109600. /**
  109601. * Define bias applied to computed fresnel term
  109602. */
  109603. bias: number;
  109604. /**
  109605. * Defined the power exponent applied to fresnel term
  109606. */
  109607. power: number;
  109608. /**
  109609. * Creates a new FresnelParameters object.
  109610. *
  109611. * @param options provide your own settings to optionally to override defaults
  109612. */
  109613. constructor(options?: IFresnelParametersCreationOptions);
  109614. /**
  109615. * Clones the current fresnel and its valuues
  109616. * @returns a clone fresnel configuration
  109617. */
  109618. clone(): FresnelParameters;
  109619. /**
  109620. * Determines equality between FresnelParameters objects
  109621. * @param otherFresnelParameters defines the second operand
  109622. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109623. */
  109624. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109625. /**
  109626. * Serializes the current fresnel parameters to a JSON representation.
  109627. * @return the JSON serialization
  109628. */
  109629. serialize(): IFresnelParametersSerialized;
  109630. /**
  109631. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109632. * @param parsedFresnelParameters Define the JSON representation
  109633. * @returns the parsed parameters
  109634. */
  109635. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109636. }
  109637. }
  109638. declare module BABYLON {
  109639. /**
  109640. * This groups all the flags used to control the materials channel.
  109641. */
  109642. export class MaterialFlags {
  109643. private static _DiffuseTextureEnabled;
  109644. /**
  109645. * Are diffuse textures enabled in the application.
  109646. */
  109647. static get DiffuseTextureEnabled(): boolean;
  109648. static set DiffuseTextureEnabled(value: boolean);
  109649. private static _DetailTextureEnabled;
  109650. /**
  109651. * Are detail textures enabled in the application.
  109652. */
  109653. static get DetailTextureEnabled(): boolean;
  109654. static set DetailTextureEnabled(value: boolean);
  109655. private static _AmbientTextureEnabled;
  109656. /**
  109657. * Are ambient textures enabled in the application.
  109658. */
  109659. static get AmbientTextureEnabled(): boolean;
  109660. static set AmbientTextureEnabled(value: boolean);
  109661. private static _OpacityTextureEnabled;
  109662. /**
  109663. * Are opacity textures enabled in the application.
  109664. */
  109665. static get OpacityTextureEnabled(): boolean;
  109666. static set OpacityTextureEnabled(value: boolean);
  109667. private static _ReflectionTextureEnabled;
  109668. /**
  109669. * Are reflection textures enabled in the application.
  109670. */
  109671. static get ReflectionTextureEnabled(): boolean;
  109672. static set ReflectionTextureEnabled(value: boolean);
  109673. private static _EmissiveTextureEnabled;
  109674. /**
  109675. * Are emissive textures enabled in the application.
  109676. */
  109677. static get EmissiveTextureEnabled(): boolean;
  109678. static set EmissiveTextureEnabled(value: boolean);
  109679. private static _SpecularTextureEnabled;
  109680. /**
  109681. * Are specular textures enabled in the application.
  109682. */
  109683. static get SpecularTextureEnabled(): boolean;
  109684. static set SpecularTextureEnabled(value: boolean);
  109685. private static _BumpTextureEnabled;
  109686. /**
  109687. * Are bump textures enabled in the application.
  109688. */
  109689. static get BumpTextureEnabled(): boolean;
  109690. static set BumpTextureEnabled(value: boolean);
  109691. private static _LightmapTextureEnabled;
  109692. /**
  109693. * Are lightmap textures enabled in the application.
  109694. */
  109695. static get LightmapTextureEnabled(): boolean;
  109696. static set LightmapTextureEnabled(value: boolean);
  109697. private static _RefractionTextureEnabled;
  109698. /**
  109699. * Are refraction textures enabled in the application.
  109700. */
  109701. static get RefractionTextureEnabled(): boolean;
  109702. static set RefractionTextureEnabled(value: boolean);
  109703. private static _ColorGradingTextureEnabled;
  109704. /**
  109705. * Are color grading textures enabled in the application.
  109706. */
  109707. static get ColorGradingTextureEnabled(): boolean;
  109708. static set ColorGradingTextureEnabled(value: boolean);
  109709. private static _FresnelEnabled;
  109710. /**
  109711. * Are fresnels enabled in the application.
  109712. */
  109713. static get FresnelEnabled(): boolean;
  109714. static set FresnelEnabled(value: boolean);
  109715. private static _ClearCoatTextureEnabled;
  109716. /**
  109717. * Are clear coat textures enabled in the application.
  109718. */
  109719. static get ClearCoatTextureEnabled(): boolean;
  109720. static set ClearCoatTextureEnabled(value: boolean);
  109721. private static _ClearCoatBumpTextureEnabled;
  109722. /**
  109723. * Are clear coat bump textures enabled in the application.
  109724. */
  109725. static get ClearCoatBumpTextureEnabled(): boolean;
  109726. static set ClearCoatBumpTextureEnabled(value: boolean);
  109727. private static _ClearCoatTintTextureEnabled;
  109728. /**
  109729. * Are clear coat tint textures enabled in the application.
  109730. */
  109731. static get ClearCoatTintTextureEnabled(): boolean;
  109732. static set ClearCoatTintTextureEnabled(value: boolean);
  109733. private static _SheenTextureEnabled;
  109734. /**
  109735. * Are sheen textures enabled in the application.
  109736. */
  109737. static get SheenTextureEnabled(): boolean;
  109738. static set SheenTextureEnabled(value: boolean);
  109739. private static _AnisotropicTextureEnabled;
  109740. /**
  109741. * Are anisotropic textures enabled in the application.
  109742. */
  109743. static get AnisotropicTextureEnabled(): boolean;
  109744. static set AnisotropicTextureEnabled(value: boolean);
  109745. private static _ThicknessTextureEnabled;
  109746. /**
  109747. * Are thickness textures enabled in the application.
  109748. */
  109749. static get ThicknessTextureEnabled(): boolean;
  109750. static set ThicknessTextureEnabled(value: boolean);
  109751. }
  109752. }
  109753. declare module BABYLON {
  109754. /** @hidden */
  109755. export var defaultFragmentDeclaration: {
  109756. name: string;
  109757. shader: string;
  109758. };
  109759. }
  109760. declare module BABYLON {
  109761. /** @hidden */
  109762. export var defaultUboDeclaration: {
  109763. name: string;
  109764. shader: string;
  109765. };
  109766. }
  109767. declare module BABYLON {
  109768. /** @hidden */
  109769. export var prePassDeclaration: {
  109770. name: string;
  109771. shader: string;
  109772. };
  109773. }
  109774. declare module BABYLON {
  109775. /** @hidden */
  109776. export var lightFragmentDeclaration: {
  109777. name: string;
  109778. shader: string;
  109779. };
  109780. }
  109781. declare module BABYLON {
  109782. /** @hidden */
  109783. export var lightUboDeclaration: {
  109784. name: string;
  109785. shader: string;
  109786. };
  109787. }
  109788. declare module BABYLON {
  109789. /** @hidden */
  109790. export var lightsFragmentFunctions: {
  109791. name: string;
  109792. shader: string;
  109793. };
  109794. }
  109795. declare module BABYLON {
  109796. /** @hidden */
  109797. export var shadowsFragmentFunctions: {
  109798. name: string;
  109799. shader: string;
  109800. };
  109801. }
  109802. declare module BABYLON {
  109803. /** @hidden */
  109804. export var fresnelFunction: {
  109805. name: string;
  109806. shader: string;
  109807. };
  109808. }
  109809. declare module BABYLON {
  109810. /** @hidden */
  109811. export var bumpFragmentMainFunctions: {
  109812. name: string;
  109813. shader: string;
  109814. };
  109815. }
  109816. declare module BABYLON {
  109817. /** @hidden */
  109818. export var bumpFragmentFunctions: {
  109819. name: string;
  109820. shader: string;
  109821. };
  109822. }
  109823. declare module BABYLON {
  109824. /** @hidden */
  109825. export var logDepthDeclaration: {
  109826. name: string;
  109827. shader: string;
  109828. };
  109829. }
  109830. declare module BABYLON {
  109831. /** @hidden */
  109832. export var bumpFragment: {
  109833. name: string;
  109834. shader: string;
  109835. };
  109836. }
  109837. declare module BABYLON {
  109838. /** @hidden */
  109839. export var depthPrePass: {
  109840. name: string;
  109841. shader: string;
  109842. };
  109843. }
  109844. declare module BABYLON {
  109845. /** @hidden */
  109846. export var lightFragment: {
  109847. name: string;
  109848. shader: string;
  109849. };
  109850. }
  109851. declare module BABYLON {
  109852. /** @hidden */
  109853. export var logDepthFragment: {
  109854. name: string;
  109855. shader: string;
  109856. };
  109857. }
  109858. declare module BABYLON {
  109859. /** @hidden */
  109860. export var defaultPixelShader: {
  109861. name: string;
  109862. shader: string;
  109863. };
  109864. }
  109865. declare module BABYLON {
  109866. /** @hidden */
  109867. export var defaultVertexDeclaration: {
  109868. name: string;
  109869. shader: string;
  109870. };
  109871. }
  109872. declare module BABYLON {
  109873. /** @hidden */
  109874. export var bumpVertexDeclaration: {
  109875. name: string;
  109876. shader: string;
  109877. };
  109878. }
  109879. declare module BABYLON {
  109880. /** @hidden */
  109881. export var bumpVertex: {
  109882. name: string;
  109883. shader: string;
  109884. };
  109885. }
  109886. declare module BABYLON {
  109887. /** @hidden */
  109888. export var fogVertex: {
  109889. name: string;
  109890. shader: string;
  109891. };
  109892. }
  109893. declare module BABYLON {
  109894. /** @hidden */
  109895. export var shadowsVertex: {
  109896. name: string;
  109897. shader: string;
  109898. };
  109899. }
  109900. declare module BABYLON {
  109901. /** @hidden */
  109902. export var pointCloudVertex: {
  109903. name: string;
  109904. shader: string;
  109905. };
  109906. }
  109907. declare module BABYLON {
  109908. /** @hidden */
  109909. export var logDepthVertex: {
  109910. name: string;
  109911. shader: string;
  109912. };
  109913. }
  109914. declare module BABYLON {
  109915. /** @hidden */
  109916. export var defaultVertexShader: {
  109917. name: string;
  109918. shader: string;
  109919. };
  109920. }
  109921. declare module BABYLON {
  109922. /**
  109923. * @hidden
  109924. */
  109925. export interface IMaterialDetailMapDefines {
  109926. DETAIL: boolean;
  109927. DETAILDIRECTUV: number;
  109928. DETAIL_NORMALBLENDMETHOD: number;
  109929. /** @hidden */
  109930. _areTexturesDirty: boolean;
  109931. }
  109932. /**
  109933. * Define the code related to the detail map parameters of a material
  109934. *
  109935. * Inspired from:
  109936. * 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
  109937. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109938. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109939. */
  109940. export class DetailMapConfiguration {
  109941. private _texture;
  109942. /**
  109943. * The detail texture of the material.
  109944. */
  109945. texture: Nullable<BaseTexture>;
  109946. /**
  109947. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109948. * Bigger values mean stronger blending
  109949. */
  109950. diffuseBlendLevel: number;
  109951. /**
  109952. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109953. * Bigger values mean stronger blending. Only used with PBR materials
  109954. */
  109955. roughnessBlendLevel: number;
  109956. /**
  109957. * Defines how strong the bump effect from the detail map is
  109958. * Bigger values mean stronger effect
  109959. */
  109960. bumpLevel: number;
  109961. private _normalBlendMethod;
  109962. /**
  109963. * The method used to blend the bump and detail normals together
  109964. */
  109965. normalBlendMethod: number;
  109966. private _isEnabled;
  109967. /**
  109968. * Enable or disable the detail map on this material
  109969. */
  109970. isEnabled: boolean;
  109971. /** @hidden */
  109972. private _internalMarkAllSubMeshesAsTexturesDirty;
  109973. /** @hidden */
  109974. _markAllSubMeshesAsTexturesDirty(): void;
  109975. /**
  109976. * Instantiate a new detail map
  109977. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109978. */
  109979. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109980. /**
  109981. * Gets whether the submesh is ready to be used or not.
  109982. * @param defines the list of "defines" to update.
  109983. * @param scene defines the scene the material belongs to.
  109984. * @returns - boolean indicating that the submesh is ready or not.
  109985. */
  109986. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109987. /**
  109988. * Update the defines for detail map usage
  109989. * @param defines the list of "defines" to update.
  109990. * @param scene defines the scene the material belongs to.
  109991. */
  109992. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109993. /**
  109994. * Binds the material data.
  109995. * @param uniformBuffer defines the Uniform buffer to fill in.
  109996. * @param scene defines the scene the material belongs to.
  109997. * @param isFrozen defines whether the material is frozen or not.
  109998. */
  109999. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  110000. /**
  110001. * Checks to see if a texture is used in the material.
  110002. * @param texture - Base texture to use.
  110003. * @returns - Boolean specifying if a texture is used in the material.
  110004. */
  110005. hasTexture(texture: BaseTexture): boolean;
  110006. /**
  110007. * Returns an array of the actively used textures.
  110008. * @param activeTextures Array of BaseTextures
  110009. */
  110010. getActiveTextures(activeTextures: BaseTexture[]): void;
  110011. /**
  110012. * Returns the animatable textures.
  110013. * @param animatables Array of animatable textures.
  110014. */
  110015. getAnimatables(animatables: IAnimatable[]): void;
  110016. /**
  110017. * Disposes the resources of the material.
  110018. * @param forceDisposeTextures - Forces the disposal of all textures.
  110019. */
  110020. dispose(forceDisposeTextures?: boolean): void;
  110021. /**
  110022. * Get the current class name useful for serialization or dynamic coding.
  110023. * @returns "DetailMap"
  110024. */
  110025. getClassName(): string;
  110026. /**
  110027. * Add the required uniforms to the current list.
  110028. * @param uniforms defines the current uniform list.
  110029. */
  110030. static AddUniforms(uniforms: string[]): void;
  110031. /**
  110032. * Add the required samplers to the current list.
  110033. * @param samplers defines the current sampler list.
  110034. */
  110035. static AddSamplers(samplers: string[]): void;
  110036. /**
  110037. * Add the required uniforms to the current buffer.
  110038. * @param uniformBuffer defines the current uniform buffer.
  110039. */
  110040. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110041. /**
  110042. * Makes a duplicate of the current instance into another one.
  110043. * @param detailMap define the instance where to copy the info
  110044. */
  110045. copyTo(detailMap: DetailMapConfiguration): void;
  110046. /**
  110047. * Serializes this detail map instance
  110048. * @returns - An object with the serialized instance.
  110049. */
  110050. serialize(): any;
  110051. /**
  110052. * Parses a detail map setting from a serialized object.
  110053. * @param source - Serialized object.
  110054. * @param scene Defines the scene we are parsing for
  110055. * @param rootUrl Defines the rootUrl to load from
  110056. */
  110057. parse(source: any, scene: Scene, rootUrl: string): void;
  110058. }
  110059. }
  110060. declare module BABYLON {
  110061. /** @hidden */
  110062. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110063. MAINUV1: boolean;
  110064. MAINUV2: boolean;
  110065. DIFFUSE: boolean;
  110066. DIFFUSEDIRECTUV: number;
  110067. DETAIL: boolean;
  110068. DETAILDIRECTUV: number;
  110069. DETAIL_NORMALBLENDMETHOD: number;
  110070. AMBIENT: boolean;
  110071. AMBIENTDIRECTUV: number;
  110072. OPACITY: boolean;
  110073. OPACITYDIRECTUV: number;
  110074. OPACITYRGB: boolean;
  110075. REFLECTION: boolean;
  110076. EMISSIVE: boolean;
  110077. EMISSIVEDIRECTUV: number;
  110078. SPECULAR: boolean;
  110079. SPECULARDIRECTUV: number;
  110080. BUMP: boolean;
  110081. BUMPDIRECTUV: number;
  110082. PARALLAX: boolean;
  110083. PARALLAXOCCLUSION: boolean;
  110084. SPECULAROVERALPHA: boolean;
  110085. CLIPPLANE: boolean;
  110086. CLIPPLANE2: boolean;
  110087. CLIPPLANE3: boolean;
  110088. CLIPPLANE4: boolean;
  110089. CLIPPLANE5: boolean;
  110090. CLIPPLANE6: boolean;
  110091. ALPHATEST: boolean;
  110092. DEPTHPREPASS: boolean;
  110093. ALPHAFROMDIFFUSE: boolean;
  110094. POINTSIZE: boolean;
  110095. FOG: boolean;
  110096. SPECULARTERM: boolean;
  110097. DIFFUSEFRESNEL: boolean;
  110098. OPACITYFRESNEL: boolean;
  110099. REFLECTIONFRESNEL: boolean;
  110100. REFRACTIONFRESNEL: boolean;
  110101. EMISSIVEFRESNEL: boolean;
  110102. FRESNEL: boolean;
  110103. NORMAL: boolean;
  110104. UV1: boolean;
  110105. UV2: boolean;
  110106. VERTEXCOLOR: boolean;
  110107. VERTEXALPHA: boolean;
  110108. NUM_BONE_INFLUENCERS: number;
  110109. BonesPerMesh: number;
  110110. BONETEXTURE: boolean;
  110111. INSTANCES: boolean;
  110112. THIN_INSTANCES: boolean;
  110113. GLOSSINESS: boolean;
  110114. ROUGHNESS: boolean;
  110115. EMISSIVEASILLUMINATION: boolean;
  110116. LINKEMISSIVEWITHDIFFUSE: boolean;
  110117. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110118. LIGHTMAP: boolean;
  110119. LIGHTMAPDIRECTUV: number;
  110120. OBJECTSPACE_NORMALMAP: boolean;
  110121. USELIGHTMAPASSHADOWMAP: boolean;
  110122. REFLECTIONMAP_3D: boolean;
  110123. REFLECTIONMAP_SPHERICAL: boolean;
  110124. REFLECTIONMAP_PLANAR: boolean;
  110125. REFLECTIONMAP_CUBIC: boolean;
  110126. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110127. REFLECTIONMAP_PROJECTION: boolean;
  110128. REFLECTIONMAP_SKYBOX: boolean;
  110129. REFLECTIONMAP_EXPLICIT: boolean;
  110130. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110131. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110132. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110133. INVERTCUBICMAP: boolean;
  110134. LOGARITHMICDEPTH: boolean;
  110135. REFRACTION: boolean;
  110136. REFRACTIONMAP_3D: boolean;
  110137. REFLECTIONOVERALPHA: boolean;
  110138. TWOSIDEDLIGHTING: boolean;
  110139. SHADOWFLOAT: boolean;
  110140. MORPHTARGETS: boolean;
  110141. MORPHTARGETS_NORMAL: boolean;
  110142. MORPHTARGETS_TANGENT: boolean;
  110143. MORPHTARGETS_UV: boolean;
  110144. NUM_MORPH_INFLUENCERS: number;
  110145. NONUNIFORMSCALING: boolean;
  110146. PREMULTIPLYALPHA: boolean;
  110147. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110148. ALPHABLEND: boolean;
  110149. PREPASS: boolean;
  110150. SCENE_MRT_COUNT: number;
  110151. RGBDLIGHTMAP: boolean;
  110152. RGBDREFLECTION: boolean;
  110153. RGBDREFRACTION: boolean;
  110154. IMAGEPROCESSING: boolean;
  110155. VIGNETTE: boolean;
  110156. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110157. VIGNETTEBLENDMODEOPAQUE: boolean;
  110158. TONEMAPPING: boolean;
  110159. TONEMAPPING_ACES: boolean;
  110160. CONTRAST: boolean;
  110161. COLORCURVES: boolean;
  110162. COLORGRADING: boolean;
  110163. COLORGRADING3D: boolean;
  110164. SAMPLER3DGREENDEPTH: boolean;
  110165. SAMPLER3DBGRMAP: boolean;
  110166. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110167. MULTIVIEW: boolean;
  110168. /**
  110169. * If the reflection texture on this material is in linear color space
  110170. * @hidden
  110171. */
  110172. IS_REFLECTION_LINEAR: boolean;
  110173. /**
  110174. * If the refraction texture on this material is in linear color space
  110175. * @hidden
  110176. */
  110177. IS_REFRACTION_LINEAR: boolean;
  110178. EXPOSURE: boolean;
  110179. constructor();
  110180. setReflectionMode(modeToEnable: string): void;
  110181. }
  110182. /**
  110183. * This is the default material used in Babylon. It is the best trade off between quality
  110184. * and performances.
  110185. * @see https://doc.babylonjs.com/babylon101/materials
  110186. */
  110187. export class StandardMaterial extends PushMaterial {
  110188. private _diffuseTexture;
  110189. /**
  110190. * The basic texture of the material as viewed under a light.
  110191. */
  110192. diffuseTexture: Nullable<BaseTexture>;
  110193. private _ambientTexture;
  110194. /**
  110195. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110196. */
  110197. ambientTexture: Nullable<BaseTexture>;
  110198. private _opacityTexture;
  110199. /**
  110200. * Define the transparency of the material from a texture.
  110201. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110202. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110203. */
  110204. opacityTexture: Nullable<BaseTexture>;
  110205. private _reflectionTexture;
  110206. /**
  110207. * Define the texture used to display the reflection.
  110208. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110209. */
  110210. reflectionTexture: Nullable<BaseTexture>;
  110211. private _emissiveTexture;
  110212. /**
  110213. * Define texture of the material as if self lit.
  110214. * This will be mixed in the final result even in the absence of light.
  110215. */
  110216. emissiveTexture: Nullable<BaseTexture>;
  110217. private _specularTexture;
  110218. /**
  110219. * Define how the color and intensity of the highlight given by the light in the material.
  110220. */
  110221. specularTexture: Nullable<BaseTexture>;
  110222. private _bumpTexture;
  110223. /**
  110224. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110225. * 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.
  110226. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110227. */
  110228. bumpTexture: Nullable<BaseTexture>;
  110229. private _lightmapTexture;
  110230. /**
  110231. * Complex lighting can be computationally expensive to compute at runtime.
  110232. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110233. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110234. */
  110235. lightmapTexture: Nullable<BaseTexture>;
  110236. private _refractionTexture;
  110237. /**
  110238. * Define the texture used to display the refraction.
  110239. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110240. */
  110241. refractionTexture: Nullable<BaseTexture>;
  110242. /**
  110243. * The color of the material lit by the environmental background lighting.
  110244. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110245. */
  110246. ambientColor: Color3;
  110247. /**
  110248. * The basic color of the material as viewed under a light.
  110249. */
  110250. diffuseColor: Color3;
  110251. /**
  110252. * Define how the color and intensity of the highlight given by the light in the material.
  110253. */
  110254. specularColor: Color3;
  110255. /**
  110256. * Define the color of the material as if self lit.
  110257. * This will be mixed in the final result even in the absence of light.
  110258. */
  110259. emissiveColor: Color3;
  110260. /**
  110261. * Defines how sharp are the highlights in the material.
  110262. * The bigger the value the sharper giving a more glossy feeling to the result.
  110263. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110264. */
  110265. specularPower: number;
  110266. private _useAlphaFromDiffuseTexture;
  110267. /**
  110268. * Does the transparency come from the diffuse texture alpha channel.
  110269. */
  110270. useAlphaFromDiffuseTexture: boolean;
  110271. private _useEmissiveAsIllumination;
  110272. /**
  110273. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110274. */
  110275. useEmissiveAsIllumination: boolean;
  110276. private _linkEmissiveWithDiffuse;
  110277. /**
  110278. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110279. * the emissive level when the final color is close to one.
  110280. */
  110281. linkEmissiveWithDiffuse: boolean;
  110282. private _useSpecularOverAlpha;
  110283. /**
  110284. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110285. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110286. */
  110287. useSpecularOverAlpha: boolean;
  110288. private _useReflectionOverAlpha;
  110289. /**
  110290. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110291. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110292. */
  110293. useReflectionOverAlpha: boolean;
  110294. private _disableLighting;
  110295. /**
  110296. * Does lights from the scene impacts this material.
  110297. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110298. */
  110299. disableLighting: boolean;
  110300. private _useObjectSpaceNormalMap;
  110301. /**
  110302. * Allows using an object space normal map (instead of tangent space).
  110303. */
  110304. useObjectSpaceNormalMap: boolean;
  110305. private _useParallax;
  110306. /**
  110307. * Is parallax enabled or not.
  110308. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110309. */
  110310. useParallax: boolean;
  110311. private _useParallaxOcclusion;
  110312. /**
  110313. * Is parallax occlusion enabled or not.
  110314. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110315. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110316. */
  110317. useParallaxOcclusion: boolean;
  110318. /**
  110319. * 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.
  110320. */
  110321. parallaxScaleBias: number;
  110322. private _roughness;
  110323. /**
  110324. * Helps to define how blurry the reflections should appears in the material.
  110325. */
  110326. roughness: number;
  110327. /**
  110328. * In case of refraction, define the value of the index of refraction.
  110329. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110330. */
  110331. indexOfRefraction: number;
  110332. /**
  110333. * Invert the refraction texture alongside the y axis.
  110334. * It can be useful with procedural textures or probe for instance.
  110335. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110336. */
  110337. invertRefractionY: boolean;
  110338. /**
  110339. * Defines the alpha limits in alpha test mode.
  110340. */
  110341. alphaCutOff: number;
  110342. private _useLightmapAsShadowmap;
  110343. /**
  110344. * In case of light mapping, define whether the map contains light or shadow informations.
  110345. */
  110346. useLightmapAsShadowmap: boolean;
  110347. private _diffuseFresnelParameters;
  110348. /**
  110349. * Define the diffuse fresnel parameters of the material.
  110350. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110351. */
  110352. diffuseFresnelParameters: FresnelParameters;
  110353. private _opacityFresnelParameters;
  110354. /**
  110355. * Define the opacity fresnel parameters of the material.
  110356. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110357. */
  110358. opacityFresnelParameters: FresnelParameters;
  110359. private _reflectionFresnelParameters;
  110360. /**
  110361. * Define the reflection fresnel parameters of the material.
  110362. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110363. */
  110364. reflectionFresnelParameters: FresnelParameters;
  110365. private _refractionFresnelParameters;
  110366. /**
  110367. * Define the refraction fresnel parameters of the material.
  110368. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110369. */
  110370. refractionFresnelParameters: FresnelParameters;
  110371. private _emissiveFresnelParameters;
  110372. /**
  110373. * Define the emissive fresnel parameters of the material.
  110374. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110375. */
  110376. emissiveFresnelParameters: FresnelParameters;
  110377. private _useReflectionFresnelFromSpecular;
  110378. /**
  110379. * If true automatically deducts the fresnels values from the material specularity.
  110380. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110381. */
  110382. useReflectionFresnelFromSpecular: boolean;
  110383. private _useGlossinessFromSpecularMapAlpha;
  110384. /**
  110385. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110386. */
  110387. useGlossinessFromSpecularMapAlpha: boolean;
  110388. private _maxSimultaneousLights;
  110389. /**
  110390. * Defines the maximum number of lights that can be used in the material
  110391. */
  110392. maxSimultaneousLights: number;
  110393. private _invertNormalMapX;
  110394. /**
  110395. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110396. */
  110397. invertNormalMapX: boolean;
  110398. private _invertNormalMapY;
  110399. /**
  110400. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110401. */
  110402. invertNormalMapY: boolean;
  110403. private _twoSidedLighting;
  110404. /**
  110405. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110406. */
  110407. twoSidedLighting: boolean;
  110408. /**
  110409. * Default configuration related to image processing available in the standard Material.
  110410. */
  110411. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110412. /**
  110413. * Gets the image processing configuration used either in this material.
  110414. */
  110415. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110416. /**
  110417. * Sets the Default image processing configuration used either in the this material.
  110418. *
  110419. * If sets to null, the scene one is in use.
  110420. */
  110421. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110422. /**
  110423. * Keep track of the image processing observer to allow dispose and replace.
  110424. */
  110425. private _imageProcessingObserver;
  110426. /**
  110427. * Attaches a new image processing configuration to the Standard Material.
  110428. * @param configuration
  110429. */
  110430. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110431. /**
  110432. * Gets wether the color curves effect is enabled.
  110433. */
  110434. get cameraColorCurvesEnabled(): boolean;
  110435. /**
  110436. * Sets wether the color curves effect is enabled.
  110437. */
  110438. set cameraColorCurvesEnabled(value: boolean);
  110439. /**
  110440. * Gets wether the color grading effect is enabled.
  110441. */
  110442. get cameraColorGradingEnabled(): boolean;
  110443. /**
  110444. * Gets wether the color grading effect is enabled.
  110445. */
  110446. set cameraColorGradingEnabled(value: boolean);
  110447. /**
  110448. * Gets wether tonemapping is enabled or not.
  110449. */
  110450. get cameraToneMappingEnabled(): boolean;
  110451. /**
  110452. * Sets wether tonemapping is enabled or not
  110453. */
  110454. set cameraToneMappingEnabled(value: boolean);
  110455. /**
  110456. * The camera exposure used on this material.
  110457. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110458. * This corresponds to a photographic exposure.
  110459. */
  110460. get cameraExposure(): number;
  110461. /**
  110462. * The camera exposure used on this material.
  110463. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110464. * This corresponds to a photographic exposure.
  110465. */
  110466. set cameraExposure(value: number);
  110467. /**
  110468. * Gets The camera contrast used on this material.
  110469. */
  110470. get cameraContrast(): number;
  110471. /**
  110472. * Sets The camera contrast used on this material.
  110473. */
  110474. set cameraContrast(value: number);
  110475. /**
  110476. * Gets the Color Grading 2D Lookup Texture.
  110477. */
  110478. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110479. /**
  110480. * Sets the Color Grading 2D Lookup Texture.
  110481. */
  110482. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110483. /**
  110484. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110485. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110486. * 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;
  110487. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110488. */
  110489. get cameraColorCurves(): Nullable<ColorCurves>;
  110490. /**
  110491. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110492. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110493. * 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;
  110494. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110495. */
  110496. set cameraColorCurves(value: Nullable<ColorCurves>);
  110497. /**
  110498. * Can this material render to several textures at once
  110499. */
  110500. get canRenderToMRT(): boolean;
  110501. /**
  110502. * Defines the detail map parameters for the material.
  110503. */
  110504. readonly detailMap: DetailMapConfiguration;
  110505. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110506. protected _worldViewProjectionMatrix: Matrix;
  110507. protected _globalAmbientColor: Color3;
  110508. protected _useLogarithmicDepth: boolean;
  110509. protected _rebuildInParallel: boolean;
  110510. /**
  110511. * Instantiates a new standard material.
  110512. * This is the default material used in Babylon. It is the best trade off between quality
  110513. * and performances.
  110514. * @see https://doc.babylonjs.com/babylon101/materials
  110515. * @param name Define the name of the material in the scene
  110516. * @param scene Define the scene the material belong to
  110517. */
  110518. constructor(name: string, scene: Scene);
  110519. /**
  110520. * Gets a boolean indicating that current material needs to register RTT
  110521. */
  110522. get hasRenderTargetTextures(): boolean;
  110523. /**
  110524. * Gets the current class name of the material e.g. "StandardMaterial"
  110525. * Mainly use in serialization.
  110526. * @returns the class name
  110527. */
  110528. getClassName(): string;
  110529. /**
  110530. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110531. * You can try switching to logarithmic depth.
  110532. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110533. */
  110534. get useLogarithmicDepth(): boolean;
  110535. set useLogarithmicDepth(value: boolean);
  110536. /**
  110537. * Specifies if the material will require alpha blending
  110538. * @returns a boolean specifying if alpha blending is needed
  110539. */
  110540. needAlphaBlending(): boolean;
  110541. /**
  110542. * Specifies if this material should be rendered in alpha test mode
  110543. * @returns a boolean specifying if an alpha test is needed.
  110544. */
  110545. needAlphaTesting(): boolean;
  110546. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110547. /**
  110548. * Get the texture used for alpha test purpose.
  110549. * @returns the diffuse texture in case of the standard material.
  110550. */
  110551. getAlphaTestTexture(): Nullable<BaseTexture>;
  110552. /**
  110553. * Get if the submesh is ready to be used and all its information available.
  110554. * Child classes can use it to update shaders
  110555. * @param mesh defines the mesh to check
  110556. * @param subMesh defines which submesh to check
  110557. * @param useInstances specifies that instances should be used
  110558. * @returns a boolean indicating that the submesh is ready or not
  110559. */
  110560. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110561. /**
  110562. * Builds the material UBO layouts.
  110563. * Used internally during the effect preparation.
  110564. */
  110565. buildUniformLayout(): void;
  110566. /**
  110567. * Unbinds the material from the mesh
  110568. */
  110569. unbind(): void;
  110570. /**
  110571. * Binds the submesh to this material by preparing the effect and shader to draw
  110572. * @param world defines the world transformation matrix
  110573. * @param mesh defines the mesh containing the submesh
  110574. * @param subMesh defines the submesh to bind the material to
  110575. */
  110576. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110577. /**
  110578. * Get the list of animatables in the material.
  110579. * @returns the list of animatables object used in the material
  110580. */
  110581. getAnimatables(): IAnimatable[];
  110582. /**
  110583. * Gets the active textures from the material
  110584. * @returns an array of textures
  110585. */
  110586. getActiveTextures(): BaseTexture[];
  110587. /**
  110588. * Specifies if the material uses a texture
  110589. * @param texture defines the texture to check against the material
  110590. * @returns a boolean specifying if the material uses the texture
  110591. */
  110592. hasTexture(texture: BaseTexture): boolean;
  110593. /**
  110594. * Disposes the material
  110595. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110596. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110597. */
  110598. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110599. /**
  110600. * Makes a duplicate of the material, and gives it a new name
  110601. * @param name defines the new name for the duplicated material
  110602. * @returns the cloned material
  110603. */
  110604. clone(name: string): StandardMaterial;
  110605. /**
  110606. * Serializes this material in a JSON representation
  110607. * @returns the serialized material object
  110608. */
  110609. serialize(): any;
  110610. /**
  110611. * Creates a standard material from parsed material data
  110612. * @param source defines the JSON representation of the material
  110613. * @param scene defines the hosting scene
  110614. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110615. * @returns a new standard material
  110616. */
  110617. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110618. /**
  110619. * Are diffuse textures enabled in the application.
  110620. */
  110621. static get DiffuseTextureEnabled(): boolean;
  110622. static set DiffuseTextureEnabled(value: boolean);
  110623. /**
  110624. * Are detail textures enabled in the application.
  110625. */
  110626. static get DetailTextureEnabled(): boolean;
  110627. static set DetailTextureEnabled(value: boolean);
  110628. /**
  110629. * Are ambient textures enabled in the application.
  110630. */
  110631. static get AmbientTextureEnabled(): boolean;
  110632. static set AmbientTextureEnabled(value: boolean);
  110633. /**
  110634. * Are opacity textures enabled in the application.
  110635. */
  110636. static get OpacityTextureEnabled(): boolean;
  110637. static set OpacityTextureEnabled(value: boolean);
  110638. /**
  110639. * Are reflection textures enabled in the application.
  110640. */
  110641. static get ReflectionTextureEnabled(): boolean;
  110642. static set ReflectionTextureEnabled(value: boolean);
  110643. /**
  110644. * Are emissive textures enabled in the application.
  110645. */
  110646. static get EmissiveTextureEnabled(): boolean;
  110647. static set EmissiveTextureEnabled(value: boolean);
  110648. /**
  110649. * Are specular textures enabled in the application.
  110650. */
  110651. static get SpecularTextureEnabled(): boolean;
  110652. static set SpecularTextureEnabled(value: boolean);
  110653. /**
  110654. * Are bump textures enabled in the application.
  110655. */
  110656. static get BumpTextureEnabled(): boolean;
  110657. static set BumpTextureEnabled(value: boolean);
  110658. /**
  110659. * Are lightmap textures enabled in the application.
  110660. */
  110661. static get LightmapTextureEnabled(): boolean;
  110662. static set LightmapTextureEnabled(value: boolean);
  110663. /**
  110664. * Are refraction textures enabled in the application.
  110665. */
  110666. static get RefractionTextureEnabled(): boolean;
  110667. static set RefractionTextureEnabled(value: boolean);
  110668. /**
  110669. * Are color grading textures enabled in the application.
  110670. */
  110671. static get ColorGradingTextureEnabled(): boolean;
  110672. static set ColorGradingTextureEnabled(value: boolean);
  110673. /**
  110674. * Are fresnels enabled in the application.
  110675. */
  110676. static get FresnelEnabled(): boolean;
  110677. static set FresnelEnabled(value: boolean);
  110678. }
  110679. }
  110680. declare module BABYLON {
  110681. /**
  110682. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110683. *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.
  110684. * The SPS is also a particle system. It provides some methods to manage the particles.
  110685. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110686. *
  110687. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110688. */
  110689. export class SolidParticleSystem implements IDisposable {
  110690. /**
  110691. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110692. * Example : var p = SPS.particles[i];
  110693. */
  110694. particles: SolidParticle[];
  110695. /**
  110696. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110697. */
  110698. nbParticles: number;
  110699. /**
  110700. * If the particles must ever face the camera (default false). Useful for planar particles.
  110701. */
  110702. billboard: boolean;
  110703. /**
  110704. * Recompute normals when adding a shape
  110705. */
  110706. recomputeNormals: boolean;
  110707. /**
  110708. * This a counter ofr your own usage. It's not set by any SPS functions.
  110709. */
  110710. counter: number;
  110711. /**
  110712. * The SPS name. This name is also given to the underlying mesh.
  110713. */
  110714. name: string;
  110715. /**
  110716. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110717. */
  110718. mesh: Mesh;
  110719. /**
  110720. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110721. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110722. */
  110723. vars: any;
  110724. /**
  110725. * This array is populated when the SPS is set as 'pickable'.
  110726. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110727. * Each element of this array is an object `{idx: int, faceId: int}`.
  110728. * `idx` is the picked particle index in the `SPS.particles` array
  110729. * `faceId` is the picked face index counted within this particle.
  110730. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110731. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110732. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110733. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110734. */
  110735. pickedParticles: {
  110736. idx: number;
  110737. faceId: number;
  110738. }[];
  110739. /**
  110740. * This array is populated when the SPS is set as 'pickable'
  110741. * Each key of this array is a submesh index.
  110742. * Each element of this array is a second array defined like this :
  110743. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110744. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110745. * `idx` is the picked particle index in the `SPS.particles` array
  110746. * `faceId` is the picked face index counted within this particle.
  110747. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110748. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110749. */
  110750. pickedBySubMesh: {
  110751. idx: number;
  110752. faceId: number;
  110753. }[][];
  110754. /**
  110755. * This array is populated when `enableDepthSort` is set to true.
  110756. * Each element of this array is an instance of the class DepthSortedParticle.
  110757. */
  110758. depthSortedParticles: DepthSortedParticle[];
  110759. /**
  110760. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110761. * @hidden
  110762. */
  110763. _bSphereOnly: boolean;
  110764. /**
  110765. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110766. * @hidden
  110767. */
  110768. _bSphereRadiusFactor: number;
  110769. private _scene;
  110770. private _positions;
  110771. private _indices;
  110772. private _normals;
  110773. private _colors;
  110774. private _uvs;
  110775. private _indices32;
  110776. private _positions32;
  110777. private _normals32;
  110778. private _fixedNormal32;
  110779. private _colors32;
  110780. private _uvs32;
  110781. private _index;
  110782. private _updatable;
  110783. private _pickable;
  110784. private _isVisibilityBoxLocked;
  110785. private _alwaysVisible;
  110786. private _depthSort;
  110787. private _expandable;
  110788. private _shapeCounter;
  110789. private _copy;
  110790. private _color;
  110791. private _computeParticleColor;
  110792. private _computeParticleTexture;
  110793. private _computeParticleRotation;
  110794. private _computeParticleVertex;
  110795. private _computeBoundingBox;
  110796. private _depthSortParticles;
  110797. private _camera;
  110798. private _mustUnrotateFixedNormals;
  110799. private _particlesIntersect;
  110800. private _needs32Bits;
  110801. private _isNotBuilt;
  110802. private _lastParticleId;
  110803. private _idxOfId;
  110804. private _multimaterialEnabled;
  110805. private _useModelMaterial;
  110806. private _indicesByMaterial;
  110807. private _materialIndexes;
  110808. private _depthSortFunction;
  110809. private _materialSortFunction;
  110810. private _materials;
  110811. private _multimaterial;
  110812. private _materialIndexesById;
  110813. private _defaultMaterial;
  110814. private _autoUpdateSubMeshes;
  110815. private _tmpVertex;
  110816. /**
  110817. * Creates a SPS (Solid Particle System) object.
  110818. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110819. * @param scene (Scene) is the scene in which the SPS is added.
  110820. * @param options defines the options of the sps e.g.
  110821. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110822. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110823. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110824. * * 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.
  110825. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110826. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110827. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110828. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110829. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110830. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110831. */
  110832. constructor(name: string, scene: Scene, options?: {
  110833. updatable?: boolean;
  110834. isPickable?: boolean;
  110835. enableDepthSort?: boolean;
  110836. particleIntersection?: boolean;
  110837. boundingSphereOnly?: boolean;
  110838. bSphereRadiusFactor?: number;
  110839. expandable?: boolean;
  110840. useModelMaterial?: boolean;
  110841. enableMultiMaterial?: boolean;
  110842. });
  110843. /**
  110844. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110845. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110846. * @returns the created mesh
  110847. */
  110848. buildMesh(): Mesh;
  110849. /**
  110850. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110851. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110852. * Thus the particles generated from `digest()` have their property `position` set yet.
  110853. * @param mesh ( Mesh ) is the mesh to be digested
  110854. * @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
  110855. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110856. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110857. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110858. * @returns the current SPS
  110859. */
  110860. digest(mesh: Mesh, options?: {
  110861. facetNb?: number;
  110862. number?: number;
  110863. delta?: number;
  110864. storage?: [];
  110865. }): SolidParticleSystem;
  110866. /**
  110867. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110868. * @hidden
  110869. */
  110870. private _unrotateFixedNormals;
  110871. /**
  110872. * Resets the temporary working copy particle
  110873. * @hidden
  110874. */
  110875. private _resetCopy;
  110876. /**
  110877. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110878. * @param p the current index in the positions array to be updated
  110879. * @param ind the current index in the indices array
  110880. * @param shape a Vector3 array, the shape geometry
  110881. * @param positions the positions array to be updated
  110882. * @param meshInd the shape indices array
  110883. * @param indices the indices array to be updated
  110884. * @param meshUV the shape uv array
  110885. * @param uvs the uv array to be updated
  110886. * @param meshCol the shape color array
  110887. * @param colors the color array to be updated
  110888. * @param meshNor the shape normals array
  110889. * @param normals the normals array to be updated
  110890. * @param idx the particle index
  110891. * @param idxInShape the particle index in its shape
  110892. * @param options the addShape() method passed options
  110893. * @model the particle model
  110894. * @hidden
  110895. */
  110896. private _meshBuilder;
  110897. /**
  110898. * Returns a shape Vector3 array from positions float array
  110899. * @param positions float array
  110900. * @returns a vector3 array
  110901. * @hidden
  110902. */
  110903. private _posToShape;
  110904. /**
  110905. * Returns a shapeUV array from a float uvs (array deep copy)
  110906. * @param uvs as a float array
  110907. * @returns a shapeUV array
  110908. * @hidden
  110909. */
  110910. private _uvsToShapeUV;
  110911. /**
  110912. * Adds a new particle object in the particles array
  110913. * @param idx particle index in particles array
  110914. * @param id particle id
  110915. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110916. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110917. * @param model particle ModelShape object
  110918. * @param shapeId model shape identifier
  110919. * @param idxInShape index of the particle in the current model
  110920. * @param bInfo model bounding info object
  110921. * @param storage target storage array, if any
  110922. * @hidden
  110923. */
  110924. private _addParticle;
  110925. /**
  110926. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110927. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110928. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110929. * @param nb (positive integer) the number of particles to be created from this model
  110930. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110931. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110932. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110933. * @returns the number of shapes in the system
  110934. */
  110935. addShape(mesh: Mesh, nb: number, options?: {
  110936. positionFunction?: any;
  110937. vertexFunction?: any;
  110938. storage?: [];
  110939. }): number;
  110940. /**
  110941. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110942. * @hidden
  110943. */
  110944. private _rebuildParticle;
  110945. /**
  110946. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110947. * @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.
  110948. * @returns the SPS.
  110949. */
  110950. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110951. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110952. * Returns an array with the removed particles.
  110953. * 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.
  110954. * The SPS can't be empty so at least one particle needs to remain in place.
  110955. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110956. * @param start index of the first particle to remove
  110957. * @param end index of the last particle to remove (included)
  110958. * @returns an array populated with the removed particles
  110959. */
  110960. removeParticles(start: number, end: number): SolidParticle[];
  110961. /**
  110962. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110963. * @param solidParticleArray an array populated with Solid Particles objects
  110964. * @returns the SPS
  110965. */
  110966. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110967. /**
  110968. * Creates a new particle and modifies the SPS mesh geometry :
  110969. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110970. * - calls _addParticle() to populate the particle array
  110971. * factorized code from addShape() and insertParticlesFromArray()
  110972. * @param idx particle index in the particles array
  110973. * @param i particle index in its shape
  110974. * @param modelShape particle ModelShape object
  110975. * @param shape shape vertex array
  110976. * @param meshInd shape indices array
  110977. * @param meshUV shape uv array
  110978. * @param meshCol shape color array
  110979. * @param meshNor shape normals array
  110980. * @param bbInfo shape bounding info
  110981. * @param storage target particle storage
  110982. * @options addShape() passed options
  110983. * @hidden
  110984. */
  110985. private _insertNewParticle;
  110986. /**
  110987. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110988. * This method calls `updateParticle()` for each particle of the SPS.
  110989. * For an animated SPS, it is usually called within the render loop.
  110990. * 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.
  110991. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110992. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110993. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110994. * @returns the SPS.
  110995. */
  110996. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110997. /**
  110998. * Disposes the SPS.
  110999. */
  111000. dispose(): void;
  111001. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  111002. * idx is the particle index in the SPS
  111003. * faceId is the picked face index counted within this particle.
  111004. * Returns null if the pickInfo can't identify a picked particle.
  111005. * @param pickingInfo (PickingInfo object)
  111006. * @returns {idx: number, faceId: number} or null
  111007. */
  111008. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  111009. idx: number;
  111010. faceId: number;
  111011. }>;
  111012. /**
  111013. * Returns a SolidParticle object from its identifier : particle.id
  111014. * @param id (integer) the particle Id
  111015. * @returns the searched particle or null if not found in the SPS.
  111016. */
  111017. getParticleById(id: number): Nullable<SolidParticle>;
  111018. /**
  111019. * Returns a new array populated with the particles having the passed shapeId.
  111020. * @param shapeId (integer) the shape identifier
  111021. * @returns a new solid particle array
  111022. */
  111023. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111024. /**
  111025. * Populates the passed array "ref" with the particles having the passed shapeId.
  111026. * @param shapeId the shape identifier
  111027. * @returns the SPS
  111028. * @param ref
  111029. */
  111030. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111031. /**
  111032. * Computes the required SubMeshes according the materials assigned to the particles.
  111033. * @returns the solid particle system.
  111034. * Does nothing if called before the SPS mesh is built.
  111035. */
  111036. computeSubMeshes(): SolidParticleSystem;
  111037. /**
  111038. * Sorts the solid particles by material when MultiMaterial is enabled.
  111039. * Updates the indices32 array.
  111040. * Updates the indicesByMaterial array.
  111041. * Updates the mesh indices array.
  111042. * @returns the SPS
  111043. * @hidden
  111044. */
  111045. private _sortParticlesByMaterial;
  111046. /**
  111047. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111048. * @hidden
  111049. */
  111050. private _setMaterialIndexesById;
  111051. /**
  111052. * Returns an array with unique values of Materials from the passed array
  111053. * @param array the material array to be checked and filtered
  111054. * @hidden
  111055. */
  111056. private _filterUniqueMaterialId;
  111057. /**
  111058. * Sets a new Standard Material as _defaultMaterial if not already set.
  111059. * @hidden
  111060. */
  111061. private _setDefaultMaterial;
  111062. /**
  111063. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111064. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111065. * @returns the SPS.
  111066. */
  111067. refreshVisibleSize(): SolidParticleSystem;
  111068. /**
  111069. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111070. * @param size the size (float) of the visibility box
  111071. * note : this doesn't lock the SPS mesh bounding box.
  111072. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111073. */
  111074. setVisibilityBox(size: number): void;
  111075. /**
  111076. * Gets whether the SPS as always visible or not
  111077. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111078. */
  111079. get isAlwaysVisible(): boolean;
  111080. /**
  111081. * Sets the SPS as always visible or not
  111082. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111083. */
  111084. set isAlwaysVisible(val: boolean);
  111085. /**
  111086. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111087. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111088. */
  111089. set isVisibilityBoxLocked(val: boolean);
  111090. /**
  111091. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111092. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111093. */
  111094. get isVisibilityBoxLocked(): boolean;
  111095. /**
  111096. * Tells to `setParticles()` to compute the particle rotations or not.
  111097. * Default value : true. The SPS is faster when it's set to false.
  111098. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111099. */
  111100. set computeParticleRotation(val: boolean);
  111101. /**
  111102. * Tells to `setParticles()` to compute the particle colors or not.
  111103. * Default value : true. The SPS is faster when it's set to false.
  111104. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111105. */
  111106. set computeParticleColor(val: boolean);
  111107. set computeParticleTexture(val: boolean);
  111108. /**
  111109. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111110. * Default value : false. The SPS is faster when it's set to false.
  111111. * Note : the particle custom vertex positions aren't stored values.
  111112. */
  111113. set computeParticleVertex(val: boolean);
  111114. /**
  111115. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111116. */
  111117. set computeBoundingBox(val: boolean);
  111118. /**
  111119. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111120. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111121. * Default : `true`
  111122. */
  111123. set depthSortParticles(val: boolean);
  111124. /**
  111125. * Gets if `setParticles()` computes the particle rotations or not.
  111126. * Default value : true. The SPS is faster when it's set to false.
  111127. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111128. */
  111129. get computeParticleRotation(): boolean;
  111130. /**
  111131. * Gets if `setParticles()` computes the particle colors or not.
  111132. * Default value : true. The SPS is faster when it's set to false.
  111133. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111134. */
  111135. get computeParticleColor(): boolean;
  111136. /**
  111137. * Gets if `setParticles()` computes the particle textures or not.
  111138. * Default value : true. The SPS is faster when it's set to false.
  111139. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111140. */
  111141. get computeParticleTexture(): boolean;
  111142. /**
  111143. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111144. * Default value : false. The SPS is faster when it's set to false.
  111145. * Note : the particle custom vertex positions aren't stored values.
  111146. */
  111147. get computeParticleVertex(): boolean;
  111148. /**
  111149. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111150. */
  111151. get computeBoundingBox(): boolean;
  111152. /**
  111153. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111154. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111155. * Default : `true`
  111156. */
  111157. get depthSortParticles(): boolean;
  111158. /**
  111159. * Gets if the SPS is created as expandable at construction time.
  111160. * Default : `false`
  111161. */
  111162. get expandable(): boolean;
  111163. /**
  111164. * Gets if the SPS supports the Multi Materials
  111165. */
  111166. get multimaterialEnabled(): boolean;
  111167. /**
  111168. * Gets if the SPS uses the model materials for its own multimaterial.
  111169. */
  111170. get useModelMaterial(): boolean;
  111171. /**
  111172. * The SPS used material array.
  111173. */
  111174. get materials(): Material[];
  111175. /**
  111176. * Sets the SPS MultiMaterial from the passed materials.
  111177. * Note : the passed array is internally copied and not used then by reference.
  111178. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111179. */
  111180. setMultiMaterial(materials: Material[]): void;
  111181. /**
  111182. * The SPS computed multimaterial object
  111183. */
  111184. get multimaterial(): MultiMaterial;
  111185. set multimaterial(mm: MultiMaterial);
  111186. /**
  111187. * If the subMeshes must be updated on the next call to setParticles()
  111188. */
  111189. get autoUpdateSubMeshes(): boolean;
  111190. set autoUpdateSubMeshes(val: boolean);
  111191. /**
  111192. * This function does nothing. It may be overwritten to set all the particle first values.
  111193. * The SPS doesn't call this function, you may have to call it by your own.
  111194. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111195. */
  111196. initParticles(): void;
  111197. /**
  111198. * This function does nothing. It may be overwritten to recycle a particle.
  111199. * The SPS doesn't call this function, you may have to call it by your own.
  111200. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111201. * @param particle The particle to recycle
  111202. * @returns the recycled particle
  111203. */
  111204. recycleParticle(particle: SolidParticle): SolidParticle;
  111205. /**
  111206. * Updates a particle : this function should be overwritten by the user.
  111207. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111208. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111209. * @example : just set a particle position or velocity and recycle conditions
  111210. * @param particle The particle to update
  111211. * @returns the updated particle
  111212. */
  111213. updateParticle(particle: SolidParticle): SolidParticle;
  111214. /**
  111215. * Updates a vertex of a particle : it can be overwritten by the user.
  111216. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111217. * @param particle the current particle
  111218. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111219. * @param pt the index of the current vertex in the particle shape
  111220. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111221. * @example : just set a vertex particle position or color
  111222. * @returns the sps
  111223. */
  111224. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111225. /**
  111226. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111227. * This does nothing and may be overwritten by the user.
  111228. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111229. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111230. * @param update the boolean update value actually passed to setParticles()
  111231. */
  111232. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111233. /**
  111234. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111235. * This will be passed three parameters.
  111236. * This does nothing and may be overwritten by the user.
  111237. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111238. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111239. * @param update the boolean update value actually passed to setParticles()
  111240. */
  111241. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111242. }
  111243. }
  111244. declare module BABYLON {
  111245. /**
  111246. * Represents one particle of a solid particle system.
  111247. */
  111248. export class SolidParticle {
  111249. /**
  111250. * particle global index
  111251. */
  111252. idx: number;
  111253. /**
  111254. * particle identifier
  111255. */
  111256. id: number;
  111257. /**
  111258. * The color of the particle
  111259. */
  111260. color: Nullable<Color4>;
  111261. /**
  111262. * The world space position of the particle.
  111263. */
  111264. position: Vector3;
  111265. /**
  111266. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111267. */
  111268. rotation: Vector3;
  111269. /**
  111270. * The world space rotation quaternion of the particle.
  111271. */
  111272. rotationQuaternion: Nullable<Quaternion>;
  111273. /**
  111274. * The scaling of the particle.
  111275. */
  111276. scaling: Vector3;
  111277. /**
  111278. * The uvs of the particle.
  111279. */
  111280. uvs: Vector4;
  111281. /**
  111282. * The current speed of the particle.
  111283. */
  111284. velocity: Vector3;
  111285. /**
  111286. * The pivot point in the particle local space.
  111287. */
  111288. pivot: Vector3;
  111289. /**
  111290. * Must the particle be translated from its pivot point in its local space ?
  111291. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111292. * Default : false
  111293. */
  111294. translateFromPivot: boolean;
  111295. /**
  111296. * Is the particle active or not ?
  111297. */
  111298. alive: boolean;
  111299. /**
  111300. * Is the particle visible or not ?
  111301. */
  111302. isVisible: boolean;
  111303. /**
  111304. * Index of this particle in the global "positions" array (Internal use)
  111305. * @hidden
  111306. */
  111307. _pos: number;
  111308. /**
  111309. * @hidden Index of this particle in the global "indices" array (Internal use)
  111310. */
  111311. _ind: number;
  111312. /**
  111313. * @hidden ModelShape of this particle (Internal use)
  111314. */
  111315. _model: ModelShape;
  111316. /**
  111317. * ModelShape id of this particle
  111318. */
  111319. shapeId: number;
  111320. /**
  111321. * Index of the particle in its shape id
  111322. */
  111323. idxInShape: number;
  111324. /**
  111325. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111326. */
  111327. _modelBoundingInfo: BoundingInfo;
  111328. /**
  111329. * @hidden Particle BoundingInfo object (Internal use)
  111330. */
  111331. _boundingInfo: BoundingInfo;
  111332. /**
  111333. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111334. */
  111335. _sps: SolidParticleSystem;
  111336. /**
  111337. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111338. */
  111339. _stillInvisible: boolean;
  111340. /**
  111341. * @hidden Last computed particle rotation matrix
  111342. */
  111343. _rotationMatrix: number[];
  111344. /**
  111345. * Parent particle Id, if any.
  111346. * Default null.
  111347. */
  111348. parentId: Nullable<number>;
  111349. /**
  111350. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111351. */
  111352. materialIndex: Nullable<number>;
  111353. /**
  111354. * Custom object or properties.
  111355. */
  111356. props: Nullable<any>;
  111357. /**
  111358. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111359. * The possible values are :
  111360. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111361. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111362. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111363. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111364. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111365. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111366. * */
  111367. cullingStrategy: number;
  111368. /**
  111369. * @hidden Internal global position in the SPS.
  111370. */
  111371. _globalPosition: Vector3;
  111372. /**
  111373. * Creates a Solid Particle object.
  111374. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111375. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111376. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111377. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111378. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111379. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111380. * @param shapeId (integer) is the model shape identifier in the SPS.
  111381. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111382. * @param sps defines the sps it is associated to
  111383. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111384. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111385. */
  111386. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111387. /**
  111388. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111389. * @param target the particle target
  111390. * @returns the current particle
  111391. */
  111392. copyToRef(target: SolidParticle): SolidParticle;
  111393. /**
  111394. * Legacy support, changed scale to scaling
  111395. */
  111396. get scale(): Vector3;
  111397. /**
  111398. * Legacy support, changed scale to scaling
  111399. */
  111400. set scale(scale: Vector3);
  111401. /**
  111402. * Legacy support, changed quaternion to rotationQuaternion
  111403. */
  111404. get quaternion(): Nullable<Quaternion>;
  111405. /**
  111406. * Legacy support, changed quaternion to rotationQuaternion
  111407. */
  111408. set quaternion(q: Nullable<Quaternion>);
  111409. /**
  111410. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111411. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111412. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111413. * @returns true if it intersects
  111414. */
  111415. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111416. /**
  111417. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111418. * A particle is in the frustum if its bounding box intersects the frustum
  111419. * @param frustumPlanes defines the frustum to test
  111420. * @returns true if the particle is in the frustum planes
  111421. */
  111422. isInFrustum(frustumPlanes: Plane[]): boolean;
  111423. /**
  111424. * get the rotation matrix of the particle
  111425. * @hidden
  111426. */
  111427. getRotationMatrix(m: Matrix): void;
  111428. }
  111429. /**
  111430. * Represents the shape of the model used by one particle of a solid particle system.
  111431. * SPS internal tool, don't use it manually.
  111432. */
  111433. export class ModelShape {
  111434. /**
  111435. * The shape id
  111436. * @hidden
  111437. */
  111438. shapeID: number;
  111439. /**
  111440. * flat array of model positions (internal use)
  111441. * @hidden
  111442. */
  111443. _shape: Vector3[];
  111444. /**
  111445. * flat array of model UVs (internal use)
  111446. * @hidden
  111447. */
  111448. _shapeUV: number[];
  111449. /**
  111450. * color array of the model
  111451. * @hidden
  111452. */
  111453. _shapeColors: number[];
  111454. /**
  111455. * indices array of the model
  111456. * @hidden
  111457. */
  111458. _indices: number[];
  111459. /**
  111460. * normals array of the model
  111461. * @hidden
  111462. */
  111463. _normals: number[];
  111464. /**
  111465. * length of the shape in the model indices array (internal use)
  111466. * @hidden
  111467. */
  111468. _indicesLength: number;
  111469. /**
  111470. * Custom position function (internal use)
  111471. * @hidden
  111472. */
  111473. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111474. /**
  111475. * Custom vertex function (internal use)
  111476. * @hidden
  111477. */
  111478. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111479. /**
  111480. * Model material (internal use)
  111481. * @hidden
  111482. */
  111483. _material: Nullable<Material>;
  111484. /**
  111485. * 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.
  111486. * SPS internal tool, don't use it manually.
  111487. * @hidden
  111488. */
  111489. 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>);
  111490. }
  111491. /**
  111492. * Represents a Depth Sorted Particle in the solid particle system.
  111493. * @hidden
  111494. */
  111495. export class DepthSortedParticle {
  111496. /**
  111497. * Particle index
  111498. */
  111499. idx: number;
  111500. /**
  111501. * Index of the particle in the "indices" array
  111502. */
  111503. ind: number;
  111504. /**
  111505. * Length of the particle shape in the "indices" array
  111506. */
  111507. indicesLength: number;
  111508. /**
  111509. * Squared distance from the particle to the camera
  111510. */
  111511. sqDistance: number;
  111512. /**
  111513. * Material index when used with MultiMaterials
  111514. */
  111515. materialIndex: number;
  111516. /**
  111517. * Creates a new sorted particle
  111518. * @param materialIndex
  111519. */
  111520. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111521. }
  111522. /**
  111523. * Represents a solid particle vertex
  111524. */
  111525. export class SolidParticleVertex {
  111526. /**
  111527. * Vertex position
  111528. */
  111529. position: Vector3;
  111530. /**
  111531. * Vertex color
  111532. */
  111533. color: Color4;
  111534. /**
  111535. * Vertex UV
  111536. */
  111537. uv: Vector2;
  111538. /**
  111539. * Creates a new solid particle vertex
  111540. */
  111541. constructor();
  111542. /** Vertex x coordinate */
  111543. get x(): number;
  111544. set x(val: number);
  111545. /** Vertex y coordinate */
  111546. get y(): number;
  111547. set y(val: number);
  111548. /** Vertex z coordinate */
  111549. get z(): number;
  111550. set z(val: number);
  111551. }
  111552. }
  111553. declare module BABYLON {
  111554. /**
  111555. * @hidden
  111556. */
  111557. export class _MeshCollisionData {
  111558. _checkCollisions: boolean;
  111559. _collisionMask: number;
  111560. _collisionGroup: number;
  111561. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111562. _collider: Nullable<Collider>;
  111563. _oldPositionForCollisions: Vector3;
  111564. _diffPositionForCollisions: Vector3;
  111565. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111566. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111567. }
  111568. }
  111569. declare module BABYLON {
  111570. /** @hidden */
  111571. class _FacetDataStorage {
  111572. facetPositions: Vector3[];
  111573. facetNormals: Vector3[];
  111574. facetPartitioning: number[][];
  111575. facetNb: number;
  111576. partitioningSubdivisions: number;
  111577. partitioningBBoxRatio: number;
  111578. facetDataEnabled: boolean;
  111579. facetParameters: any;
  111580. bbSize: Vector3;
  111581. subDiv: {
  111582. max: number;
  111583. X: number;
  111584. Y: number;
  111585. Z: number;
  111586. };
  111587. facetDepthSort: boolean;
  111588. facetDepthSortEnabled: boolean;
  111589. depthSortedIndices: IndicesArray;
  111590. depthSortedFacets: {
  111591. ind: number;
  111592. sqDistance: number;
  111593. }[];
  111594. facetDepthSortFunction: (f1: {
  111595. ind: number;
  111596. sqDistance: number;
  111597. }, f2: {
  111598. ind: number;
  111599. sqDistance: number;
  111600. }) => number;
  111601. facetDepthSortFrom: Vector3;
  111602. facetDepthSortOrigin: Vector3;
  111603. invertedMatrix: Matrix;
  111604. }
  111605. /**
  111606. * @hidden
  111607. **/
  111608. class _InternalAbstractMeshDataInfo {
  111609. _hasVertexAlpha: boolean;
  111610. _useVertexColors: boolean;
  111611. _numBoneInfluencers: number;
  111612. _applyFog: boolean;
  111613. _receiveShadows: boolean;
  111614. _facetData: _FacetDataStorage;
  111615. _visibility: number;
  111616. _skeleton: Nullable<Skeleton>;
  111617. _layerMask: number;
  111618. _computeBonesUsingShaders: boolean;
  111619. _isActive: boolean;
  111620. _onlyForInstances: boolean;
  111621. _isActiveIntermediate: boolean;
  111622. _onlyForInstancesIntermediate: boolean;
  111623. _actAsRegularMesh: boolean;
  111624. }
  111625. /**
  111626. * Class used to store all common mesh properties
  111627. */
  111628. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111629. /** No occlusion */
  111630. static OCCLUSION_TYPE_NONE: number;
  111631. /** Occlusion set to optimisitic */
  111632. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111633. /** Occlusion set to strict */
  111634. static OCCLUSION_TYPE_STRICT: number;
  111635. /** Use an accurante occlusion algorithm */
  111636. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111637. /** Use a conservative occlusion algorithm */
  111638. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111639. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111640. * Test order :
  111641. * Is the bounding sphere outside the frustum ?
  111642. * If not, are the bounding box vertices outside the frustum ?
  111643. * It not, then the cullable object is in the frustum.
  111644. */
  111645. static readonly CULLINGSTRATEGY_STANDARD: number;
  111646. /** Culling strategy : Bounding Sphere Only.
  111647. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111648. * It's also less accurate than the standard because some not visible objects can still be selected.
  111649. * Test : is the bounding sphere outside the frustum ?
  111650. * If not, then the cullable object is in the frustum.
  111651. */
  111652. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111653. /** Culling strategy : Optimistic Inclusion.
  111654. * This in an inclusion test first, then the standard exclusion test.
  111655. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111656. * 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.
  111657. * Anyway, it's as accurate as the standard strategy.
  111658. * Test :
  111659. * Is the cullable object bounding sphere center in the frustum ?
  111660. * If not, apply the default culling strategy.
  111661. */
  111662. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111663. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111664. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111665. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111666. * 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.
  111667. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111668. * Test :
  111669. * Is the cullable object bounding sphere center in the frustum ?
  111670. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111671. */
  111672. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111673. /**
  111674. * No billboard
  111675. */
  111676. static get BILLBOARDMODE_NONE(): number;
  111677. /** Billboard on X axis */
  111678. static get BILLBOARDMODE_X(): number;
  111679. /** Billboard on Y axis */
  111680. static get BILLBOARDMODE_Y(): number;
  111681. /** Billboard on Z axis */
  111682. static get BILLBOARDMODE_Z(): number;
  111683. /** Billboard on all axes */
  111684. static get BILLBOARDMODE_ALL(): number;
  111685. /** Billboard on using position instead of orientation */
  111686. static get BILLBOARDMODE_USE_POSITION(): number;
  111687. /** @hidden */
  111688. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111689. /**
  111690. * The culling strategy to use to check whether the mesh must be rendered or not.
  111691. * This value can be changed at any time and will be used on the next render mesh selection.
  111692. * The possible values are :
  111693. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111694. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111695. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111696. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111697. * Please read each static variable documentation to get details about the culling process.
  111698. * */
  111699. cullingStrategy: number;
  111700. /**
  111701. * Gets the number of facets in the mesh
  111702. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111703. */
  111704. get facetNb(): number;
  111705. /**
  111706. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111707. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111708. */
  111709. get partitioningSubdivisions(): number;
  111710. set partitioningSubdivisions(nb: number);
  111711. /**
  111712. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111713. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111714. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111715. */
  111716. get partitioningBBoxRatio(): number;
  111717. set partitioningBBoxRatio(ratio: number);
  111718. /**
  111719. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111720. * Works only for updatable meshes.
  111721. * Doesn't work with multi-materials
  111722. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111723. */
  111724. get mustDepthSortFacets(): boolean;
  111725. set mustDepthSortFacets(sort: boolean);
  111726. /**
  111727. * The location (Vector3) where the facet depth sort must be computed from.
  111728. * By default, the active camera position.
  111729. * Used only when facet depth sort is enabled
  111730. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111731. */
  111732. get facetDepthSortFrom(): Vector3;
  111733. set facetDepthSortFrom(location: Vector3);
  111734. /**
  111735. * gets a boolean indicating if facetData is enabled
  111736. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111737. */
  111738. get isFacetDataEnabled(): boolean;
  111739. /** @hidden */
  111740. _updateNonUniformScalingState(value: boolean): boolean;
  111741. /**
  111742. * An event triggered when this mesh collides with another one
  111743. */
  111744. onCollideObservable: Observable<AbstractMesh>;
  111745. /** Set a function to call when this mesh collides with another one */
  111746. set onCollide(callback: () => void);
  111747. /**
  111748. * An event triggered when the collision's position changes
  111749. */
  111750. onCollisionPositionChangeObservable: Observable<Vector3>;
  111751. /** Set a function to call when the collision's position changes */
  111752. set onCollisionPositionChange(callback: () => void);
  111753. /**
  111754. * An event triggered when material is changed
  111755. */
  111756. onMaterialChangedObservable: Observable<AbstractMesh>;
  111757. /**
  111758. * Gets or sets the orientation for POV movement & rotation
  111759. */
  111760. definedFacingForward: boolean;
  111761. /** @hidden */
  111762. _occlusionQuery: Nullable<WebGLQuery>;
  111763. /** @hidden */
  111764. _renderingGroup: Nullable<RenderingGroup>;
  111765. /**
  111766. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111767. */
  111768. get visibility(): number;
  111769. /**
  111770. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111771. */
  111772. set visibility(value: number);
  111773. /** Gets or sets the alpha index used to sort transparent meshes
  111774. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111775. */
  111776. alphaIndex: number;
  111777. /**
  111778. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111779. */
  111780. isVisible: boolean;
  111781. /**
  111782. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111783. */
  111784. isPickable: boolean;
  111785. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111786. showSubMeshesBoundingBox: boolean;
  111787. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111788. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111789. */
  111790. isBlocker: boolean;
  111791. /**
  111792. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111793. */
  111794. enablePointerMoveEvents: boolean;
  111795. private _renderingGroupId;
  111796. /**
  111797. * Specifies the rendering group id for this mesh (0 by default)
  111798. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111799. */
  111800. get renderingGroupId(): number;
  111801. set renderingGroupId(value: number);
  111802. private _material;
  111803. /** Gets or sets current material */
  111804. get material(): Nullable<Material>;
  111805. set material(value: Nullable<Material>);
  111806. /**
  111807. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111808. * @see https://doc.babylonjs.com/babylon101/shadows
  111809. */
  111810. get receiveShadows(): boolean;
  111811. set receiveShadows(value: boolean);
  111812. /** Defines color to use when rendering outline */
  111813. outlineColor: Color3;
  111814. /** Define width to use when rendering outline */
  111815. outlineWidth: number;
  111816. /** Defines color to use when rendering overlay */
  111817. overlayColor: Color3;
  111818. /** Defines alpha to use when rendering overlay */
  111819. overlayAlpha: number;
  111820. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111821. get hasVertexAlpha(): boolean;
  111822. set hasVertexAlpha(value: boolean);
  111823. /** 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) */
  111824. get useVertexColors(): boolean;
  111825. set useVertexColors(value: boolean);
  111826. /**
  111827. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111828. */
  111829. get computeBonesUsingShaders(): boolean;
  111830. set computeBonesUsingShaders(value: boolean);
  111831. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111832. get numBoneInfluencers(): number;
  111833. set numBoneInfluencers(value: number);
  111834. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111835. get applyFog(): boolean;
  111836. set applyFog(value: boolean);
  111837. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111838. useOctreeForRenderingSelection: boolean;
  111839. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111840. useOctreeForPicking: boolean;
  111841. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111842. useOctreeForCollisions: boolean;
  111843. /**
  111844. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111845. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111846. */
  111847. get layerMask(): number;
  111848. set layerMask(value: number);
  111849. /**
  111850. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111851. */
  111852. alwaysSelectAsActiveMesh: boolean;
  111853. /**
  111854. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111855. */
  111856. doNotSyncBoundingInfo: boolean;
  111857. /**
  111858. * Gets or sets the current action manager
  111859. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111860. */
  111861. actionManager: Nullable<AbstractActionManager>;
  111862. private _meshCollisionData;
  111863. /**
  111864. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111865. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111866. */
  111867. ellipsoid: Vector3;
  111868. /**
  111869. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111870. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111871. */
  111872. ellipsoidOffset: Vector3;
  111873. /**
  111874. * Gets or sets a collision mask used to mask collisions (default is -1).
  111875. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111876. */
  111877. get collisionMask(): number;
  111878. set collisionMask(mask: number);
  111879. /**
  111880. * Gets or sets the current collision group mask (-1 by default).
  111881. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111882. */
  111883. get collisionGroup(): number;
  111884. set collisionGroup(mask: number);
  111885. /**
  111886. * Gets or sets current surrounding meshes (null by default).
  111887. *
  111888. * By default collision detection is tested against every mesh in the scene.
  111889. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111890. * meshes will be tested for the collision.
  111891. *
  111892. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111893. */
  111894. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111895. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111896. /**
  111897. * Defines edge width used when edgesRenderer is enabled
  111898. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111899. */
  111900. edgesWidth: number;
  111901. /**
  111902. * Defines edge color used when edgesRenderer is enabled
  111903. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111904. */
  111905. edgesColor: Color4;
  111906. /** @hidden */
  111907. _edgesRenderer: Nullable<IEdgesRenderer>;
  111908. /** @hidden */
  111909. _masterMesh: Nullable<AbstractMesh>;
  111910. /** @hidden */
  111911. _boundingInfo: Nullable<BoundingInfo>;
  111912. /** @hidden */
  111913. _renderId: number;
  111914. /**
  111915. * Gets or sets the list of subMeshes
  111916. * @see https://doc.babylonjs.com/how_to/multi_materials
  111917. */
  111918. subMeshes: SubMesh[];
  111919. /** @hidden */
  111920. _intersectionsInProgress: AbstractMesh[];
  111921. /** @hidden */
  111922. _unIndexed: boolean;
  111923. /** @hidden */
  111924. _lightSources: Light[];
  111925. /** Gets the list of lights affecting that mesh */
  111926. get lightSources(): Light[];
  111927. /** @hidden */
  111928. get _positions(): Nullable<Vector3[]>;
  111929. /** @hidden */
  111930. _waitingData: {
  111931. lods: Nullable<any>;
  111932. actions: Nullable<any>;
  111933. freezeWorldMatrix: Nullable<boolean>;
  111934. };
  111935. /** @hidden */
  111936. _bonesTransformMatrices: Nullable<Float32Array>;
  111937. /** @hidden */
  111938. _transformMatrixTexture: Nullable<RawTexture>;
  111939. /**
  111940. * Gets or sets a skeleton to apply skining transformations
  111941. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111942. */
  111943. set skeleton(value: Nullable<Skeleton>);
  111944. get skeleton(): Nullable<Skeleton>;
  111945. /**
  111946. * An event triggered when the mesh is rebuilt.
  111947. */
  111948. onRebuildObservable: Observable<AbstractMesh>;
  111949. /**
  111950. * Creates a new AbstractMesh
  111951. * @param name defines the name of the mesh
  111952. * @param scene defines the hosting scene
  111953. */
  111954. constructor(name: string, scene?: Nullable<Scene>);
  111955. /**
  111956. * Returns the string "AbstractMesh"
  111957. * @returns "AbstractMesh"
  111958. */
  111959. getClassName(): string;
  111960. /**
  111961. * Gets a string representation of the current mesh
  111962. * @param fullDetails defines a boolean indicating if full details must be included
  111963. * @returns a string representation of the current mesh
  111964. */
  111965. toString(fullDetails?: boolean): string;
  111966. /**
  111967. * @hidden
  111968. */
  111969. protected _getEffectiveParent(): Nullable<Node>;
  111970. /** @hidden */
  111971. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111972. /** @hidden */
  111973. _rebuild(): void;
  111974. /** @hidden */
  111975. _resyncLightSources(): void;
  111976. /** @hidden */
  111977. _resyncLightSource(light: Light): void;
  111978. /** @hidden */
  111979. _unBindEffect(): void;
  111980. /** @hidden */
  111981. _removeLightSource(light: Light, dispose: boolean): void;
  111982. private _markSubMeshesAsDirty;
  111983. /** @hidden */
  111984. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111985. /** @hidden */
  111986. _markSubMeshesAsAttributesDirty(): void;
  111987. /** @hidden */
  111988. _markSubMeshesAsMiscDirty(): void;
  111989. /**
  111990. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111991. */
  111992. get scaling(): Vector3;
  111993. set scaling(newScaling: Vector3);
  111994. /**
  111995. * Returns true if the mesh is blocked. Implemented by child classes
  111996. */
  111997. get isBlocked(): boolean;
  111998. /**
  111999. * Returns the mesh itself by default. Implemented by child classes
  112000. * @param camera defines the camera to use to pick the right LOD level
  112001. * @returns the currentAbstractMesh
  112002. */
  112003. getLOD(camera: Camera): Nullable<AbstractMesh>;
  112004. /**
  112005. * Returns 0 by default. Implemented by child classes
  112006. * @returns an integer
  112007. */
  112008. getTotalVertices(): number;
  112009. /**
  112010. * Returns a positive integer : the total number of indices in this mesh geometry.
  112011. * @returns the numner of indices or zero if the mesh has no geometry.
  112012. */
  112013. getTotalIndices(): number;
  112014. /**
  112015. * Returns null by default. Implemented by child classes
  112016. * @returns null
  112017. */
  112018. getIndices(): Nullable<IndicesArray>;
  112019. /**
  112020. * Returns the array of the requested vertex data kind. Implemented by child classes
  112021. * @param kind defines the vertex data kind to use
  112022. * @returns null
  112023. */
  112024. getVerticesData(kind: string): Nullable<FloatArray>;
  112025. /**
  112026. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112027. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112028. * Note that a new underlying VertexBuffer object is created each call.
  112029. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112030. * @param kind defines vertex data kind:
  112031. * * VertexBuffer.PositionKind
  112032. * * VertexBuffer.UVKind
  112033. * * VertexBuffer.UV2Kind
  112034. * * VertexBuffer.UV3Kind
  112035. * * VertexBuffer.UV4Kind
  112036. * * VertexBuffer.UV5Kind
  112037. * * VertexBuffer.UV6Kind
  112038. * * VertexBuffer.ColorKind
  112039. * * VertexBuffer.MatricesIndicesKind
  112040. * * VertexBuffer.MatricesIndicesExtraKind
  112041. * * VertexBuffer.MatricesWeightsKind
  112042. * * VertexBuffer.MatricesWeightsExtraKind
  112043. * @param data defines the data source
  112044. * @param updatable defines if the data must be flagged as updatable (or static)
  112045. * @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
  112046. * @returns the current mesh
  112047. */
  112048. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112049. /**
  112050. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112051. * If the mesh has no geometry, it is simply returned as it is.
  112052. * @param kind defines vertex data kind:
  112053. * * VertexBuffer.PositionKind
  112054. * * VertexBuffer.UVKind
  112055. * * VertexBuffer.UV2Kind
  112056. * * VertexBuffer.UV3Kind
  112057. * * VertexBuffer.UV4Kind
  112058. * * VertexBuffer.UV5Kind
  112059. * * VertexBuffer.UV6Kind
  112060. * * VertexBuffer.ColorKind
  112061. * * VertexBuffer.MatricesIndicesKind
  112062. * * VertexBuffer.MatricesIndicesExtraKind
  112063. * * VertexBuffer.MatricesWeightsKind
  112064. * * VertexBuffer.MatricesWeightsExtraKind
  112065. * @param data defines the data source
  112066. * @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
  112067. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112068. * @returns the current mesh
  112069. */
  112070. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112071. /**
  112072. * Sets the mesh indices,
  112073. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112074. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112075. * @param totalVertices Defines the total number of vertices
  112076. * @returns the current mesh
  112077. */
  112078. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112079. /**
  112080. * Gets a boolean indicating if specific vertex data is present
  112081. * @param kind defines the vertex data kind to use
  112082. * @returns true is data kind is present
  112083. */
  112084. isVerticesDataPresent(kind: string): boolean;
  112085. /**
  112086. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112087. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112088. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112089. * @returns a BoundingInfo
  112090. */
  112091. getBoundingInfo(): BoundingInfo;
  112092. /**
  112093. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112094. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112095. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112096. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112097. * @returns the current mesh
  112098. */
  112099. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112100. /**
  112101. * Overwrite the current bounding info
  112102. * @param boundingInfo defines the new bounding info
  112103. * @returns the current mesh
  112104. */
  112105. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112106. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112107. get useBones(): boolean;
  112108. /** @hidden */
  112109. _preActivate(): void;
  112110. /** @hidden */
  112111. _preActivateForIntermediateRendering(renderId: number): void;
  112112. /** @hidden */
  112113. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112114. /** @hidden */
  112115. _postActivate(): void;
  112116. /** @hidden */
  112117. _freeze(): void;
  112118. /** @hidden */
  112119. _unFreeze(): void;
  112120. /**
  112121. * Gets the current world matrix
  112122. * @returns a Matrix
  112123. */
  112124. getWorldMatrix(): Matrix;
  112125. /** @hidden */
  112126. _getWorldMatrixDeterminant(): number;
  112127. /**
  112128. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112129. */
  112130. get isAnInstance(): boolean;
  112131. /**
  112132. * Gets a boolean indicating if this mesh has instances
  112133. */
  112134. get hasInstances(): boolean;
  112135. /**
  112136. * Gets a boolean indicating if this mesh has thin instances
  112137. */
  112138. get hasThinInstances(): boolean;
  112139. /**
  112140. * Perform relative position change from the point of view of behind the front of the mesh.
  112141. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112142. * Supports definition of mesh facing forward or backward
  112143. * @param amountRight defines the distance on the right axis
  112144. * @param amountUp defines the distance on the up axis
  112145. * @param amountForward defines the distance on the forward axis
  112146. * @returns the current mesh
  112147. */
  112148. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112149. /**
  112150. * Calculate relative position change from the point of view of behind the front of the mesh.
  112151. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112152. * Supports definition of mesh facing forward or backward
  112153. * @param amountRight defines the distance on the right axis
  112154. * @param amountUp defines the distance on the up axis
  112155. * @param amountForward defines the distance on the forward axis
  112156. * @returns the new displacement vector
  112157. */
  112158. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112159. /**
  112160. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112161. * Supports definition of mesh facing forward or backward
  112162. * @param flipBack defines the flip
  112163. * @param twirlClockwise defines the twirl
  112164. * @param tiltRight defines the tilt
  112165. * @returns the current mesh
  112166. */
  112167. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112168. /**
  112169. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112170. * Supports definition of mesh facing forward or backward.
  112171. * @param flipBack defines the flip
  112172. * @param twirlClockwise defines the twirl
  112173. * @param tiltRight defines the tilt
  112174. * @returns the new rotation vector
  112175. */
  112176. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112177. /**
  112178. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112179. * This means the mesh underlying bounding box and sphere are recomputed.
  112180. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112181. * @returns the current mesh
  112182. */
  112183. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112184. /** @hidden */
  112185. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112186. /** @hidden */
  112187. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112188. /** @hidden */
  112189. _updateBoundingInfo(): AbstractMesh;
  112190. /** @hidden */
  112191. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112192. /** @hidden */
  112193. protected _afterComputeWorldMatrix(): void;
  112194. /** @hidden */
  112195. get _effectiveMesh(): AbstractMesh;
  112196. /**
  112197. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112198. * A mesh is in the frustum if its bounding box intersects the frustum
  112199. * @param frustumPlanes defines the frustum to test
  112200. * @returns true if the mesh is in the frustum planes
  112201. */
  112202. isInFrustum(frustumPlanes: Plane[]): boolean;
  112203. /**
  112204. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112205. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112206. * @param frustumPlanes defines the frustum to test
  112207. * @returns true if the mesh is completely in the frustum planes
  112208. */
  112209. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112210. /**
  112211. * True if the mesh intersects another mesh or a SolidParticle object
  112212. * @param mesh defines a target mesh or SolidParticle to test
  112213. * @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)
  112214. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112215. * @returns true if there is an intersection
  112216. */
  112217. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112218. /**
  112219. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112220. * @param point defines the point to test
  112221. * @returns true if there is an intersection
  112222. */
  112223. intersectsPoint(point: Vector3): boolean;
  112224. /**
  112225. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112226. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112227. */
  112228. get checkCollisions(): boolean;
  112229. set checkCollisions(collisionEnabled: boolean);
  112230. /**
  112231. * Gets Collider object used to compute collisions (not physics)
  112232. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112233. */
  112234. get collider(): Nullable<Collider>;
  112235. /**
  112236. * Move the mesh using collision engine
  112237. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112238. * @param displacement defines the requested displacement vector
  112239. * @returns the current mesh
  112240. */
  112241. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112242. private _onCollisionPositionChange;
  112243. /** @hidden */
  112244. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112245. /** @hidden */
  112246. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112247. /** @hidden */
  112248. _checkCollision(collider: Collider): AbstractMesh;
  112249. /** @hidden */
  112250. _generatePointsArray(): boolean;
  112251. /**
  112252. * Checks if the passed Ray intersects with the mesh
  112253. * @param ray defines the ray to use
  112254. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112255. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112256. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112257. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112258. * @returns the picking info
  112259. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112260. */
  112261. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112262. /**
  112263. * Clones the current mesh
  112264. * @param name defines the mesh name
  112265. * @param newParent defines the new mesh parent
  112266. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112267. * @returns the new mesh
  112268. */
  112269. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112270. /**
  112271. * Disposes all the submeshes of the current meshnp
  112272. * @returns the current mesh
  112273. */
  112274. releaseSubMeshes(): AbstractMesh;
  112275. /**
  112276. * Releases resources associated with this abstract mesh.
  112277. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112278. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112279. */
  112280. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112281. /**
  112282. * Adds the passed mesh as a child to the current mesh
  112283. * @param mesh defines the child mesh
  112284. * @returns the current mesh
  112285. */
  112286. addChild(mesh: AbstractMesh): AbstractMesh;
  112287. /**
  112288. * Removes the passed mesh from the current mesh children list
  112289. * @param mesh defines the child mesh
  112290. * @returns the current mesh
  112291. */
  112292. removeChild(mesh: AbstractMesh): AbstractMesh;
  112293. /** @hidden */
  112294. private _initFacetData;
  112295. /**
  112296. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112297. * This method can be called within the render loop.
  112298. * 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
  112299. * @returns the current mesh
  112300. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112301. */
  112302. updateFacetData(): AbstractMesh;
  112303. /**
  112304. * Returns the facetLocalNormals array.
  112305. * The normals are expressed in the mesh local spac
  112306. * @returns an array of Vector3
  112307. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112308. */
  112309. getFacetLocalNormals(): Vector3[];
  112310. /**
  112311. * Returns the facetLocalPositions array.
  112312. * The facet positions are expressed in the mesh local space
  112313. * @returns an array of Vector3
  112314. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112315. */
  112316. getFacetLocalPositions(): Vector3[];
  112317. /**
  112318. * Returns the facetLocalPartioning array
  112319. * @returns an array of array of numbers
  112320. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112321. */
  112322. getFacetLocalPartitioning(): number[][];
  112323. /**
  112324. * Returns the i-th facet position in the world system.
  112325. * This method allocates a new Vector3 per call
  112326. * @param i defines the facet index
  112327. * @returns a new Vector3
  112328. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112329. */
  112330. getFacetPosition(i: number): Vector3;
  112331. /**
  112332. * Sets the reference Vector3 with the i-th facet position in the world system
  112333. * @param i defines the facet index
  112334. * @param ref defines the target vector
  112335. * @returns the current mesh
  112336. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112337. */
  112338. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112339. /**
  112340. * Returns the i-th facet normal in the world system.
  112341. * This method allocates a new Vector3 per call
  112342. * @param i defines the facet index
  112343. * @returns a new Vector3
  112344. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112345. */
  112346. getFacetNormal(i: number): Vector3;
  112347. /**
  112348. * Sets the reference Vector3 with the i-th facet normal in the world system
  112349. * @param i defines the facet index
  112350. * @param ref defines the target vector
  112351. * @returns the current mesh
  112352. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112353. */
  112354. getFacetNormalToRef(i: number, ref: Vector3): this;
  112355. /**
  112356. * 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)
  112357. * @param x defines x coordinate
  112358. * @param y defines y coordinate
  112359. * @param z defines z coordinate
  112360. * @returns the array of facet indexes
  112361. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112362. */
  112363. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112364. /**
  112365. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112366. * @param projected sets as the (x,y,z) world projection on the facet
  112367. * @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
  112368. * @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
  112369. * @param x defines x coordinate
  112370. * @param y defines y coordinate
  112371. * @param z defines z coordinate
  112372. * @returns the face index if found (or null instead)
  112373. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112374. */
  112375. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112376. /**
  112377. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112378. * @param projected sets as the (x,y,z) local projection on the facet
  112379. * @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
  112380. * @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
  112381. * @param x defines x coordinate
  112382. * @param y defines y coordinate
  112383. * @param z defines z coordinate
  112384. * @returns the face index if found (or null instead)
  112385. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112386. */
  112387. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112388. /**
  112389. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112390. * @returns the parameters
  112391. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112392. */
  112393. getFacetDataParameters(): any;
  112394. /**
  112395. * Disables the feature FacetData and frees the related memory
  112396. * @returns the current mesh
  112397. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112398. */
  112399. disableFacetData(): AbstractMesh;
  112400. /**
  112401. * Updates the AbstractMesh indices array
  112402. * @param indices defines the data source
  112403. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112404. * @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)
  112405. * @returns the current mesh
  112406. */
  112407. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112408. /**
  112409. * Creates new normals data for the mesh
  112410. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112411. * @returns the current mesh
  112412. */
  112413. createNormals(updatable: boolean): AbstractMesh;
  112414. /**
  112415. * Align the mesh with a normal
  112416. * @param normal defines the normal to use
  112417. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112418. * @returns the current mesh
  112419. */
  112420. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112421. /** @hidden */
  112422. _checkOcclusionQuery(): boolean;
  112423. /**
  112424. * Disables the mesh edge rendering mode
  112425. * @returns the currentAbstractMesh
  112426. */
  112427. disableEdgesRendering(): AbstractMesh;
  112428. /**
  112429. * Enables the edge rendering mode on the mesh.
  112430. * This mode makes the mesh edges visible
  112431. * @param epsilon defines the maximal distance between two angles to detect a face
  112432. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112433. * @returns the currentAbstractMesh
  112434. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112435. */
  112436. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112437. /**
  112438. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112439. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112440. */
  112441. getConnectedParticleSystems(): IParticleSystem[];
  112442. }
  112443. }
  112444. declare module BABYLON {
  112445. /**
  112446. * Interface used to define ActionEvent
  112447. */
  112448. export interface IActionEvent {
  112449. /** The mesh or sprite that triggered the action */
  112450. source: any;
  112451. /** The X mouse cursor position at the time of the event */
  112452. pointerX: number;
  112453. /** The Y mouse cursor position at the time of the event */
  112454. pointerY: number;
  112455. /** The mesh that is currently pointed at (can be null) */
  112456. meshUnderPointer: Nullable<AbstractMesh>;
  112457. /** the original (browser) event that triggered the ActionEvent */
  112458. sourceEvent?: any;
  112459. /** additional data for the event */
  112460. additionalData?: any;
  112461. }
  112462. /**
  112463. * ActionEvent is the event being sent when an action is triggered.
  112464. */
  112465. export class ActionEvent implements IActionEvent {
  112466. /** The mesh or sprite that triggered the action */
  112467. source: any;
  112468. /** The X mouse cursor position at the time of the event */
  112469. pointerX: number;
  112470. /** The Y mouse cursor position at the time of the event */
  112471. pointerY: number;
  112472. /** The mesh that is currently pointed at (can be null) */
  112473. meshUnderPointer: Nullable<AbstractMesh>;
  112474. /** the original (browser) event that triggered the ActionEvent */
  112475. sourceEvent?: any;
  112476. /** additional data for the event */
  112477. additionalData?: any;
  112478. /**
  112479. * Creates a new ActionEvent
  112480. * @param source The mesh or sprite that triggered the action
  112481. * @param pointerX The X mouse cursor position at the time of the event
  112482. * @param pointerY The Y mouse cursor position at the time of the event
  112483. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112484. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112485. * @param additionalData additional data for the event
  112486. */
  112487. constructor(
  112488. /** The mesh or sprite that triggered the action */
  112489. source: any,
  112490. /** The X mouse cursor position at the time of the event */
  112491. pointerX: number,
  112492. /** The Y mouse cursor position at the time of the event */
  112493. pointerY: number,
  112494. /** The mesh that is currently pointed at (can be null) */
  112495. meshUnderPointer: Nullable<AbstractMesh>,
  112496. /** the original (browser) event that triggered the ActionEvent */
  112497. sourceEvent?: any,
  112498. /** additional data for the event */
  112499. additionalData?: any);
  112500. /**
  112501. * Helper function to auto-create an ActionEvent from a source mesh.
  112502. * @param source The source mesh that triggered the event
  112503. * @param evt The original (browser) event
  112504. * @param additionalData additional data for the event
  112505. * @returns the new ActionEvent
  112506. */
  112507. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112508. /**
  112509. * Helper function to auto-create an ActionEvent from a source sprite
  112510. * @param source The source sprite that triggered the event
  112511. * @param scene Scene associated with the sprite
  112512. * @param evt The original (browser) event
  112513. * @param additionalData additional data for the event
  112514. * @returns the new ActionEvent
  112515. */
  112516. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112517. /**
  112518. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112519. * @param scene the scene where the event occurred
  112520. * @param evt The original (browser) event
  112521. * @returns the new ActionEvent
  112522. */
  112523. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112524. /**
  112525. * Helper function to auto-create an ActionEvent from a primitive
  112526. * @param prim defines the target primitive
  112527. * @param pointerPos defines the pointer position
  112528. * @param evt The original (browser) event
  112529. * @param additionalData additional data for the event
  112530. * @returns the new ActionEvent
  112531. */
  112532. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112533. }
  112534. }
  112535. declare module BABYLON {
  112536. /**
  112537. * Abstract class used to decouple action Manager from scene and meshes.
  112538. * Do not instantiate.
  112539. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112540. */
  112541. export abstract class AbstractActionManager implements IDisposable {
  112542. /** Gets the list of active triggers */
  112543. static Triggers: {
  112544. [key: string]: number;
  112545. };
  112546. /** Gets the cursor to use when hovering items */
  112547. hoverCursor: string;
  112548. /** Gets the list of actions */
  112549. actions: IAction[];
  112550. /**
  112551. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112552. */
  112553. isRecursive: boolean;
  112554. /**
  112555. * Releases all associated resources
  112556. */
  112557. abstract dispose(): void;
  112558. /**
  112559. * Does this action manager has pointer triggers
  112560. */
  112561. abstract get hasPointerTriggers(): boolean;
  112562. /**
  112563. * Does this action manager has pick triggers
  112564. */
  112565. abstract get hasPickTriggers(): boolean;
  112566. /**
  112567. * Process a specific trigger
  112568. * @param trigger defines the trigger to process
  112569. * @param evt defines the event details to be processed
  112570. */
  112571. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112572. /**
  112573. * Does this action manager handles actions of any of the given triggers
  112574. * @param triggers defines the triggers to be tested
  112575. * @return a boolean indicating whether one (or more) of the triggers is handled
  112576. */
  112577. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112578. /**
  112579. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112580. * speed.
  112581. * @param triggerA defines the trigger to be tested
  112582. * @param triggerB defines the trigger to be tested
  112583. * @return a boolean indicating whether one (or more) of the triggers is handled
  112584. */
  112585. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112586. /**
  112587. * Does this action manager handles actions of a given trigger
  112588. * @param trigger defines the trigger to be tested
  112589. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112590. * @return whether the trigger is handled
  112591. */
  112592. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112593. /**
  112594. * Serialize this manager to a JSON object
  112595. * @param name defines the property name to store this manager
  112596. * @returns a JSON representation of this manager
  112597. */
  112598. abstract serialize(name: string): any;
  112599. /**
  112600. * Registers an action to this action manager
  112601. * @param action defines the action to be registered
  112602. * @return the action amended (prepared) after registration
  112603. */
  112604. abstract registerAction(action: IAction): Nullable<IAction>;
  112605. /**
  112606. * Unregisters an action to this action manager
  112607. * @param action defines the action to be unregistered
  112608. * @return a boolean indicating whether the action has been unregistered
  112609. */
  112610. abstract unregisterAction(action: IAction): Boolean;
  112611. /**
  112612. * Does exist one action manager with at least one trigger
  112613. **/
  112614. static get HasTriggers(): boolean;
  112615. /**
  112616. * Does exist one action manager with at least one pick trigger
  112617. **/
  112618. static get HasPickTriggers(): boolean;
  112619. /**
  112620. * Does exist one action manager that handles actions of a given trigger
  112621. * @param trigger defines the trigger to be tested
  112622. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112623. **/
  112624. static HasSpecificTrigger(trigger: number): boolean;
  112625. }
  112626. }
  112627. declare module BABYLON {
  112628. /**
  112629. * Defines how a node can be built from a string name.
  112630. */
  112631. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112632. /**
  112633. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112634. */
  112635. export class Node implements IBehaviorAware<Node> {
  112636. /** @hidden */
  112637. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112638. private static _NodeConstructors;
  112639. /**
  112640. * Add a new node constructor
  112641. * @param type defines the type name of the node to construct
  112642. * @param constructorFunc defines the constructor function
  112643. */
  112644. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112645. /**
  112646. * Returns a node constructor based on type name
  112647. * @param type defines the type name
  112648. * @param name defines the new node name
  112649. * @param scene defines the hosting scene
  112650. * @param options defines optional options to transmit to constructors
  112651. * @returns the new constructor or null
  112652. */
  112653. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112654. /**
  112655. * Gets or sets the name of the node
  112656. */
  112657. name: string;
  112658. /**
  112659. * Gets or sets the id of the node
  112660. */
  112661. id: string;
  112662. /**
  112663. * Gets or sets the unique id of the node
  112664. */
  112665. uniqueId: number;
  112666. /**
  112667. * Gets or sets a string used to store user defined state for the node
  112668. */
  112669. state: string;
  112670. /**
  112671. * Gets or sets an object used to store user defined information for the node
  112672. */
  112673. metadata: any;
  112674. /**
  112675. * For internal use only. Please do not use.
  112676. */
  112677. reservedDataStore: any;
  112678. /**
  112679. * List of inspectable custom properties (used by the Inspector)
  112680. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112681. */
  112682. inspectableCustomProperties: IInspectable[];
  112683. private _doNotSerialize;
  112684. /**
  112685. * Gets or sets a boolean used to define if the node must be serialized
  112686. */
  112687. get doNotSerialize(): boolean;
  112688. set doNotSerialize(value: boolean);
  112689. /** @hidden */
  112690. _isDisposed: boolean;
  112691. /**
  112692. * Gets a list of Animations associated with the node
  112693. */
  112694. animations: Animation[];
  112695. protected _ranges: {
  112696. [name: string]: Nullable<AnimationRange>;
  112697. };
  112698. /**
  112699. * Callback raised when the node is ready to be used
  112700. */
  112701. onReady: Nullable<(node: Node) => void>;
  112702. private _isEnabled;
  112703. private _isParentEnabled;
  112704. private _isReady;
  112705. /** @hidden */
  112706. _currentRenderId: number;
  112707. private _parentUpdateId;
  112708. /** @hidden */
  112709. _childUpdateId: number;
  112710. /** @hidden */
  112711. _waitingParentId: Nullable<string>;
  112712. /** @hidden */
  112713. _scene: Scene;
  112714. /** @hidden */
  112715. _cache: any;
  112716. private _parentNode;
  112717. private _children;
  112718. /** @hidden */
  112719. _worldMatrix: Matrix;
  112720. /** @hidden */
  112721. _worldMatrixDeterminant: number;
  112722. /** @hidden */
  112723. _worldMatrixDeterminantIsDirty: boolean;
  112724. /** @hidden */
  112725. private _sceneRootNodesIndex;
  112726. /**
  112727. * Gets a boolean indicating if the node has been disposed
  112728. * @returns true if the node was disposed
  112729. */
  112730. isDisposed(): boolean;
  112731. /**
  112732. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112733. * @see https://doc.babylonjs.com/how_to/parenting
  112734. */
  112735. set parent(parent: Nullable<Node>);
  112736. get parent(): Nullable<Node>;
  112737. /** @hidden */
  112738. _addToSceneRootNodes(): void;
  112739. /** @hidden */
  112740. _removeFromSceneRootNodes(): void;
  112741. private _animationPropertiesOverride;
  112742. /**
  112743. * Gets or sets the animation properties override
  112744. */
  112745. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112746. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112747. /**
  112748. * Gets a string identifying the name of the class
  112749. * @returns "Node" string
  112750. */
  112751. getClassName(): string;
  112752. /** @hidden */
  112753. readonly _isNode: boolean;
  112754. /**
  112755. * An event triggered when the mesh is disposed
  112756. */
  112757. onDisposeObservable: Observable<Node>;
  112758. private _onDisposeObserver;
  112759. /**
  112760. * Sets a callback that will be raised when the node will be disposed
  112761. */
  112762. set onDispose(callback: () => void);
  112763. /**
  112764. * Creates a new Node
  112765. * @param name the name and id to be given to this node
  112766. * @param scene the scene this node will be added to
  112767. */
  112768. constructor(name: string, scene?: Nullable<Scene>);
  112769. /**
  112770. * Gets the scene of the node
  112771. * @returns a scene
  112772. */
  112773. getScene(): Scene;
  112774. /**
  112775. * Gets the engine of the node
  112776. * @returns a Engine
  112777. */
  112778. getEngine(): Engine;
  112779. private _behaviors;
  112780. /**
  112781. * Attach a behavior to the node
  112782. * @see https://doc.babylonjs.com/features/behaviour
  112783. * @param behavior defines the behavior to attach
  112784. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112785. * @returns the current Node
  112786. */
  112787. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112788. /**
  112789. * Remove an attached behavior
  112790. * @see https://doc.babylonjs.com/features/behaviour
  112791. * @param behavior defines the behavior to attach
  112792. * @returns the current Node
  112793. */
  112794. removeBehavior(behavior: Behavior<Node>): Node;
  112795. /**
  112796. * Gets the list of attached behaviors
  112797. * @see https://doc.babylonjs.com/features/behaviour
  112798. */
  112799. get behaviors(): Behavior<Node>[];
  112800. /**
  112801. * Gets an attached behavior by name
  112802. * @param name defines the name of the behavior to look for
  112803. * @see https://doc.babylonjs.com/features/behaviour
  112804. * @returns null if behavior was not found else the requested behavior
  112805. */
  112806. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112807. /**
  112808. * Returns the latest update of the World matrix
  112809. * @returns a Matrix
  112810. */
  112811. getWorldMatrix(): Matrix;
  112812. /** @hidden */
  112813. _getWorldMatrixDeterminant(): number;
  112814. /**
  112815. * Returns directly the latest state of the mesh World matrix.
  112816. * A Matrix is returned.
  112817. */
  112818. get worldMatrixFromCache(): Matrix;
  112819. /** @hidden */
  112820. _initCache(): void;
  112821. /** @hidden */
  112822. updateCache(force?: boolean): void;
  112823. /** @hidden */
  112824. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112825. /** @hidden */
  112826. _updateCache(ignoreParentClass?: boolean): void;
  112827. /** @hidden */
  112828. _isSynchronized(): boolean;
  112829. /** @hidden */
  112830. _markSyncedWithParent(): void;
  112831. /** @hidden */
  112832. isSynchronizedWithParent(): boolean;
  112833. /** @hidden */
  112834. isSynchronized(): boolean;
  112835. /**
  112836. * Is this node ready to be used/rendered
  112837. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112838. * @return true if the node is ready
  112839. */
  112840. isReady(completeCheck?: boolean): boolean;
  112841. /**
  112842. * Is this node enabled?
  112843. * 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
  112844. * @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
  112845. * @return whether this node (and its parent) is enabled
  112846. */
  112847. isEnabled(checkAncestors?: boolean): boolean;
  112848. /** @hidden */
  112849. protected _syncParentEnabledState(): void;
  112850. /**
  112851. * Set the enabled state of this node
  112852. * @param value defines the new enabled state
  112853. */
  112854. setEnabled(value: boolean): void;
  112855. /**
  112856. * Is this node a descendant of the given node?
  112857. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112858. * @param ancestor defines the parent node to inspect
  112859. * @returns a boolean indicating if this node is a descendant of the given node
  112860. */
  112861. isDescendantOf(ancestor: Node): boolean;
  112862. /** @hidden */
  112863. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112864. /**
  112865. * Will return all nodes that have this node as ascendant
  112866. * @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
  112867. * @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
  112868. * @return all children nodes of all types
  112869. */
  112870. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112871. /**
  112872. * Get all child-meshes of this node
  112873. * @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)
  112874. * @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
  112875. * @returns an array of AbstractMesh
  112876. */
  112877. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112878. /**
  112879. * Get all direct children of this node
  112880. * @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
  112881. * @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)
  112882. * @returns an array of Node
  112883. */
  112884. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112885. /** @hidden */
  112886. _setReady(state: boolean): void;
  112887. /**
  112888. * Get an animation by name
  112889. * @param name defines the name of the animation to look for
  112890. * @returns null if not found else the requested animation
  112891. */
  112892. getAnimationByName(name: string): Nullable<Animation>;
  112893. /**
  112894. * Creates an animation range for this node
  112895. * @param name defines the name of the range
  112896. * @param from defines the starting key
  112897. * @param to defines the end key
  112898. */
  112899. createAnimationRange(name: string, from: number, to: number): void;
  112900. /**
  112901. * Delete a specific animation range
  112902. * @param name defines the name of the range to delete
  112903. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112904. */
  112905. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112906. /**
  112907. * Get an animation range by name
  112908. * @param name defines the name of the animation range to look for
  112909. * @returns null if not found else the requested animation range
  112910. */
  112911. getAnimationRange(name: string): Nullable<AnimationRange>;
  112912. /**
  112913. * Gets the list of all animation ranges defined on this node
  112914. * @returns an array
  112915. */
  112916. getAnimationRanges(): Nullable<AnimationRange>[];
  112917. /**
  112918. * Will start the animation sequence
  112919. * @param name defines the range frames for animation sequence
  112920. * @param loop defines if the animation should loop (false by default)
  112921. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112922. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112923. * @returns the object created for this animation. If range does not exist, it will return null
  112924. */
  112925. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112926. /**
  112927. * Serialize animation ranges into a JSON compatible object
  112928. * @returns serialization object
  112929. */
  112930. serializeAnimationRanges(): any;
  112931. /**
  112932. * Computes the world matrix of the node
  112933. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112934. * @returns the world matrix
  112935. */
  112936. computeWorldMatrix(force?: boolean): Matrix;
  112937. /**
  112938. * Releases resources associated with this node.
  112939. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112940. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112941. */
  112942. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112943. /**
  112944. * Parse animation range data from a serialization object and store them into a given node
  112945. * @param node defines where to store the animation ranges
  112946. * @param parsedNode defines the serialization object to read data from
  112947. * @param scene defines the hosting scene
  112948. */
  112949. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112950. /**
  112951. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112952. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112953. * @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
  112954. * @returns the new bounding vectors
  112955. */
  112956. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112957. min: Vector3;
  112958. max: Vector3;
  112959. };
  112960. }
  112961. }
  112962. declare module BABYLON {
  112963. /**
  112964. * @hidden
  112965. */
  112966. export class _IAnimationState {
  112967. key: number;
  112968. repeatCount: number;
  112969. workValue?: any;
  112970. loopMode?: number;
  112971. offsetValue?: any;
  112972. highLimitValue?: any;
  112973. }
  112974. /**
  112975. * Class used to store any kind of animation
  112976. */
  112977. export class Animation {
  112978. /**Name of the animation */
  112979. name: string;
  112980. /**Property to animate */
  112981. targetProperty: string;
  112982. /**The frames per second of the animation */
  112983. framePerSecond: number;
  112984. /**The data type of the animation */
  112985. dataType: number;
  112986. /**The loop mode of the animation */
  112987. loopMode?: number | undefined;
  112988. /**Specifies if blending should be enabled */
  112989. enableBlending?: boolean | undefined;
  112990. /**
  112991. * Use matrix interpolation instead of using direct key value when animating matrices
  112992. */
  112993. static AllowMatricesInterpolation: boolean;
  112994. /**
  112995. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112996. */
  112997. static AllowMatrixDecomposeForInterpolation: boolean;
  112998. /** Define the Url to load snippets */
  112999. static SnippetUrl: string;
  113000. /** Snippet ID if the animation was created from the snippet server */
  113001. snippetId: string;
  113002. /**
  113003. * Stores the key frames of the animation
  113004. */
  113005. private _keys;
  113006. /**
  113007. * Stores the easing function of the animation
  113008. */
  113009. private _easingFunction;
  113010. /**
  113011. * @hidden Internal use only
  113012. */
  113013. _runtimeAnimations: RuntimeAnimation[];
  113014. /**
  113015. * The set of event that will be linked to this animation
  113016. */
  113017. private _events;
  113018. /**
  113019. * Stores an array of target property paths
  113020. */
  113021. targetPropertyPath: string[];
  113022. /**
  113023. * Stores the blending speed of the animation
  113024. */
  113025. blendingSpeed: number;
  113026. /**
  113027. * Stores the animation ranges for the animation
  113028. */
  113029. private _ranges;
  113030. /**
  113031. * @hidden Internal use
  113032. */
  113033. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113034. /**
  113035. * Sets up an animation
  113036. * @param property The property to animate
  113037. * @param animationType The animation type to apply
  113038. * @param framePerSecond The frames per second of the animation
  113039. * @param easingFunction The easing function used in the animation
  113040. * @returns The created animation
  113041. */
  113042. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113043. /**
  113044. * Create and start an animation on a node
  113045. * @param name defines the name of the global animation that will be run on all nodes
  113046. * @param node defines the root node where the animation will take place
  113047. * @param targetProperty defines property to animate
  113048. * @param framePerSecond defines the number of frame per second yo use
  113049. * @param totalFrame defines the number of frames in total
  113050. * @param from defines the initial value
  113051. * @param to defines the final value
  113052. * @param loopMode defines which loop mode you want to use (off by default)
  113053. * @param easingFunction defines the easing function to use (linear by default)
  113054. * @param onAnimationEnd defines the callback to call when animation end
  113055. * @returns the animatable created for this animation
  113056. */
  113057. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113058. /**
  113059. * Create and start an animation on a node and its descendants
  113060. * @param name defines the name of the global animation that will be run on all nodes
  113061. * @param node defines the root node where the animation will take place
  113062. * @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
  113063. * @param targetProperty defines property to animate
  113064. * @param framePerSecond defines the number of frame per second to use
  113065. * @param totalFrame defines the number of frames in total
  113066. * @param from defines the initial value
  113067. * @param to defines the final value
  113068. * @param loopMode defines which loop mode you want to use (off by default)
  113069. * @param easingFunction defines the easing function to use (linear by default)
  113070. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113071. * @returns the list of animatables created for all nodes
  113072. * @example https://www.babylonjs-playground.com/#MH0VLI
  113073. */
  113074. 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[]>;
  113075. /**
  113076. * Creates a new animation, merges it with the existing animations and starts it
  113077. * @param name Name of the animation
  113078. * @param node Node which contains the scene that begins the animations
  113079. * @param targetProperty Specifies which property to animate
  113080. * @param framePerSecond The frames per second of the animation
  113081. * @param totalFrame The total number of frames
  113082. * @param from The frame at the beginning of the animation
  113083. * @param to The frame at the end of the animation
  113084. * @param loopMode Specifies the loop mode of the animation
  113085. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113086. * @param onAnimationEnd Callback to run once the animation is complete
  113087. * @returns Nullable animation
  113088. */
  113089. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113090. /**
  113091. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113092. * @param sourceAnimation defines the Animation containing keyframes to convert
  113093. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113094. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113095. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113096. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113097. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113098. */
  113099. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113100. /**
  113101. * Transition property of an host to the target Value
  113102. * @param property The property to transition
  113103. * @param targetValue The target Value of the property
  113104. * @param host The object where the property to animate belongs
  113105. * @param scene Scene used to run the animation
  113106. * @param frameRate Framerate (in frame/s) to use
  113107. * @param transition The transition type we want to use
  113108. * @param duration The duration of the animation, in milliseconds
  113109. * @param onAnimationEnd Callback trigger at the end of the animation
  113110. * @returns Nullable animation
  113111. */
  113112. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113113. /**
  113114. * Return the array of runtime animations currently using this animation
  113115. */
  113116. get runtimeAnimations(): RuntimeAnimation[];
  113117. /**
  113118. * Specifies if any of the runtime animations are currently running
  113119. */
  113120. get hasRunningRuntimeAnimations(): boolean;
  113121. /**
  113122. * Initializes the animation
  113123. * @param name Name of the animation
  113124. * @param targetProperty Property to animate
  113125. * @param framePerSecond The frames per second of the animation
  113126. * @param dataType The data type of the animation
  113127. * @param loopMode The loop mode of the animation
  113128. * @param enableBlending Specifies if blending should be enabled
  113129. */
  113130. constructor(
  113131. /**Name of the animation */
  113132. name: string,
  113133. /**Property to animate */
  113134. targetProperty: string,
  113135. /**The frames per second of the animation */
  113136. framePerSecond: number,
  113137. /**The data type of the animation */
  113138. dataType: number,
  113139. /**The loop mode of the animation */
  113140. loopMode?: number | undefined,
  113141. /**Specifies if blending should be enabled */
  113142. enableBlending?: boolean | undefined);
  113143. /**
  113144. * Converts the animation to a string
  113145. * @param fullDetails support for multiple levels of logging within scene loading
  113146. * @returns String form of the animation
  113147. */
  113148. toString(fullDetails?: boolean): string;
  113149. /**
  113150. * Add an event to this animation
  113151. * @param event Event to add
  113152. */
  113153. addEvent(event: AnimationEvent): void;
  113154. /**
  113155. * Remove all events found at the given frame
  113156. * @param frame The frame to remove events from
  113157. */
  113158. removeEvents(frame: number): void;
  113159. /**
  113160. * Retrieves all the events from the animation
  113161. * @returns Events from the animation
  113162. */
  113163. getEvents(): AnimationEvent[];
  113164. /**
  113165. * Creates an animation range
  113166. * @param name Name of the animation range
  113167. * @param from Starting frame of the animation range
  113168. * @param to Ending frame of the animation
  113169. */
  113170. createRange(name: string, from: number, to: number): void;
  113171. /**
  113172. * Deletes an animation range by name
  113173. * @param name Name of the animation range to delete
  113174. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113175. */
  113176. deleteRange(name: string, deleteFrames?: boolean): void;
  113177. /**
  113178. * Gets the animation range by name, or null if not defined
  113179. * @param name Name of the animation range
  113180. * @returns Nullable animation range
  113181. */
  113182. getRange(name: string): Nullable<AnimationRange>;
  113183. /**
  113184. * Gets the key frames from the animation
  113185. * @returns The key frames of the animation
  113186. */
  113187. getKeys(): Array<IAnimationKey>;
  113188. /**
  113189. * Gets the highest frame rate of the animation
  113190. * @returns Highest frame rate of the animation
  113191. */
  113192. getHighestFrame(): number;
  113193. /**
  113194. * Gets the easing function of the animation
  113195. * @returns Easing function of the animation
  113196. */
  113197. getEasingFunction(): IEasingFunction;
  113198. /**
  113199. * Sets the easing function of the animation
  113200. * @param easingFunction A custom mathematical formula for animation
  113201. */
  113202. setEasingFunction(easingFunction: EasingFunction): void;
  113203. /**
  113204. * Interpolates a scalar linearly
  113205. * @param startValue Start value of the animation curve
  113206. * @param endValue End value of the animation curve
  113207. * @param gradient Scalar amount to interpolate
  113208. * @returns Interpolated scalar value
  113209. */
  113210. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113211. /**
  113212. * Interpolates a scalar cubically
  113213. * @param startValue Start value of the animation curve
  113214. * @param outTangent End tangent of the animation
  113215. * @param endValue End value of the animation curve
  113216. * @param inTangent Start tangent of the animation curve
  113217. * @param gradient Scalar amount to interpolate
  113218. * @returns Interpolated scalar value
  113219. */
  113220. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113221. /**
  113222. * Interpolates a quaternion using a spherical linear interpolation
  113223. * @param startValue Start value of the animation curve
  113224. * @param endValue End value of the animation curve
  113225. * @param gradient Scalar amount to interpolate
  113226. * @returns Interpolated quaternion value
  113227. */
  113228. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113229. /**
  113230. * Interpolates a quaternion cubically
  113231. * @param startValue Start value of the animation curve
  113232. * @param outTangent End tangent of the animation curve
  113233. * @param endValue End value of the animation curve
  113234. * @param inTangent Start tangent of the animation curve
  113235. * @param gradient Scalar amount to interpolate
  113236. * @returns Interpolated quaternion value
  113237. */
  113238. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113239. /**
  113240. * Interpolates a Vector3 linearl
  113241. * @param startValue Start value of the animation curve
  113242. * @param endValue End value of the animation curve
  113243. * @param gradient Scalar amount to interpolate
  113244. * @returns Interpolated scalar value
  113245. */
  113246. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113247. /**
  113248. * Interpolates a Vector3 cubically
  113249. * @param startValue Start value of the animation curve
  113250. * @param outTangent End tangent of the animation
  113251. * @param endValue End value of the animation curve
  113252. * @param inTangent Start tangent of the animation curve
  113253. * @param gradient Scalar amount to interpolate
  113254. * @returns InterpolatedVector3 value
  113255. */
  113256. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113257. /**
  113258. * Interpolates a Vector2 linearly
  113259. * @param startValue Start value of the animation curve
  113260. * @param endValue End value of the animation curve
  113261. * @param gradient Scalar amount to interpolate
  113262. * @returns Interpolated Vector2 value
  113263. */
  113264. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113265. /**
  113266. * Interpolates a Vector2 cubically
  113267. * @param startValue Start value of the animation curve
  113268. * @param outTangent End tangent of the animation
  113269. * @param endValue End value of the animation curve
  113270. * @param inTangent Start tangent of the animation curve
  113271. * @param gradient Scalar amount to interpolate
  113272. * @returns Interpolated Vector2 value
  113273. */
  113274. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113275. /**
  113276. * Interpolates a size linearly
  113277. * @param startValue Start value of the animation curve
  113278. * @param endValue End value of the animation curve
  113279. * @param gradient Scalar amount to interpolate
  113280. * @returns Interpolated Size value
  113281. */
  113282. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113283. /**
  113284. * Interpolates a Color3 linearly
  113285. * @param startValue Start value of the animation curve
  113286. * @param endValue End value of the animation curve
  113287. * @param gradient Scalar amount to interpolate
  113288. * @returns Interpolated Color3 value
  113289. */
  113290. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113291. /**
  113292. * Interpolates a Color4 linearly
  113293. * @param startValue Start value of the animation curve
  113294. * @param endValue End value of the animation curve
  113295. * @param gradient Scalar amount to interpolate
  113296. * @returns Interpolated Color3 value
  113297. */
  113298. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113299. /**
  113300. * @hidden Internal use only
  113301. */
  113302. _getKeyValue(value: any): any;
  113303. /**
  113304. * @hidden Internal use only
  113305. */
  113306. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113307. /**
  113308. * Defines the function to use to interpolate matrices
  113309. * @param startValue defines the start matrix
  113310. * @param endValue defines the end matrix
  113311. * @param gradient defines the gradient between both matrices
  113312. * @param result defines an optional target matrix where to store the interpolation
  113313. * @returns the interpolated matrix
  113314. */
  113315. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113316. /**
  113317. * Makes a copy of the animation
  113318. * @returns Cloned animation
  113319. */
  113320. clone(): Animation;
  113321. /**
  113322. * Sets the key frames of the animation
  113323. * @param values The animation key frames to set
  113324. */
  113325. setKeys(values: Array<IAnimationKey>): void;
  113326. /**
  113327. * Serializes the animation to an object
  113328. * @returns Serialized object
  113329. */
  113330. serialize(): any;
  113331. /**
  113332. * Float animation type
  113333. */
  113334. static readonly ANIMATIONTYPE_FLOAT: number;
  113335. /**
  113336. * Vector3 animation type
  113337. */
  113338. static readonly ANIMATIONTYPE_VECTOR3: number;
  113339. /**
  113340. * Quaternion animation type
  113341. */
  113342. static readonly ANIMATIONTYPE_QUATERNION: number;
  113343. /**
  113344. * Matrix animation type
  113345. */
  113346. static readonly ANIMATIONTYPE_MATRIX: number;
  113347. /**
  113348. * Color3 animation type
  113349. */
  113350. static readonly ANIMATIONTYPE_COLOR3: number;
  113351. /**
  113352. * Color3 animation type
  113353. */
  113354. static readonly ANIMATIONTYPE_COLOR4: number;
  113355. /**
  113356. * Vector2 animation type
  113357. */
  113358. static readonly ANIMATIONTYPE_VECTOR2: number;
  113359. /**
  113360. * Size animation type
  113361. */
  113362. static readonly ANIMATIONTYPE_SIZE: number;
  113363. /**
  113364. * Relative Loop Mode
  113365. */
  113366. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113367. /**
  113368. * Cycle Loop Mode
  113369. */
  113370. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113371. /**
  113372. * Constant Loop Mode
  113373. */
  113374. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113375. /** @hidden */
  113376. static _UniversalLerp(left: any, right: any, amount: number): any;
  113377. /**
  113378. * Parses an animation object and creates an animation
  113379. * @param parsedAnimation Parsed animation object
  113380. * @returns Animation object
  113381. */
  113382. static Parse(parsedAnimation: any): Animation;
  113383. /**
  113384. * Appends the serialized animations from the source animations
  113385. * @param source Source containing the animations
  113386. * @param destination Target to store the animations
  113387. */
  113388. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113389. /**
  113390. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113391. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113392. * @param url defines the url to load from
  113393. * @returns a promise that will resolve to the new animation or an array of animations
  113394. */
  113395. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113396. /**
  113397. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113398. * @param snippetId defines the snippet to load
  113399. * @returns a promise that will resolve to the new animation or a new array of animations
  113400. */
  113401. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113402. }
  113403. }
  113404. declare module BABYLON {
  113405. /**
  113406. * Interface containing an array of animations
  113407. */
  113408. export interface IAnimatable {
  113409. /**
  113410. * Array of animations
  113411. */
  113412. animations: Nullable<Array<Animation>>;
  113413. }
  113414. }
  113415. declare module BABYLON {
  113416. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113417. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113418. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113419. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113420. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113421. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113422. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113423. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113424. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113425. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113426. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113427. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113428. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113429. /**
  113430. * Decorator used to define property that can be serialized as reference to a camera
  113431. * @param sourceName defines the name of the property to decorate
  113432. */
  113433. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113434. /**
  113435. * Class used to help serialization objects
  113436. */
  113437. export class SerializationHelper {
  113438. /** @hidden */
  113439. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113440. /** @hidden */
  113441. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113442. /** @hidden */
  113443. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113444. /** @hidden */
  113445. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113446. /**
  113447. * Appends the serialized animations from the source animations
  113448. * @param source Source containing the animations
  113449. * @param destination Target to store the animations
  113450. */
  113451. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113452. /**
  113453. * Static function used to serialized a specific entity
  113454. * @param entity defines the entity to serialize
  113455. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113456. * @returns a JSON compatible object representing the serialization of the entity
  113457. */
  113458. static Serialize<T>(entity: T, serializationObject?: any): any;
  113459. /**
  113460. * Creates a new entity from a serialization data object
  113461. * @param creationFunction defines a function used to instanciated the new entity
  113462. * @param source defines the source serialization data
  113463. * @param scene defines the hosting scene
  113464. * @param rootUrl defines the root url for resources
  113465. * @returns a new entity
  113466. */
  113467. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113468. /**
  113469. * Clones an object
  113470. * @param creationFunction defines the function used to instanciate the new object
  113471. * @param source defines the source object
  113472. * @returns the cloned object
  113473. */
  113474. static Clone<T>(creationFunction: () => T, source: T): T;
  113475. /**
  113476. * Instanciates a new object based on a source one (some data will be shared between both object)
  113477. * @param creationFunction defines the function used to instanciate the new object
  113478. * @param source defines the source object
  113479. * @returns the new object
  113480. */
  113481. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113482. }
  113483. }
  113484. declare module BABYLON {
  113485. /**
  113486. * Base class of all the textures in babylon.
  113487. * It groups all the common properties the materials, post process, lights... might need
  113488. * in order to make a correct use of the texture.
  113489. */
  113490. export class BaseTexture implements IAnimatable {
  113491. /**
  113492. * Default anisotropic filtering level for the application.
  113493. * It is set to 4 as a good tradeoff between perf and quality.
  113494. */
  113495. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113496. /**
  113497. * Gets or sets the unique id of the texture
  113498. */
  113499. uniqueId: number;
  113500. /**
  113501. * Define the name of the texture.
  113502. */
  113503. name: string;
  113504. /**
  113505. * Gets or sets an object used to store user defined information.
  113506. */
  113507. metadata: any;
  113508. /**
  113509. * For internal use only. Please do not use.
  113510. */
  113511. reservedDataStore: any;
  113512. private _hasAlpha;
  113513. /**
  113514. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113515. */
  113516. set hasAlpha(value: boolean);
  113517. get hasAlpha(): boolean;
  113518. /**
  113519. * Defines if the alpha value should be determined via the rgb values.
  113520. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113521. */
  113522. getAlphaFromRGB: boolean;
  113523. /**
  113524. * Intensity or strength of the texture.
  113525. * It is commonly used by materials to fine tune the intensity of the texture
  113526. */
  113527. level: number;
  113528. /**
  113529. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113530. * This is part of the texture as textures usually maps to one uv set.
  113531. */
  113532. coordinatesIndex: number;
  113533. protected _coordinatesMode: number;
  113534. /**
  113535. * How a texture is mapped.
  113536. *
  113537. * | Value | Type | Description |
  113538. * | ----- | ----------------------------------- | ----------- |
  113539. * | 0 | EXPLICIT_MODE | |
  113540. * | 1 | SPHERICAL_MODE | |
  113541. * | 2 | PLANAR_MODE | |
  113542. * | 3 | CUBIC_MODE | |
  113543. * | 4 | PROJECTION_MODE | |
  113544. * | 5 | SKYBOX_MODE | |
  113545. * | 6 | INVCUBIC_MODE | |
  113546. * | 7 | EQUIRECTANGULAR_MODE | |
  113547. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113548. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113549. */
  113550. set coordinatesMode(value: number);
  113551. get coordinatesMode(): number;
  113552. private _wrapU;
  113553. /**
  113554. * | Value | Type | Description |
  113555. * | ----- | ------------------ | ----------- |
  113556. * | 0 | CLAMP_ADDRESSMODE | |
  113557. * | 1 | WRAP_ADDRESSMODE | |
  113558. * | 2 | MIRROR_ADDRESSMODE | |
  113559. */
  113560. get wrapU(): number;
  113561. set wrapU(value: number);
  113562. private _wrapV;
  113563. /**
  113564. * | Value | Type | Description |
  113565. * | ----- | ------------------ | ----------- |
  113566. * | 0 | CLAMP_ADDRESSMODE | |
  113567. * | 1 | WRAP_ADDRESSMODE | |
  113568. * | 2 | MIRROR_ADDRESSMODE | |
  113569. */
  113570. get wrapV(): number;
  113571. set wrapV(value: number);
  113572. /**
  113573. * | Value | Type | Description |
  113574. * | ----- | ------------------ | ----------- |
  113575. * | 0 | CLAMP_ADDRESSMODE | |
  113576. * | 1 | WRAP_ADDRESSMODE | |
  113577. * | 2 | MIRROR_ADDRESSMODE | |
  113578. */
  113579. wrapR: number;
  113580. /**
  113581. * With compliant hardware and browser (supporting anisotropic filtering)
  113582. * this defines the level of anisotropic filtering in the texture.
  113583. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113584. */
  113585. anisotropicFilteringLevel: number;
  113586. /**
  113587. * Define if the texture is a cube texture or if false a 2d texture.
  113588. */
  113589. get isCube(): boolean;
  113590. set isCube(value: boolean);
  113591. /**
  113592. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113593. */
  113594. get is3D(): boolean;
  113595. set is3D(value: boolean);
  113596. /**
  113597. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113598. */
  113599. get is2DArray(): boolean;
  113600. set is2DArray(value: boolean);
  113601. /**
  113602. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113603. * HDR texture are usually stored in linear space.
  113604. * This only impacts the PBR and Background materials
  113605. */
  113606. gammaSpace: boolean;
  113607. /**
  113608. * Gets or sets whether or not the texture contains RGBD data.
  113609. */
  113610. get isRGBD(): boolean;
  113611. set isRGBD(value: boolean);
  113612. /**
  113613. * Is Z inverted in the texture (useful in a cube texture).
  113614. */
  113615. invertZ: boolean;
  113616. /**
  113617. * Are mip maps generated for this texture or not.
  113618. */
  113619. get noMipmap(): boolean;
  113620. /**
  113621. * @hidden
  113622. */
  113623. lodLevelInAlpha: boolean;
  113624. /**
  113625. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113626. */
  113627. get lodGenerationOffset(): number;
  113628. set lodGenerationOffset(value: number);
  113629. /**
  113630. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113631. */
  113632. get lodGenerationScale(): number;
  113633. set lodGenerationScale(value: number);
  113634. /**
  113635. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113636. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113637. * average roughness values.
  113638. */
  113639. get linearSpecularLOD(): boolean;
  113640. set linearSpecularLOD(value: boolean);
  113641. /**
  113642. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113643. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113644. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113645. */
  113646. get irradianceTexture(): Nullable<BaseTexture>;
  113647. set irradianceTexture(value: Nullable<BaseTexture>);
  113648. /**
  113649. * Define if the texture is a render target.
  113650. */
  113651. isRenderTarget: boolean;
  113652. /**
  113653. * Define the unique id of the texture in the scene.
  113654. */
  113655. get uid(): string;
  113656. /** @hidden */
  113657. _prefiltered: boolean;
  113658. /**
  113659. * Return a string representation of the texture.
  113660. * @returns the texture as a string
  113661. */
  113662. toString(): string;
  113663. /**
  113664. * Get the class name of the texture.
  113665. * @returns "BaseTexture"
  113666. */
  113667. getClassName(): string;
  113668. /**
  113669. * Define the list of animation attached to the texture.
  113670. */
  113671. animations: Animation[];
  113672. /**
  113673. * An event triggered when the texture is disposed.
  113674. */
  113675. onDisposeObservable: Observable<BaseTexture>;
  113676. private _onDisposeObserver;
  113677. /**
  113678. * Callback triggered when the texture has been disposed.
  113679. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113680. */
  113681. set onDispose(callback: () => void);
  113682. /**
  113683. * Define the current state of the loading sequence when in delayed load mode.
  113684. */
  113685. delayLoadState: number;
  113686. protected _scene: Nullable<Scene>;
  113687. protected _engine: Nullable<ThinEngine>;
  113688. /** @hidden */
  113689. _texture: Nullable<InternalTexture>;
  113690. private _uid;
  113691. /**
  113692. * Define if the texture is preventinga material to render or not.
  113693. * If not and the texture is not ready, the engine will use a default black texture instead.
  113694. */
  113695. get isBlocking(): boolean;
  113696. /**
  113697. * Instantiates a new BaseTexture.
  113698. * Base class of all the textures in babylon.
  113699. * It groups all the common properties the materials, post process, lights... might need
  113700. * in order to make a correct use of the texture.
  113701. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113702. */
  113703. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113704. /**
  113705. * Get the scene the texture belongs to.
  113706. * @returns the scene or null if undefined
  113707. */
  113708. getScene(): Nullable<Scene>;
  113709. /** @hidden */
  113710. protected _getEngine(): Nullable<ThinEngine>;
  113711. /**
  113712. * Get the texture transform matrix used to offset tile the texture for istance.
  113713. * @returns the transformation matrix
  113714. */
  113715. getTextureMatrix(): Matrix;
  113716. /**
  113717. * Get the texture reflection matrix used to rotate/transform the reflection.
  113718. * @returns the reflection matrix
  113719. */
  113720. getReflectionTextureMatrix(): Matrix;
  113721. /**
  113722. * Get the underlying lower level texture from Babylon.
  113723. * @returns the insternal texture
  113724. */
  113725. getInternalTexture(): Nullable<InternalTexture>;
  113726. /**
  113727. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113728. * @returns true if ready or not blocking
  113729. */
  113730. isReadyOrNotBlocking(): boolean;
  113731. /**
  113732. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113733. * @returns true if fully ready
  113734. */
  113735. isReady(): boolean;
  113736. private _cachedSize;
  113737. /**
  113738. * Get the size of the texture.
  113739. * @returns the texture size.
  113740. */
  113741. getSize(): ISize;
  113742. /**
  113743. * Get the base size of the texture.
  113744. * It can be different from the size if the texture has been resized for POT for instance
  113745. * @returns the base size
  113746. */
  113747. getBaseSize(): ISize;
  113748. /**
  113749. * Update the sampling mode of the texture.
  113750. * Default is Trilinear mode.
  113751. *
  113752. * | Value | Type | Description |
  113753. * | ----- | ------------------ | ----------- |
  113754. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113755. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113756. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113757. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113758. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113759. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113760. * | 7 | NEAREST_LINEAR | |
  113761. * | 8 | NEAREST_NEAREST | |
  113762. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113763. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113764. * | 11 | LINEAR_LINEAR | |
  113765. * | 12 | LINEAR_NEAREST | |
  113766. *
  113767. * > _mag_: magnification filter (close to the viewer)
  113768. * > _min_: minification filter (far from the viewer)
  113769. * > _mip_: filter used between mip map levels
  113770. *@param samplingMode Define the new sampling mode of the texture
  113771. */
  113772. updateSamplingMode(samplingMode: number): void;
  113773. /**
  113774. * Scales the texture if is `canRescale()`
  113775. * @param ratio the resize factor we want to use to rescale
  113776. */
  113777. scale(ratio: number): void;
  113778. /**
  113779. * Get if the texture can rescale.
  113780. */
  113781. get canRescale(): boolean;
  113782. /** @hidden */
  113783. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113784. /** @hidden */
  113785. _rebuild(): void;
  113786. /**
  113787. * Triggers the load sequence in delayed load mode.
  113788. */
  113789. delayLoad(): void;
  113790. /**
  113791. * Clones the texture.
  113792. * @returns the cloned texture
  113793. */
  113794. clone(): Nullable<BaseTexture>;
  113795. /**
  113796. * Get the texture underlying type (INT, FLOAT...)
  113797. */
  113798. get textureType(): number;
  113799. /**
  113800. * Get the texture underlying format (RGB, RGBA...)
  113801. */
  113802. get textureFormat(): number;
  113803. /**
  113804. * Indicates that textures need to be re-calculated for all materials
  113805. */
  113806. protected _markAllSubMeshesAsTexturesDirty(): void;
  113807. /**
  113808. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113809. * This will returns an RGBA array buffer containing either in values (0-255) or
  113810. * float values (0-1) depending of the underlying buffer type.
  113811. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113812. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113813. * @param buffer defines a user defined buffer to fill with data (can be null)
  113814. * @returns The Array buffer containing the pixels data.
  113815. */
  113816. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113817. /**
  113818. * Release and destroy the underlying lower level texture aka internalTexture.
  113819. */
  113820. releaseInternalTexture(): void;
  113821. /** @hidden */
  113822. get _lodTextureHigh(): Nullable<BaseTexture>;
  113823. /** @hidden */
  113824. get _lodTextureMid(): Nullable<BaseTexture>;
  113825. /** @hidden */
  113826. get _lodTextureLow(): Nullable<BaseTexture>;
  113827. /**
  113828. * Dispose the texture and release its associated resources.
  113829. */
  113830. dispose(): void;
  113831. /**
  113832. * Serialize the texture into a JSON representation that can be parsed later on.
  113833. * @returns the JSON representation of the texture
  113834. */
  113835. serialize(): any;
  113836. /**
  113837. * Helper function to be called back once a list of texture contains only ready textures.
  113838. * @param textures Define the list of textures to wait for
  113839. * @param callback Define the callback triggered once the entire list will be ready
  113840. */
  113841. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113842. private static _isScene;
  113843. }
  113844. }
  113845. declare module BABYLON {
  113846. /**
  113847. * Options to be used when creating an effect.
  113848. */
  113849. export interface IEffectCreationOptions {
  113850. /**
  113851. * Atrributes that will be used in the shader.
  113852. */
  113853. attributes: string[];
  113854. /**
  113855. * Uniform varible names that will be set in the shader.
  113856. */
  113857. uniformsNames: string[];
  113858. /**
  113859. * Uniform buffer variable names that will be set in the shader.
  113860. */
  113861. uniformBuffersNames: string[];
  113862. /**
  113863. * Sampler texture variable names that will be set in the shader.
  113864. */
  113865. samplers: string[];
  113866. /**
  113867. * Define statements that will be set in the shader.
  113868. */
  113869. defines: any;
  113870. /**
  113871. * Possible fallbacks for this effect to improve performance when needed.
  113872. */
  113873. fallbacks: Nullable<IEffectFallbacks>;
  113874. /**
  113875. * Callback that will be called when the shader is compiled.
  113876. */
  113877. onCompiled: Nullable<(effect: Effect) => void>;
  113878. /**
  113879. * Callback that will be called if an error occurs during shader compilation.
  113880. */
  113881. onError: Nullable<(effect: Effect, errors: string) => void>;
  113882. /**
  113883. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113884. */
  113885. indexParameters?: any;
  113886. /**
  113887. * Max number of lights that can be used in the shader.
  113888. */
  113889. maxSimultaneousLights?: number;
  113890. /**
  113891. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113892. */
  113893. transformFeedbackVaryings?: Nullable<string[]>;
  113894. /**
  113895. * 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
  113896. */
  113897. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113898. /**
  113899. * Is this effect rendering to several color attachments ?
  113900. */
  113901. multiTarget?: boolean;
  113902. }
  113903. /**
  113904. * Effect containing vertex and fragment shader that can be executed on an object.
  113905. */
  113906. export class Effect implements IDisposable {
  113907. /**
  113908. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113909. */
  113910. static ShadersRepository: string;
  113911. /**
  113912. * Enable logging of the shader code when a compilation error occurs
  113913. */
  113914. static LogShaderCodeOnCompilationError: boolean;
  113915. /**
  113916. * Name of the effect.
  113917. */
  113918. name: any;
  113919. /**
  113920. * String container all the define statements that should be set on the shader.
  113921. */
  113922. defines: string;
  113923. /**
  113924. * Callback that will be called when the shader is compiled.
  113925. */
  113926. onCompiled: Nullable<(effect: Effect) => void>;
  113927. /**
  113928. * Callback that will be called if an error occurs during shader compilation.
  113929. */
  113930. onError: Nullable<(effect: Effect, errors: string) => void>;
  113931. /**
  113932. * Callback that will be called when effect is bound.
  113933. */
  113934. onBind: Nullable<(effect: Effect) => void>;
  113935. /**
  113936. * Unique ID of the effect.
  113937. */
  113938. uniqueId: number;
  113939. /**
  113940. * Observable that will be called when the shader is compiled.
  113941. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113942. */
  113943. onCompileObservable: Observable<Effect>;
  113944. /**
  113945. * Observable that will be called if an error occurs during shader compilation.
  113946. */
  113947. onErrorObservable: Observable<Effect>;
  113948. /** @hidden */
  113949. _onBindObservable: Nullable<Observable<Effect>>;
  113950. /**
  113951. * @hidden
  113952. * Specifies if the effect was previously ready
  113953. */
  113954. _wasPreviouslyReady: boolean;
  113955. /**
  113956. * Observable that will be called when effect is bound.
  113957. */
  113958. get onBindObservable(): Observable<Effect>;
  113959. /** @hidden */
  113960. _bonesComputationForcedToCPU: boolean;
  113961. /** @hidden */
  113962. _multiTarget: boolean;
  113963. private static _uniqueIdSeed;
  113964. private _engine;
  113965. private _uniformBuffersNames;
  113966. private _uniformBuffersNamesList;
  113967. private _uniformsNames;
  113968. private _samplerList;
  113969. private _samplers;
  113970. private _isReady;
  113971. private _compilationError;
  113972. private _allFallbacksProcessed;
  113973. private _attributesNames;
  113974. private _attributes;
  113975. private _attributeLocationByName;
  113976. private _uniforms;
  113977. /**
  113978. * Key for the effect.
  113979. * @hidden
  113980. */
  113981. _key: string;
  113982. private _indexParameters;
  113983. private _fallbacks;
  113984. private _vertexSourceCode;
  113985. private _fragmentSourceCode;
  113986. private _vertexSourceCodeOverride;
  113987. private _fragmentSourceCodeOverride;
  113988. private _transformFeedbackVaryings;
  113989. /**
  113990. * Compiled shader to webGL program.
  113991. * @hidden
  113992. */
  113993. _pipelineContext: Nullable<IPipelineContext>;
  113994. private _valueCache;
  113995. private static _baseCache;
  113996. /**
  113997. * Instantiates an effect.
  113998. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113999. * @param baseName Name of the effect.
  114000. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  114001. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  114002. * @param samplers List of sampler variables that will be passed to the shader.
  114003. * @param engine Engine to be used to render the effect
  114004. * @param defines Define statements to be added to the shader.
  114005. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  114006. * @param onCompiled Callback that will be called when the shader is compiled.
  114007. * @param onError Callback that will be called if an error occurs during shader compilation.
  114008. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114009. */
  114010. 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);
  114011. private _useFinalCode;
  114012. /**
  114013. * Unique key for this effect
  114014. */
  114015. get key(): string;
  114016. /**
  114017. * If the effect has been compiled and prepared.
  114018. * @returns if the effect is compiled and prepared.
  114019. */
  114020. isReady(): boolean;
  114021. private _isReadyInternal;
  114022. /**
  114023. * The engine the effect was initialized with.
  114024. * @returns the engine.
  114025. */
  114026. getEngine(): Engine;
  114027. /**
  114028. * The pipeline context for this effect
  114029. * @returns the associated pipeline context
  114030. */
  114031. getPipelineContext(): Nullable<IPipelineContext>;
  114032. /**
  114033. * The set of names of attribute variables for the shader.
  114034. * @returns An array of attribute names.
  114035. */
  114036. getAttributesNames(): string[];
  114037. /**
  114038. * Returns the attribute at the given index.
  114039. * @param index The index of the attribute.
  114040. * @returns The location of the attribute.
  114041. */
  114042. getAttributeLocation(index: number): number;
  114043. /**
  114044. * Returns the attribute based on the name of the variable.
  114045. * @param name of the attribute to look up.
  114046. * @returns the attribute location.
  114047. */
  114048. getAttributeLocationByName(name: string): number;
  114049. /**
  114050. * The number of attributes.
  114051. * @returns the numnber of attributes.
  114052. */
  114053. getAttributesCount(): number;
  114054. /**
  114055. * Gets the index of a uniform variable.
  114056. * @param uniformName of the uniform to look up.
  114057. * @returns the index.
  114058. */
  114059. getUniformIndex(uniformName: string): number;
  114060. /**
  114061. * Returns the attribute based on the name of the variable.
  114062. * @param uniformName of the uniform to look up.
  114063. * @returns the location of the uniform.
  114064. */
  114065. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114066. /**
  114067. * Returns an array of sampler variable names
  114068. * @returns The array of sampler variable names.
  114069. */
  114070. getSamplers(): string[];
  114071. /**
  114072. * Returns an array of uniform variable names
  114073. * @returns The array of uniform variable names.
  114074. */
  114075. getUniformNames(): string[];
  114076. /**
  114077. * Returns an array of uniform buffer variable names
  114078. * @returns The array of uniform buffer variable names.
  114079. */
  114080. getUniformBuffersNames(): string[];
  114081. /**
  114082. * Returns the index parameters used to create the effect
  114083. * @returns The index parameters object
  114084. */
  114085. getIndexParameters(): any;
  114086. /**
  114087. * The error from the last compilation.
  114088. * @returns the error string.
  114089. */
  114090. getCompilationError(): string;
  114091. /**
  114092. * Gets a boolean indicating that all fallbacks were used during compilation
  114093. * @returns true if all fallbacks were used
  114094. */
  114095. allFallbacksProcessed(): boolean;
  114096. /**
  114097. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114098. * @param func The callback to be used.
  114099. */
  114100. executeWhenCompiled(func: (effect: Effect) => void): void;
  114101. private _checkIsReady;
  114102. private _loadShader;
  114103. /**
  114104. * Gets the vertex shader source code of this effect
  114105. */
  114106. get vertexSourceCode(): string;
  114107. /**
  114108. * Gets the fragment shader source code of this effect
  114109. */
  114110. get fragmentSourceCode(): string;
  114111. /**
  114112. * Recompiles the webGL program
  114113. * @param vertexSourceCode The source code for the vertex shader.
  114114. * @param fragmentSourceCode The source code for the fragment shader.
  114115. * @param onCompiled Callback called when completed.
  114116. * @param onError Callback called on error.
  114117. * @hidden
  114118. */
  114119. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114120. /**
  114121. * Prepares the effect
  114122. * @hidden
  114123. */
  114124. _prepareEffect(): void;
  114125. private _getShaderCodeAndErrorLine;
  114126. private _processCompilationErrors;
  114127. /**
  114128. * Checks if the effect is supported. (Must be called after compilation)
  114129. */
  114130. get isSupported(): boolean;
  114131. /**
  114132. * Binds a texture to the engine to be used as output of the shader.
  114133. * @param channel Name of the output variable.
  114134. * @param texture Texture to bind.
  114135. * @hidden
  114136. */
  114137. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114138. /**
  114139. * Sets a texture on the engine to be used in the shader.
  114140. * @param channel Name of the sampler variable.
  114141. * @param texture Texture to set.
  114142. */
  114143. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114144. /**
  114145. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114146. * @param channel Name of the sampler variable.
  114147. * @param texture Texture to set.
  114148. */
  114149. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114150. /**
  114151. * Sets an array of textures on the engine to be used in the shader.
  114152. * @param channel Name of the variable.
  114153. * @param textures Textures to set.
  114154. */
  114155. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114156. /**
  114157. * 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)
  114158. * @param channel Name of the sampler variable.
  114159. * @param postProcess Post process to get the input texture from.
  114160. */
  114161. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114162. /**
  114163. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114164. * 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)
  114165. * @param channel Name of the sampler variable.
  114166. * @param postProcess Post process to get the output texture from.
  114167. */
  114168. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114169. /** @hidden */
  114170. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114171. /** @hidden */
  114172. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114173. /** @hidden */
  114174. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114175. /** @hidden */
  114176. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114177. /**
  114178. * Binds a buffer to a uniform.
  114179. * @param buffer Buffer to bind.
  114180. * @param name Name of the uniform variable to bind to.
  114181. */
  114182. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114183. /**
  114184. * Binds block to a uniform.
  114185. * @param blockName Name of the block to bind.
  114186. * @param index Index to bind.
  114187. */
  114188. bindUniformBlock(blockName: string, index: number): void;
  114189. /**
  114190. * Sets an interger value on a uniform variable.
  114191. * @param uniformName Name of the variable.
  114192. * @param value Value to be set.
  114193. * @returns this effect.
  114194. */
  114195. setInt(uniformName: string, value: number): Effect;
  114196. /**
  114197. * Sets an int array on a uniform variable.
  114198. * @param uniformName Name of the variable.
  114199. * @param array array to be set.
  114200. * @returns this effect.
  114201. */
  114202. setIntArray(uniformName: string, array: Int32Array): Effect;
  114203. /**
  114204. * 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)
  114205. * @param uniformName Name of the variable.
  114206. * @param array array to be set.
  114207. * @returns this effect.
  114208. */
  114209. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114210. /**
  114211. * 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)
  114212. * @param uniformName Name of the variable.
  114213. * @param array array to be set.
  114214. * @returns this effect.
  114215. */
  114216. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114217. /**
  114218. * 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)
  114219. * @param uniformName Name of the variable.
  114220. * @param array array to be set.
  114221. * @returns this effect.
  114222. */
  114223. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114224. /**
  114225. * Sets an float array on a uniform variable.
  114226. * @param uniformName Name of the variable.
  114227. * @param array array to be set.
  114228. * @returns this effect.
  114229. */
  114230. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114231. /**
  114232. * 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)
  114233. * @param uniformName Name of the variable.
  114234. * @param array array to be set.
  114235. * @returns this effect.
  114236. */
  114237. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114238. /**
  114239. * 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)
  114240. * @param uniformName Name of the variable.
  114241. * @param array array to be set.
  114242. * @returns this effect.
  114243. */
  114244. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114245. /**
  114246. * 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)
  114247. * @param uniformName Name of the variable.
  114248. * @param array array to be set.
  114249. * @returns this effect.
  114250. */
  114251. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114252. /**
  114253. * Sets an array on a uniform variable.
  114254. * @param uniformName Name of the variable.
  114255. * @param array array to be set.
  114256. * @returns this effect.
  114257. */
  114258. setArray(uniformName: string, array: number[]): Effect;
  114259. /**
  114260. * 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)
  114261. * @param uniformName Name of the variable.
  114262. * @param array array to be set.
  114263. * @returns this effect.
  114264. */
  114265. setArray2(uniformName: string, array: number[]): Effect;
  114266. /**
  114267. * 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)
  114268. * @param uniformName Name of the variable.
  114269. * @param array array to be set.
  114270. * @returns this effect.
  114271. */
  114272. setArray3(uniformName: string, array: number[]): Effect;
  114273. /**
  114274. * 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)
  114275. * @param uniformName Name of the variable.
  114276. * @param array array to be set.
  114277. * @returns this effect.
  114278. */
  114279. setArray4(uniformName: string, array: number[]): Effect;
  114280. /**
  114281. * Sets matrices on a uniform variable.
  114282. * @param uniformName Name of the variable.
  114283. * @param matrices matrices to be set.
  114284. * @returns this effect.
  114285. */
  114286. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114287. /**
  114288. * Sets matrix on a uniform variable.
  114289. * @param uniformName Name of the variable.
  114290. * @param matrix matrix to be set.
  114291. * @returns this effect.
  114292. */
  114293. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114294. /**
  114295. * 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)
  114296. * @param uniformName Name of the variable.
  114297. * @param matrix matrix to be set.
  114298. * @returns this effect.
  114299. */
  114300. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114301. /**
  114302. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114303. * @param uniformName Name of the variable.
  114304. * @param matrix matrix to be set.
  114305. * @returns this effect.
  114306. */
  114307. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114308. /**
  114309. * Sets a float on a uniform variable.
  114310. * @param uniformName Name of the variable.
  114311. * @param value value to be set.
  114312. * @returns this effect.
  114313. */
  114314. setFloat(uniformName: string, value: number): Effect;
  114315. /**
  114316. * Sets a boolean on a uniform variable.
  114317. * @param uniformName Name of the variable.
  114318. * @param bool value to be set.
  114319. * @returns this effect.
  114320. */
  114321. setBool(uniformName: string, bool: boolean): Effect;
  114322. /**
  114323. * Sets a Vector2 on a uniform variable.
  114324. * @param uniformName Name of the variable.
  114325. * @param vector2 vector2 to be set.
  114326. * @returns this effect.
  114327. */
  114328. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114329. /**
  114330. * Sets a float2 on a uniform variable.
  114331. * @param uniformName Name of the variable.
  114332. * @param x First float in float2.
  114333. * @param y Second float in float2.
  114334. * @returns this effect.
  114335. */
  114336. setFloat2(uniformName: string, x: number, y: number): Effect;
  114337. /**
  114338. * Sets a Vector3 on a uniform variable.
  114339. * @param uniformName Name of the variable.
  114340. * @param vector3 Value to be set.
  114341. * @returns this effect.
  114342. */
  114343. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114344. /**
  114345. * Sets a float3 on a uniform variable.
  114346. * @param uniformName Name of the variable.
  114347. * @param x First float in float3.
  114348. * @param y Second float in float3.
  114349. * @param z Third float in float3.
  114350. * @returns this effect.
  114351. */
  114352. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114353. /**
  114354. * Sets a Vector4 on a uniform variable.
  114355. * @param uniformName Name of the variable.
  114356. * @param vector4 Value to be set.
  114357. * @returns this effect.
  114358. */
  114359. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114360. /**
  114361. * Sets a float4 on a uniform variable.
  114362. * @param uniformName Name of the variable.
  114363. * @param x First float in float4.
  114364. * @param y Second float in float4.
  114365. * @param z Third float in float4.
  114366. * @param w Fourth float in float4.
  114367. * @returns this effect.
  114368. */
  114369. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114370. /**
  114371. * Sets a Color3 on a uniform variable.
  114372. * @param uniformName Name of the variable.
  114373. * @param color3 Value to be set.
  114374. * @returns this effect.
  114375. */
  114376. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114377. /**
  114378. * Sets a Color4 on a uniform variable.
  114379. * @param uniformName Name of the variable.
  114380. * @param color3 Value to be set.
  114381. * @param alpha Alpha value to be set.
  114382. * @returns this effect.
  114383. */
  114384. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114385. /**
  114386. * Sets a Color4 on a uniform variable
  114387. * @param uniformName defines the name of the variable
  114388. * @param color4 defines the value to be set
  114389. * @returns this effect.
  114390. */
  114391. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114392. /** Release all associated resources */
  114393. dispose(): void;
  114394. /**
  114395. * This function will add a new shader to the shader store
  114396. * @param name the name of the shader
  114397. * @param pixelShader optional pixel shader content
  114398. * @param vertexShader optional vertex shader content
  114399. */
  114400. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114401. /**
  114402. * Store of each shader (The can be looked up using effect.key)
  114403. */
  114404. static ShadersStore: {
  114405. [key: string]: string;
  114406. };
  114407. /**
  114408. * Store of each included file for a shader (The can be looked up using effect.key)
  114409. */
  114410. static IncludesShadersStore: {
  114411. [key: string]: string;
  114412. };
  114413. /**
  114414. * Resets the cache of effects.
  114415. */
  114416. static ResetCache(): void;
  114417. }
  114418. }
  114419. declare module BABYLON {
  114420. /**
  114421. * Interface used to describe the capabilities of the engine relatively to the current browser
  114422. */
  114423. export interface EngineCapabilities {
  114424. /** Maximum textures units per fragment shader */
  114425. maxTexturesImageUnits: number;
  114426. /** Maximum texture units per vertex shader */
  114427. maxVertexTextureImageUnits: number;
  114428. /** Maximum textures units in the entire pipeline */
  114429. maxCombinedTexturesImageUnits: number;
  114430. /** Maximum texture size */
  114431. maxTextureSize: number;
  114432. /** Maximum texture samples */
  114433. maxSamples?: number;
  114434. /** Maximum cube texture size */
  114435. maxCubemapTextureSize: number;
  114436. /** Maximum render texture size */
  114437. maxRenderTextureSize: number;
  114438. /** Maximum number of vertex attributes */
  114439. maxVertexAttribs: number;
  114440. /** Maximum number of varyings */
  114441. maxVaryingVectors: number;
  114442. /** Maximum number of uniforms per vertex shader */
  114443. maxVertexUniformVectors: number;
  114444. /** Maximum number of uniforms per fragment shader */
  114445. maxFragmentUniformVectors: number;
  114446. /** Defines if standard derivates (dx/dy) are supported */
  114447. standardDerivatives: boolean;
  114448. /** Defines if s3tc texture compression is supported */
  114449. s3tc?: WEBGL_compressed_texture_s3tc;
  114450. /** Defines if pvrtc texture compression is supported */
  114451. pvrtc: any;
  114452. /** Defines if etc1 texture compression is supported */
  114453. etc1: any;
  114454. /** Defines if etc2 texture compression is supported */
  114455. etc2: any;
  114456. /** Defines if astc texture compression is supported */
  114457. astc: any;
  114458. /** Defines if float textures are supported */
  114459. textureFloat: boolean;
  114460. /** Defines if vertex array objects are supported */
  114461. vertexArrayObject: boolean;
  114462. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114463. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114464. /** Gets the maximum level of anisotropy supported */
  114465. maxAnisotropy: number;
  114466. /** Defines if instancing is supported */
  114467. instancedArrays: boolean;
  114468. /** Defines if 32 bits indices are supported */
  114469. uintIndices: boolean;
  114470. /** Defines if high precision shaders are supported */
  114471. highPrecisionShaderSupported: boolean;
  114472. /** Defines if depth reading in the fragment shader is supported */
  114473. fragmentDepthSupported: boolean;
  114474. /** Defines if float texture linear filtering is supported*/
  114475. textureFloatLinearFiltering: boolean;
  114476. /** Defines if rendering to float textures is supported */
  114477. textureFloatRender: boolean;
  114478. /** Defines if half float textures are supported*/
  114479. textureHalfFloat: boolean;
  114480. /** Defines if half float texture linear filtering is supported*/
  114481. textureHalfFloatLinearFiltering: boolean;
  114482. /** Defines if rendering to half float textures is supported */
  114483. textureHalfFloatRender: boolean;
  114484. /** Defines if textureLOD shader command is supported */
  114485. textureLOD: boolean;
  114486. /** Defines if draw buffers extension is supported */
  114487. drawBuffersExtension: boolean;
  114488. /** Defines if depth textures are supported */
  114489. depthTextureExtension: boolean;
  114490. /** Defines if float color buffer are supported */
  114491. colorBufferFloat: boolean;
  114492. /** Gets disjoint timer query extension (null if not supported) */
  114493. timerQuery?: EXT_disjoint_timer_query;
  114494. /** Defines if timestamp can be used with timer query */
  114495. canUseTimestampForTimerQuery: boolean;
  114496. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114497. multiview?: any;
  114498. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114499. oculusMultiview?: any;
  114500. /** Function used to let the system compiles shaders in background */
  114501. parallelShaderCompile?: {
  114502. COMPLETION_STATUS_KHR: number;
  114503. };
  114504. /** Max number of texture samples for MSAA */
  114505. maxMSAASamples: number;
  114506. /** Defines if the blend min max extension is supported */
  114507. blendMinMax: boolean;
  114508. }
  114509. }
  114510. declare module BABYLON {
  114511. /**
  114512. * @hidden
  114513. **/
  114514. export class DepthCullingState {
  114515. private _isDepthTestDirty;
  114516. private _isDepthMaskDirty;
  114517. private _isDepthFuncDirty;
  114518. private _isCullFaceDirty;
  114519. private _isCullDirty;
  114520. private _isZOffsetDirty;
  114521. private _isFrontFaceDirty;
  114522. private _depthTest;
  114523. private _depthMask;
  114524. private _depthFunc;
  114525. private _cull;
  114526. private _cullFace;
  114527. private _zOffset;
  114528. private _frontFace;
  114529. /**
  114530. * Initializes the state.
  114531. */
  114532. constructor();
  114533. get isDirty(): boolean;
  114534. get zOffset(): number;
  114535. set zOffset(value: number);
  114536. get cullFace(): Nullable<number>;
  114537. set cullFace(value: Nullable<number>);
  114538. get cull(): Nullable<boolean>;
  114539. set cull(value: Nullable<boolean>);
  114540. get depthFunc(): Nullable<number>;
  114541. set depthFunc(value: Nullable<number>);
  114542. get depthMask(): boolean;
  114543. set depthMask(value: boolean);
  114544. get depthTest(): boolean;
  114545. set depthTest(value: boolean);
  114546. get frontFace(): Nullable<number>;
  114547. set frontFace(value: Nullable<number>);
  114548. reset(): void;
  114549. apply(gl: WebGLRenderingContext): void;
  114550. }
  114551. }
  114552. declare module BABYLON {
  114553. /**
  114554. * @hidden
  114555. **/
  114556. export class StencilState {
  114557. /** 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 */
  114558. static readonly ALWAYS: number;
  114559. /** Passed to stencilOperation to specify that stencil value must be kept */
  114560. static readonly KEEP: number;
  114561. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114562. static readonly REPLACE: number;
  114563. private _isStencilTestDirty;
  114564. private _isStencilMaskDirty;
  114565. private _isStencilFuncDirty;
  114566. private _isStencilOpDirty;
  114567. private _stencilTest;
  114568. private _stencilMask;
  114569. private _stencilFunc;
  114570. private _stencilFuncRef;
  114571. private _stencilFuncMask;
  114572. private _stencilOpStencilFail;
  114573. private _stencilOpDepthFail;
  114574. private _stencilOpStencilDepthPass;
  114575. get isDirty(): boolean;
  114576. get stencilFunc(): number;
  114577. set stencilFunc(value: number);
  114578. get stencilFuncRef(): number;
  114579. set stencilFuncRef(value: number);
  114580. get stencilFuncMask(): number;
  114581. set stencilFuncMask(value: number);
  114582. get stencilOpStencilFail(): number;
  114583. set stencilOpStencilFail(value: number);
  114584. get stencilOpDepthFail(): number;
  114585. set stencilOpDepthFail(value: number);
  114586. get stencilOpStencilDepthPass(): number;
  114587. set stencilOpStencilDepthPass(value: number);
  114588. get stencilMask(): number;
  114589. set stencilMask(value: number);
  114590. get stencilTest(): boolean;
  114591. set stencilTest(value: boolean);
  114592. constructor();
  114593. reset(): void;
  114594. apply(gl: WebGLRenderingContext): void;
  114595. }
  114596. }
  114597. declare module BABYLON {
  114598. /**
  114599. * @hidden
  114600. **/
  114601. export class AlphaState {
  114602. private _isAlphaBlendDirty;
  114603. private _isBlendFunctionParametersDirty;
  114604. private _isBlendEquationParametersDirty;
  114605. private _isBlendConstantsDirty;
  114606. private _alphaBlend;
  114607. private _blendFunctionParameters;
  114608. private _blendEquationParameters;
  114609. private _blendConstants;
  114610. /**
  114611. * Initializes the state.
  114612. */
  114613. constructor();
  114614. get isDirty(): boolean;
  114615. get alphaBlend(): boolean;
  114616. set alphaBlend(value: boolean);
  114617. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114618. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114619. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114620. reset(): void;
  114621. apply(gl: WebGLRenderingContext): void;
  114622. }
  114623. }
  114624. declare module BABYLON {
  114625. /** @hidden */
  114626. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114627. attributeProcessor(attribute: string): string;
  114628. varyingProcessor(varying: string, isFragment: boolean): string;
  114629. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114630. }
  114631. }
  114632. declare module BABYLON {
  114633. /**
  114634. * Interface for attribute information associated with buffer instanciation
  114635. */
  114636. export interface InstancingAttributeInfo {
  114637. /**
  114638. * Name of the GLSL attribute
  114639. * if attribute index is not specified, this is used to retrieve the index from the effect
  114640. */
  114641. attributeName: string;
  114642. /**
  114643. * Index/offset of the attribute in the vertex shader
  114644. * if not specified, this will be computes from the name.
  114645. */
  114646. index?: number;
  114647. /**
  114648. * size of the attribute, 1, 2, 3 or 4
  114649. */
  114650. attributeSize: number;
  114651. /**
  114652. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114653. */
  114654. offset: number;
  114655. /**
  114656. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114657. * default to 1
  114658. */
  114659. divisor?: number;
  114660. /**
  114661. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114662. * default is FLOAT
  114663. */
  114664. attributeType?: number;
  114665. /**
  114666. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114667. */
  114668. normalized?: boolean;
  114669. }
  114670. }
  114671. declare module BABYLON {
  114672. interface ThinEngine {
  114673. /**
  114674. * Update a video texture
  114675. * @param texture defines the texture to update
  114676. * @param video defines the video element to use
  114677. * @param invertY defines if data must be stored with Y axis inverted
  114678. */
  114679. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114680. }
  114681. }
  114682. declare module BABYLON {
  114683. interface ThinEngine {
  114684. /**
  114685. * Creates a dynamic texture
  114686. * @param width defines the width of the texture
  114687. * @param height defines the height of the texture
  114688. * @param generateMipMaps defines if the engine should generate the mip levels
  114689. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114690. * @returns the dynamic texture inside an InternalTexture
  114691. */
  114692. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114693. /**
  114694. * Update the content of a dynamic texture
  114695. * @param texture defines the texture to update
  114696. * @param canvas defines the canvas containing the source
  114697. * @param invertY defines if data must be stored with Y axis inverted
  114698. * @param premulAlpha defines if alpha is stored as premultiplied
  114699. * @param format defines the format of the data
  114700. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114701. */
  114702. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114703. }
  114704. }
  114705. declare module BABYLON {
  114706. /**
  114707. * Settings for finer control over video usage
  114708. */
  114709. export interface VideoTextureSettings {
  114710. /**
  114711. * Applies `autoplay` to video, if specified
  114712. */
  114713. autoPlay?: boolean;
  114714. /**
  114715. * Applies `loop` to video, if specified
  114716. */
  114717. loop?: boolean;
  114718. /**
  114719. * Automatically updates internal texture from video at every frame in the render loop
  114720. */
  114721. autoUpdateTexture: boolean;
  114722. /**
  114723. * Image src displayed during the video loading or until the user interacts with the video.
  114724. */
  114725. poster?: string;
  114726. }
  114727. /**
  114728. * If you want to display a video in your scene, this is the special texture for that.
  114729. * This special texture works similar to other textures, with the exception of a few parameters.
  114730. * @see https://doc.babylonjs.com/how_to/video_texture
  114731. */
  114732. export class VideoTexture extends Texture {
  114733. /**
  114734. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114735. */
  114736. readonly autoUpdateTexture: boolean;
  114737. /**
  114738. * The video instance used by the texture internally
  114739. */
  114740. readonly video: HTMLVideoElement;
  114741. private _onUserActionRequestedObservable;
  114742. /**
  114743. * Event triggerd when a dom action is required by the user to play the video.
  114744. * This happens due to recent changes in browser policies preventing video to auto start.
  114745. */
  114746. get onUserActionRequestedObservable(): Observable<Texture>;
  114747. private _generateMipMaps;
  114748. private _stillImageCaptured;
  114749. private _displayingPosterTexture;
  114750. private _settings;
  114751. private _createInternalTextureOnEvent;
  114752. private _frameId;
  114753. private _currentSrc;
  114754. /**
  114755. * Creates a video texture.
  114756. * If you want to display a video in your scene, this is the special texture for that.
  114757. * This special texture works similar to other textures, with the exception of a few parameters.
  114758. * @see https://doc.babylonjs.com/how_to/video_texture
  114759. * @param name optional name, will detect from video source, if not defined
  114760. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114761. * @param scene is obviously the current scene.
  114762. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114763. * @param invertY is false by default but can be used to invert video on Y axis
  114764. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114765. * @param settings allows finer control over video usage
  114766. */
  114767. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114768. private _getName;
  114769. private _getVideo;
  114770. private _createInternalTexture;
  114771. private reset;
  114772. /**
  114773. * @hidden Internal method to initiate `update`.
  114774. */
  114775. _rebuild(): void;
  114776. /**
  114777. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114778. */
  114779. update(): void;
  114780. /**
  114781. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114782. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114783. */
  114784. updateTexture(isVisible: boolean): void;
  114785. protected _updateInternalTexture: () => void;
  114786. /**
  114787. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114788. * @param url New url.
  114789. */
  114790. updateURL(url: string): void;
  114791. /**
  114792. * Clones the texture.
  114793. * @returns the cloned texture
  114794. */
  114795. clone(): VideoTexture;
  114796. /**
  114797. * Dispose the texture and release its associated resources.
  114798. */
  114799. dispose(): void;
  114800. /**
  114801. * Creates a video texture straight from a stream.
  114802. * @param scene Define the scene the texture should be created in
  114803. * @param stream Define the stream the texture should be created from
  114804. * @returns The created video texture as a promise
  114805. */
  114806. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114807. /**
  114808. * Creates a video texture straight from your WebCam video feed.
  114809. * @param scene Define the scene the texture should be created in
  114810. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114811. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114812. * @returns The created video texture as a promise
  114813. */
  114814. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114815. minWidth: number;
  114816. maxWidth: number;
  114817. minHeight: number;
  114818. maxHeight: number;
  114819. deviceId: string;
  114820. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114821. /**
  114822. * Creates a video texture straight from your WebCam video feed.
  114823. * @param scene Define the scene the texture should be created in
  114824. * @param onReady Define a callback to triggered once the texture will be ready
  114825. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114826. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114827. */
  114828. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114829. minWidth: number;
  114830. maxWidth: number;
  114831. minHeight: number;
  114832. maxHeight: number;
  114833. deviceId: string;
  114834. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114835. }
  114836. }
  114837. declare module BABYLON {
  114838. /**
  114839. * Defines the interface used by objects working like Scene
  114840. * @hidden
  114841. */
  114842. export interface ISceneLike {
  114843. _addPendingData(data: any): void;
  114844. _removePendingData(data: any): void;
  114845. offlineProvider: IOfflineProvider;
  114846. }
  114847. /**
  114848. * Information about the current host
  114849. */
  114850. export interface HostInformation {
  114851. /**
  114852. * Defines if the current host is a mobile
  114853. */
  114854. isMobile: boolean;
  114855. }
  114856. /** Interface defining initialization parameters for Engine class */
  114857. export interface EngineOptions extends WebGLContextAttributes {
  114858. /**
  114859. * Defines if the engine should no exceed a specified device ratio
  114860. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114861. */
  114862. limitDeviceRatio?: number;
  114863. /**
  114864. * Defines if webvr should be enabled automatically
  114865. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114866. */
  114867. autoEnableWebVR?: boolean;
  114868. /**
  114869. * Defines if webgl2 should be turned off even if supported
  114870. * @see https://doc.babylonjs.com/features/webgl2
  114871. */
  114872. disableWebGL2Support?: boolean;
  114873. /**
  114874. * Defines if webaudio should be initialized as well
  114875. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114876. */
  114877. audioEngine?: boolean;
  114878. /**
  114879. * Defines if animations should run using a deterministic lock step
  114880. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114881. */
  114882. deterministicLockstep?: boolean;
  114883. /** Defines the maximum steps to use with deterministic lock step mode */
  114884. lockstepMaxSteps?: number;
  114885. /** Defines the seconds between each deterministic lock step */
  114886. timeStep?: number;
  114887. /**
  114888. * Defines that engine should ignore context lost events
  114889. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114890. */
  114891. doNotHandleContextLost?: boolean;
  114892. /**
  114893. * Defines that engine should ignore modifying touch action attribute and style
  114894. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114895. */
  114896. doNotHandleTouchAction?: boolean;
  114897. /**
  114898. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114899. */
  114900. useHighPrecisionFloats?: boolean;
  114901. /**
  114902. * Make the canvas XR Compatible for XR sessions
  114903. */
  114904. xrCompatible?: boolean;
  114905. /**
  114906. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114907. */
  114908. useHighPrecisionMatrix?: boolean;
  114909. }
  114910. /**
  114911. * The base engine class (root of all engines)
  114912. */
  114913. export class ThinEngine {
  114914. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114915. static ExceptionList: ({
  114916. key: string;
  114917. capture: string;
  114918. captureConstraint: number;
  114919. targets: string[];
  114920. } | {
  114921. key: string;
  114922. capture: null;
  114923. captureConstraint: null;
  114924. targets: string[];
  114925. })[];
  114926. /** @hidden */
  114927. static _TextureLoaders: IInternalTextureLoader[];
  114928. /**
  114929. * Returns the current npm package of the sdk
  114930. */
  114931. static get NpmPackage(): string;
  114932. /**
  114933. * Returns the current version of the framework
  114934. */
  114935. static get Version(): string;
  114936. /**
  114937. * Returns a string describing the current engine
  114938. */
  114939. get description(): string;
  114940. /**
  114941. * Gets or sets the epsilon value used by collision engine
  114942. */
  114943. static CollisionsEpsilon: number;
  114944. /**
  114945. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114946. */
  114947. static get ShadersRepository(): string;
  114948. static set ShadersRepository(value: string);
  114949. /** @hidden */
  114950. _shaderProcessor: IShaderProcessor;
  114951. /**
  114952. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114953. */
  114954. forcePOTTextures: boolean;
  114955. /**
  114956. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114957. */
  114958. isFullscreen: boolean;
  114959. /**
  114960. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114961. */
  114962. cullBackFaces: boolean;
  114963. /**
  114964. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114965. */
  114966. renderEvenInBackground: boolean;
  114967. /**
  114968. * Gets or sets a boolean indicating that cache can be kept between frames
  114969. */
  114970. preventCacheWipeBetweenFrames: boolean;
  114971. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114972. validateShaderPrograms: boolean;
  114973. /**
  114974. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114975. * This can provide greater z depth for distant objects.
  114976. */
  114977. useReverseDepthBuffer: boolean;
  114978. /**
  114979. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114980. */
  114981. disableUniformBuffers: boolean;
  114982. /** @hidden */
  114983. _uniformBuffers: UniformBuffer[];
  114984. /**
  114985. * Gets a boolean indicating that the engine supports uniform buffers
  114986. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114987. */
  114988. get supportsUniformBuffers(): boolean;
  114989. /** @hidden */
  114990. _gl: WebGLRenderingContext;
  114991. /** @hidden */
  114992. _webGLVersion: number;
  114993. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114994. protected _windowIsBackground: boolean;
  114995. protected _creationOptions: EngineOptions;
  114996. protected _highPrecisionShadersAllowed: boolean;
  114997. /** @hidden */
  114998. get _shouldUseHighPrecisionShader(): boolean;
  114999. /**
  115000. * Gets a boolean indicating that only power of 2 textures are supported
  115001. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  115002. */
  115003. get needPOTTextures(): boolean;
  115004. /** @hidden */
  115005. _badOS: boolean;
  115006. /** @hidden */
  115007. _badDesktopOS: boolean;
  115008. private _hardwareScalingLevel;
  115009. /** @hidden */
  115010. _caps: EngineCapabilities;
  115011. private _isStencilEnable;
  115012. private _glVersion;
  115013. private _glRenderer;
  115014. private _glVendor;
  115015. /** @hidden */
  115016. _videoTextureSupported: boolean;
  115017. protected _renderingQueueLaunched: boolean;
  115018. protected _activeRenderLoops: (() => void)[];
  115019. /**
  115020. * Observable signaled when a context lost event is raised
  115021. */
  115022. onContextLostObservable: Observable<ThinEngine>;
  115023. /**
  115024. * Observable signaled when a context restored event is raised
  115025. */
  115026. onContextRestoredObservable: Observable<ThinEngine>;
  115027. private _onContextLost;
  115028. private _onContextRestored;
  115029. protected _contextWasLost: boolean;
  115030. /** @hidden */
  115031. _doNotHandleContextLost: boolean;
  115032. /**
  115033. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115034. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115035. */
  115036. get doNotHandleContextLost(): boolean;
  115037. set doNotHandleContextLost(value: boolean);
  115038. /**
  115039. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115040. */
  115041. disableVertexArrayObjects: boolean;
  115042. /** @hidden */
  115043. protected _colorWrite: boolean;
  115044. /** @hidden */
  115045. protected _colorWriteChanged: boolean;
  115046. /** @hidden */
  115047. protected _depthCullingState: DepthCullingState;
  115048. /** @hidden */
  115049. protected _stencilState: StencilState;
  115050. /** @hidden */
  115051. _alphaState: AlphaState;
  115052. /** @hidden */
  115053. _alphaMode: number;
  115054. /** @hidden */
  115055. _alphaEquation: number;
  115056. /** @hidden */
  115057. _internalTexturesCache: InternalTexture[];
  115058. /** @hidden */
  115059. protected _activeChannel: number;
  115060. private _currentTextureChannel;
  115061. /** @hidden */
  115062. protected _boundTexturesCache: {
  115063. [key: string]: Nullable<InternalTexture>;
  115064. };
  115065. /** @hidden */
  115066. protected _currentEffect: Nullable<Effect>;
  115067. /** @hidden */
  115068. protected _currentProgram: Nullable<WebGLProgram>;
  115069. private _compiledEffects;
  115070. private _vertexAttribArraysEnabled;
  115071. /** @hidden */
  115072. protected _cachedViewport: Nullable<IViewportLike>;
  115073. private _cachedVertexArrayObject;
  115074. /** @hidden */
  115075. protected _cachedVertexBuffers: any;
  115076. /** @hidden */
  115077. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115078. /** @hidden */
  115079. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115080. /** @hidden */
  115081. _currentRenderTarget: Nullable<InternalTexture>;
  115082. private _uintIndicesCurrentlySet;
  115083. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115084. /** @hidden */
  115085. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115086. /** @hidden */
  115087. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115088. private _currentBufferPointers;
  115089. private _currentInstanceLocations;
  115090. private _currentInstanceBuffers;
  115091. private _textureUnits;
  115092. /** @hidden */
  115093. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115094. /** @hidden */
  115095. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115096. /** @hidden */
  115097. _boundRenderFunction: any;
  115098. private _vaoRecordInProgress;
  115099. private _mustWipeVertexAttributes;
  115100. private _emptyTexture;
  115101. private _emptyCubeTexture;
  115102. private _emptyTexture3D;
  115103. private _emptyTexture2DArray;
  115104. /** @hidden */
  115105. _frameHandler: number;
  115106. private _nextFreeTextureSlots;
  115107. private _maxSimultaneousTextures;
  115108. private _activeRequests;
  115109. /** @hidden */
  115110. _transformTextureUrl: Nullable<(url: string) => string>;
  115111. /**
  115112. * Gets information about the current host
  115113. */
  115114. hostInformation: HostInformation;
  115115. protected get _supportsHardwareTextureRescaling(): boolean;
  115116. private _framebufferDimensionsObject;
  115117. /**
  115118. * sets the object from which width and height will be taken from when getting render width and height
  115119. * Will fallback to the gl object
  115120. * @param dimensions the framebuffer width and height that will be used.
  115121. */
  115122. set framebufferDimensionsObject(dimensions: Nullable<{
  115123. framebufferWidth: number;
  115124. framebufferHeight: number;
  115125. }>);
  115126. /**
  115127. * Gets the current viewport
  115128. */
  115129. get currentViewport(): Nullable<IViewportLike>;
  115130. /**
  115131. * Gets the default empty texture
  115132. */
  115133. get emptyTexture(): InternalTexture;
  115134. /**
  115135. * Gets the default empty 3D texture
  115136. */
  115137. get emptyTexture3D(): InternalTexture;
  115138. /**
  115139. * Gets the default empty 2D array texture
  115140. */
  115141. get emptyTexture2DArray(): InternalTexture;
  115142. /**
  115143. * Gets the default empty cube texture
  115144. */
  115145. get emptyCubeTexture(): InternalTexture;
  115146. /**
  115147. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115148. */
  115149. readonly premultipliedAlpha: boolean;
  115150. /**
  115151. * Observable event triggered before each texture is initialized
  115152. */
  115153. onBeforeTextureInitObservable: Observable<Texture>;
  115154. /**
  115155. * Creates a new engine
  115156. * @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
  115157. * @param antialias defines enable antialiasing (default: false)
  115158. * @param options defines further options to be sent to the getContext() function
  115159. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115160. */
  115161. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115162. private _rebuildInternalTextures;
  115163. private _rebuildEffects;
  115164. /**
  115165. * Gets a boolean indicating if all created effects are ready
  115166. * @returns true if all effects are ready
  115167. */
  115168. areAllEffectsReady(): boolean;
  115169. protected _rebuildBuffers(): void;
  115170. protected _initGLContext(): void;
  115171. /**
  115172. * Gets version of the current webGL context
  115173. */
  115174. get webGLVersion(): number;
  115175. /**
  115176. * Gets a string identifying the name of the class
  115177. * @returns "Engine" string
  115178. */
  115179. getClassName(): string;
  115180. /**
  115181. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115182. */
  115183. get isStencilEnable(): boolean;
  115184. /** @hidden */
  115185. _prepareWorkingCanvas(): void;
  115186. /**
  115187. * Reset the texture cache to empty state
  115188. */
  115189. resetTextureCache(): void;
  115190. /**
  115191. * Gets an object containing information about the current webGL context
  115192. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115193. */
  115194. getGlInfo(): {
  115195. vendor: string;
  115196. renderer: string;
  115197. version: string;
  115198. };
  115199. /**
  115200. * Defines the hardware scaling level.
  115201. * By default the hardware scaling level is computed from the window device ratio.
  115202. * 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.
  115203. * @param level defines the level to use
  115204. */
  115205. setHardwareScalingLevel(level: number): void;
  115206. /**
  115207. * Gets the current hardware scaling level.
  115208. * By default the hardware scaling level is computed from the window device ratio.
  115209. * 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.
  115210. * @returns a number indicating the current hardware scaling level
  115211. */
  115212. getHardwareScalingLevel(): number;
  115213. /**
  115214. * Gets the list of loaded textures
  115215. * @returns an array containing all loaded textures
  115216. */
  115217. getLoadedTexturesCache(): InternalTexture[];
  115218. /**
  115219. * Gets the object containing all engine capabilities
  115220. * @returns the EngineCapabilities object
  115221. */
  115222. getCaps(): EngineCapabilities;
  115223. /**
  115224. * stop executing a render loop function and remove it from the execution array
  115225. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115226. */
  115227. stopRenderLoop(renderFunction?: () => void): void;
  115228. /** @hidden */
  115229. _renderLoop(): void;
  115230. /**
  115231. * Gets the HTML canvas attached with the current webGL context
  115232. * @returns a HTML canvas
  115233. */
  115234. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115235. /**
  115236. * Gets host window
  115237. * @returns the host window object
  115238. */
  115239. getHostWindow(): Nullable<Window>;
  115240. /**
  115241. * Gets the current render width
  115242. * @param useScreen defines if screen size must be used (or the current render target if any)
  115243. * @returns a number defining the current render width
  115244. */
  115245. getRenderWidth(useScreen?: boolean): number;
  115246. /**
  115247. * Gets the current render height
  115248. * @param useScreen defines if screen size must be used (or the current render target if any)
  115249. * @returns a number defining the current render height
  115250. */
  115251. getRenderHeight(useScreen?: boolean): number;
  115252. /**
  115253. * Can be used to override the current requestAnimationFrame requester.
  115254. * @hidden
  115255. */
  115256. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115257. /**
  115258. * Register and execute a render loop. The engine can have more than one render function
  115259. * @param renderFunction defines the function to continuously execute
  115260. */
  115261. runRenderLoop(renderFunction: () => void): void;
  115262. /**
  115263. * Clear the current render buffer or the current render target (if any is set up)
  115264. * @param color defines the color to use
  115265. * @param backBuffer defines if the back buffer must be cleared
  115266. * @param depth defines if the depth buffer must be cleared
  115267. * @param stencil defines if the stencil buffer must be cleared
  115268. */
  115269. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115270. private _viewportCached;
  115271. /** @hidden */
  115272. _viewport(x: number, y: number, width: number, height: number): void;
  115273. /**
  115274. * Set the WebGL's viewport
  115275. * @param viewport defines the viewport element to be used
  115276. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115277. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115278. */
  115279. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115280. /**
  115281. * Begin a new frame
  115282. */
  115283. beginFrame(): void;
  115284. /**
  115285. * Enf the current frame
  115286. */
  115287. endFrame(): void;
  115288. /**
  115289. * Resize the view according to the canvas' size
  115290. */
  115291. resize(): void;
  115292. /**
  115293. * Force a specific size of the canvas
  115294. * @param width defines the new canvas' width
  115295. * @param height defines the new canvas' height
  115296. * @returns true if the size was changed
  115297. */
  115298. setSize(width: number, height: number): boolean;
  115299. /**
  115300. * Binds the frame buffer to the specified texture.
  115301. * @param texture The texture to render to or null for the default canvas
  115302. * @param faceIndex The face of the texture to render to in case of cube texture
  115303. * @param requiredWidth The width of the target to render to
  115304. * @param requiredHeight The height of the target to render to
  115305. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115306. * @param lodLevel defines the lod level to bind to the frame buffer
  115307. * @param layer defines the 2d array index to bind to frame buffer to
  115308. */
  115309. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115310. /** @hidden */
  115311. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115312. /**
  115313. * Unbind the current render target texture from the webGL context
  115314. * @param texture defines the render target texture to unbind
  115315. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115316. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115317. */
  115318. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115319. /**
  115320. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115321. */
  115322. flushFramebuffer(): void;
  115323. /**
  115324. * Unbind the current render target and bind the default framebuffer
  115325. */
  115326. restoreDefaultFramebuffer(): void;
  115327. /** @hidden */
  115328. protected _resetVertexBufferBinding(): void;
  115329. /**
  115330. * Creates a vertex buffer
  115331. * @param data the data for the vertex buffer
  115332. * @returns the new WebGL static buffer
  115333. */
  115334. createVertexBuffer(data: DataArray): DataBuffer;
  115335. private _createVertexBuffer;
  115336. /**
  115337. * Creates a dynamic vertex buffer
  115338. * @param data the data for the dynamic vertex buffer
  115339. * @returns the new WebGL dynamic buffer
  115340. */
  115341. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115342. protected _resetIndexBufferBinding(): void;
  115343. /**
  115344. * Creates a new index buffer
  115345. * @param indices defines the content of the index buffer
  115346. * @param updatable defines if the index buffer must be updatable
  115347. * @returns a new webGL buffer
  115348. */
  115349. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115350. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115351. /**
  115352. * Bind a webGL buffer to the webGL context
  115353. * @param buffer defines the buffer to bind
  115354. */
  115355. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115356. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115357. private bindBuffer;
  115358. /**
  115359. * update the bound buffer with the given data
  115360. * @param data defines the data to update
  115361. */
  115362. updateArrayBuffer(data: Float32Array): void;
  115363. private _vertexAttribPointer;
  115364. /** @hidden */
  115365. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115366. private _bindVertexBuffersAttributes;
  115367. /**
  115368. * Records a vertex array object
  115369. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115370. * @param vertexBuffers defines the list of vertex buffers to store
  115371. * @param indexBuffer defines the index buffer to store
  115372. * @param effect defines the effect to store
  115373. * @returns the new vertex array object
  115374. */
  115375. recordVertexArrayObject(vertexBuffers: {
  115376. [key: string]: VertexBuffer;
  115377. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115378. /**
  115379. * Bind a specific vertex array object
  115380. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115381. * @param vertexArrayObject defines the vertex array object to bind
  115382. * @param indexBuffer defines the index buffer to bind
  115383. */
  115384. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115385. /**
  115386. * Bind webGl buffers directly to the webGL context
  115387. * @param vertexBuffer defines the vertex buffer to bind
  115388. * @param indexBuffer defines the index buffer to bind
  115389. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115390. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115391. * @param effect defines the effect associated with the vertex buffer
  115392. */
  115393. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115394. private _unbindVertexArrayObject;
  115395. /**
  115396. * Bind a list of vertex buffers to the webGL context
  115397. * @param vertexBuffers defines the list of vertex buffers to bind
  115398. * @param indexBuffer defines the index buffer to bind
  115399. * @param effect defines the effect associated with the vertex buffers
  115400. */
  115401. bindBuffers(vertexBuffers: {
  115402. [key: string]: Nullable<VertexBuffer>;
  115403. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115404. /**
  115405. * Unbind all instance attributes
  115406. */
  115407. unbindInstanceAttributes(): void;
  115408. /**
  115409. * Release and free the memory of a vertex array object
  115410. * @param vao defines the vertex array object to delete
  115411. */
  115412. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115413. /** @hidden */
  115414. _releaseBuffer(buffer: DataBuffer): boolean;
  115415. protected _deleteBuffer(buffer: DataBuffer): void;
  115416. /**
  115417. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115418. * @param instancesBuffer defines the webGL buffer to update and bind
  115419. * @param data defines the data to store in the buffer
  115420. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115421. */
  115422. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115423. /**
  115424. * Bind the content of a webGL buffer used with instantiation
  115425. * @param instancesBuffer defines the webGL buffer to bind
  115426. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115427. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115428. */
  115429. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115430. /**
  115431. * Disable the instance attribute corresponding to the name in parameter
  115432. * @param name defines the name of the attribute to disable
  115433. */
  115434. disableInstanceAttributeByName(name: string): void;
  115435. /**
  115436. * Disable the instance attribute corresponding to the location in parameter
  115437. * @param attributeLocation defines the attribute location of the attribute to disable
  115438. */
  115439. disableInstanceAttribute(attributeLocation: number): void;
  115440. /**
  115441. * Disable the attribute corresponding to the location in parameter
  115442. * @param attributeLocation defines the attribute location of the attribute to disable
  115443. */
  115444. disableAttributeByIndex(attributeLocation: number): void;
  115445. /**
  115446. * Send a draw order
  115447. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115448. * @param indexStart defines the starting index
  115449. * @param indexCount defines the number of index to draw
  115450. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115451. */
  115452. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115453. /**
  115454. * Draw a list of points
  115455. * @param verticesStart defines the index of first vertex to draw
  115456. * @param verticesCount defines the count of vertices to draw
  115457. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115458. */
  115459. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115460. /**
  115461. * Draw a list of unindexed primitives
  115462. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115463. * @param verticesStart defines the index of first vertex to draw
  115464. * @param verticesCount defines the count of vertices to draw
  115465. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115466. */
  115467. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115468. /**
  115469. * Draw a list of indexed primitives
  115470. * @param fillMode defines the primitive to use
  115471. * @param indexStart defines the starting index
  115472. * @param indexCount defines the number of index to draw
  115473. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115474. */
  115475. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115476. /**
  115477. * Draw a list of unindexed primitives
  115478. * @param fillMode defines the primitive to use
  115479. * @param verticesStart defines the index of first vertex to draw
  115480. * @param verticesCount defines the count of vertices to draw
  115481. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115482. */
  115483. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115484. private _drawMode;
  115485. /** @hidden */
  115486. protected _reportDrawCall(): void;
  115487. /** @hidden */
  115488. _releaseEffect(effect: Effect): void;
  115489. /** @hidden */
  115490. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115491. /**
  115492. * Create a new effect (used to store vertex/fragment shaders)
  115493. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115494. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115495. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115496. * @param samplers defines an array of string used to represent textures
  115497. * @param defines defines the string containing the defines to use to compile the shaders
  115498. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115499. * @param onCompiled defines a function to call when the effect creation is successful
  115500. * @param onError defines a function to call when the effect creation has failed
  115501. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115502. * @returns the new Effect
  115503. */
  115504. 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;
  115505. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115506. private _compileShader;
  115507. private _compileRawShader;
  115508. /** @hidden */
  115509. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115510. /**
  115511. * Directly creates a webGL program
  115512. * @param pipelineContext defines the pipeline context to attach to
  115513. * @param vertexCode defines the vertex shader code to use
  115514. * @param fragmentCode defines the fragment shader code to use
  115515. * @param context defines the webGL context to use (if not set, the current one will be used)
  115516. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115517. * @returns the new webGL program
  115518. */
  115519. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115520. /**
  115521. * Creates a webGL program
  115522. * @param pipelineContext defines the pipeline context to attach to
  115523. * @param vertexCode defines the vertex shader code to use
  115524. * @param fragmentCode defines the fragment shader code to use
  115525. * @param defines defines the string containing the defines to use to compile the shaders
  115526. * @param context defines the webGL context to use (if not set, the current one will be used)
  115527. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115528. * @returns the new webGL program
  115529. */
  115530. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115531. /**
  115532. * Creates a new pipeline context
  115533. * @returns the new pipeline
  115534. */
  115535. createPipelineContext(): IPipelineContext;
  115536. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115537. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115538. /** @hidden */
  115539. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115540. /** @hidden */
  115541. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115542. /** @hidden */
  115543. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115544. /**
  115545. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115546. * @param pipelineContext defines the pipeline context to use
  115547. * @param uniformsNames defines the list of uniform names
  115548. * @returns an array of webGL uniform locations
  115549. */
  115550. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115551. /**
  115552. * Gets the lsit of active attributes for a given webGL program
  115553. * @param pipelineContext defines the pipeline context to use
  115554. * @param attributesNames defines the list of attribute names to get
  115555. * @returns an array of indices indicating the offset of each attribute
  115556. */
  115557. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115558. /**
  115559. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115560. * @param effect defines the effect to activate
  115561. */
  115562. enableEffect(effect: Nullable<Effect>): void;
  115563. /**
  115564. * Set the value of an uniform to a number (int)
  115565. * @param uniform defines the webGL uniform location where to store the value
  115566. * @param value defines the int number to store
  115567. */
  115568. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115569. /**
  115570. * Set the value of an uniform to an array of int32
  115571. * @param uniform defines the webGL uniform location where to store the value
  115572. * @param array defines the array of int32 to store
  115573. */
  115574. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115575. /**
  115576. * Set the value of an uniform to an array of int32 (stored as vec2)
  115577. * @param uniform defines the webGL uniform location where to store the value
  115578. * @param array defines the array of int32 to store
  115579. */
  115580. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115581. /**
  115582. * Set the value of an uniform to an array of int32 (stored as vec3)
  115583. * @param uniform defines the webGL uniform location where to store the value
  115584. * @param array defines the array of int32 to store
  115585. */
  115586. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115587. /**
  115588. * Set the value of an uniform to an array of int32 (stored as vec4)
  115589. * @param uniform defines the webGL uniform location where to store the value
  115590. * @param array defines the array of int32 to store
  115591. */
  115592. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115593. /**
  115594. * Set the value of an uniform to an array of number
  115595. * @param uniform defines the webGL uniform location where to store the value
  115596. * @param array defines the array of number to store
  115597. */
  115598. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115599. /**
  115600. * Set the value of an uniform to an array of number (stored as vec2)
  115601. * @param uniform defines the webGL uniform location where to store the value
  115602. * @param array defines the array of number to store
  115603. */
  115604. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115605. /**
  115606. * Set the value of an uniform to an array of number (stored as vec3)
  115607. * @param uniform defines the webGL uniform location where to store the value
  115608. * @param array defines the array of number to store
  115609. */
  115610. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115611. /**
  115612. * Set the value of an uniform to an array of number (stored as vec4)
  115613. * @param uniform defines the webGL uniform location where to store the value
  115614. * @param array defines the array of number to store
  115615. */
  115616. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115617. /**
  115618. * Set the value of an uniform to an array of float32 (stored as matrices)
  115619. * @param uniform defines the webGL uniform location where to store the value
  115620. * @param matrices defines the array of float32 to store
  115621. */
  115622. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115623. /**
  115624. * Set the value of an uniform to a matrix (3x3)
  115625. * @param uniform defines the webGL uniform location where to store the value
  115626. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115627. */
  115628. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115629. /**
  115630. * Set the value of an uniform to a matrix (2x2)
  115631. * @param uniform defines the webGL uniform location where to store the value
  115632. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115633. */
  115634. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115635. /**
  115636. * Set the value of an uniform to a number (float)
  115637. * @param uniform defines the webGL uniform location where to store the value
  115638. * @param value defines the float number to store
  115639. */
  115640. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115641. /**
  115642. * Set the value of an uniform to a vec2
  115643. * @param uniform defines the webGL uniform location where to store the value
  115644. * @param x defines the 1st component of the value
  115645. * @param y defines the 2nd component of the value
  115646. */
  115647. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115648. /**
  115649. * Set the value of an uniform to a vec3
  115650. * @param uniform defines the webGL uniform location where to store the value
  115651. * @param x defines the 1st component of the value
  115652. * @param y defines the 2nd component of the value
  115653. * @param z defines the 3rd component of the value
  115654. */
  115655. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115656. /**
  115657. * Set the value of an uniform to a vec4
  115658. * @param uniform defines the webGL uniform location where to store the value
  115659. * @param x defines the 1st component of the value
  115660. * @param y defines the 2nd component of the value
  115661. * @param z defines the 3rd component of the value
  115662. * @param w defines the 4th component of the value
  115663. */
  115664. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115665. /**
  115666. * Apply all cached states (depth, culling, stencil and alpha)
  115667. */
  115668. applyStates(): void;
  115669. /**
  115670. * Enable or disable color writing
  115671. * @param enable defines the state to set
  115672. */
  115673. setColorWrite(enable: boolean): void;
  115674. /**
  115675. * Gets a boolean indicating if color writing is enabled
  115676. * @returns the current color writing state
  115677. */
  115678. getColorWrite(): boolean;
  115679. /**
  115680. * Gets the depth culling state manager
  115681. */
  115682. get depthCullingState(): DepthCullingState;
  115683. /**
  115684. * Gets the alpha state manager
  115685. */
  115686. get alphaState(): AlphaState;
  115687. /**
  115688. * Gets the stencil state manager
  115689. */
  115690. get stencilState(): StencilState;
  115691. /**
  115692. * Clears the list of texture accessible through engine.
  115693. * This can help preventing texture load conflict due to name collision.
  115694. */
  115695. clearInternalTexturesCache(): void;
  115696. /**
  115697. * Force the entire cache to be cleared
  115698. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115699. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115700. */
  115701. wipeCaches(bruteForce?: boolean): void;
  115702. /** @hidden */
  115703. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115704. min: number;
  115705. mag: number;
  115706. };
  115707. /** @hidden */
  115708. _createTexture(): WebGLTexture;
  115709. /**
  115710. * Usually called from Texture.ts.
  115711. * Passed information to create a WebGLTexture
  115712. * @param url defines a value which contains one of the following:
  115713. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115714. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115715. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115716. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115717. * @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)
  115718. * @param scene needed for loading to the correct scene
  115719. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115720. * @param onLoad optional callback to be called upon successful completion
  115721. * @param onError optional callback to be called upon failure
  115722. * @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
  115723. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115724. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115725. * @param forcedExtension defines the extension to use to pick the right loader
  115726. * @param mimeType defines an optional mime type
  115727. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115728. */
  115729. 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;
  115730. /**
  115731. * Loads an image as an HTMLImageElement.
  115732. * @param input url string, ArrayBuffer, or Blob to load
  115733. * @param onLoad callback called when the image successfully loads
  115734. * @param onError callback called when the image fails to load
  115735. * @param offlineProvider offline provider for caching
  115736. * @param mimeType optional mime type
  115737. * @returns the HTMLImageElement of the loaded image
  115738. * @hidden
  115739. */
  115740. 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>;
  115741. /**
  115742. * @hidden
  115743. */
  115744. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115745. private _unpackFlipYCached;
  115746. /**
  115747. * In case you are sharing the context with other applications, it might
  115748. * be interested to not cache the unpack flip y state to ensure a consistent
  115749. * value would be set.
  115750. */
  115751. enableUnpackFlipYCached: boolean;
  115752. /** @hidden */
  115753. _unpackFlipY(value: boolean): void;
  115754. /** @hidden */
  115755. _getUnpackAlignement(): number;
  115756. private _getTextureTarget;
  115757. /**
  115758. * Update the sampling mode of a given texture
  115759. * @param samplingMode defines the required sampling mode
  115760. * @param texture defines the texture to update
  115761. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115762. */
  115763. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115764. /**
  115765. * Update the sampling mode of a given texture
  115766. * @param texture defines the texture to update
  115767. * @param wrapU defines the texture wrap mode of the u coordinates
  115768. * @param wrapV defines the texture wrap mode of the v coordinates
  115769. * @param wrapR defines the texture wrap mode of the r coordinates
  115770. */
  115771. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115772. /** @hidden */
  115773. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115774. width: number;
  115775. height: number;
  115776. layers?: number;
  115777. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115778. /** @hidden */
  115779. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115780. /** @hidden */
  115781. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115782. /**
  115783. * Update a portion of an internal texture
  115784. * @param texture defines the texture to update
  115785. * @param imageData defines the data to store into the texture
  115786. * @param xOffset defines the x coordinates of the update rectangle
  115787. * @param yOffset defines the y coordinates of the update rectangle
  115788. * @param width defines the width of the update rectangle
  115789. * @param height defines the height of the update rectangle
  115790. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115791. * @param lod defines the lod level to update (0 by default)
  115792. */
  115793. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115794. /** @hidden */
  115795. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115796. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115797. private _prepareWebGLTexture;
  115798. /** @hidden */
  115799. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115800. private _getDepthStencilBuffer;
  115801. /** @hidden */
  115802. _releaseFramebufferObjects(texture: InternalTexture): void;
  115803. /** @hidden */
  115804. _releaseTexture(texture: InternalTexture): void;
  115805. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115806. protected _setProgram(program: WebGLProgram): void;
  115807. protected _boundUniforms: {
  115808. [key: number]: WebGLUniformLocation;
  115809. };
  115810. /**
  115811. * Binds an effect to the webGL context
  115812. * @param effect defines the effect to bind
  115813. */
  115814. bindSamplers(effect: Effect): void;
  115815. private _activateCurrentTexture;
  115816. /** @hidden */
  115817. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115818. /** @hidden */
  115819. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115820. /**
  115821. * Unbind all textures from the webGL context
  115822. */
  115823. unbindAllTextures(): void;
  115824. /**
  115825. * Sets a texture to the according uniform.
  115826. * @param channel The texture channel
  115827. * @param uniform The uniform to set
  115828. * @param texture The texture to apply
  115829. */
  115830. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115831. private _bindSamplerUniformToChannel;
  115832. private _getTextureWrapMode;
  115833. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115834. /**
  115835. * Sets an array of texture to the webGL context
  115836. * @param channel defines the channel where the texture array must be set
  115837. * @param uniform defines the associated uniform location
  115838. * @param textures defines the array of textures to bind
  115839. */
  115840. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115841. /** @hidden */
  115842. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115843. private _setTextureParameterFloat;
  115844. private _setTextureParameterInteger;
  115845. /**
  115846. * Unbind all vertex attributes from the webGL context
  115847. */
  115848. unbindAllAttributes(): void;
  115849. /**
  115850. * 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
  115851. */
  115852. releaseEffects(): void;
  115853. /**
  115854. * Dispose and release all associated resources
  115855. */
  115856. dispose(): void;
  115857. /**
  115858. * Attach a new callback raised when context lost event is fired
  115859. * @param callback defines the callback to call
  115860. */
  115861. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115862. /**
  115863. * Attach a new callback raised when context restored event is fired
  115864. * @param callback defines the callback to call
  115865. */
  115866. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115867. /**
  115868. * Get the current error code of the webGL context
  115869. * @returns the error code
  115870. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115871. */
  115872. getError(): number;
  115873. private _canRenderToFloatFramebuffer;
  115874. private _canRenderToHalfFloatFramebuffer;
  115875. private _canRenderToFramebuffer;
  115876. /** @hidden */
  115877. _getWebGLTextureType(type: number): number;
  115878. /** @hidden */
  115879. _getInternalFormat(format: number): number;
  115880. /** @hidden */
  115881. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115882. /** @hidden */
  115883. _getRGBAMultiSampleBufferFormat(type: number): number;
  115884. /** @hidden */
  115885. _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;
  115886. /**
  115887. * Loads a file from a url
  115888. * @param url url to load
  115889. * @param onSuccess callback called when the file successfully loads
  115890. * @param onProgress callback called while file is loading (if the server supports this mode)
  115891. * @param offlineProvider defines the offline provider for caching
  115892. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115893. * @param onError callback called when the file fails to load
  115894. * @returns a file request object
  115895. * @hidden
  115896. */
  115897. 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;
  115898. /**
  115899. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115900. * @param x defines the x coordinate of the rectangle where pixels must be read
  115901. * @param y defines the y coordinate of the rectangle where pixels must be read
  115902. * @param width defines the width of the rectangle where pixels must be read
  115903. * @param height defines the height of the rectangle where pixels must be read
  115904. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115905. * @returns a Uint8Array containing RGBA colors
  115906. */
  115907. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115908. private static _isSupported;
  115909. /**
  115910. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115911. * @returns true if the engine can be created
  115912. * @ignorenaming
  115913. */
  115914. static isSupported(): boolean;
  115915. /**
  115916. * Find the next highest power of two.
  115917. * @param x Number to start search from.
  115918. * @return Next highest power of two.
  115919. */
  115920. static CeilingPOT(x: number): number;
  115921. /**
  115922. * Find the next lowest power of two.
  115923. * @param x Number to start search from.
  115924. * @return Next lowest power of two.
  115925. */
  115926. static FloorPOT(x: number): number;
  115927. /**
  115928. * Find the nearest power of two.
  115929. * @param x Number to start search from.
  115930. * @return Next nearest power of two.
  115931. */
  115932. static NearestPOT(x: number): number;
  115933. /**
  115934. * Get the closest exponent of two
  115935. * @param value defines the value to approximate
  115936. * @param max defines the maximum value to return
  115937. * @param mode defines how to define the closest value
  115938. * @returns closest exponent of two of the given value
  115939. */
  115940. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115941. /**
  115942. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115943. * @param func - the function to be called
  115944. * @param requester - the object that will request the next frame. Falls back to window.
  115945. * @returns frame number
  115946. */
  115947. static QueueNewFrame(func: () => void, requester?: any): number;
  115948. /**
  115949. * Gets host document
  115950. * @returns the host document object
  115951. */
  115952. getHostDocument(): Nullable<Document>;
  115953. }
  115954. }
  115955. declare module BABYLON {
  115956. /**
  115957. * Class representing spherical harmonics coefficients to the 3rd degree
  115958. */
  115959. export class SphericalHarmonics {
  115960. /**
  115961. * Defines whether or not the harmonics have been prescaled for rendering.
  115962. */
  115963. preScaled: boolean;
  115964. /**
  115965. * The l0,0 coefficients of the spherical harmonics
  115966. */
  115967. l00: Vector3;
  115968. /**
  115969. * The l1,-1 coefficients of the spherical harmonics
  115970. */
  115971. l1_1: Vector3;
  115972. /**
  115973. * The l1,0 coefficients of the spherical harmonics
  115974. */
  115975. l10: Vector3;
  115976. /**
  115977. * The l1,1 coefficients of the spherical harmonics
  115978. */
  115979. l11: Vector3;
  115980. /**
  115981. * The l2,-2 coefficients of the spherical harmonics
  115982. */
  115983. l2_2: Vector3;
  115984. /**
  115985. * The l2,-1 coefficients of the spherical harmonics
  115986. */
  115987. l2_1: Vector3;
  115988. /**
  115989. * The l2,0 coefficients of the spherical harmonics
  115990. */
  115991. l20: Vector3;
  115992. /**
  115993. * The l2,1 coefficients of the spherical harmonics
  115994. */
  115995. l21: Vector3;
  115996. /**
  115997. * The l2,2 coefficients of the spherical harmonics
  115998. */
  115999. l22: Vector3;
  116000. /**
  116001. * Adds a light to the spherical harmonics
  116002. * @param direction the direction of the light
  116003. * @param color the color of the light
  116004. * @param deltaSolidAngle the delta solid angle of the light
  116005. */
  116006. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  116007. /**
  116008. * Scales the spherical harmonics by the given amount
  116009. * @param scale the amount to scale
  116010. */
  116011. scaleInPlace(scale: number): void;
  116012. /**
  116013. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116014. *
  116015. * ```
  116016. * E_lm = A_l * L_lm
  116017. * ```
  116018. *
  116019. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116020. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116021. * the scaling factors are given in equation 9.
  116022. */
  116023. convertIncidentRadianceToIrradiance(): void;
  116024. /**
  116025. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116026. *
  116027. * ```
  116028. * L = (1/pi) * E * rho
  116029. * ```
  116030. *
  116031. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116032. */
  116033. convertIrradianceToLambertianRadiance(): void;
  116034. /**
  116035. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116036. * required operations at run time.
  116037. *
  116038. * This is simply done by scaling back the SH with Ylm constants parameter.
  116039. * The trigonometric part being applied by the shader at run time.
  116040. */
  116041. preScaleForRendering(): void;
  116042. /**
  116043. * Constructs a spherical harmonics from an array.
  116044. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116045. * @returns the spherical harmonics
  116046. */
  116047. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116048. /**
  116049. * Gets the spherical harmonics from polynomial
  116050. * @param polynomial the spherical polynomial
  116051. * @returns the spherical harmonics
  116052. */
  116053. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116054. }
  116055. /**
  116056. * Class representing spherical polynomial coefficients to the 3rd degree
  116057. */
  116058. export class SphericalPolynomial {
  116059. private _harmonics;
  116060. /**
  116061. * The spherical harmonics used to create the polynomials.
  116062. */
  116063. get preScaledHarmonics(): SphericalHarmonics;
  116064. /**
  116065. * The x coefficients of the spherical polynomial
  116066. */
  116067. x: Vector3;
  116068. /**
  116069. * The y coefficients of the spherical polynomial
  116070. */
  116071. y: Vector3;
  116072. /**
  116073. * The z coefficients of the spherical polynomial
  116074. */
  116075. z: Vector3;
  116076. /**
  116077. * The xx coefficients of the spherical polynomial
  116078. */
  116079. xx: Vector3;
  116080. /**
  116081. * The yy coefficients of the spherical polynomial
  116082. */
  116083. yy: Vector3;
  116084. /**
  116085. * The zz coefficients of the spherical polynomial
  116086. */
  116087. zz: Vector3;
  116088. /**
  116089. * The xy coefficients of the spherical polynomial
  116090. */
  116091. xy: Vector3;
  116092. /**
  116093. * The yz coefficients of the spherical polynomial
  116094. */
  116095. yz: Vector3;
  116096. /**
  116097. * The zx coefficients of the spherical polynomial
  116098. */
  116099. zx: Vector3;
  116100. /**
  116101. * Adds an ambient color to the spherical polynomial
  116102. * @param color the color to add
  116103. */
  116104. addAmbient(color: Color3): void;
  116105. /**
  116106. * Scales the spherical polynomial by the given amount
  116107. * @param scale the amount to scale
  116108. */
  116109. scaleInPlace(scale: number): void;
  116110. /**
  116111. * Gets the spherical polynomial from harmonics
  116112. * @param harmonics the spherical harmonics
  116113. * @returns the spherical polynomial
  116114. */
  116115. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116116. /**
  116117. * Constructs a spherical polynomial from an array.
  116118. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116119. * @returns the spherical polynomial
  116120. */
  116121. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116122. }
  116123. }
  116124. declare module BABYLON {
  116125. /**
  116126. * Defines the source of the internal texture
  116127. */
  116128. export enum InternalTextureSource {
  116129. /**
  116130. * The source of the texture data is unknown
  116131. */
  116132. Unknown = 0,
  116133. /**
  116134. * Texture data comes from an URL
  116135. */
  116136. Url = 1,
  116137. /**
  116138. * Texture data is only used for temporary storage
  116139. */
  116140. Temp = 2,
  116141. /**
  116142. * Texture data comes from raw data (ArrayBuffer)
  116143. */
  116144. Raw = 3,
  116145. /**
  116146. * Texture content is dynamic (video or dynamic texture)
  116147. */
  116148. Dynamic = 4,
  116149. /**
  116150. * Texture content is generated by rendering to it
  116151. */
  116152. RenderTarget = 5,
  116153. /**
  116154. * Texture content is part of a multi render target process
  116155. */
  116156. MultiRenderTarget = 6,
  116157. /**
  116158. * Texture data comes from a cube data file
  116159. */
  116160. Cube = 7,
  116161. /**
  116162. * Texture data comes from a raw cube data
  116163. */
  116164. CubeRaw = 8,
  116165. /**
  116166. * Texture data come from a prefiltered cube data file
  116167. */
  116168. CubePrefiltered = 9,
  116169. /**
  116170. * Texture content is raw 3D data
  116171. */
  116172. Raw3D = 10,
  116173. /**
  116174. * Texture content is raw 2D array data
  116175. */
  116176. Raw2DArray = 11,
  116177. /**
  116178. * Texture content is a depth texture
  116179. */
  116180. Depth = 12,
  116181. /**
  116182. * Texture data comes from a raw cube data encoded with RGBD
  116183. */
  116184. CubeRawRGBD = 13
  116185. }
  116186. /**
  116187. * Class used to store data associated with WebGL texture data for the engine
  116188. * This class should not be used directly
  116189. */
  116190. export class InternalTexture {
  116191. /** @hidden */
  116192. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116193. /**
  116194. * Defines if the texture is ready
  116195. */
  116196. isReady: boolean;
  116197. /**
  116198. * Defines if the texture is a cube texture
  116199. */
  116200. isCube: boolean;
  116201. /**
  116202. * Defines if the texture contains 3D data
  116203. */
  116204. is3D: boolean;
  116205. /**
  116206. * Defines if the texture contains 2D array data
  116207. */
  116208. is2DArray: boolean;
  116209. /**
  116210. * Defines if the texture contains multiview data
  116211. */
  116212. isMultiview: boolean;
  116213. /**
  116214. * Gets the URL used to load this texture
  116215. */
  116216. url: string;
  116217. /**
  116218. * Gets the sampling mode of the texture
  116219. */
  116220. samplingMode: number;
  116221. /**
  116222. * Gets a boolean indicating if the texture needs mipmaps generation
  116223. */
  116224. generateMipMaps: boolean;
  116225. /**
  116226. * Gets the number of samples used by the texture (WebGL2+ only)
  116227. */
  116228. samples: number;
  116229. /**
  116230. * Gets the type of the texture (int, float...)
  116231. */
  116232. type: number;
  116233. /**
  116234. * Gets the format of the texture (RGB, RGBA...)
  116235. */
  116236. format: number;
  116237. /**
  116238. * Observable called when the texture is loaded
  116239. */
  116240. onLoadedObservable: Observable<InternalTexture>;
  116241. /**
  116242. * Gets the width of the texture
  116243. */
  116244. width: number;
  116245. /**
  116246. * Gets the height of the texture
  116247. */
  116248. height: number;
  116249. /**
  116250. * Gets the depth of the texture
  116251. */
  116252. depth: number;
  116253. /**
  116254. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116255. */
  116256. baseWidth: number;
  116257. /**
  116258. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116259. */
  116260. baseHeight: number;
  116261. /**
  116262. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116263. */
  116264. baseDepth: number;
  116265. /**
  116266. * Gets a boolean indicating if the texture is inverted on Y axis
  116267. */
  116268. invertY: boolean;
  116269. /** @hidden */
  116270. _invertVScale: boolean;
  116271. /** @hidden */
  116272. _associatedChannel: number;
  116273. /** @hidden */
  116274. _source: InternalTextureSource;
  116275. /** @hidden */
  116276. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116277. /** @hidden */
  116278. _bufferView: Nullable<ArrayBufferView>;
  116279. /** @hidden */
  116280. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116281. /** @hidden */
  116282. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116283. /** @hidden */
  116284. _size: number;
  116285. /** @hidden */
  116286. _extension: string;
  116287. /** @hidden */
  116288. _files: Nullable<string[]>;
  116289. /** @hidden */
  116290. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116291. /** @hidden */
  116292. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116293. /** @hidden */
  116294. _framebuffer: Nullable<WebGLFramebuffer>;
  116295. /** @hidden */
  116296. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116297. /** @hidden */
  116298. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116299. /** @hidden */
  116300. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116301. /** @hidden */
  116302. _attachments: Nullable<number[]>;
  116303. /** @hidden */
  116304. _textureArray: Nullable<InternalTexture[]>;
  116305. /** @hidden */
  116306. _cachedCoordinatesMode: Nullable<number>;
  116307. /** @hidden */
  116308. _cachedWrapU: Nullable<number>;
  116309. /** @hidden */
  116310. _cachedWrapV: Nullable<number>;
  116311. /** @hidden */
  116312. _cachedWrapR: Nullable<number>;
  116313. /** @hidden */
  116314. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116315. /** @hidden */
  116316. _isDisabled: boolean;
  116317. /** @hidden */
  116318. _compression: Nullable<string>;
  116319. /** @hidden */
  116320. _generateStencilBuffer: boolean;
  116321. /** @hidden */
  116322. _generateDepthBuffer: boolean;
  116323. /** @hidden */
  116324. _comparisonFunction: number;
  116325. /** @hidden */
  116326. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116327. /** @hidden */
  116328. _lodGenerationScale: number;
  116329. /** @hidden */
  116330. _lodGenerationOffset: number;
  116331. /** @hidden */
  116332. _depthStencilTexture: Nullable<InternalTexture>;
  116333. /** @hidden */
  116334. _colorTextureArray: Nullable<WebGLTexture>;
  116335. /** @hidden */
  116336. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116337. /** @hidden */
  116338. _lodTextureHigh: Nullable<BaseTexture>;
  116339. /** @hidden */
  116340. _lodTextureMid: Nullable<BaseTexture>;
  116341. /** @hidden */
  116342. _lodTextureLow: Nullable<BaseTexture>;
  116343. /** @hidden */
  116344. _isRGBD: boolean;
  116345. /** @hidden */
  116346. _linearSpecularLOD: boolean;
  116347. /** @hidden */
  116348. _irradianceTexture: Nullable<BaseTexture>;
  116349. /** @hidden */
  116350. _webGLTexture: Nullable<WebGLTexture>;
  116351. /** @hidden */
  116352. _references: number;
  116353. private _engine;
  116354. /**
  116355. * Gets the Engine the texture belongs to.
  116356. * @returns The babylon engine
  116357. */
  116358. getEngine(): ThinEngine;
  116359. /**
  116360. * Gets the data source type of the texture
  116361. */
  116362. get source(): InternalTextureSource;
  116363. /**
  116364. * Creates a new InternalTexture
  116365. * @param engine defines the engine to use
  116366. * @param source defines the type of data that will be used
  116367. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116368. */
  116369. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116370. /**
  116371. * Increments the number of references (ie. the number of Texture that point to it)
  116372. */
  116373. incrementReferences(): void;
  116374. /**
  116375. * Change the size of the texture (not the size of the content)
  116376. * @param width defines the new width
  116377. * @param height defines the new height
  116378. * @param depth defines the new depth (1 by default)
  116379. */
  116380. updateSize(width: int, height: int, depth?: int): void;
  116381. /** @hidden */
  116382. _rebuild(): void;
  116383. /** @hidden */
  116384. _swapAndDie(target: InternalTexture): void;
  116385. /**
  116386. * Dispose the current allocated resources
  116387. */
  116388. dispose(): void;
  116389. }
  116390. }
  116391. declare module BABYLON {
  116392. /**
  116393. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116394. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116395. */
  116396. export class Analyser {
  116397. /**
  116398. * Gets or sets the smoothing
  116399. * @ignorenaming
  116400. */
  116401. SMOOTHING: number;
  116402. /**
  116403. * Gets or sets the FFT table size
  116404. * @ignorenaming
  116405. */
  116406. FFT_SIZE: number;
  116407. /**
  116408. * Gets or sets the bar graph amplitude
  116409. * @ignorenaming
  116410. */
  116411. BARGRAPHAMPLITUDE: number;
  116412. /**
  116413. * Gets or sets the position of the debug canvas
  116414. * @ignorenaming
  116415. */
  116416. DEBUGCANVASPOS: {
  116417. x: number;
  116418. y: number;
  116419. };
  116420. /**
  116421. * Gets or sets the debug canvas size
  116422. * @ignorenaming
  116423. */
  116424. DEBUGCANVASSIZE: {
  116425. width: number;
  116426. height: number;
  116427. };
  116428. private _byteFreqs;
  116429. private _byteTime;
  116430. private _floatFreqs;
  116431. private _webAudioAnalyser;
  116432. private _debugCanvas;
  116433. private _debugCanvasContext;
  116434. private _scene;
  116435. private _registerFunc;
  116436. private _audioEngine;
  116437. /**
  116438. * Creates a new analyser
  116439. * @param scene defines hosting scene
  116440. */
  116441. constructor(scene: Scene);
  116442. /**
  116443. * Get the number of data values you will have to play with for the visualization
  116444. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116445. * @returns a number
  116446. */
  116447. getFrequencyBinCount(): number;
  116448. /**
  116449. * Gets the current frequency data as a byte array
  116450. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116451. * @returns a Uint8Array
  116452. */
  116453. getByteFrequencyData(): Uint8Array;
  116454. /**
  116455. * Gets the current waveform as a byte array
  116456. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116457. * @returns a Uint8Array
  116458. */
  116459. getByteTimeDomainData(): Uint8Array;
  116460. /**
  116461. * Gets the current frequency data as a float array
  116462. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116463. * @returns a Float32Array
  116464. */
  116465. getFloatFrequencyData(): Float32Array;
  116466. /**
  116467. * Renders the debug canvas
  116468. */
  116469. drawDebugCanvas(): void;
  116470. /**
  116471. * Stops rendering the debug canvas and removes it
  116472. */
  116473. stopDebugCanvas(): void;
  116474. /**
  116475. * Connects two audio nodes
  116476. * @param inputAudioNode defines first node to connect
  116477. * @param outputAudioNode defines second node to connect
  116478. */
  116479. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116480. /**
  116481. * Releases all associated resources
  116482. */
  116483. dispose(): void;
  116484. }
  116485. }
  116486. declare module BABYLON {
  116487. /**
  116488. * This represents an audio engine and it is responsible
  116489. * to play, synchronize and analyse sounds throughout the application.
  116490. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116491. */
  116492. export interface IAudioEngine extends IDisposable {
  116493. /**
  116494. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116495. */
  116496. readonly canUseWebAudio: boolean;
  116497. /**
  116498. * Gets the current AudioContext if available.
  116499. */
  116500. readonly audioContext: Nullable<AudioContext>;
  116501. /**
  116502. * The master gain node defines the global audio volume of your audio engine.
  116503. */
  116504. readonly masterGain: GainNode;
  116505. /**
  116506. * Gets whether or not mp3 are supported by your browser.
  116507. */
  116508. readonly isMP3supported: boolean;
  116509. /**
  116510. * Gets whether or not ogg are supported by your browser.
  116511. */
  116512. readonly isOGGsupported: boolean;
  116513. /**
  116514. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116515. * @ignoreNaming
  116516. */
  116517. WarnedWebAudioUnsupported: boolean;
  116518. /**
  116519. * Defines if the audio engine relies on a custom unlocked button.
  116520. * In this case, the embedded button will not be displayed.
  116521. */
  116522. useCustomUnlockedButton: boolean;
  116523. /**
  116524. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116525. */
  116526. readonly unlocked: boolean;
  116527. /**
  116528. * Event raised when audio has been unlocked on the browser.
  116529. */
  116530. onAudioUnlockedObservable: Observable<AudioEngine>;
  116531. /**
  116532. * Event raised when audio has been locked on the browser.
  116533. */
  116534. onAudioLockedObservable: Observable<AudioEngine>;
  116535. /**
  116536. * Flags the audio engine in Locked state.
  116537. * This happens due to new browser policies preventing audio to autoplay.
  116538. */
  116539. lock(): void;
  116540. /**
  116541. * Unlocks the audio engine once a user action has been done on the dom.
  116542. * This is helpful to resume play once browser policies have been satisfied.
  116543. */
  116544. unlock(): void;
  116545. /**
  116546. * Gets the global volume sets on the master gain.
  116547. * @returns the global volume if set or -1 otherwise
  116548. */
  116549. getGlobalVolume(): number;
  116550. /**
  116551. * Sets the global volume of your experience (sets on the master gain).
  116552. * @param newVolume Defines the new global volume of the application
  116553. */
  116554. setGlobalVolume(newVolume: number): void;
  116555. /**
  116556. * Connect the audio engine to an audio analyser allowing some amazing
  116557. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116558. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116559. * @param analyser The analyser to connect to the engine
  116560. */
  116561. connectToAnalyser(analyser: Analyser): void;
  116562. }
  116563. /**
  116564. * This represents the default audio engine used in babylon.
  116565. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116566. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116567. */
  116568. export class AudioEngine implements IAudioEngine {
  116569. private _audioContext;
  116570. private _audioContextInitialized;
  116571. private _muteButton;
  116572. private _hostElement;
  116573. /**
  116574. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116575. */
  116576. canUseWebAudio: boolean;
  116577. /**
  116578. * The master gain node defines the global audio volume of your audio engine.
  116579. */
  116580. masterGain: GainNode;
  116581. /**
  116582. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116583. * @ignoreNaming
  116584. */
  116585. WarnedWebAudioUnsupported: boolean;
  116586. /**
  116587. * Gets whether or not mp3 are supported by your browser.
  116588. */
  116589. isMP3supported: boolean;
  116590. /**
  116591. * Gets whether or not ogg are supported by your browser.
  116592. */
  116593. isOGGsupported: boolean;
  116594. /**
  116595. * Gets whether audio has been unlocked on the device.
  116596. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116597. * a user interaction has happened.
  116598. */
  116599. unlocked: boolean;
  116600. /**
  116601. * Defines if the audio engine relies on a custom unlocked button.
  116602. * In this case, the embedded button will not be displayed.
  116603. */
  116604. useCustomUnlockedButton: boolean;
  116605. /**
  116606. * Event raised when audio has been unlocked on the browser.
  116607. */
  116608. onAudioUnlockedObservable: Observable<AudioEngine>;
  116609. /**
  116610. * Event raised when audio has been locked on the browser.
  116611. */
  116612. onAudioLockedObservable: Observable<AudioEngine>;
  116613. /**
  116614. * Gets the current AudioContext if available.
  116615. */
  116616. get audioContext(): Nullable<AudioContext>;
  116617. private _connectedAnalyser;
  116618. /**
  116619. * Instantiates a new audio engine.
  116620. *
  116621. * There should be only one per page as some browsers restrict the number
  116622. * of audio contexts you can create.
  116623. * @param hostElement defines the host element where to display the mute icon if necessary
  116624. */
  116625. constructor(hostElement?: Nullable<HTMLElement>);
  116626. /**
  116627. * Flags the audio engine in Locked state.
  116628. * This happens due to new browser policies preventing audio to autoplay.
  116629. */
  116630. lock(): void;
  116631. /**
  116632. * Unlocks the audio engine once a user action has been done on the dom.
  116633. * This is helpful to resume play once browser policies have been satisfied.
  116634. */
  116635. unlock(): void;
  116636. private _resumeAudioContext;
  116637. private _initializeAudioContext;
  116638. private _tryToRun;
  116639. private _triggerRunningState;
  116640. private _triggerSuspendedState;
  116641. private _displayMuteButton;
  116642. private _moveButtonToTopLeft;
  116643. private _onResize;
  116644. private _hideMuteButton;
  116645. /**
  116646. * Destroy and release the resources associated with the audio ccontext.
  116647. */
  116648. dispose(): void;
  116649. /**
  116650. * Gets the global volume sets on the master gain.
  116651. * @returns the global volume if set or -1 otherwise
  116652. */
  116653. getGlobalVolume(): number;
  116654. /**
  116655. * Sets the global volume of your experience (sets on the master gain).
  116656. * @param newVolume Defines the new global volume of the application
  116657. */
  116658. setGlobalVolume(newVolume: number): void;
  116659. /**
  116660. * Connect the audio engine to an audio analyser allowing some amazing
  116661. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116662. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116663. * @param analyser The analyser to connect to the engine
  116664. */
  116665. connectToAnalyser(analyser: Analyser): void;
  116666. }
  116667. }
  116668. declare module BABYLON {
  116669. /**
  116670. * Interface used to present a loading screen while loading a scene
  116671. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116672. */
  116673. export interface ILoadingScreen {
  116674. /**
  116675. * Function called to display the loading screen
  116676. */
  116677. displayLoadingUI: () => void;
  116678. /**
  116679. * Function called to hide the loading screen
  116680. */
  116681. hideLoadingUI: () => void;
  116682. /**
  116683. * Gets or sets the color to use for the background
  116684. */
  116685. loadingUIBackgroundColor: string;
  116686. /**
  116687. * Gets or sets the text to display while loading
  116688. */
  116689. loadingUIText: string;
  116690. }
  116691. /**
  116692. * Class used for the default loading screen
  116693. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116694. */
  116695. export class DefaultLoadingScreen implements ILoadingScreen {
  116696. private _renderingCanvas;
  116697. private _loadingText;
  116698. private _loadingDivBackgroundColor;
  116699. private _loadingDiv;
  116700. private _loadingTextDiv;
  116701. /** Gets or sets the logo url to use for the default loading screen */
  116702. static DefaultLogoUrl: string;
  116703. /** Gets or sets the spinner url to use for the default loading screen */
  116704. static DefaultSpinnerUrl: string;
  116705. /**
  116706. * Creates a new default loading screen
  116707. * @param _renderingCanvas defines the canvas used to render the scene
  116708. * @param _loadingText defines the default text to display
  116709. * @param _loadingDivBackgroundColor defines the default background color
  116710. */
  116711. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116712. /**
  116713. * Function called to display the loading screen
  116714. */
  116715. displayLoadingUI(): void;
  116716. /**
  116717. * Function called to hide the loading screen
  116718. */
  116719. hideLoadingUI(): void;
  116720. /**
  116721. * Gets or sets the text to display while loading
  116722. */
  116723. set loadingUIText(text: string);
  116724. get loadingUIText(): string;
  116725. /**
  116726. * Gets or sets the color to use for the background
  116727. */
  116728. get loadingUIBackgroundColor(): string;
  116729. set loadingUIBackgroundColor(color: string);
  116730. private _resizeLoadingUI;
  116731. }
  116732. }
  116733. declare module BABYLON {
  116734. /**
  116735. * Interface for any object that can request an animation frame
  116736. */
  116737. export interface ICustomAnimationFrameRequester {
  116738. /**
  116739. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116740. */
  116741. renderFunction?: Function;
  116742. /**
  116743. * Called to request the next frame to render to
  116744. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116745. */
  116746. requestAnimationFrame: Function;
  116747. /**
  116748. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116749. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116750. */
  116751. requestID?: number;
  116752. }
  116753. }
  116754. declare module BABYLON {
  116755. /**
  116756. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116757. */
  116758. export class PerformanceMonitor {
  116759. private _enabled;
  116760. private _rollingFrameTime;
  116761. private _lastFrameTimeMs;
  116762. /**
  116763. * constructor
  116764. * @param frameSampleSize The number of samples required to saturate the sliding window
  116765. */
  116766. constructor(frameSampleSize?: number);
  116767. /**
  116768. * Samples current frame
  116769. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116770. */
  116771. sampleFrame(timeMs?: number): void;
  116772. /**
  116773. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116774. */
  116775. get averageFrameTime(): number;
  116776. /**
  116777. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116778. */
  116779. get averageFrameTimeVariance(): number;
  116780. /**
  116781. * Returns the frame time of the most recent frame
  116782. */
  116783. get instantaneousFrameTime(): number;
  116784. /**
  116785. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116786. */
  116787. get averageFPS(): number;
  116788. /**
  116789. * Returns the average framerate in frames per second using the most recent frame time
  116790. */
  116791. get instantaneousFPS(): number;
  116792. /**
  116793. * Returns true if enough samples have been taken to completely fill the sliding window
  116794. */
  116795. get isSaturated(): boolean;
  116796. /**
  116797. * Enables contributions to the sliding window sample set
  116798. */
  116799. enable(): void;
  116800. /**
  116801. * Disables contributions to the sliding window sample set
  116802. * Samples will not be interpolated over the disabled period
  116803. */
  116804. disable(): void;
  116805. /**
  116806. * Returns true if sampling is enabled
  116807. */
  116808. get isEnabled(): boolean;
  116809. /**
  116810. * Resets performance monitor
  116811. */
  116812. reset(): void;
  116813. }
  116814. /**
  116815. * RollingAverage
  116816. *
  116817. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116818. */
  116819. export class RollingAverage {
  116820. /**
  116821. * Current average
  116822. */
  116823. average: number;
  116824. /**
  116825. * Current variance
  116826. */
  116827. variance: number;
  116828. protected _samples: Array<number>;
  116829. protected _sampleCount: number;
  116830. protected _pos: number;
  116831. protected _m2: number;
  116832. /**
  116833. * constructor
  116834. * @param length The number of samples required to saturate the sliding window
  116835. */
  116836. constructor(length: number);
  116837. /**
  116838. * Adds a sample to the sample set
  116839. * @param v The sample value
  116840. */
  116841. add(v: number): void;
  116842. /**
  116843. * Returns previously added values or null if outside of history or outside the sliding window domain
  116844. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116845. * @return Value previously recorded with add() or null if outside of range
  116846. */
  116847. history(i: number): number;
  116848. /**
  116849. * Returns true if enough samples have been taken to completely fill the sliding window
  116850. * @return true if sample-set saturated
  116851. */
  116852. isSaturated(): boolean;
  116853. /**
  116854. * Resets the rolling average (equivalent to 0 samples taken so far)
  116855. */
  116856. reset(): void;
  116857. /**
  116858. * Wraps a value around the sample range boundaries
  116859. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116860. * @return Wrapped position in sample range
  116861. */
  116862. protected _wrapPosition(i: number): number;
  116863. }
  116864. }
  116865. declare module BABYLON {
  116866. /**
  116867. * This class is used to track a performance counter which is number based.
  116868. * The user has access to many properties which give statistics of different nature.
  116869. *
  116870. * The implementer can track two kinds of Performance Counter: time and count.
  116871. * 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.
  116872. * 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.
  116873. */
  116874. export class PerfCounter {
  116875. /**
  116876. * Gets or sets a global boolean to turn on and off all the counters
  116877. */
  116878. static Enabled: boolean;
  116879. /**
  116880. * Returns the smallest value ever
  116881. */
  116882. get min(): number;
  116883. /**
  116884. * Returns the biggest value ever
  116885. */
  116886. get max(): number;
  116887. /**
  116888. * Returns the average value since the performance counter is running
  116889. */
  116890. get average(): number;
  116891. /**
  116892. * Returns the average value of the last second the counter was monitored
  116893. */
  116894. get lastSecAverage(): number;
  116895. /**
  116896. * Returns the current value
  116897. */
  116898. get current(): number;
  116899. /**
  116900. * Gets the accumulated total
  116901. */
  116902. get total(): number;
  116903. /**
  116904. * Gets the total value count
  116905. */
  116906. get count(): number;
  116907. /**
  116908. * Creates a new counter
  116909. */
  116910. constructor();
  116911. /**
  116912. * Call this method to start monitoring a new frame.
  116913. * 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.
  116914. */
  116915. fetchNewFrame(): void;
  116916. /**
  116917. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116918. * @param newCount the count value to add to the monitored count
  116919. * @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.
  116920. */
  116921. addCount(newCount: number, fetchResult: boolean): void;
  116922. /**
  116923. * Start monitoring this performance counter
  116924. */
  116925. beginMonitoring(): void;
  116926. /**
  116927. * Compute the time lapsed since the previous beginMonitoring() call.
  116928. * @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
  116929. */
  116930. endMonitoring(newFrame?: boolean): void;
  116931. private _fetchResult;
  116932. private _startMonitoringTime;
  116933. private _min;
  116934. private _max;
  116935. private _average;
  116936. private _current;
  116937. private _totalValueCount;
  116938. private _totalAccumulated;
  116939. private _lastSecAverage;
  116940. private _lastSecAccumulated;
  116941. private _lastSecTime;
  116942. private _lastSecValueCount;
  116943. }
  116944. }
  116945. declare module BABYLON {
  116946. interface ThinEngine {
  116947. /** @hidden */
  116948. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116949. }
  116950. }
  116951. declare module BABYLON {
  116952. /**
  116953. * Defines the interface used by display changed events
  116954. */
  116955. export interface IDisplayChangedEventArgs {
  116956. /** Gets the vrDisplay object (if any) */
  116957. vrDisplay: Nullable<any>;
  116958. /** Gets a boolean indicating if webVR is supported */
  116959. vrSupported: boolean;
  116960. }
  116961. /**
  116962. * Defines the interface used by objects containing a viewport (like a camera)
  116963. */
  116964. interface IViewportOwnerLike {
  116965. /**
  116966. * Gets or sets the viewport
  116967. */
  116968. viewport: IViewportLike;
  116969. }
  116970. /**
  116971. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116972. */
  116973. export class Engine extends ThinEngine {
  116974. /** Defines that alpha blending is disabled */
  116975. static readonly ALPHA_DISABLE: number;
  116976. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116977. static readonly ALPHA_ADD: number;
  116978. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116979. static readonly ALPHA_COMBINE: number;
  116980. /** Defines that alpha blending to DEST - SRC * DEST */
  116981. static readonly ALPHA_SUBTRACT: number;
  116982. /** Defines that alpha blending to SRC * DEST */
  116983. static readonly ALPHA_MULTIPLY: number;
  116984. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116985. static readonly ALPHA_MAXIMIZED: number;
  116986. /** Defines that alpha blending to SRC + DEST */
  116987. static readonly ALPHA_ONEONE: number;
  116988. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116989. static readonly ALPHA_PREMULTIPLIED: number;
  116990. /**
  116991. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116992. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116993. */
  116994. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116995. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116996. static readonly ALPHA_INTERPOLATE: number;
  116997. /**
  116998. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116999. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  117000. */
  117001. static readonly ALPHA_SCREENMODE: number;
  117002. /** Defines that the ressource is not delayed*/
  117003. static readonly DELAYLOADSTATE_NONE: number;
  117004. /** Defines that the ressource was successfully delay loaded */
  117005. static readonly DELAYLOADSTATE_LOADED: number;
  117006. /** Defines that the ressource is currently delay loading */
  117007. static readonly DELAYLOADSTATE_LOADING: number;
  117008. /** Defines that the ressource is delayed and has not started loading */
  117009. static readonly DELAYLOADSTATE_NOTLOADED: number;
  117010. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  117011. static readonly NEVER: number;
  117012. /** 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 */
  117013. static readonly ALWAYS: number;
  117014. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117015. static readonly LESS: number;
  117016. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117017. static readonly EQUAL: number;
  117018. /** 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 */
  117019. static readonly LEQUAL: number;
  117020. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117021. static readonly GREATER: number;
  117022. /** 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 */
  117023. static readonly GEQUAL: number;
  117024. /** 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 */
  117025. static readonly NOTEQUAL: number;
  117026. /** Passed to stencilOperation to specify that stencil value must be kept */
  117027. static readonly KEEP: number;
  117028. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117029. static readonly REPLACE: number;
  117030. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117031. static readonly INCR: number;
  117032. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117033. static readonly DECR: number;
  117034. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117035. static readonly INVERT: number;
  117036. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117037. static readonly INCR_WRAP: number;
  117038. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117039. static readonly DECR_WRAP: number;
  117040. /** Texture is not repeating outside of 0..1 UVs */
  117041. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117042. /** Texture is repeating outside of 0..1 UVs */
  117043. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117044. /** Texture is repeating and mirrored */
  117045. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117046. /** ALPHA */
  117047. static readonly TEXTUREFORMAT_ALPHA: number;
  117048. /** LUMINANCE */
  117049. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117050. /** LUMINANCE_ALPHA */
  117051. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117052. /** RGB */
  117053. static readonly TEXTUREFORMAT_RGB: number;
  117054. /** RGBA */
  117055. static readonly TEXTUREFORMAT_RGBA: number;
  117056. /** RED */
  117057. static readonly TEXTUREFORMAT_RED: number;
  117058. /** RED (2nd reference) */
  117059. static readonly TEXTUREFORMAT_R: number;
  117060. /** RG */
  117061. static readonly TEXTUREFORMAT_RG: number;
  117062. /** RED_INTEGER */
  117063. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117064. /** RED_INTEGER (2nd reference) */
  117065. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117066. /** RG_INTEGER */
  117067. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117068. /** RGB_INTEGER */
  117069. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117070. /** RGBA_INTEGER */
  117071. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117072. /** UNSIGNED_BYTE */
  117073. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117074. /** UNSIGNED_BYTE (2nd reference) */
  117075. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117076. /** FLOAT */
  117077. static readonly TEXTURETYPE_FLOAT: number;
  117078. /** HALF_FLOAT */
  117079. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117080. /** BYTE */
  117081. static readonly TEXTURETYPE_BYTE: number;
  117082. /** SHORT */
  117083. static readonly TEXTURETYPE_SHORT: number;
  117084. /** UNSIGNED_SHORT */
  117085. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117086. /** INT */
  117087. static readonly TEXTURETYPE_INT: number;
  117088. /** UNSIGNED_INT */
  117089. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117090. /** UNSIGNED_SHORT_4_4_4_4 */
  117091. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117092. /** UNSIGNED_SHORT_5_5_5_1 */
  117093. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117094. /** UNSIGNED_SHORT_5_6_5 */
  117095. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117096. /** UNSIGNED_INT_2_10_10_10_REV */
  117097. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117098. /** UNSIGNED_INT_24_8 */
  117099. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117100. /** UNSIGNED_INT_10F_11F_11F_REV */
  117101. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117102. /** UNSIGNED_INT_5_9_9_9_REV */
  117103. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117104. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117105. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117106. /** nearest is mag = nearest and min = nearest and mip = linear */
  117107. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117108. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117109. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117110. /** Trilinear is mag = linear and min = linear and mip = linear */
  117111. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117112. /** nearest is mag = nearest and min = nearest and mip = linear */
  117113. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117114. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117115. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117116. /** Trilinear is mag = linear and min = linear and mip = linear */
  117117. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117118. /** mag = nearest and min = nearest and mip = nearest */
  117119. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117120. /** mag = nearest and min = linear and mip = nearest */
  117121. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117122. /** mag = nearest and min = linear and mip = linear */
  117123. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117124. /** mag = nearest and min = linear and mip = none */
  117125. static readonly TEXTURE_NEAREST_LINEAR: number;
  117126. /** mag = nearest and min = nearest and mip = none */
  117127. static readonly TEXTURE_NEAREST_NEAREST: number;
  117128. /** mag = linear and min = nearest and mip = nearest */
  117129. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117130. /** mag = linear and min = nearest and mip = linear */
  117131. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117132. /** mag = linear and min = linear and mip = none */
  117133. static readonly TEXTURE_LINEAR_LINEAR: number;
  117134. /** mag = linear and min = nearest and mip = none */
  117135. static readonly TEXTURE_LINEAR_NEAREST: number;
  117136. /** Explicit coordinates mode */
  117137. static readonly TEXTURE_EXPLICIT_MODE: number;
  117138. /** Spherical coordinates mode */
  117139. static readonly TEXTURE_SPHERICAL_MODE: number;
  117140. /** Planar coordinates mode */
  117141. static readonly TEXTURE_PLANAR_MODE: number;
  117142. /** Cubic coordinates mode */
  117143. static readonly TEXTURE_CUBIC_MODE: number;
  117144. /** Projection coordinates mode */
  117145. static readonly TEXTURE_PROJECTION_MODE: number;
  117146. /** Skybox coordinates mode */
  117147. static readonly TEXTURE_SKYBOX_MODE: number;
  117148. /** Inverse Cubic coordinates mode */
  117149. static readonly TEXTURE_INVCUBIC_MODE: number;
  117150. /** Equirectangular coordinates mode */
  117151. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117152. /** Equirectangular Fixed coordinates mode */
  117153. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117154. /** Equirectangular Fixed Mirrored coordinates mode */
  117155. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117156. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117157. static readonly SCALEMODE_FLOOR: number;
  117158. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117159. static readonly SCALEMODE_NEAREST: number;
  117160. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117161. static readonly SCALEMODE_CEILING: number;
  117162. /**
  117163. * Returns the current npm package of the sdk
  117164. */
  117165. static get NpmPackage(): string;
  117166. /**
  117167. * Returns the current version of the framework
  117168. */
  117169. static get Version(): string;
  117170. /** Gets the list of created engines */
  117171. static get Instances(): Engine[];
  117172. /**
  117173. * Gets the latest created engine
  117174. */
  117175. static get LastCreatedEngine(): Nullable<Engine>;
  117176. /**
  117177. * Gets the latest created scene
  117178. */
  117179. static get LastCreatedScene(): Nullable<Scene>;
  117180. /**
  117181. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117182. * @param flag defines which part of the materials must be marked as dirty
  117183. * @param predicate defines a predicate used to filter which materials should be affected
  117184. */
  117185. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117186. /**
  117187. * Method called to create the default loading screen.
  117188. * This can be overriden in your own app.
  117189. * @param canvas The rendering canvas element
  117190. * @returns The loading screen
  117191. */
  117192. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117193. /**
  117194. * Method called to create the default rescale post process on each engine.
  117195. */
  117196. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117197. /**
  117198. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117199. **/
  117200. enableOfflineSupport: boolean;
  117201. /**
  117202. * 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)
  117203. **/
  117204. disableManifestCheck: boolean;
  117205. /**
  117206. * Gets the list of created scenes
  117207. */
  117208. scenes: Scene[];
  117209. /**
  117210. * Event raised when a new scene is created
  117211. */
  117212. onNewSceneAddedObservable: Observable<Scene>;
  117213. /**
  117214. * Gets the list of created postprocesses
  117215. */
  117216. postProcesses: PostProcess[];
  117217. /**
  117218. * Gets a boolean indicating if the pointer is currently locked
  117219. */
  117220. isPointerLock: boolean;
  117221. /**
  117222. * Observable event triggered each time the rendering canvas is resized
  117223. */
  117224. onResizeObservable: Observable<Engine>;
  117225. /**
  117226. * Observable event triggered each time the canvas loses focus
  117227. */
  117228. onCanvasBlurObservable: Observable<Engine>;
  117229. /**
  117230. * Observable event triggered each time the canvas gains focus
  117231. */
  117232. onCanvasFocusObservable: Observable<Engine>;
  117233. /**
  117234. * Observable event triggered each time the canvas receives pointerout event
  117235. */
  117236. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117237. /**
  117238. * Observable raised when the engine begins a new frame
  117239. */
  117240. onBeginFrameObservable: Observable<Engine>;
  117241. /**
  117242. * If set, will be used to request the next animation frame for the render loop
  117243. */
  117244. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117245. /**
  117246. * Observable raised when the engine ends the current frame
  117247. */
  117248. onEndFrameObservable: Observable<Engine>;
  117249. /**
  117250. * Observable raised when the engine is about to compile a shader
  117251. */
  117252. onBeforeShaderCompilationObservable: Observable<Engine>;
  117253. /**
  117254. * Observable raised when the engine has jsut compiled a shader
  117255. */
  117256. onAfterShaderCompilationObservable: Observable<Engine>;
  117257. /**
  117258. * Gets the audio engine
  117259. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117260. * @ignorenaming
  117261. */
  117262. static audioEngine: IAudioEngine;
  117263. /**
  117264. * Default AudioEngine factory responsible of creating the Audio Engine.
  117265. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117266. */
  117267. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117268. /**
  117269. * Default offline support factory responsible of creating a tool used to store data locally.
  117270. * By default, this will create a Database object if the workload has been embedded.
  117271. */
  117272. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117273. private _loadingScreen;
  117274. private _pointerLockRequested;
  117275. private _rescalePostProcess;
  117276. private _deterministicLockstep;
  117277. private _lockstepMaxSteps;
  117278. private _timeStep;
  117279. protected get _supportsHardwareTextureRescaling(): boolean;
  117280. private _fps;
  117281. private _deltaTime;
  117282. /** @hidden */
  117283. _drawCalls: PerfCounter;
  117284. /** 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 */
  117285. canvasTabIndex: number;
  117286. /**
  117287. * Turn this value on if you want to pause FPS computation when in background
  117288. */
  117289. disablePerformanceMonitorInBackground: boolean;
  117290. private _performanceMonitor;
  117291. /**
  117292. * Gets the performance monitor attached to this engine
  117293. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117294. */
  117295. get performanceMonitor(): PerformanceMonitor;
  117296. private _onFocus;
  117297. private _onBlur;
  117298. private _onCanvasPointerOut;
  117299. private _onCanvasBlur;
  117300. private _onCanvasFocus;
  117301. private _onFullscreenChange;
  117302. private _onPointerLockChange;
  117303. /**
  117304. * Gets the HTML element used to attach event listeners
  117305. * @returns a HTML element
  117306. */
  117307. getInputElement(): Nullable<HTMLElement>;
  117308. /**
  117309. * Creates a new engine
  117310. * @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
  117311. * @param antialias defines enable antialiasing (default: false)
  117312. * @param options defines further options to be sent to the getContext() function
  117313. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117314. */
  117315. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117316. /**
  117317. * Gets current aspect ratio
  117318. * @param viewportOwner defines the camera to use to get the aspect ratio
  117319. * @param useScreen defines if screen size must be used (or the current render target if any)
  117320. * @returns a number defining the aspect ratio
  117321. */
  117322. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117323. /**
  117324. * Gets current screen aspect ratio
  117325. * @returns a number defining the aspect ratio
  117326. */
  117327. getScreenAspectRatio(): number;
  117328. /**
  117329. * Gets the client rect of the HTML canvas attached with the current webGL context
  117330. * @returns a client rectanglee
  117331. */
  117332. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117333. /**
  117334. * Gets the client rect of the HTML element used for events
  117335. * @returns a client rectanglee
  117336. */
  117337. getInputElementClientRect(): Nullable<ClientRect>;
  117338. /**
  117339. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117340. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117341. * @returns true if engine is in deterministic lock step mode
  117342. */
  117343. isDeterministicLockStep(): boolean;
  117344. /**
  117345. * Gets the max steps when engine is running in deterministic lock step
  117346. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117347. * @returns the max steps
  117348. */
  117349. getLockstepMaxSteps(): number;
  117350. /**
  117351. * Returns the time in ms between steps when using deterministic lock step.
  117352. * @returns time step in (ms)
  117353. */
  117354. getTimeStep(): number;
  117355. /**
  117356. * Force the mipmap generation for the given render target texture
  117357. * @param texture defines the render target texture to use
  117358. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117359. */
  117360. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117361. /** States */
  117362. /**
  117363. * Set various states to the webGL context
  117364. * @param culling defines backface culling state
  117365. * @param zOffset defines the value to apply to zOffset (0 by default)
  117366. * @param force defines if states must be applied even if cache is up to date
  117367. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117368. */
  117369. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117370. /**
  117371. * Set the z offset to apply to current rendering
  117372. * @param value defines the offset to apply
  117373. */
  117374. setZOffset(value: number): void;
  117375. /**
  117376. * Gets the current value of the zOffset
  117377. * @returns the current zOffset state
  117378. */
  117379. getZOffset(): number;
  117380. /**
  117381. * Enable or disable depth buffering
  117382. * @param enable defines the state to set
  117383. */
  117384. setDepthBuffer(enable: boolean): void;
  117385. /**
  117386. * Gets a boolean indicating if depth writing is enabled
  117387. * @returns the current depth writing state
  117388. */
  117389. getDepthWrite(): boolean;
  117390. /**
  117391. * Enable or disable depth writing
  117392. * @param enable defines the state to set
  117393. */
  117394. setDepthWrite(enable: boolean): void;
  117395. /**
  117396. * Gets a boolean indicating if stencil buffer is enabled
  117397. * @returns the current stencil buffer state
  117398. */
  117399. getStencilBuffer(): boolean;
  117400. /**
  117401. * Enable or disable the stencil buffer
  117402. * @param enable defines if the stencil buffer must be enabled or disabled
  117403. */
  117404. setStencilBuffer(enable: boolean): void;
  117405. /**
  117406. * Gets the current stencil mask
  117407. * @returns a number defining the new stencil mask to use
  117408. */
  117409. getStencilMask(): number;
  117410. /**
  117411. * Sets the current stencil mask
  117412. * @param mask defines the new stencil mask to use
  117413. */
  117414. setStencilMask(mask: number): void;
  117415. /**
  117416. * Gets the current stencil function
  117417. * @returns a number defining the stencil function to use
  117418. */
  117419. getStencilFunction(): number;
  117420. /**
  117421. * Gets the current stencil reference value
  117422. * @returns a number defining the stencil reference value to use
  117423. */
  117424. getStencilFunctionReference(): number;
  117425. /**
  117426. * Gets the current stencil mask
  117427. * @returns a number defining the stencil mask to use
  117428. */
  117429. getStencilFunctionMask(): number;
  117430. /**
  117431. * Sets the current stencil function
  117432. * @param stencilFunc defines the new stencil function to use
  117433. */
  117434. setStencilFunction(stencilFunc: number): void;
  117435. /**
  117436. * Sets the current stencil reference
  117437. * @param reference defines the new stencil reference to use
  117438. */
  117439. setStencilFunctionReference(reference: number): void;
  117440. /**
  117441. * Sets the current stencil mask
  117442. * @param mask defines the new stencil mask to use
  117443. */
  117444. setStencilFunctionMask(mask: number): void;
  117445. /**
  117446. * Gets the current stencil operation when stencil fails
  117447. * @returns a number defining stencil operation to use when stencil fails
  117448. */
  117449. getStencilOperationFail(): number;
  117450. /**
  117451. * Gets the current stencil operation when depth fails
  117452. * @returns a number defining stencil operation to use when depth fails
  117453. */
  117454. getStencilOperationDepthFail(): number;
  117455. /**
  117456. * Gets the current stencil operation when stencil passes
  117457. * @returns a number defining stencil operation to use when stencil passes
  117458. */
  117459. getStencilOperationPass(): number;
  117460. /**
  117461. * Sets the stencil operation to use when stencil fails
  117462. * @param operation defines the stencil operation to use when stencil fails
  117463. */
  117464. setStencilOperationFail(operation: number): void;
  117465. /**
  117466. * Sets the stencil operation to use when depth fails
  117467. * @param operation defines the stencil operation to use when depth fails
  117468. */
  117469. setStencilOperationDepthFail(operation: number): void;
  117470. /**
  117471. * Sets the stencil operation to use when stencil passes
  117472. * @param operation defines the stencil operation to use when stencil passes
  117473. */
  117474. setStencilOperationPass(operation: number): void;
  117475. /**
  117476. * Sets a boolean indicating if the dithering state is enabled or disabled
  117477. * @param value defines the dithering state
  117478. */
  117479. setDitheringState(value: boolean): void;
  117480. /**
  117481. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117482. * @param value defines the rasterizer state
  117483. */
  117484. setRasterizerState(value: boolean): void;
  117485. /**
  117486. * Gets the current depth function
  117487. * @returns a number defining the depth function
  117488. */
  117489. getDepthFunction(): Nullable<number>;
  117490. /**
  117491. * Sets the current depth function
  117492. * @param depthFunc defines the function to use
  117493. */
  117494. setDepthFunction(depthFunc: number): void;
  117495. /**
  117496. * Sets the current depth function to GREATER
  117497. */
  117498. setDepthFunctionToGreater(): void;
  117499. /**
  117500. * Sets the current depth function to GEQUAL
  117501. */
  117502. setDepthFunctionToGreaterOrEqual(): void;
  117503. /**
  117504. * Sets the current depth function to LESS
  117505. */
  117506. setDepthFunctionToLess(): void;
  117507. /**
  117508. * Sets the current depth function to LEQUAL
  117509. */
  117510. setDepthFunctionToLessOrEqual(): void;
  117511. private _cachedStencilBuffer;
  117512. private _cachedStencilFunction;
  117513. private _cachedStencilMask;
  117514. private _cachedStencilOperationPass;
  117515. private _cachedStencilOperationFail;
  117516. private _cachedStencilOperationDepthFail;
  117517. private _cachedStencilReference;
  117518. /**
  117519. * Caches the the state of the stencil buffer
  117520. */
  117521. cacheStencilState(): void;
  117522. /**
  117523. * Restores the state of the stencil buffer
  117524. */
  117525. restoreStencilState(): void;
  117526. /**
  117527. * Directly set the WebGL Viewport
  117528. * @param x defines the x coordinate of the viewport (in screen space)
  117529. * @param y defines the y coordinate of the viewport (in screen space)
  117530. * @param width defines the width of the viewport (in screen space)
  117531. * @param height defines the height of the viewport (in screen space)
  117532. * @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
  117533. */
  117534. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117535. /**
  117536. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117537. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117538. * @param y defines the y-coordinate of the corner of the clear rectangle
  117539. * @param width defines the width of the clear rectangle
  117540. * @param height defines the height of the clear rectangle
  117541. * @param clearColor defines the clear color
  117542. */
  117543. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117544. /**
  117545. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117546. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117547. * @param y defines the y-coordinate of the corner of the clear rectangle
  117548. * @param width defines the width of the clear rectangle
  117549. * @param height defines the height of the clear rectangle
  117550. */
  117551. enableScissor(x: number, y: number, width: number, height: number): void;
  117552. /**
  117553. * Disable previously set scissor test rectangle
  117554. */
  117555. disableScissor(): void;
  117556. protected _reportDrawCall(): void;
  117557. /**
  117558. * Initializes a webVR display and starts listening to display change events
  117559. * The onVRDisplayChangedObservable will be notified upon these changes
  117560. * @returns The onVRDisplayChangedObservable
  117561. */
  117562. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117563. /** @hidden */
  117564. _prepareVRComponent(): void;
  117565. /** @hidden */
  117566. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117567. /** @hidden */
  117568. _submitVRFrame(): void;
  117569. /**
  117570. * Call this function to leave webVR mode
  117571. * Will do nothing if webVR is not supported or if there is no webVR device
  117572. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117573. */
  117574. disableVR(): void;
  117575. /**
  117576. * Gets a boolean indicating that the system is in VR mode and is presenting
  117577. * @returns true if VR mode is engaged
  117578. */
  117579. isVRPresenting(): boolean;
  117580. /** @hidden */
  117581. _requestVRFrame(): void;
  117582. /** @hidden */
  117583. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117584. /**
  117585. * Gets the source code of the vertex shader associated with a specific webGL program
  117586. * @param program defines the program to use
  117587. * @returns a string containing the source code of the vertex shader associated with the program
  117588. */
  117589. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117590. /**
  117591. * Gets the source code of the fragment shader associated with a specific webGL program
  117592. * @param program defines the program to use
  117593. * @returns a string containing the source code of the fragment shader associated with the program
  117594. */
  117595. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117596. /**
  117597. * Sets a depth stencil texture from a render target to the according uniform.
  117598. * @param channel The texture channel
  117599. * @param uniform The uniform to set
  117600. * @param texture The render target texture containing the depth stencil texture to apply
  117601. */
  117602. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117603. /**
  117604. * Sets a texture to the webGL context from a postprocess
  117605. * @param channel defines the channel to use
  117606. * @param postProcess defines the source postprocess
  117607. */
  117608. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117609. /**
  117610. * Binds the output of the passed in post process to the texture channel specified
  117611. * @param channel The channel the texture should be bound to
  117612. * @param postProcess The post process which's output should be bound
  117613. */
  117614. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117615. protected _rebuildBuffers(): void;
  117616. /** @hidden */
  117617. _renderFrame(): void;
  117618. _renderLoop(): void;
  117619. /** @hidden */
  117620. _renderViews(): boolean;
  117621. /**
  117622. * Toggle full screen mode
  117623. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117624. */
  117625. switchFullscreen(requestPointerLock: boolean): void;
  117626. /**
  117627. * Enters full screen mode
  117628. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117629. */
  117630. enterFullscreen(requestPointerLock: boolean): void;
  117631. /**
  117632. * Exits full screen mode
  117633. */
  117634. exitFullscreen(): void;
  117635. /**
  117636. * Enters Pointerlock mode
  117637. */
  117638. enterPointerlock(): void;
  117639. /**
  117640. * Exits Pointerlock mode
  117641. */
  117642. exitPointerlock(): void;
  117643. /**
  117644. * Begin a new frame
  117645. */
  117646. beginFrame(): void;
  117647. /**
  117648. * Enf the current frame
  117649. */
  117650. endFrame(): void;
  117651. resize(): void;
  117652. /**
  117653. * Force a specific size of the canvas
  117654. * @param width defines the new canvas' width
  117655. * @param height defines the new canvas' height
  117656. * @returns true if the size was changed
  117657. */
  117658. setSize(width: number, height: number): boolean;
  117659. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117660. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117661. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117662. _releaseTexture(texture: InternalTexture): void;
  117663. /**
  117664. * @hidden
  117665. * Rescales a texture
  117666. * @param source input texutre
  117667. * @param destination destination texture
  117668. * @param scene scene to use to render the resize
  117669. * @param internalFormat format to use when resizing
  117670. * @param onComplete callback to be called when resize has completed
  117671. */
  117672. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117673. /**
  117674. * Gets the current framerate
  117675. * @returns a number representing the framerate
  117676. */
  117677. getFps(): number;
  117678. /**
  117679. * Gets the time spent between current and previous frame
  117680. * @returns a number representing the delta time in ms
  117681. */
  117682. getDeltaTime(): number;
  117683. private _measureFps;
  117684. /** @hidden */
  117685. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117686. /**
  117687. * Updates the sample count of a render target texture
  117688. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117689. * @param texture defines the texture to update
  117690. * @param samples defines the sample count to set
  117691. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117692. */
  117693. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117694. /**
  117695. * Updates a depth texture Comparison Mode and Function.
  117696. * If the comparison Function is equal to 0, the mode will be set to none.
  117697. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117698. * @param texture The texture to set the comparison function for
  117699. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117700. */
  117701. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117702. /**
  117703. * Creates a webGL buffer to use with instanciation
  117704. * @param capacity defines the size of the buffer
  117705. * @returns the webGL buffer
  117706. */
  117707. createInstancesBuffer(capacity: number): DataBuffer;
  117708. /**
  117709. * Delete a webGL buffer used with instanciation
  117710. * @param buffer defines the webGL buffer to delete
  117711. */
  117712. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117713. private _clientWaitAsync;
  117714. /** @hidden */
  117715. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117716. dispose(): void;
  117717. private _disableTouchAction;
  117718. /**
  117719. * Display the loading screen
  117720. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117721. */
  117722. displayLoadingUI(): void;
  117723. /**
  117724. * Hide the loading screen
  117725. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117726. */
  117727. hideLoadingUI(): void;
  117728. /**
  117729. * Gets the current loading screen object
  117730. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117731. */
  117732. get loadingScreen(): ILoadingScreen;
  117733. /**
  117734. * Sets the current loading screen object
  117735. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117736. */
  117737. set loadingScreen(loadingScreen: ILoadingScreen);
  117738. /**
  117739. * Sets the current loading screen text
  117740. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117741. */
  117742. set loadingUIText(text: string);
  117743. /**
  117744. * Sets the current loading screen background color
  117745. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117746. */
  117747. set loadingUIBackgroundColor(color: string);
  117748. /** Pointerlock and fullscreen */
  117749. /**
  117750. * Ask the browser to promote the current element to pointerlock mode
  117751. * @param element defines the DOM element to promote
  117752. */
  117753. static _RequestPointerlock(element: HTMLElement): void;
  117754. /**
  117755. * Asks the browser to exit pointerlock mode
  117756. */
  117757. static _ExitPointerlock(): void;
  117758. /**
  117759. * Ask the browser to promote the current element to fullscreen rendering mode
  117760. * @param element defines the DOM element to promote
  117761. */
  117762. static _RequestFullscreen(element: HTMLElement): void;
  117763. /**
  117764. * Asks the browser to exit fullscreen mode
  117765. */
  117766. static _ExitFullscreen(): void;
  117767. }
  117768. }
  117769. declare module BABYLON {
  117770. /**
  117771. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117772. * during the life time of the application.
  117773. */
  117774. export class EngineStore {
  117775. /** Gets the list of created engines */
  117776. static Instances: Engine[];
  117777. /** @hidden */
  117778. static _LastCreatedScene: Nullable<Scene>;
  117779. /**
  117780. * Gets the latest created engine
  117781. */
  117782. static get LastCreatedEngine(): Nullable<Engine>;
  117783. /**
  117784. * Gets the latest created scene
  117785. */
  117786. static get LastCreatedScene(): Nullable<Scene>;
  117787. /**
  117788. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117789. * @ignorenaming
  117790. */
  117791. static UseFallbackTexture: boolean;
  117792. /**
  117793. * Texture content used if a texture cannot loaded
  117794. * @ignorenaming
  117795. */
  117796. static FallbackTexture: string;
  117797. }
  117798. }
  117799. declare module BABYLON {
  117800. /**
  117801. * Helper class that provides a small promise polyfill
  117802. */
  117803. export class PromisePolyfill {
  117804. /**
  117805. * Static function used to check if the polyfill is required
  117806. * If this is the case then the function will inject the polyfill to window.Promise
  117807. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117808. */
  117809. static Apply(force?: boolean): void;
  117810. }
  117811. }
  117812. declare module BABYLON {
  117813. /**
  117814. * Interface for screenshot methods with describe argument called `size` as object with options
  117815. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117816. */
  117817. export interface IScreenshotSize {
  117818. /**
  117819. * number in pixels for canvas height
  117820. */
  117821. height?: number;
  117822. /**
  117823. * multiplier allowing render at a higher or lower resolution
  117824. * If value is defined then height and width will be ignored and taken from camera
  117825. */
  117826. precision?: number;
  117827. /**
  117828. * number in pixels for canvas width
  117829. */
  117830. width?: number;
  117831. }
  117832. }
  117833. declare module BABYLON {
  117834. interface IColor4Like {
  117835. r: float;
  117836. g: float;
  117837. b: float;
  117838. a: float;
  117839. }
  117840. /**
  117841. * Class containing a set of static utilities functions
  117842. */
  117843. export class Tools {
  117844. /**
  117845. * Gets or sets the base URL to use to load assets
  117846. */
  117847. static get BaseUrl(): string;
  117848. static set BaseUrl(value: string);
  117849. /**
  117850. * Enable/Disable Custom HTTP Request Headers globally.
  117851. * default = false
  117852. * @see CustomRequestHeaders
  117853. */
  117854. static UseCustomRequestHeaders: boolean;
  117855. /**
  117856. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117857. * i.e. when loading files, where the server/service expects an Authorization header
  117858. */
  117859. static CustomRequestHeaders: {
  117860. [key: string]: string;
  117861. };
  117862. /**
  117863. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117864. */
  117865. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117866. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117867. /**
  117868. * Default behaviour for cors in the application.
  117869. * It can be a string if the expected behavior is identical in the entire app.
  117870. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117871. */
  117872. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117873. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117874. /**
  117875. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117876. * @ignorenaming
  117877. */
  117878. static get UseFallbackTexture(): boolean;
  117879. static set UseFallbackTexture(value: boolean);
  117880. /**
  117881. * Use this object to register external classes like custom textures or material
  117882. * to allow the laoders to instantiate them
  117883. */
  117884. static get RegisteredExternalClasses(): {
  117885. [key: string]: Object;
  117886. };
  117887. static set RegisteredExternalClasses(classes: {
  117888. [key: string]: Object;
  117889. });
  117890. /**
  117891. * Texture content used if a texture cannot loaded
  117892. * @ignorenaming
  117893. */
  117894. static get fallbackTexture(): string;
  117895. static set fallbackTexture(value: string);
  117896. /**
  117897. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117898. * @param u defines the coordinate on X axis
  117899. * @param v defines the coordinate on Y axis
  117900. * @param width defines the width of the source data
  117901. * @param height defines the height of the source data
  117902. * @param pixels defines the source byte array
  117903. * @param color defines the output color
  117904. */
  117905. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117906. /**
  117907. * Interpolates between a and b via alpha
  117908. * @param a The lower value (returned when alpha = 0)
  117909. * @param b The upper value (returned when alpha = 1)
  117910. * @param alpha The interpolation-factor
  117911. * @return The mixed value
  117912. */
  117913. static Mix(a: number, b: number, alpha: number): number;
  117914. /**
  117915. * Tries to instantiate a new object from a given class name
  117916. * @param className defines the class name to instantiate
  117917. * @returns the new object or null if the system was not able to do the instantiation
  117918. */
  117919. static Instantiate(className: string): any;
  117920. /**
  117921. * Provides a slice function that will work even on IE
  117922. * @param data defines the array to slice
  117923. * @param start defines the start of the data (optional)
  117924. * @param end defines the end of the data (optional)
  117925. * @returns the new sliced array
  117926. */
  117927. static Slice<T>(data: T, start?: number, end?: number): T;
  117928. /**
  117929. * Polyfill for setImmediate
  117930. * @param action defines the action to execute after the current execution block
  117931. */
  117932. static SetImmediate(action: () => void): void;
  117933. /**
  117934. * Function indicating if a number is an exponent of 2
  117935. * @param value defines the value to test
  117936. * @returns true if the value is an exponent of 2
  117937. */
  117938. static IsExponentOfTwo(value: number): boolean;
  117939. private static _tmpFloatArray;
  117940. /**
  117941. * Returns the nearest 32-bit single precision float representation of a Number
  117942. * @param value A Number. If the parameter is of a different type, it will get converted
  117943. * to a number or to NaN if it cannot be converted
  117944. * @returns number
  117945. */
  117946. static FloatRound(value: number): number;
  117947. /**
  117948. * Extracts the filename from a path
  117949. * @param path defines the path to use
  117950. * @returns the filename
  117951. */
  117952. static GetFilename(path: string): string;
  117953. /**
  117954. * Extracts the "folder" part of a path (everything before the filename).
  117955. * @param uri The URI to extract the info from
  117956. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117957. * @returns The "folder" part of the path
  117958. */
  117959. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117960. /**
  117961. * Extracts text content from a DOM element hierarchy
  117962. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117963. */
  117964. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117965. /**
  117966. * Convert an angle in radians to degrees
  117967. * @param angle defines the angle to convert
  117968. * @returns the angle in degrees
  117969. */
  117970. static ToDegrees(angle: number): number;
  117971. /**
  117972. * Convert an angle in degrees to radians
  117973. * @param angle defines the angle to convert
  117974. * @returns the angle in radians
  117975. */
  117976. static ToRadians(angle: number): number;
  117977. /**
  117978. * Returns an array if obj is not an array
  117979. * @param obj defines the object to evaluate as an array
  117980. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117981. * @returns either obj directly if obj is an array or a new array containing obj
  117982. */
  117983. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117984. /**
  117985. * Gets the pointer prefix to use
  117986. * @param engine defines the engine we are finding the prefix for
  117987. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117988. */
  117989. static GetPointerPrefix(engine: Engine): string;
  117990. /**
  117991. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117992. * @param url define the url we are trying
  117993. * @param element define the dom element where to configure the cors policy
  117994. */
  117995. static SetCorsBehavior(url: string | string[], element: {
  117996. crossOrigin: string | null;
  117997. }): void;
  117998. /**
  117999. * Removes unwanted characters from an url
  118000. * @param url defines the url to clean
  118001. * @returns the cleaned url
  118002. */
  118003. static CleanUrl(url: string): string;
  118004. /**
  118005. * Gets or sets a function used to pre-process url before using them to load assets
  118006. */
  118007. static get PreprocessUrl(): (url: string) => string;
  118008. static set PreprocessUrl(processor: (url: string) => string);
  118009. /**
  118010. * Loads an image as an HTMLImageElement.
  118011. * @param input url string, ArrayBuffer, or Blob to load
  118012. * @param onLoad callback called when the image successfully loads
  118013. * @param onError callback called when the image fails to load
  118014. * @param offlineProvider offline provider for caching
  118015. * @param mimeType optional mime type
  118016. * @returns the HTMLImageElement of the loaded image
  118017. */
  118018. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118019. /**
  118020. * Loads a file from a url
  118021. * @param url url string, ArrayBuffer, or Blob to load
  118022. * @param onSuccess callback called when the file successfully loads
  118023. * @param onProgress callback called while file is loading (if the server supports this mode)
  118024. * @param offlineProvider defines the offline provider for caching
  118025. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118026. * @param onError callback called when the file fails to load
  118027. * @returns a file request object
  118028. */
  118029. 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;
  118030. /**
  118031. * Loads a file from a url
  118032. * @param url the file url to load
  118033. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118034. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118035. */
  118036. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118037. /**
  118038. * Load a script (identified by an url). When the url returns, the
  118039. * content of this file is added into a new script element, attached to the DOM (body element)
  118040. * @param scriptUrl defines the url of the script to laod
  118041. * @param onSuccess defines the callback called when the script is loaded
  118042. * @param onError defines the callback to call if an error occurs
  118043. * @param scriptId defines the id of the script element
  118044. */
  118045. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118046. /**
  118047. * Load an asynchronous script (identified by an url). When the url returns, the
  118048. * content of this file is added into a new script element, attached to the DOM (body element)
  118049. * @param scriptUrl defines the url of the script to laod
  118050. * @param scriptId defines the id of the script element
  118051. * @returns a promise request object
  118052. */
  118053. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118054. /**
  118055. * Loads a file from a blob
  118056. * @param fileToLoad defines the blob to use
  118057. * @param callback defines the callback to call when data is loaded
  118058. * @param progressCallback defines the callback to call during loading process
  118059. * @returns a file request object
  118060. */
  118061. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118062. /**
  118063. * Reads a file from a File object
  118064. * @param file defines the file to load
  118065. * @param onSuccess defines the callback to call when data is loaded
  118066. * @param onProgress defines the callback to call during loading process
  118067. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118068. * @param onError defines the callback to call when an error occurs
  118069. * @returns a file request object
  118070. */
  118071. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118072. /**
  118073. * Creates a data url from a given string content
  118074. * @param content defines the content to convert
  118075. * @returns the new data url link
  118076. */
  118077. static FileAsURL(content: string): string;
  118078. /**
  118079. * Format the given number to a specific decimal format
  118080. * @param value defines the number to format
  118081. * @param decimals defines the number of decimals to use
  118082. * @returns the formatted string
  118083. */
  118084. static Format(value: number, decimals?: number): string;
  118085. /**
  118086. * Tries to copy an object by duplicating every property
  118087. * @param source defines the source object
  118088. * @param destination defines the target object
  118089. * @param doNotCopyList defines a list of properties to avoid
  118090. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118091. */
  118092. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118093. /**
  118094. * Gets a boolean indicating if the given object has no own property
  118095. * @param obj defines the object to test
  118096. * @returns true if object has no own property
  118097. */
  118098. static IsEmpty(obj: any): boolean;
  118099. /**
  118100. * Function used to register events at window level
  118101. * @param windowElement defines the Window object to use
  118102. * @param events defines the events to register
  118103. */
  118104. static RegisterTopRootEvents(windowElement: Window, events: {
  118105. name: string;
  118106. handler: Nullable<(e: FocusEvent) => any>;
  118107. }[]): void;
  118108. /**
  118109. * Function used to unregister events from window level
  118110. * @param windowElement defines the Window object to use
  118111. * @param events defines the events to unregister
  118112. */
  118113. static UnregisterTopRootEvents(windowElement: Window, events: {
  118114. name: string;
  118115. handler: Nullable<(e: FocusEvent) => any>;
  118116. }[]): void;
  118117. /**
  118118. * @ignore
  118119. */
  118120. static _ScreenshotCanvas: HTMLCanvasElement;
  118121. /**
  118122. * Dumps the current bound framebuffer
  118123. * @param width defines the rendering width
  118124. * @param height defines the rendering height
  118125. * @param engine defines the hosting engine
  118126. * @param successCallback defines the callback triggered once the data are available
  118127. * @param mimeType defines the mime type of the result
  118128. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118129. */
  118130. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118131. /**
  118132. * Converts the canvas data to blob.
  118133. * This acts as a polyfill for browsers not supporting the to blob function.
  118134. * @param canvas Defines the canvas to extract the data from
  118135. * @param successCallback Defines the callback triggered once the data are available
  118136. * @param mimeType Defines the mime type of the result
  118137. */
  118138. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118139. /**
  118140. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118141. * @param successCallback defines the callback triggered once the data are available
  118142. * @param mimeType defines the mime type of the result
  118143. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118144. */
  118145. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118146. /**
  118147. * Downloads a blob in the browser
  118148. * @param blob defines the blob to download
  118149. * @param fileName defines the name of the downloaded file
  118150. */
  118151. static Download(blob: Blob, fileName: string): void;
  118152. /**
  118153. * Captures a screenshot of the current rendering
  118154. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118155. * @param engine defines the rendering engine
  118156. * @param camera defines the source camera
  118157. * @param size This parameter can be set to a single number or to an object with the
  118158. * following (optional) properties: precision, width, height. If a single number is passed,
  118159. * it will be used for both width and height. If an object is passed, the screenshot size
  118160. * will be derived from the parameters. The precision property is a multiplier allowing
  118161. * rendering at a higher or lower resolution
  118162. * @param successCallback defines the callback receives a single parameter which contains the
  118163. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118164. * src parameter of an <img> to display it
  118165. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118166. * Check your browser for supported MIME types
  118167. */
  118168. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118169. /**
  118170. * Captures a screenshot of the current rendering
  118171. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118172. * @param engine defines the rendering engine
  118173. * @param camera defines the source camera
  118174. * @param size This parameter can be set to a single number or to an object with the
  118175. * following (optional) properties: precision, width, height. If a single number is passed,
  118176. * it will be used for both width and height. If an object is passed, the screenshot size
  118177. * will be derived from the parameters. The precision property is a multiplier allowing
  118178. * rendering at a higher or lower resolution
  118179. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118180. * Check your browser for supported MIME types
  118181. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118182. * to the src parameter of an <img> to display it
  118183. */
  118184. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118185. /**
  118186. * Generates an image screenshot from the specified camera.
  118187. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118188. * @param engine The engine to use for rendering
  118189. * @param camera The camera to use for rendering
  118190. * @param size This parameter can be set to a single number or to an object with the
  118191. * following (optional) properties: precision, width, height. If a single number is passed,
  118192. * it will be used for both width and height. If an object is passed, the screenshot size
  118193. * will be derived from the parameters. The precision property is a multiplier allowing
  118194. * rendering at a higher or lower resolution
  118195. * @param successCallback The callback receives a single parameter which contains the
  118196. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118197. * src parameter of an <img> to display it
  118198. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118199. * Check your browser for supported MIME types
  118200. * @param samples Texture samples (default: 1)
  118201. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118202. * @param fileName A name for for the downloaded file.
  118203. */
  118204. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118205. /**
  118206. * Generates an image screenshot from the specified camera.
  118207. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118208. * @param engine The engine to use for rendering
  118209. * @param camera The camera to use for rendering
  118210. * @param size This parameter can be set to a single number or to an object with the
  118211. * following (optional) properties: precision, width, height. If a single number is passed,
  118212. * it will be used for both width and height. If an object is passed, the screenshot size
  118213. * will be derived from the parameters. The precision property is a multiplier allowing
  118214. * rendering at a higher or lower resolution
  118215. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118216. * Check your browser for supported MIME types
  118217. * @param samples Texture samples (default: 1)
  118218. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118219. * @param fileName A name for for the downloaded file.
  118220. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118221. * to the src parameter of an <img> to display it
  118222. */
  118223. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118224. /**
  118225. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118226. * Be aware Math.random() could cause collisions, but:
  118227. * "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"
  118228. * @returns a pseudo random id
  118229. */
  118230. static RandomId(): string;
  118231. /**
  118232. * Test if the given uri is a base64 string
  118233. * @param uri The uri to test
  118234. * @return True if the uri is a base64 string or false otherwise
  118235. */
  118236. static IsBase64(uri: string): boolean;
  118237. /**
  118238. * Decode the given base64 uri.
  118239. * @param uri The uri to decode
  118240. * @return The decoded base64 data.
  118241. */
  118242. static DecodeBase64(uri: string): ArrayBuffer;
  118243. /**
  118244. * Gets the absolute url.
  118245. * @param url the input url
  118246. * @return the absolute url
  118247. */
  118248. static GetAbsoluteUrl(url: string): string;
  118249. /**
  118250. * No log
  118251. */
  118252. static readonly NoneLogLevel: number;
  118253. /**
  118254. * Only message logs
  118255. */
  118256. static readonly MessageLogLevel: number;
  118257. /**
  118258. * Only warning logs
  118259. */
  118260. static readonly WarningLogLevel: number;
  118261. /**
  118262. * Only error logs
  118263. */
  118264. static readonly ErrorLogLevel: number;
  118265. /**
  118266. * All logs
  118267. */
  118268. static readonly AllLogLevel: number;
  118269. /**
  118270. * Gets a value indicating the number of loading errors
  118271. * @ignorenaming
  118272. */
  118273. static get errorsCount(): number;
  118274. /**
  118275. * Callback called when a new log is added
  118276. */
  118277. static OnNewCacheEntry: (entry: string) => void;
  118278. /**
  118279. * Log a message to the console
  118280. * @param message defines the message to log
  118281. */
  118282. static Log(message: string): void;
  118283. /**
  118284. * Write a warning message to the console
  118285. * @param message defines the message to log
  118286. */
  118287. static Warn(message: string): void;
  118288. /**
  118289. * Write an error message to the console
  118290. * @param message defines the message to log
  118291. */
  118292. static Error(message: string): void;
  118293. /**
  118294. * Gets current log cache (list of logs)
  118295. */
  118296. static get LogCache(): string;
  118297. /**
  118298. * Clears the log cache
  118299. */
  118300. static ClearLogCache(): void;
  118301. /**
  118302. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118303. */
  118304. static set LogLevels(level: number);
  118305. /**
  118306. * Checks if the window object exists
  118307. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118308. */
  118309. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118310. /**
  118311. * No performance log
  118312. */
  118313. static readonly PerformanceNoneLogLevel: number;
  118314. /**
  118315. * Use user marks to log performance
  118316. */
  118317. static readonly PerformanceUserMarkLogLevel: number;
  118318. /**
  118319. * Log performance to the console
  118320. */
  118321. static readonly PerformanceConsoleLogLevel: number;
  118322. private static _performance;
  118323. /**
  118324. * Sets the current performance log level
  118325. */
  118326. static set PerformanceLogLevel(level: number);
  118327. private static _StartPerformanceCounterDisabled;
  118328. private static _EndPerformanceCounterDisabled;
  118329. private static _StartUserMark;
  118330. private static _EndUserMark;
  118331. private static _StartPerformanceConsole;
  118332. private static _EndPerformanceConsole;
  118333. /**
  118334. * Starts a performance counter
  118335. */
  118336. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118337. /**
  118338. * Ends a specific performance coutner
  118339. */
  118340. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118341. /**
  118342. * Gets either window.performance.now() if supported or Date.now() else
  118343. */
  118344. static get Now(): number;
  118345. /**
  118346. * This method will return the name of the class used to create the instance of the given object.
  118347. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118348. * @param object the object to get the class name from
  118349. * @param isType defines if the object is actually a type
  118350. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118351. */
  118352. static GetClassName(object: any, isType?: boolean): string;
  118353. /**
  118354. * Gets the first element of an array satisfying a given predicate
  118355. * @param array defines the array to browse
  118356. * @param predicate defines the predicate to use
  118357. * @returns null if not found or the element
  118358. */
  118359. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118360. /**
  118361. * This method will return the name of the full name of the class, including its owning module (if any).
  118362. * 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).
  118363. * @param object the object to get the class name from
  118364. * @param isType defines if the object is actually a type
  118365. * @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.
  118366. * @ignorenaming
  118367. */
  118368. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118369. /**
  118370. * Returns a promise that resolves after the given amount of time.
  118371. * @param delay Number of milliseconds to delay
  118372. * @returns Promise that resolves after the given amount of time
  118373. */
  118374. static DelayAsync(delay: number): Promise<void>;
  118375. /**
  118376. * Utility function to detect if the current user agent is Safari
  118377. * @returns whether or not the current user agent is safari
  118378. */
  118379. static IsSafari(): boolean;
  118380. }
  118381. /**
  118382. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118383. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118384. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118385. * @param name The name of the class, case should be preserved
  118386. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118387. */
  118388. export function className(name: string, module?: string): (target: Object) => void;
  118389. /**
  118390. * An implementation of a loop for asynchronous functions.
  118391. */
  118392. export class AsyncLoop {
  118393. /**
  118394. * Defines the number of iterations for the loop
  118395. */
  118396. iterations: number;
  118397. /**
  118398. * Defines the current index of the loop.
  118399. */
  118400. index: number;
  118401. private _done;
  118402. private _fn;
  118403. private _successCallback;
  118404. /**
  118405. * Constructor.
  118406. * @param iterations the number of iterations.
  118407. * @param func the function to run each iteration
  118408. * @param successCallback the callback that will be called upon succesful execution
  118409. * @param offset starting offset.
  118410. */
  118411. constructor(
  118412. /**
  118413. * Defines the number of iterations for the loop
  118414. */
  118415. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118416. /**
  118417. * Execute the next iteration. Must be called after the last iteration was finished.
  118418. */
  118419. executeNext(): void;
  118420. /**
  118421. * Break the loop and run the success callback.
  118422. */
  118423. breakLoop(): void;
  118424. /**
  118425. * Create and run an async loop.
  118426. * @param iterations the number of iterations.
  118427. * @param fn the function to run each iteration
  118428. * @param successCallback the callback that will be called upon succesful execution
  118429. * @param offset starting offset.
  118430. * @returns the created async loop object
  118431. */
  118432. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118433. /**
  118434. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118435. * @param iterations total number of iterations
  118436. * @param syncedIterations number of synchronous iterations in each async iteration.
  118437. * @param fn the function to call each iteration.
  118438. * @param callback a success call back that will be called when iterating stops.
  118439. * @param breakFunction a break condition (optional)
  118440. * @param timeout timeout settings for the setTimeout function. default - 0.
  118441. * @returns the created async loop object
  118442. */
  118443. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118444. }
  118445. }
  118446. declare module BABYLON {
  118447. /**
  118448. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118449. * The underlying implementation relies on an associative array to ensure the best performances.
  118450. * The value can be anything including 'null' but except 'undefined'
  118451. */
  118452. export class StringDictionary<T> {
  118453. /**
  118454. * This will clear this dictionary and copy the content from the 'source' one.
  118455. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118456. * @param source the dictionary to take the content from and copy to this dictionary
  118457. */
  118458. copyFrom(source: StringDictionary<T>): void;
  118459. /**
  118460. * Get a value based from its key
  118461. * @param key the given key to get the matching value from
  118462. * @return the value if found, otherwise undefined is returned
  118463. */
  118464. get(key: string): T | undefined;
  118465. /**
  118466. * Get a value from its key or add it if it doesn't exist.
  118467. * This method will ensure you that a given key/data will be present in the dictionary.
  118468. * @param key the given key to get the matching value from
  118469. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118470. * The factory will only be invoked if there's no data for the given key.
  118471. * @return the value corresponding to the key.
  118472. */
  118473. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118474. /**
  118475. * Get a value from its key if present in the dictionary otherwise add it
  118476. * @param key the key to get the value from
  118477. * @param val if there's no such key/value pair in the dictionary add it with this value
  118478. * @return the value corresponding to the key
  118479. */
  118480. getOrAdd(key: string, val: T): T;
  118481. /**
  118482. * Check if there's a given key in the dictionary
  118483. * @param key the key to check for
  118484. * @return true if the key is present, false otherwise
  118485. */
  118486. contains(key: string): boolean;
  118487. /**
  118488. * Add a new key and its corresponding value
  118489. * @param key the key to add
  118490. * @param value the value corresponding to the key
  118491. * @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
  118492. */
  118493. add(key: string, value: T): boolean;
  118494. /**
  118495. * Update a specific value associated to a key
  118496. * @param key defines the key to use
  118497. * @param value defines the value to store
  118498. * @returns true if the value was updated (or false if the key was not found)
  118499. */
  118500. set(key: string, value: T): boolean;
  118501. /**
  118502. * Get the element of the given key and remove it from the dictionary
  118503. * @param key defines the key to search
  118504. * @returns the value associated with the key or null if not found
  118505. */
  118506. getAndRemove(key: string): Nullable<T>;
  118507. /**
  118508. * Remove a key/value from the dictionary.
  118509. * @param key the key to remove
  118510. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118511. */
  118512. remove(key: string): boolean;
  118513. /**
  118514. * Clear the whole content of the dictionary
  118515. */
  118516. clear(): void;
  118517. /**
  118518. * Gets the current count
  118519. */
  118520. get count(): number;
  118521. /**
  118522. * Execute a callback on each key/val of the dictionary.
  118523. * Note that you can remove any element in this dictionary in the callback implementation
  118524. * @param callback the callback to execute on a given key/value pair
  118525. */
  118526. forEach(callback: (key: string, val: T) => void): void;
  118527. /**
  118528. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118529. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118530. * Note that you can remove any element in this dictionary in the callback implementation
  118531. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118532. * @returns the first item
  118533. */
  118534. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118535. private _count;
  118536. private _data;
  118537. }
  118538. }
  118539. declare module BABYLON {
  118540. /** @hidden */
  118541. export interface ICollisionCoordinator {
  118542. createCollider(): Collider;
  118543. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118544. init(scene: Scene): void;
  118545. }
  118546. /** @hidden */
  118547. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118548. private _scene;
  118549. private _scaledPosition;
  118550. private _scaledVelocity;
  118551. private _finalPosition;
  118552. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118553. createCollider(): Collider;
  118554. init(scene: Scene): void;
  118555. private _collideWithWorld;
  118556. }
  118557. }
  118558. declare module BABYLON {
  118559. /**
  118560. * Class used to manage all inputs for the scene.
  118561. */
  118562. export class InputManager {
  118563. /** The distance in pixel that you have to move to prevent some events */
  118564. static DragMovementThreshold: number;
  118565. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118566. static LongPressDelay: number;
  118567. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118568. static DoubleClickDelay: number;
  118569. /** If you need to check double click without raising a single click at first click, enable this flag */
  118570. static ExclusiveDoubleClickMode: boolean;
  118571. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  118572. private _alreadyAttached;
  118573. private _wheelEventName;
  118574. private _onPointerMove;
  118575. private _onPointerDown;
  118576. private _onPointerUp;
  118577. private _initClickEvent;
  118578. private _initActionManager;
  118579. private _delayedSimpleClick;
  118580. private _delayedSimpleClickTimeout;
  118581. private _previousDelayedSimpleClickTimeout;
  118582. private _meshPickProceed;
  118583. private _previousButtonPressed;
  118584. private _currentPickResult;
  118585. private _previousPickResult;
  118586. private _totalPointersPressed;
  118587. private _doubleClickOccured;
  118588. private _pointerOverMesh;
  118589. private _pickedDownMesh;
  118590. private _pickedUpMesh;
  118591. private _pointerX;
  118592. private _pointerY;
  118593. private _unTranslatedPointerX;
  118594. private _unTranslatedPointerY;
  118595. private _startingPointerPosition;
  118596. private _previousStartingPointerPosition;
  118597. private _startingPointerTime;
  118598. private _previousStartingPointerTime;
  118599. private _pointerCaptures;
  118600. private _meshUnderPointerId;
  118601. private _onKeyDown;
  118602. private _onKeyUp;
  118603. private _onCanvasFocusObserver;
  118604. private _onCanvasBlurObserver;
  118605. private _scene;
  118606. /**
  118607. * Creates a new InputManager
  118608. * @param scene defines the hosting scene
  118609. */
  118610. constructor(scene: Scene);
  118611. /**
  118612. * Gets the mesh that is currently under the pointer
  118613. */
  118614. get meshUnderPointer(): Nullable<AbstractMesh>;
  118615. /**
  118616. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  118617. * @param pointerId the pointer id to use
  118618. * @returns The mesh under this pointer id or null if not found
  118619. */
  118620. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  118621. /**
  118622. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118623. */
  118624. get unTranslatedPointer(): Vector2;
  118625. /**
  118626. * Gets or sets the current on-screen X position of the pointer
  118627. */
  118628. get pointerX(): number;
  118629. set pointerX(value: number);
  118630. /**
  118631. * Gets or sets the current on-screen Y position of the pointer
  118632. */
  118633. get pointerY(): number;
  118634. set pointerY(value: number);
  118635. private _updatePointerPosition;
  118636. private _processPointerMove;
  118637. private _setRayOnPointerInfo;
  118638. private _checkPrePointerObservable;
  118639. /**
  118640. * Use this method to simulate a pointer move on a mesh
  118641. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118642. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118643. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118644. */
  118645. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118646. /**
  118647. * Use this method to simulate a pointer down on a mesh
  118648. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118649. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118650. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118651. */
  118652. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118653. private _processPointerDown;
  118654. /** @hidden */
  118655. _isPointerSwiping(): boolean;
  118656. /**
  118657. * Use this method to simulate a pointer up on a mesh
  118658. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118659. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118660. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118661. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118662. */
  118663. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118664. private _processPointerUp;
  118665. /**
  118666. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118667. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118668. * @returns true if the pointer was captured
  118669. */
  118670. isPointerCaptured(pointerId?: number): boolean;
  118671. /**
  118672. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118673. * @param attachUp defines if you want to attach events to pointerup
  118674. * @param attachDown defines if you want to attach events to pointerdown
  118675. * @param attachMove defines if you want to attach events to pointermove
  118676. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118677. */
  118678. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118679. /**
  118680. * Detaches all event handlers
  118681. */
  118682. detachControl(): void;
  118683. /**
  118684. * Force the value of meshUnderPointer
  118685. * @param mesh defines the mesh to use
  118686. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  118687. */
  118688. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  118689. /**
  118690. * Gets the mesh under the pointer
  118691. * @returns a Mesh or null if no mesh is under the pointer
  118692. */
  118693. getPointerOverMesh(): Nullable<AbstractMesh>;
  118694. }
  118695. }
  118696. declare module BABYLON {
  118697. /**
  118698. * This class defines the direct association between an animation and a target
  118699. */
  118700. export class TargetedAnimation {
  118701. /**
  118702. * Animation to perform
  118703. */
  118704. animation: Animation;
  118705. /**
  118706. * Target to animate
  118707. */
  118708. target: any;
  118709. /**
  118710. * Returns the string "TargetedAnimation"
  118711. * @returns "TargetedAnimation"
  118712. */
  118713. getClassName(): string;
  118714. /**
  118715. * Serialize the object
  118716. * @returns the JSON object representing the current entity
  118717. */
  118718. serialize(): any;
  118719. }
  118720. /**
  118721. * Use this class to create coordinated animations on multiple targets
  118722. */
  118723. export class AnimationGroup implements IDisposable {
  118724. /** The name of the animation group */
  118725. name: string;
  118726. private _scene;
  118727. private _targetedAnimations;
  118728. private _animatables;
  118729. private _from;
  118730. private _to;
  118731. private _isStarted;
  118732. private _isPaused;
  118733. private _speedRatio;
  118734. private _loopAnimation;
  118735. private _isAdditive;
  118736. /**
  118737. * Gets or sets the unique id of the node
  118738. */
  118739. uniqueId: number;
  118740. /**
  118741. * This observable will notify when one animation have ended
  118742. */
  118743. onAnimationEndObservable: Observable<TargetedAnimation>;
  118744. /**
  118745. * Observer raised when one animation loops
  118746. */
  118747. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118748. /**
  118749. * Observer raised when all animations have looped
  118750. */
  118751. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118752. /**
  118753. * This observable will notify when all animations have ended.
  118754. */
  118755. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118756. /**
  118757. * This observable will notify when all animations have paused.
  118758. */
  118759. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118760. /**
  118761. * This observable will notify when all animations are playing.
  118762. */
  118763. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118764. /**
  118765. * Gets the first frame
  118766. */
  118767. get from(): number;
  118768. /**
  118769. * Gets the last frame
  118770. */
  118771. get to(): number;
  118772. /**
  118773. * Define if the animations are started
  118774. */
  118775. get isStarted(): boolean;
  118776. /**
  118777. * Gets a value indicating that the current group is playing
  118778. */
  118779. get isPlaying(): boolean;
  118780. /**
  118781. * Gets or sets the speed ratio to use for all animations
  118782. */
  118783. get speedRatio(): number;
  118784. /**
  118785. * Gets or sets the speed ratio to use for all animations
  118786. */
  118787. set speedRatio(value: number);
  118788. /**
  118789. * Gets or sets if all animations should loop or not
  118790. */
  118791. get loopAnimation(): boolean;
  118792. set loopAnimation(value: boolean);
  118793. /**
  118794. * Gets or sets if all animations should be evaluated additively
  118795. */
  118796. get isAdditive(): boolean;
  118797. set isAdditive(value: boolean);
  118798. /**
  118799. * Gets the targeted animations for this animation group
  118800. */
  118801. get targetedAnimations(): Array<TargetedAnimation>;
  118802. /**
  118803. * returning the list of animatables controlled by this animation group.
  118804. */
  118805. get animatables(): Array<Animatable>;
  118806. /**
  118807. * Gets the list of target animations
  118808. */
  118809. get children(): TargetedAnimation[];
  118810. /**
  118811. * Instantiates a new Animation Group.
  118812. * This helps managing several animations at once.
  118813. * @see https://doc.babylonjs.com/how_to/group
  118814. * @param name Defines the name of the group
  118815. * @param scene Defines the scene the group belongs to
  118816. */
  118817. constructor(
  118818. /** The name of the animation group */
  118819. name: string, scene?: Nullable<Scene>);
  118820. /**
  118821. * Add an animation (with its target) in the group
  118822. * @param animation defines the animation we want to add
  118823. * @param target defines the target of the animation
  118824. * @returns the TargetedAnimation object
  118825. */
  118826. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118827. /**
  118828. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118829. * It can add constant keys at begin or end
  118830. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118831. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118832. * @returns the animation group
  118833. */
  118834. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118835. private _animationLoopCount;
  118836. private _animationLoopFlags;
  118837. private _processLoop;
  118838. /**
  118839. * Start all animations on given targets
  118840. * @param loop defines if animations must loop
  118841. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118842. * @param from defines the from key (optional)
  118843. * @param to defines the to key (optional)
  118844. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118845. * @returns the current animation group
  118846. */
  118847. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118848. /**
  118849. * Pause all animations
  118850. * @returns the animation group
  118851. */
  118852. pause(): AnimationGroup;
  118853. /**
  118854. * Play all animations to initial state
  118855. * This function will start() the animations if they were not started or will restart() them if they were paused
  118856. * @param loop defines if animations must loop
  118857. * @returns the animation group
  118858. */
  118859. play(loop?: boolean): AnimationGroup;
  118860. /**
  118861. * Reset all animations to initial state
  118862. * @returns the animation group
  118863. */
  118864. reset(): AnimationGroup;
  118865. /**
  118866. * Restart animations from key 0
  118867. * @returns the animation group
  118868. */
  118869. restart(): AnimationGroup;
  118870. /**
  118871. * Stop all animations
  118872. * @returns the animation group
  118873. */
  118874. stop(): AnimationGroup;
  118875. /**
  118876. * Set animation weight for all animatables
  118877. * @param weight defines the weight to use
  118878. * @return the animationGroup
  118879. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118880. */
  118881. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118882. /**
  118883. * Synchronize and normalize all animatables with a source animatable
  118884. * @param root defines the root animatable to synchronize with
  118885. * @return the animationGroup
  118886. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118887. */
  118888. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118889. /**
  118890. * Goes to a specific frame in this animation group
  118891. * @param frame the frame number to go to
  118892. * @return the animationGroup
  118893. */
  118894. goToFrame(frame: number): AnimationGroup;
  118895. /**
  118896. * Dispose all associated resources
  118897. */
  118898. dispose(): void;
  118899. private _checkAnimationGroupEnded;
  118900. /**
  118901. * Clone the current animation group and returns a copy
  118902. * @param newName defines the name of the new group
  118903. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118904. * @returns the new aniamtion group
  118905. */
  118906. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118907. /**
  118908. * Serializes the animationGroup to an object
  118909. * @returns Serialized object
  118910. */
  118911. serialize(): any;
  118912. /**
  118913. * Returns a new AnimationGroup object parsed from the source provided.
  118914. * @param parsedAnimationGroup defines the source
  118915. * @param scene defines the scene that will receive the animationGroup
  118916. * @returns a new AnimationGroup
  118917. */
  118918. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118919. /**
  118920. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118921. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118922. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118923. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118924. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118925. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118926. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118927. */
  118928. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118929. /**
  118930. * Returns the string "AnimationGroup"
  118931. * @returns "AnimationGroup"
  118932. */
  118933. getClassName(): string;
  118934. /**
  118935. * Creates a detailled string about the object
  118936. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118937. * @returns a string representing the object
  118938. */
  118939. toString(fullDetails?: boolean): string;
  118940. }
  118941. }
  118942. declare module BABYLON {
  118943. /**
  118944. * Define an interface for all classes that will hold resources
  118945. */
  118946. export interface IDisposable {
  118947. /**
  118948. * Releases all held resources
  118949. */
  118950. dispose(): void;
  118951. }
  118952. /** Interface defining initialization parameters for Scene class */
  118953. export interface SceneOptions {
  118954. /**
  118955. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118956. * It will improve performance when the number of geometries becomes important.
  118957. */
  118958. useGeometryUniqueIdsMap?: boolean;
  118959. /**
  118960. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118961. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118962. */
  118963. useMaterialMeshMap?: boolean;
  118964. /**
  118965. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118966. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118967. */
  118968. useClonedMeshMap?: boolean;
  118969. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118970. virtual?: boolean;
  118971. }
  118972. /**
  118973. * Represents a scene to be rendered by the engine.
  118974. * @see https://doc.babylonjs.com/features/scene
  118975. */
  118976. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118977. /** The fog is deactivated */
  118978. static readonly FOGMODE_NONE: number;
  118979. /** The fog density is following an exponential function */
  118980. static readonly FOGMODE_EXP: number;
  118981. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118982. static readonly FOGMODE_EXP2: number;
  118983. /** The fog density is following a linear function. */
  118984. static readonly FOGMODE_LINEAR: number;
  118985. /**
  118986. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118987. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118988. */
  118989. static MinDeltaTime: number;
  118990. /**
  118991. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118992. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118993. */
  118994. static MaxDeltaTime: number;
  118995. /**
  118996. * Factory used to create the default material.
  118997. * @param name The name of the material to create
  118998. * @param scene The scene to create the material for
  118999. * @returns The default material
  119000. */
  119001. static DefaultMaterialFactory(scene: Scene): Material;
  119002. /**
  119003. * Factory used to create the a collision coordinator.
  119004. * @returns The collision coordinator
  119005. */
  119006. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  119007. /** @hidden */
  119008. _inputManager: InputManager;
  119009. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  119010. cameraToUseForPointers: Nullable<Camera>;
  119011. /** @hidden */
  119012. readonly _isScene: boolean;
  119013. /** @hidden */
  119014. _blockEntityCollection: boolean;
  119015. /**
  119016. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119017. */
  119018. autoClear: boolean;
  119019. /**
  119020. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119021. */
  119022. autoClearDepthAndStencil: boolean;
  119023. /**
  119024. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119025. */
  119026. clearColor: Color4;
  119027. /**
  119028. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119029. */
  119030. ambientColor: Color3;
  119031. /**
  119032. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119033. * It should only be one of the following (if not the default embedded one):
  119034. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119035. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119036. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119037. * The material properties need to be setup according to the type of texture in use.
  119038. */
  119039. environmentBRDFTexture: BaseTexture;
  119040. /**
  119041. * Texture used in all pbr material as the reflection texture.
  119042. * As in the majority of the scene they are the same (exception for multi room and so on),
  119043. * this is easier to reference from here than from all the materials.
  119044. */
  119045. get environmentTexture(): Nullable<BaseTexture>;
  119046. /**
  119047. * Texture used in all pbr material as the reflection texture.
  119048. * As in the majority of the scene they are the same (exception for multi room and so on),
  119049. * this is easier to set here than in all the materials.
  119050. */
  119051. set environmentTexture(value: Nullable<BaseTexture>);
  119052. /** @hidden */
  119053. protected _environmentIntensity: number;
  119054. /**
  119055. * Intensity of the environment in all pbr material.
  119056. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119057. * As in the majority of the scene they are the same (exception for multi room and so on),
  119058. * this is easier to reference from here than from all the materials.
  119059. */
  119060. get environmentIntensity(): number;
  119061. /**
  119062. * Intensity of the environment in all pbr material.
  119063. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119064. * As in the majority of the scene they are the same (exception for multi room and so on),
  119065. * this is easier to set here than in all the materials.
  119066. */
  119067. set environmentIntensity(value: number);
  119068. /** @hidden */
  119069. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119070. /**
  119071. * Default image processing configuration used either in the rendering
  119072. * Forward main pass or through the imageProcessingPostProcess if present.
  119073. * As in the majority of the scene they are the same (exception for multi camera),
  119074. * this is easier to reference from here than from all the materials and post process.
  119075. *
  119076. * No setter as we it is a shared configuration, you can set the values instead.
  119077. */
  119078. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119079. private _forceWireframe;
  119080. /**
  119081. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119082. */
  119083. set forceWireframe(value: boolean);
  119084. get forceWireframe(): boolean;
  119085. private _skipFrustumClipping;
  119086. /**
  119087. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119088. */
  119089. set skipFrustumClipping(value: boolean);
  119090. get skipFrustumClipping(): boolean;
  119091. private _forcePointsCloud;
  119092. /**
  119093. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119094. */
  119095. set forcePointsCloud(value: boolean);
  119096. get forcePointsCloud(): boolean;
  119097. /**
  119098. * Gets or sets the active clipplane 1
  119099. */
  119100. clipPlane: Nullable<Plane>;
  119101. /**
  119102. * Gets or sets the active clipplane 2
  119103. */
  119104. clipPlane2: Nullable<Plane>;
  119105. /**
  119106. * Gets or sets the active clipplane 3
  119107. */
  119108. clipPlane3: Nullable<Plane>;
  119109. /**
  119110. * Gets or sets the active clipplane 4
  119111. */
  119112. clipPlane4: Nullable<Plane>;
  119113. /**
  119114. * Gets or sets the active clipplane 5
  119115. */
  119116. clipPlane5: Nullable<Plane>;
  119117. /**
  119118. * Gets or sets the active clipplane 6
  119119. */
  119120. clipPlane6: Nullable<Plane>;
  119121. /**
  119122. * Gets or sets a boolean indicating if animations are enabled
  119123. */
  119124. animationsEnabled: boolean;
  119125. private _animationPropertiesOverride;
  119126. /**
  119127. * Gets or sets the animation properties override
  119128. */
  119129. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119130. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119131. /**
  119132. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119133. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119134. */
  119135. useConstantAnimationDeltaTime: boolean;
  119136. /**
  119137. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119138. * Please note that it requires to run a ray cast through the scene on every frame
  119139. */
  119140. constantlyUpdateMeshUnderPointer: boolean;
  119141. /**
  119142. * Defines the HTML cursor to use when hovering over interactive elements
  119143. */
  119144. hoverCursor: string;
  119145. /**
  119146. * Defines the HTML default cursor to use (empty by default)
  119147. */
  119148. defaultCursor: string;
  119149. /**
  119150. * Defines whether cursors are handled by the scene.
  119151. */
  119152. doNotHandleCursors: boolean;
  119153. /**
  119154. * This is used to call preventDefault() on pointer down
  119155. * in order to block unwanted artifacts like system double clicks
  119156. */
  119157. preventDefaultOnPointerDown: boolean;
  119158. /**
  119159. * This is used to call preventDefault() on pointer up
  119160. * in order to block unwanted artifacts like system double clicks
  119161. */
  119162. preventDefaultOnPointerUp: boolean;
  119163. /**
  119164. * Gets or sets user defined metadata
  119165. */
  119166. metadata: any;
  119167. /**
  119168. * For internal use only. Please do not use.
  119169. */
  119170. reservedDataStore: any;
  119171. /**
  119172. * Gets the name of the plugin used to load this scene (null by default)
  119173. */
  119174. loadingPluginName: string;
  119175. /**
  119176. * Use this array to add regular expressions used to disable offline support for specific urls
  119177. */
  119178. disableOfflineSupportExceptionRules: RegExp[];
  119179. /**
  119180. * An event triggered when the scene is disposed.
  119181. */
  119182. onDisposeObservable: Observable<Scene>;
  119183. private _onDisposeObserver;
  119184. /** Sets a function to be executed when this scene is disposed. */
  119185. set onDispose(callback: () => void);
  119186. /**
  119187. * An event triggered before rendering the scene (right after animations and physics)
  119188. */
  119189. onBeforeRenderObservable: Observable<Scene>;
  119190. private _onBeforeRenderObserver;
  119191. /** Sets a function to be executed before rendering this scene */
  119192. set beforeRender(callback: Nullable<() => void>);
  119193. /**
  119194. * An event triggered after rendering the scene
  119195. */
  119196. onAfterRenderObservable: Observable<Scene>;
  119197. /**
  119198. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119199. */
  119200. onAfterRenderCameraObservable: Observable<Camera>;
  119201. private _onAfterRenderObserver;
  119202. /** Sets a function to be executed after rendering this scene */
  119203. set afterRender(callback: Nullable<() => void>);
  119204. /**
  119205. * An event triggered before animating the scene
  119206. */
  119207. onBeforeAnimationsObservable: Observable<Scene>;
  119208. /**
  119209. * An event triggered after animations processing
  119210. */
  119211. onAfterAnimationsObservable: Observable<Scene>;
  119212. /**
  119213. * An event triggered before draw calls are ready to be sent
  119214. */
  119215. onBeforeDrawPhaseObservable: Observable<Scene>;
  119216. /**
  119217. * An event triggered after draw calls have been sent
  119218. */
  119219. onAfterDrawPhaseObservable: Observable<Scene>;
  119220. /**
  119221. * An event triggered when the scene is ready
  119222. */
  119223. onReadyObservable: Observable<Scene>;
  119224. /**
  119225. * An event triggered before rendering a camera
  119226. */
  119227. onBeforeCameraRenderObservable: Observable<Camera>;
  119228. private _onBeforeCameraRenderObserver;
  119229. /** Sets a function to be executed before rendering a camera*/
  119230. set beforeCameraRender(callback: () => void);
  119231. /**
  119232. * An event triggered after rendering a camera
  119233. */
  119234. onAfterCameraRenderObservable: Observable<Camera>;
  119235. private _onAfterCameraRenderObserver;
  119236. /** Sets a function to be executed after rendering a camera*/
  119237. set afterCameraRender(callback: () => void);
  119238. /**
  119239. * An event triggered when active meshes evaluation is about to start
  119240. */
  119241. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119242. /**
  119243. * An event triggered when active meshes evaluation is done
  119244. */
  119245. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119246. /**
  119247. * An event triggered when particles rendering is about to start
  119248. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119249. */
  119250. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119251. /**
  119252. * An event triggered when particles rendering is done
  119253. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119254. */
  119255. onAfterParticlesRenderingObservable: Observable<Scene>;
  119256. /**
  119257. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119258. */
  119259. onDataLoadedObservable: Observable<Scene>;
  119260. /**
  119261. * An event triggered when a camera is created
  119262. */
  119263. onNewCameraAddedObservable: Observable<Camera>;
  119264. /**
  119265. * An event triggered when a camera is removed
  119266. */
  119267. onCameraRemovedObservable: Observable<Camera>;
  119268. /**
  119269. * An event triggered when a light is created
  119270. */
  119271. onNewLightAddedObservable: Observable<Light>;
  119272. /**
  119273. * An event triggered when a light is removed
  119274. */
  119275. onLightRemovedObservable: Observable<Light>;
  119276. /**
  119277. * An event triggered when a geometry is created
  119278. */
  119279. onNewGeometryAddedObservable: Observable<Geometry>;
  119280. /**
  119281. * An event triggered when a geometry is removed
  119282. */
  119283. onGeometryRemovedObservable: Observable<Geometry>;
  119284. /**
  119285. * An event triggered when a transform node is created
  119286. */
  119287. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119288. /**
  119289. * An event triggered when a transform node is removed
  119290. */
  119291. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119292. /**
  119293. * An event triggered when a mesh is created
  119294. */
  119295. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119296. /**
  119297. * An event triggered when a mesh is removed
  119298. */
  119299. onMeshRemovedObservable: Observable<AbstractMesh>;
  119300. /**
  119301. * An event triggered when a skeleton is created
  119302. */
  119303. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119304. /**
  119305. * An event triggered when a skeleton is removed
  119306. */
  119307. onSkeletonRemovedObservable: Observable<Skeleton>;
  119308. /**
  119309. * An event triggered when a material is created
  119310. */
  119311. onNewMaterialAddedObservable: Observable<Material>;
  119312. /**
  119313. * An event triggered when a material is removed
  119314. */
  119315. onMaterialRemovedObservable: Observable<Material>;
  119316. /**
  119317. * An event triggered when a texture is created
  119318. */
  119319. onNewTextureAddedObservable: Observable<BaseTexture>;
  119320. /**
  119321. * An event triggered when a texture is removed
  119322. */
  119323. onTextureRemovedObservable: Observable<BaseTexture>;
  119324. /**
  119325. * An event triggered when render targets are about to be rendered
  119326. * Can happen multiple times per frame.
  119327. */
  119328. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119329. /**
  119330. * An event triggered when render targets were rendered.
  119331. * Can happen multiple times per frame.
  119332. */
  119333. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119334. /**
  119335. * An event triggered before calculating deterministic simulation step
  119336. */
  119337. onBeforeStepObservable: Observable<Scene>;
  119338. /**
  119339. * An event triggered after calculating deterministic simulation step
  119340. */
  119341. onAfterStepObservable: Observable<Scene>;
  119342. /**
  119343. * An event triggered when the activeCamera property is updated
  119344. */
  119345. onActiveCameraChanged: Observable<Scene>;
  119346. /**
  119347. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119348. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119349. * 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)
  119350. */
  119351. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119352. /**
  119353. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119354. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119355. * 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)
  119356. */
  119357. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119358. /**
  119359. * This Observable will when a mesh has been imported into the scene.
  119360. */
  119361. onMeshImportedObservable: Observable<AbstractMesh>;
  119362. /**
  119363. * This Observable will when an animation file has been imported into the scene.
  119364. */
  119365. onAnimationFileImportedObservable: Observable<Scene>;
  119366. /**
  119367. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119368. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119369. */
  119370. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119371. /** @hidden */
  119372. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119373. /**
  119374. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119375. */
  119376. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119377. /**
  119378. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119379. */
  119380. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119381. /**
  119382. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119383. */
  119384. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119385. /** Callback called when a pointer move is detected */
  119386. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119387. /** Callback called when a pointer down is detected */
  119388. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119389. /** Callback called when a pointer up is detected */
  119390. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119391. /** Callback called when a pointer pick is detected */
  119392. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119393. /**
  119394. * 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).
  119395. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119396. */
  119397. onPrePointerObservable: Observable<PointerInfoPre>;
  119398. /**
  119399. * Observable event triggered each time an input event is received from the rendering canvas
  119400. */
  119401. onPointerObservable: Observable<PointerInfo>;
  119402. /**
  119403. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119404. */
  119405. get unTranslatedPointer(): Vector2;
  119406. /**
  119407. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119408. */
  119409. static get DragMovementThreshold(): number;
  119410. static set DragMovementThreshold(value: number);
  119411. /**
  119412. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119413. */
  119414. static get LongPressDelay(): number;
  119415. static set LongPressDelay(value: number);
  119416. /**
  119417. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119418. */
  119419. static get DoubleClickDelay(): number;
  119420. static set DoubleClickDelay(value: number);
  119421. /** If you need to check double click without raising a single click at first click, enable this flag */
  119422. static get ExclusiveDoubleClickMode(): boolean;
  119423. static set ExclusiveDoubleClickMode(value: boolean);
  119424. /** @hidden */
  119425. _mirroredCameraPosition: Nullable<Vector3>;
  119426. /**
  119427. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119428. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119429. */
  119430. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119431. /**
  119432. * Observable event triggered each time an keyboard event is received from the hosting window
  119433. */
  119434. onKeyboardObservable: Observable<KeyboardInfo>;
  119435. private _useRightHandedSystem;
  119436. /**
  119437. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119438. */
  119439. set useRightHandedSystem(value: boolean);
  119440. get useRightHandedSystem(): boolean;
  119441. private _timeAccumulator;
  119442. private _currentStepId;
  119443. private _currentInternalStep;
  119444. /**
  119445. * Sets the step Id used by deterministic lock step
  119446. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119447. * @param newStepId defines the step Id
  119448. */
  119449. setStepId(newStepId: number): void;
  119450. /**
  119451. * Gets the step Id used by deterministic lock step
  119452. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119453. * @returns the step Id
  119454. */
  119455. getStepId(): number;
  119456. /**
  119457. * Gets the internal step used by deterministic lock step
  119458. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119459. * @returns the internal step
  119460. */
  119461. getInternalStep(): number;
  119462. private _fogEnabled;
  119463. /**
  119464. * Gets or sets a boolean indicating if fog is enabled on this scene
  119465. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119466. * (Default is true)
  119467. */
  119468. set fogEnabled(value: boolean);
  119469. get fogEnabled(): boolean;
  119470. private _fogMode;
  119471. /**
  119472. * Gets or sets the fog mode to use
  119473. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119474. * | mode | value |
  119475. * | --- | --- |
  119476. * | FOGMODE_NONE | 0 |
  119477. * | FOGMODE_EXP | 1 |
  119478. * | FOGMODE_EXP2 | 2 |
  119479. * | FOGMODE_LINEAR | 3 |
  119480. */
  119481. set fogMode(value: number);
  119482. get fogMode(): number;
  119483. /**
  119484. * Gets or sets the fog color to use
  119485. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119486. * (Default is Color3(0.2, 0.2, 0.3))
  119487. */
  119488. fogColor: Color3;
  119489. /**
  119490. * Gets or sets the fog density to use
  119491. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119492. * (Default is 0.1)
  119493. */
  119494. fogDensity: number;
  119495. /**
  119496. * Gets or sets the fog start distance to use
  119497. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119498. * (Default is 0)
  119499. */
  119500. fogStart: number;
  119501. /**
  119502. * Gets or sets the fog end distance to use
  119503. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119504. * (Default is 1000)
  119505. */
  119506. fogEnd: number;
  119507. /**
  119508. * Flag indicating that the frame buffer binding is handled by another component
  119509. */
  119510. prePass: boolean;
  119511. private _shadowsEnabled;
  119512. /**
  119513. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119514. */
  119515. set shadowsEnabled(value: boolean);
  119516. get shadowsEnabled(): boolean;
  119517. private _lightsEnabled;
  119518. /**
  119519. * Gets or sets a boolean indicating if lights are enabled on this scene
  119520. */
  119521. set lightsEnabled(value: boolean);
  119522. get lightsEnabled(): boolean;
  119523. /** All of the active cameras added to this scene. */
  119524. activeCameras: Camera[];
  119525. /** @hidden */
  119526. _activeCamera: Nullable<Camera>;
  119527. /** Gets or sets the current active camera */
  119528. get activeCamera(): Nullable<Camera>;
  119529. set activeCamera(value: Nullable<Camera>);
  119530. private _defaultMaterial;
  119531. /** The default material used on meshes when no material is affected */
  119532. get defaultMaterial(): Material;
  119533. /** The default material used on meshes when no material is affected */
  119534. set defaultMaterial(value: Material);
  119535. private _texturesEnabled;
  119536. /**
  119537. * Gets or sets a boolean indicating if textures are enabled on this scene
  119538. */
  119539. set texturesEnabled(value: boolean);
  119540. get texturesEnabled(): boolean;
  119541. /**
  119542. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119543. */
  119544. physicsEnabled: boolean;
  119545. /**
  119546. * Gets or sets a boolean indicating if particles are enabled on this scene
  119547. */
  119548. particlesEnabled: boolean;
  119549. /**
  119550. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119551. */
  119552. spritesEnabled: boolean;
  119553. private _skeletonsEnabled;
  119554. /**
  119555. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119556. */
  119557. set skeletonsEnabled(value: boolean);
  119558. get skeletonsEnabled(): boolean;
  119559. /**
  119560. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119561. */
  119562. lensFlaresEnabled: boolean;
  119563. /**
  119564. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119565. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119566. */
  119567. collisionsEnabled: boolean;
  119568. private _collisionCoordinator;
  119569. /** @hidden */
  119570. get collisionCoordinator(): ICollisionCoordinator;
  119571. /**
  119572. * Defines the gravity applied to this scene (used only for collisions)
  119573. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119574. */
  119575. gravity: Vector3;
  119576. /**
  119577. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119578. */
  119579. postProcessesEnabled: boolean;
  119580. /**
  119581. * Gets the current postprocess manager
  119582. */
  119583. postProcessManager: PostProcessManager;
  119584. /**
  119585. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119586. */
  119587. renderTargetsEnabled: boolean;
  119588. /**
  119589. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119590. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119591. */
  119592. dumpNextRenderTargets: boolean;
  119593. /**
  119594. * The list of user defined render targets added to the scene
  119595. */
  119596. customRenderTargets: RenderTargetTexture[];
  119597. /**
  119598. * Defines if texture loading must be delayed
  119599. * If true, textures will only be loaded when they need to be rendered
  119600. */
  119601. useDelayedTextureLoading: boolean;
  119602. /**
  119603. * Gets the list of meshes imported to the scene through SceneLoader
  119604. */
  119605. importedMeshesFiles: String[];
  119606. /**
  119607. * Gets or sets a boolean indicating if probes are enabled on this scene
  119608. */
  119609. probesEnabled: boolean;
  119610. /**
  119611. * Gets or sets the current offline provider to use to store scene data
  119612. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119613. */
  119614. offlineProvider: IOfflineProvider;
  119615. /**
  119616. * Gets or sets the action manager associated with the scene
  119617. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119618. */
  119619. actionManager: AbstractActionManager;
  119620. private _meshesForIntersections;
  119621. /**
  119622. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119623. */
  119624. proceduralTexturesEnabled: boolean;
  119625. private _engine;
  119626. private _totalVertices;
  119627. /** @hidden */
  119628. _activeIndices: PerfCounter;
  119629. /** @hidden */
  119630. _activeParticles: PerfCounter;
  119631. /** @hidden */
  119632. _activeBones: PerfCounter;
  119633. private _animationRatio;
  119634. /** @hidden */
  119635. _animationTimeLast: number;
  119636. /** @hidden */
  119637. _animationTime: number;
  119638. /**
  119639. * Gets or sets a general scale for animation speed
  119640. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119641. */
  119642. animationTimeScale: number;
  119643. /** @hidden */
  119644. _cachedMaterial: Nullable<Material>;
  119645. /** @hidden */
  119646. _cachedEffect: Nullable<Effect>;
  119647. /** @hidden */
  119648. _cachedVisibility: Nullable<number>;
  119649. private _renderId;
  119650. private _frameId;
  119651. private _executeWhenReadyTimeoutId;
  119652. private _intermediateRendering;
  119653. private _viewUpdateFlag;
  119654. private _projectionUpdateFlag;
  119655. /** @hidden */
  119656. _toBeDisposed: Nullable<IDisposable>[];
  119657. private _activeRequests;
  119658. /** @hidden */
  119659. _pendingData: any[];
  119660. private _isDisposed;
  119661. /**
  119662. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119663. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119664. */
  119665. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119666. private _activeMeshes;
  119667. private _processedMaterials;
  119668. private _renderTargets;
  119669. /** @hidden */
  119670. _activeParticleSystems: SmartArray<IParticleSystem>;
  119671. private _activeSkeletons;
  119672. private _softwareSkinnedMeshes;
  119673. private _renderingManager;
  119674. /** @hidden */
  119675. _activeAnimatables: Animatable[];
  119676. private _transformMatrix;
  119677. private _sceneUbo;
  119678. /** @hidden */
  119679. _viewMatrix: Matrix;
  119680. private _projectionMatrix;
  119681. /** @hidden */
  119682. _forcedViewPosition: Nullable<Vector3>;
  119683. /** @hidden */
  119684. _frustumPlanes: Plane[];
  119685. /**
  119686. * Gets the list of frustum planes (built from the active camera)
  119687. */
  119688. get frustumPlanes(): Plane[];
  119689. /**
  119690. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119691. * This is useful if there are more lights that the maximum simulteanous authorized
  119692. */
  119693. requireLightSorting: boolean;
  119694. /** @hidden */
  119695. readonly useMaterialMeshMap: boolean;
  119696. /** @hidden */
  119697. readonly useClonedMeshMap: boolean;
  119698. private _externalData;
  119699. private _uid;
  119700. /**
  119701. * @hidden
  119702. * Backing store of defined scene components.
  119703. */
  119704. _components: ISceneComponent[];
  119705. /**
  119706. * @hidden
  119707. * Backing store of defined scene components.
  119708. */
  119709. _serializableComponents: ISceneSerializableComponent[];
  119710. /**
  119711. * List of components to register on the next registration step.
  119712. */
  119713. private _transientComponents;
  119714. /**
  119715. * Registers the transient components if needed.
  119716. */
  119717. private _registerTransientComponents;
  119718. /**
  119719. * @hidden
  119720. * Add a component to the scene.
  119721. * Note that the ccomponent could be registered on th next frame if this is called after
  119722. * the register component stage.
  119723. * @param component Defines the component to add to the scene
  119724. */
  119725. _addComponent(component: ISceneComponent): void;
  119726. /**
  119727. * @hidden
  119728. * Gets a component from the scene.
  119729. * @param name defines the name of the component to retrieve
  119730. * @returns the component or null if not present
  119731. */
  119732. _getComponent(name: string): Nullable<ISceneComponent>;
  119733. /**
  119734. * @hidden
  119735. * Defines the actions happening before camera updates.
  119736. */
  119737. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119738. /**
  119739. * @hidden
  119740. * Defines the actions happening before clear the canvas.
  119741. */
  119742. _beforeClearStage: Stage<SimpleStageAction>;
  119743. /**
  119744. * @hidden
  119745. * Defines the actions when collecting render targets for the frame.
  119746. */
  119747. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119748. /**
  119749. * @hidden
  119750. * Defines the actions happening for one camera in the frame.
  119751. */
  119752. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119753. /**
  119754. * @hidden
  119755. * Defines the actions happening during the per mesh ready checks.
  119756. */
  119757. _isReadyForMeshStage: Stage<MeshStageAction>;
  119758. /**
  119759. * @hidden
  119760. * Defines the actions happening before evaluate active mesh checks.
  119761. */
  119762. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119763. /**
  119764. * @hidden
  119765. * Defines the actions happening during the evaluate sub mesh checks.
  119766. */
  119767. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119768. /**
  119769. * @hidden
  119770. * Defines the actions happening during the active mesh stage.
  119771. */
  119772. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119773. /**
  119774. * @hidden
  119775. * Defines the actions happening during the per camera render target step.
  119776. */
  119777. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119778. /**
  119779. * @hidden
  119780. * Defines the actions happening just before the active camera is drawing.
  119781. */
  119782. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119783. /**
  119784. * @hidden
  119785. * Defines the actions happening just before a render target is drawing.
  119786. */
  119787. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119788. /**
  119789. * @hidden
  119790. * Defines the actions happening just before a rendering group is drawing.
  119791. */
  119792. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119793. /**
  119794. * @hidden
  119795. * Defines the actions happening just before a mesh is drawing.
  119796. */
  119797. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119798. /**
  119799. * @hidden
  119800. * Defines the actions happening just after a mesh has been drawn.
  119801. */
  119802. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119803. /**
  119804. * @hidden
  119805. * Defines the actions happening just after a rendering group has been drawn.
  119806. */
  119807. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119808. /**
  119809. * @hidden
  119810. * Defines the actions happening just after the active camera has been drawn.
  119811. */
  119812. _afterCameraDrawStage: Stage<CameraStageAction>;
  119813. /**
  119814. * @hidden
  119815. * Defines the actions happening just after a render target has been drawn.
  119816. */
  119817. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119818. /**
  119819. * @hidden
  119820. * Defines the actions happening just after rendering all cameras and computing intersections.
  119821. */
  119822. _afterRenderStage: Stage<SimpleStageAction>;
  119823. /**
  119824. * @hidden
  119825. * Defines the actions happening when a pointer move event happens.
  119826. */
  119827. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119828. /**
  119829. * @hidden
  119830. * Defines the actions happening when a pointer down event happens.
  119831. */
  119832. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119833. /**
  119834. * @hidden
  119835. * Defines the actions happening when a pointer up event happens.
  119836. */
  119837. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119838. /**
  119839. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119840. */
  119841. private geometriesByUniqueId;
  119842. /**
  119843. * Creates a new Scene
  119844. * @param engine defines the engine to use to render this scene
  119845. * @param options defines the scene options
  119846. */
  119847. constructor(engine: Engine, options?: SceneOptions);
  119848. /**
  119849. * Gets a string identifying the name of the class
  119850. * @returns "Scene" string
  119851. */
  119852. getClassName(): string;
  119853. private _defaultMeshCandidates;
  119854. /**
  119855. * @hidden
  119856. */
  119857. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119858. private _defaultSubMeshCandidates;
  119859. /**
  119860. * @hidden
  119861. */
  119862. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119863. /**
  119864. * Sets the default candidate providers for the scene.
  119865. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119866. * and getCollidingSubMeshCandidates to their default function
  119867. */
  119868. setDefaultCandidateProviders(): void;
  119869. /**
  119870. * Gets the mesh that is currently under the pointer
  119871. */
  119872. get meshUnderPointer(): Nullable<AbstractMesh>;
  119873. /**
  119874. * Gets or sets the current on-screen X position of the pointer
  119875. */
  119876. get pointerX(): number;
  119877. set pointerX(value: number);
  119878. /**
  119879. * Gets or sets the current on-screen Y position of the pointer
  119880. */
  119881. get pointerY(): number;
  119882. set pointerY(value: number);
  119883. /**
  119884. * Gets the cached material (ie. the latest rendered one)
  119885. * @returns the cached material
  119886. */
  119887. getCachedMaterial(): Nullable<Material>;
  119888. /**
  119889. * Gets the cached effect (ie. the latest rendered one)
  119890. * @returns the cached effect
  119891. */
  119892. getCachedEffect(): Nullable<Effect>;
  119893. /**
  119894. * Gets the cached visibility state (ie. the latest rendered one)
  119895. * @returns the cached visibility state
  119896. */
  119897. getCachedVisibility(): Nullable<number>;
  119898. /**
  119899. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119900. * @param material defines the current material
  119901. * @param effect defines the current effect
  119902. * @param visibility defines the current visibility state
  119903. * @returns true if one parameter is not cached
  119904. */
  119905. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119906. /**
  119907. * Gets the engine associated with the scene
  119908. * @returns an Engine
  119909. */
  119910. getEngine(): Engine;
  119911. /**
  119912. * Gets the total number of vertices rendered per frame
  119913. * @returns the total number of vertices rendered per frame
  119914. */
  119915. getTotalVertices(): number;
  119916. /**
  119917. * Gets the performance counter for total vertices
  119918. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119919. */
  119920. get totalVerticesPerfCounter(): PerfCounter;
  119921. /**
  119922. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119923. * @returns the total number of active indices rendered per frame
  119924. */
  119925. getActiveIndices(): number;
  119926. /**
  119927. * Gets the performance counter for active indices
  119928. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119929. */
  119930. get totalActiveIndicesPerfCounter(): PerfCounter;
  119931. /**
  119932. * Gets the total number of active particles rendered per frame
  119933. * @returns the total number of active particles rendered per frame
  119934. */
  119935. getActiveParticles(): number;
  119936. /**
  119937. * Gets the performance counter for active particles
  119938. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119939. */
  119940. get activeParticlesPerfCounter(): PerfCounter;
  119941. /**
  119942. * Gets the total number of active bones rendered per frame
  119943. * @returns the total number of active bones rendered per frame
  119944. */
  119945. getActiveBones(): number;
  119946. /**
  119947. * Gets the performance counter for active bones
  119948. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119949. */
  119950. get activeBonesPerfCounter(): PerfCounter;
  119951. /**
  119952. * Gets the array of active meshes
  119953. * @returns an array of AbstractMesh
  119954. */
  119955. getActiveMeshes(): SmartArray<AbstractMesh>;
  119956. /**
  119957. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119958. * @returns a number
  119959. */
  119960. getAnimationRatio(): number;
  119961. /**
  119962. * Gets an unique Id for the current render phase
  119963. * @returns a number
  119964. */
  119965. getRenderId(): number;
  119966. /**
  119967. * Gets an unique Id for the current frame
  119968. * @returns a number
  119969. */
  119970. getFrameId(): number;
  119971. /** Call this function if you want to manually increment the render Id*/
  119972. incrementRenderId(): void;
  119973. private _createUbo;
  119974. /**
  119975. * Use this method to simulate a pointer move on a mesh
  119976. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119977. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119978. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119979. * @returns the current scene
  119980. */
  119981. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119982. /**
  119983. * Use this method to simulate a pointer down on a mesh
  119984. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119985. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119986. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119987. * @returns the current scene
  119988. */
  119989. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119990. /**
  119991. * Use this method to simulate a pointer up on a mesh
  119992. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119993. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119994. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119995. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119996. * @returns the current scene
  119997. */
  119998. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119999. /**
  120000. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  120001. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  120002. * @returns true if the pointer was captured
  120003. */
  120004. isPointerCaptured(pointerId?: number): boolean;
  120005. /**
  120006. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  120007. * @param attachUp defines if you want to attach events to pointerup
  120008. * @param attachDown defines if you want to attach events to pointerdown
  120009. * @param attachMove defines if you want to attach events to pointermove
  120010. */
  120011. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  120012. /** Detaches all event handlers*/
  120013. detachControl(): void;
  120014. /**
  120015. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120016. * Delay loaded resources are not taking in account
  120017. * @return true if all required resources are ready
  120018. */
  120019. isReady(): boolean;
  120020. /** Resets all cached information relative to material (including effect and visibility) */
  120021. resetCachedMaterial(): void;
  120022. /**
  120023. * Registers a function to be called before every frame render
  120024. * @param func defines the function to register
  120025. */
  120026. registerBeforeRender(func: () => void): void;
  120027. /**
  120028. * Unregisters a function called before every frame render
  120029. * @param func defines the function to unregister
  120030. */
  120031. unregisterBeforeRender(func: () => void): void;
  120032. /**
  120033. * Registers a function to be called after every frame render
  120034. * @param func defines the function to register
  120035. */
  120036. registerAfterRender(func: () => void): void;
  120037. /**
  120038. * Unregisters a function called after every frame render
  120039. * @param func defines the function to unregister
  120040. */
  120041. unregisterAfterRender(func: () => void): void;
  120042. private _executeOnceBeforeRender;
  120043. /**
  120044. * The provided function will run before render once and will be disposed afterwards.
  120045. * A timeout delay can be provided so that the function will be executed in N ms.
  120046. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120047. * @param func The function to be executed.
  120048. * @param timeout optional delay in ms
  120049. */
  120050. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120051. /** @hidden */
  120052. _addPendingData(data: any): void;
  120053. /** @hidden */
  120054. _removePendingData(data: any): void;
  120055. /**
  120056. * Returns the number of items waiting to be loaded
  120057. * @returns the number of items waiting to be loaded
  120058. */
  120059. getWaitingItemsCount(): number;
  120060. /**
  120061. * Returns a boolean indicating if the scene is still loading data
  120062. */
  120063. get isLoading(): boolean;
  120064. /**
  120065. * Registers a function to be executed when the scene is ready
  120066. * @param {Function} func - the function to be executed
  120067. */
  120068. executeWhenReady(func: () => void): void;
  120069. /**
  120070. * Returns a promise that resolves when the scene is ready
  120071. * @returns A promise that resolves when the scene is ready
  120072. */
  120073. whenReadyAsync(): Promise<void>;
  120074. /** @hidden */
  120075. _checkIsReady(): void;
  120076. /**
  120077. * Gets all animatable attached to the scene
  120078. */
  120079. get animatables(): Animatable[];
  120080. /**
  120081. * Resets the last animation time frame.
  120082. * Useful to override when animations start running when loading a scene for the first time.
  120083. */
  120084. resetLastAnimationTimeFrame(): void;
  120085. /**
  120086. * Gets the current view matrix
  120087. * @returns a Matrix
  120088. */
  120089. getViewMatrix(): Matrix;
  120090. /**
  120091. * Gets the current projection matrix
  120092. * @returns a Matrix
  120093. */
  120094. getProjectionMatrix(): Matrix;
  120095. /**
  120096. * Gets the current transform matrix
  120097. * @returns a Matrix made of View * Projection
  120098. */
  120099. getTransformMatrix(): Matrix;
  120100. /**
  120101. * Sets the current transform matrix
  120102. * @param viewL defines the View matrix to use
  120103. * @param projectionL defines the Projection matrix to use
  120104. * @param viewR defines the right View matrix to use (if provided)
  120105. * @param projectionR defines the right Projection matrix to use (if provided)
  120106. */
  120107. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120108. /**
  120109. * Gets the uniform buffer used to store scene data
  120110. * @returns a UniformBuffer
  120111. */
  120112. getSceneUniformBuffer(): UniformBuffer;
  120113. /**
  120114. * Gets an unique (relatively to the current scene) Id
  120115. * @returns an unique number for the scene
  120116. */
  120117. getUniqueId(): number;
  120118. /**
  120119. * Add a mesh to the list of scene's meshes
  120120. * @param newMesh defines the mesh to add
  120121. * @param recursive if all child meshes should also be added to the scene
  120122. */
  120123. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120124. /**
  120125. * Remove a mesh for the list of scene's meshes
  120126. * @param toRemove defines the mesh to remove
  120127. * @param recursive if all child meshes should also be removed from the scene
  120128. * @returns the index where the mesh was in the mesh list
  120129. */
  120130. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120131. /**
  120132. * Add a transform node to the list of scene's transform nodes
  120133. * @param newTransformNode defines the transform node to add
  120134. */
  120135. addTransformNode(newTransformNode: TransformNode): void;
  120136. /**
  120137. * Remove a transform node for the list of scene's transform nodes
  120138. * @param toRemove defines the transform node to remove
  120139. * @returns the index where the transform node was in the transform node list
  120140. */
  120141. removeTransformNode(toRemove: TransformNode): number;
  120142. /**
  120143. * Remove a skeleton for the list of scene's skeletons
  120144. * @param toRemove defines the skeleton to remove
  120145. * @returns the index where the skeleton was in the skeleton list
  120146. */
  120147. removeSkeleton(toRemove: Skeleton): number;
  120148. /**
  120149. * Remove a morph target for the list of scene's morph targets
  120150. * @param toRemove defines the morph target to remove
  120151. * @returns the index where the morph target was in the morph target list
  120152. */
  120153. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120154. /**
  120155. * Remove a light for the list of scene's lights
  120156. * @param toRemove defines the light to remove
  120157. * @returns the index where the light was in the light list
  120158. */
  120159. removeLight(toRemove: Light): number;
  120160. /**
  120161. * Remove a camera for the list of scene's cameras
  120162. * @param toRemove defines the camera to remove
  120163. * @returns the index where the camera was in the camera list
  120164. */
  120165. removeCamera(toRemove: Camera): number;
  120166. /**
  120167. * Remove a particle system for the list of scene's particle systems
  120168. * @param toRemove defines the particle system to remove
  120169. * @returns the index where the particle system was in the particle system list
  120170. */
  120171. removeParticleSystem(toRemove: IParticleSystem): number;
  120172. /**
  120173. * Remove a animation for the list of scene's animations
  120174. * @param toRemove defines the animation to remove
  120175. * @returns the index where the animation was in the animation list
  120176. */
  120177. removeAnimation(toRemove: Animation): number;
  120178. /**
  120179. * Will stop the animation of the given target
  120180. * @param target - the target
  120181. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120182. * @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)
  120183. */
  120184. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120185. /**
  120186. * Removes the given animation group from this scene.
  120187. * @param toRemove The animation group to remove
  120188. * @returns The index of the removed animation group
  120189. */
  120190. removeAnimationGroup(toRemove: AnimationGroup): number;
  120191. /**
  120192. * Removes the given multi-material from this scene.
  120193. * @param toRemove The multi-material to remove
  120194. * @returns The index of the removed multi-material
  120195. */
  120196. removeMultiMaterial(toRemove: MultiMaterial): number;
  120197. /**
  120198. * Removes the given material from this scene.
  120199. * @param toRemove The material to remove
  120200. * @returns The index of the removed material
  120201. */
  120202. removeMaterial(toRemove: Material): number;
  120203. /**
  120204. * Removes the given action manager from this scene.
  120205. * @param toRemove The action manager to remove
  120206. * @returns The index of the removed action manager
  120207. */
  120208. removeActionManager(toRemove: AbstractActionManager): number;
  120209. /**
  120210. * Removes the given texture from this scene.
  120211. * @param toRemove The texture to remove
  120212. * @returns The index of the removed texture
  120213. */
  120214. removeTexture(toRemove: BaseTexture): number;
  120215. /**
  120216. * Adds the given light to this scene
  120217. * @param newLight The light to add
  120218. */
  120219. addLight(newLight: Light): void;
  120220. /**
  120221. * Sorts the list list based on light priorities
  120222. */
  120223. sortLightsByPriority(): void;
  120224. /**
  120225. * Adds the given camera to this scene
  120226. * @param newCamera The camera to add
  120227. */
  120228. addCamera(newCamera: Camera): void;
  120229. /**
  120230. * Adds the given skeleton to this scene
  120231. * @param newSkeleton The skeleton to add
  120232. */
  120233. addSkeleton(newSkeleton: Skeleton): void;
  120234. /**
  120235. * Adds the given particle system to this scene
  120236. * @param newParticleSystem The particle system to add
  120237. */
  120238. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120239. /**
  120240. * Adds the given animation to this scene
  120241. * @param newAnimation The animation to add
  120242. */
  120243. addAnimation(newAnimation: Animation): void;
  120244. /**
  120245. * Adds the given animation group to this scene.
  120246. * @param newAnimationGroup The animation group to add
  120247. */
  120248. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120249. /**
  120250. * Adds the given multi-material to this scene
  120251. * @param newMultiMaterial The multi-material to add
  120252. */
  120253. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120254. /**
  120255. * Adds the given material to this scene
  120256. * @param newMaterial The material to add
  120257. */
  120258. addMaterial(newMaterial: Material): void;
  120259. /**
  120260. * Adds the given morph target to this scene
  120261. * @param newMorphTargetManager The morph target to add
  120262. */
  120263. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120264. /**
  120265. * Adds the given geometry to this scene
  120266. * @param newGeometry The geometry to add
  120267. */
  120268. addGeometry(newGeometry: Geometry): void;
  120269. /**
  120270. * Adds the given action manager to this scene
  120271. * @param newActionManager The action manager to add
  120272. */
  120273. addActionManager(newActionManager: AbstractActionManager): void;
  120274. /**
  120275. * Adds the given texture to this scene.
  120276. * @param newTexture The texture to add
  120277. */
  120278. addTexture(newTexture: BaseTexture): void;
  120279. /**
  120280. * Switch active camera
  120281. * @param newCamera defines the new active camera
  120282. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120283. */
  120284. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120285. /**
  120286. * sets the active camera of the scene using its ID
  120287. * @param id defines the camera's ID
  120288. * @return the new active camera or null if none found.
  120289. */
  120290. setActiveCameraByID(id: string): Nullable<Camera>;
  120291. /**
  120292. * sets the active camera of the scene using its name
  120293. * @param name defines the camera's name
  120294. * @returns the new active camera or null if none found.
  120295. */
  120296. setActiveCameraByName(name: string): Nullable<Camera>;
  120297. /**
  120298. * get an animation group using its name
  120299. * @param name defines the material's name
  120300. * @return the animation group or null if none found.
  120301. */
  120302. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120303. /**
  120304. * Get a material using its unique id
  120305. * @param uniqueId defines the material's unique id
  120306. * @return the material or null if none found.
  120307. */
  120308. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120309. /**
  120310. * get a material using its id
  120311. * @param id defines the material's ID
  120312. * @return the material or null if none found.
  120313. */
  120314. getMaterialByID(id: string): Nullable<Material>;
  120315. /**
  120316. * Gets a the last added material using a given id
  120317. * @param id defines the material's ID
  120318. * @return the last material with the given id or null if none found.
  120319. */
  120320. getLastMaterialByID(id: string): Nullable<Material>;
  120321. /**
  120322. * Gets a material using its name
  120323. * @param name defines the material's name
  120324. * @return the material or null if none found.
  120325. */
  120326. getMaterialByName(name: string): Nullable<Material>;
  120327. /**
  120328. * Get a texture using its unique id
  120329. * @param uniqueId defines the texture's unique id
  120330. * @return the texture or null if none found.
  120331. */
  120332. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120333. /**
  120334. * Gets a camera using its id
  120335. * @param id defines the id to look for
  120336. * @returns the camera or null if not found
  120337. */
  120338. getCameraByID(id: string): Nullable<Camera>;
  120339. /**
  120340. * Gets a camera using its unique id
  120341. * @param uniqueId defines the unique id to look for
  120342. * @returns the camera or null if not found
  120343. */
  120344. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120345. /**
  120346. * Gets a camera using its name
  120347. * @param name defines the camera's name
  120348. * @return the camera or null if none found.
  120349. */
  120350. getCameraByName(name: string): Nullable<Camera>;
  120351. /**
  120352. * Gets a bone using its id
  120353. * @param id defines the bone's id
  120354. * @return the bone or null if not found
  120355. */
  120356. getBoneByID(id: string): Nullable<Bone>;
  120357. /**
  120358. * Gets a bone using its id
  120359. * @param name defines the bone's name
  120360. * @return the bone or null if not found
  120361. */
  120362. getBoneByName(name: string): Nullable<Bone>;
  120363. /**
  120364. * Gets a light node using its name
  120365. * @param name defines the the light's name
  120366. * @return the light or null if none found.
  120367. */
  120368. getLightByName(name: string): Nullable<Light>;
  120369. /**
  120370. * Gets a light node using its id
  120371. * @param id defines the light's id
  120372. * @return the light or null if none found.
  120373. */
  120374. getLightByID(id: string): Nullable<Light>;
  120375. /**
  120376. * Gets a light node using its scene-generated unique ID
  120377. * @param uniqueId defines the light's unique id
  120378. * @return the light or null if none found.
  120379. */
  120380. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120381. /**
  120382. * Gets a particle system by id
  120383. * @param id defines the particle system id
  120384. * @return the corresponding system or null if none found
  120385. */
  120386. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120387. /**
  120388. * Gets a geometry using its ID
  120389. * @param id defines the geometry's id
  120390. * @return the geometry or null if none found.
  120391. */
  120392. getGeometryByID(id: string): Nullable<Geometry>;
  120393. private _getGeometryByUniqueID;
  120394. /**
  120395. * Add a new geometry to this scene
  120396. * @param geometry defines the geometry to be added to the scene.
  120397. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120398. * @return a boolean defining if the geometry was added or not
  120399. */
  120400. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120401. /**
  120402. * Removes an existing geometry
  120403. * @param geometry defines the geometry to be removed from the scene
  120404. * @return a boolean defining if the geometry was removed or not
  120405. */
  120406. removeGeometry(geometry: Geometry): boolean;
  120407. /**
  120408. * Gets the list of geometries attached to the scene
  120409. * @returns an array of Geometry
  120410. */
  120411. getGeometries(): Geometry[];
  120412. /**
  120413. * Gets the first added mesh found of a given ID
  120414. * @param id defines the id to search for
  120415. * @return the mesh found or null if not found at all
  120416. */
  120417. getMeshByID(id: string): Nullable<AbstractMesh>;
  120418. /**
  120419. * Gets a list of meshes using their id
  120420. * @param id defines the id to search for
  120421. * @returns a list of meshes
  120422. */
  120423. getMeshesByID(id: string): Array<AbstractMesh>;
  120424. /**
  120425. * Gets the first added transform node found of a given ID
  120426. * @param id defines the id to search for
  120427. * @return the found transform node or null if not found at all.
  120428. */
  120429. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120430. /**
  120431. * Gets a transform node with its auto-generated unique id
  120432. * @param uniqueId efines the unique id to search for
  120433. * @return the found transform node or null if not found at all.
  120434. */
  120435. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120436. /**
  120437. * Gets a list of transform nodes using their id
  120438. * @param id defines the id to search for
  120439. * @returns a list of transform nodes
  120440. */
  120441. getTransformNodesByID(id: string): Array<TransformNode>;
  120442. /**
  120443. * Gets a mesh with its auto-generated unique id
  120444. * @param uniqueId defines the unique id to search for
  120445. * @return the found mesh or null if not found at all.
  120446. */
  120447. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120448. /**
  120449. * Gets a the last added mesh using a given id
  120450. * @param id defines the id to search for
  120451. * @return the found mesh or null if not found at all.
  120452. */
  120453. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120454. /**
  120455. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120456. * @param id defines the id to search for
  120457. * @return the found node or null if not found at all
  120458. */
  120459. getLastEntryByID(id: string): Nullable<Node>;
  120460. /**
  120461. * Gets a node (Mesh, Camera, Light) using a given id
  120462. * @param id defines the id to search for
  120463. * @return the found node or null if not found at all
  120464. */
  120465. getNodeByID(id: string): Nullable<Node>;
  120466. /**
  120467. * Gets a node (Mesh, Camera, Light) using a given name
  120468. * @param name defines the name to search for
  120469. * @return the found node or null if not found at all.
  120470. */
  120471. getNodeByName(name: string): Nullable<Node>;
  120472. /**
  120473. * Gets a mesh using a given name
  120474. * @param name defines the name to search for
  120475. * @return the found mesh or null if not found at all.
  120476. */
  120477. getMeshByName(name: string): Nullable<AbstractMesh>;
  120478. /**
  120479. * Gets a transform node using a given name
  120480. * @param name defines the name to search for
  120481. * @return the found transform node or null if not found at all.
  120482. */
  120483. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120484. /**
  120485. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120486. * @param id defines the id to search for
  120487. * @return the found skeleton or null if not found at all.
  120488. */
  120489. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120490. /**
  120491. * Gets a skeleton using a given auto generated unique id
  120492. * @param uniqueId defines the unique id to search for
  120493. * @return the found skeleton or null if not found at all.
  120494. */
  120495. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120496. /**
  120497. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120498. * @param id defines the id to search for
  120499. * @return the found skeleton or null if not found at all.
  120500. */
  120501. getSkeletonById(id: string): Nullable<Skeleton>;
  120502. /**
  120503. * Gets a skeleton using a given name
  120504. * @param name defines the name to search for
  120505. * @return the found skeleton or null if not found at all.
  120506. */
  120507. getSkeletonByName(name: string): Nullable<Skeleton>;
  120508. /**
  120509. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120510. * @param id defines the id to search for
  120511. * @return the found morph target manager or null if not found at all.
  120512. */
  120513. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120514. /**
  120515. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120516. * @param id defines the id to search for
  120517. * @return the found morph target or null if not found at all.
  120518. */
  120519. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120520. /**
  120521. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120522. * @param name defines the name to search for
  120523. * @return the found morph target or null if not found at all.
  120524. */
  120525. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120526. /**
  120527. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120528. * @param name defines the name to search for
  120529. * @return the found post process or null if not found at all.
  120530. */
  120531. getPostProcessByName(name: string): Nullable<PostProcess>;
  120532. /**
  120533. * Gets a boolean indicating if the given mesh is active
  120534. * @param mesh defines the mesh to look for
  120535. * @returns true if the mesh is in the active list
  120536. */
  120537. isActiveMesh(mesh: AbstractMesh): boolean;
  120538. /**
  120539. * Return a unique id as a string which can serve as an identifier for the scene
  120540. */
  120541. get uid(): string;
  120542. /**
  120543. * Add an externaly attached data from its key.
  120544. * This method call will fail and return false, if such key already exists.
  120545. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120546. * @param key the unique key that identifies the data
  120547. * @param data the data object to associate to the key for this Engine instance
  120548. * @return true if no such key were already present and the data was added successfully, false otherwise
  120549. */
  120550. addExternalData<T>(key: string, data: T): boolean;
  120551. /**
  120552. * Get an externaly attached data from its key
  120553. * @param key the unique key that identifies the data
  120554. * @return the associated data, if present (can be null), or undefined if not present
  120555. */
  120556. getExternalData<T>(key: string): Nullable<T>;
  120557. /**
  120558. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120559. * @param key the unique key that identifies the data
  120560. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120561. * @return the associated data, can be null if the factory returned null.
  120562. */
  120563. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120564. /**
  120565. * Remove an externaly attached data from the Engine instance
  120566. * @param key the unique key that identifies the data
  120567. * @return true if the data was successfully removed, false if it doesn't exist
  120568. */
  120569. removeExternalData(key: string): boolean;
  120570. private _evaluateSubMesh;
  120571. /**
  120572. * Clear the processed materials smart array preventing retention point in material dispose.
  120573. */
  120574. freeProcessedMaterials(): void;
  120575. private _preventFreeActiveMeshesAndRenderingGroups;
  120576. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120577. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120578. * when disposing several meshes in a row or a hierarchy of meshes.
  120579. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120580. */
  120581. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120582. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120583. /**
  120584. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120585. */
  120586. freeActiveMeshes(): void;
  120587. /**
  120588. * Clear the info related to rendering groups preventing retention points during dispose.
  120589. */
  120590. freeRenderingGroups(): void;
  120591. /** @hidden */
  120592. _isInIntermediateRendering(): boolean;
  120593. /**
  120594. * Lambda returning the list of potentially active meshes.
  120595. */
  120596. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120597. /**
  120598. * Lambda returning the list of potentially active sub meshes.
  120599. */
  120600. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120601. /**
  120602. * Lambda returning the list of potentially intersecting sub meshes.
  120603. */
  120604. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120605. /**
  120606. * Lambda returning the list of potentially colliding sub meshes.
  120607. */
  120608. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120609. private _activeMeshesFrozen;
  120610. private _skipEvaluateActiveMeshesCompletely;
  120611. /**
  120612. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120613. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120614. * @returns the current scene
  120615. */
  120616. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120617. /**
  120618. * Use this function to restart evaluating active meshes on every frame
  120619. * @returns the current scene
  120620. */
  120621. unfreezeActiveMeshes(): Scene;
  120622. private _evaluateActiveMeshes;
  120623. private _activeMesh;
  120624. /**
  120625. * Update the transform matrix to update from the current active camera
  120626. * @param force defines a boolean used to force the update even if cache is up to date
  120627. */
  120628. updateTransformMatrix(force?: boolean): void;
  120629. private _bindFrameBuffer;
  120630. /** @hidden */
  120631. _allowPostProcessClearColor: boolean;
  120632. /** @hidden */
  120633. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120634. private _processSubCameras;
  120635. private _checkIntersections;
  120636. /** @hidden */
  120637. _advancePhysicsEngineStep(step: number): void;
  120638. /**
  120639. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120640. */
  120641. getDeterministicFrameTime: () => number;
  120642. /** @hidden */
  120643. _animate(): void;
  120644. /** Execute all animations (for a frame) */
  120645. animate(): void;
  120646. /**
  120647. * Render the scene
  120648. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120649. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120650. */
  120651. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120652. /**
  120653. * Freeze all materials
  120654. * A frozen material will not be updatable but should be faster to render
  120655. */
  120656. freezeMaterials(): void;
  120657. /**
  120658. * Unfreeze all materials
  120659. * A frozen material will not be updatable but should be faster to render
  120660. */
  120661. unfreezeMaterials(): void;
  120662. /**
  120663. * Releases all held ressources
  120664. */
  120665. dispose(): void;
  120666. /**
  120667. * Gets if the scene is already disposed
  120668. */
  120669. get isDisposed(): boolean;
  120670. /**
  120671. * Call this function to reduce memory footprint of the scene.
  120672. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120673. */
  120674. clearCachedVertexData(): void;
  120675. /**
  120676. * This function will remove the local cached buffer data from texture.
  120677. * It will save memory but will prevent the texture from being rebuilt
  120678. */
  120679. cleanCachedTextureBuffer(): void;
  120680. /**
  120681. * Get the world extend vectors with an optional filter
  120682. *
  120683. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120684. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120685. */
  120686. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120687. min: Vector3;
  120688. max: Vector3;
  120689. };
  120690. /**
  120691. * Creates a ray that can be used to pick in the scene
  120692. * @param x defines the x coordinate of the origin (on-screen)
  120693. * @param y defines the y coordinate of the origin (on-screen)
  120694. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120695. * @param camera defines the camera to use for the picking
  120696. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120697. * @returns a Ray
  120698. */
  120699. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120700. /**
  120701. * Creates a ray that can be used to pick in the scene
  120702. * @param x defines the x coordinate of the origin (on-screen)
  120703. * @param y defines the y coordinate of the origin (on-screen)
  120704. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120705. * @param result defines the ray where to store the picking ray
  120706. * @param camera defines the camera to use for the picking
  120707. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120708. * @returns the current scene
  120709. */
  120710. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120711. /**
  120712. * Creates a ray that can be used to pick in the scene
  120713. * @param x defines the x coordinate of the origin (on-screen)
  120714. * @param y defines the y coordinate of the origin (on-screen)
  120715. * @param camera defines the camera to use for the picking
  120716. * @returns a Ray
  120717. */
  120718. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120719. /**
  120720. * Creates a ray that can be used to pick in the scene
  120721. * @param x defines the x coordinate of the origin (on-screen)
  120722. * @param y defines the y coordinate of the origin (on-screen)
  120723. * @param result defines the ray where to store the picking ray
  120724. * @param camera defines the camera to use for the picking
  120725. * @returns the current scene
  120726. */
  120727. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120728. /** Launch a ray to try to pick a mesh in the scene
  120729. * @param x position on screen
  120730. * @param y position on screen
  120731. * @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
  120732. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120733. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120734. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120735. * @returns a PickingInfo
  120736. */
  120737. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120738. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120739. * @param x position on screen
  120740. * @param y position on screen
  120741. * @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
  120742. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120743. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120744. * @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)
  120745. */
  120746. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120747. /** Use the given ray to pick a mesh in the scene
  120748. * @param ray The ray to use to pick meshes
  120749. * @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
  120750. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120751. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120752. * @returns a PickingInfo
  120753. */
  120754. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120755. /**
  120756. * Launch a ray to try to pick a mesh in the scene
  120757. * @param x X position on screen
  120758. * @param y Y position on screen
  120759. * @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
  120760. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120761. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120762. * @returns an array of PickingInfo
  120763. */
  120764. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120765. /**
  120766. * Launch a ray to try to pick a mesh in the scene
  120767. * @param ray Ray to use
  120768. * @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
  120769. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120770. * @returns an array of PickingInfo
  120771. */
  120772. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120773. /**
  120774. * Force the value of meshUnderPointer
  120775. * @param mesh defines the mesh to use
  120776. * @param pointerId optional pointer id when using more than one pointer
  120777. */
  120778. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  120779. /**
  120780. * Gets the mesh under the pointer
  120781. * @returns a Mesh or null if no mesh is under the pointer
  120782. */
  120783. getPointerOverMesh(): Nullable<AbstractMesh>;
  120784. /** @hidden */
  120785. _rebuildGeometries(): void;
  120786. /** @hidden */
  120787. _rebuildTextures(): void;
  120788. private _getByTags;
  120789. /**
  120790. * Get a list of meshes by tags
  120791. * @param tagsQuery defines the tags query to use
  120792. * @param forEach defines a predicate used to filter results
  120793. * @returns an array of Mesh
  120794. */
  120795. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120796. /**
  120797. * Get a list of cameras by tags
  120798. * @param tagsQuery defines the tags query to use
  120799. * @param forEach defines a predicate used to filter results
  120800. * @returns an array of Camera
  120801. */
  120802. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120803. /**
  120804. * Get a list of lights by tags
  120805. * @param tagsQuery defines the tags query to use
  120806. * @param forEach defines a predicate used to filter results
  120807. * @returns an array of Light
  120808. */
  120809. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120810. /**
  120811. * Get a list of materials by tags
  120812. * @param tagsQuery defines the tags query to use
  120813. * @param forEach defines a predicate used to filter results
  120814. * @returns an array of Material
  120815. */
  120816. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120817. /**
  120818. * Get a list of transform nodes by tags
  120819. * @param tagsQuery defines the tags query to use
  120820. * @param forEach defines a predicate used to filter results
  120821. * @returns an array of TransformNode
  120822. */
  120823. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120824. /**
  120825. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120826. * This allowed control for front to back rendering or reversly depending of the special needs.
  120827. *
  120828. * @param renderingGroupId The rendering group id corresponding to its index
  120829. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120830. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120831. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120832. */
  120833. 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;
  120834. /**
  120835. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120836. *
  120837. * @param renderingGroupId The rendering group id corresponding to its index
  120838. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120839. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120840. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120841. */
  120842. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120843. /**
  120844. * Gets the current auto clear configuration for one rendering group of the rendering
  120845. * manager.
  120846. * @param index the rendering group index to get the information for
  120847. * @returns The auto clear setup for the requested rendering group
  120848. */
  120849. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120850. private _blockMaterialDirtyMechanism;
  120851. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120852. get blockMaterialDirtyMechanism(): boolean;
  120853. set blockMaterialDirtyMechanism(value: boolean);
  120854. /**
  120855. * Will flag all materials as dirty to trigger new shader compilation
  120856. * @param flag defines the flag used to specify which material part must be marked as dirty
  120857. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120858. */
  120859. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120860. /** @hidden */
  120861. _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;
  120862. /** @hidden */
  120863. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120864. /** @hidden */
  120865. _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;
  120866. /** @hidden */
  120867. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120868. /** @hidden */
  120869. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120870. /** @hidden */
  120871. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120872. }
  120873. }
  120874. declare module BABYLON {
  120875. /**
  120876. * Set of assets to keep when moving a scene into an asset container.
  120877. */
  120878. export class KeepAssets extends AbstractScene {
  120879. }
  120880. /**
  120881. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120882. */
  120883. export class InstantiatedEntries {
  120884. /**
  120885. * List of new root nodes (eg. nodes with no parent)
  120886. */
  120887. rootNodes: TransformNode[];
  120888. /**
  120889. * List of new skeletons
  120890. */
  120891. skeletons: Skeleton[];
  120892. /**
  120893. * List of new animation groups
  120894. */
  120895. animationGroups: AnimationGroup[];
  120896. }
  120897. /**
  120898. * Container with a set of assets that can be added or removed from a scene.
  120899. */
  120900. export class AssetContainer extends AbstractScene {
  120901. private _wasAddedToScene;
  120902. /**
  120903. * The scene the AssetContainer belongs to.
  120904. */
  120905. scene: Scene;
  120906. /**
  120907. * Instantiates an AssetContainer.
  120908. * @param scene The scene the AssetContainer belongs to.
  120909. */
  120910. constructor(scene: Scene);
  120911. /**
  120912. * Instantiate or clone all meshes and add the new ones to the scene.
  120913. * Skeletons and animation groups will all be cloned
  120914. * @param nameFunction defines an optional function used to get new names for clones
  120915. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120916. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120917. */
  120918. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120919. /**
  120920. * Adds all the assets from the container to the scene.
  120921. */
  120922. addAllToScene(): void;
  120923. /**
  120924. * Removes all the assets in the container from the scene
  120925. */
  120926. removeAllFromScene(): void;
  120927. /**
  120928. * Disposes all the assets in the container
  120929. */
  120930. dispose(): void;
  120931. private _moveAssets;
  120932. /**
  120933. * Removes all the assets contained in the scene and adds them to the container.
  120934. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120935. */
  120936. moveAllFromScene(keepAssets?: KeepAssets): void;
  120937. /**
  120938. * 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.
  120939. * @returns the root mesh
  120940. */
  120941. createRootMesh(): Mesh;
  120942. /**
  120943. * Merge animations (direct and animation groups) from this asset container into a scene
  120944. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120945. * @param animatables set of animatables to retarget to a node from the scene
  120946. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120947. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120948. */
  120949. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120950. }
  120951. }
  120952. declare module BABYLON {
  120953. /**
  120954. * Defines how the parser contract is defined.
  120955. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120956. */
  120957. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120958. /**
  120959. * Defines how the individual parser contract is defined.
  120960. * These parser can parse an individual asset
  120961. */
  120962. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120963. /**
  120964. * Base class of the scene acting as a container for the different elements composing a scene.
  120965. * This class is dynamically extended by the different components of the scene increasing
  120966. * flexibility and reducing coupling
  120967. */
  120968. export abstract class AbstractScene {
  120969. /**
  120970. * Stores the list of available parsers in the application.
  120971. */
  120972. private static _BabylonFileParsers;
  120973. /**
  120974. * Stores the list of available individual parsers in the application.
  120975. */
  120976. private static _IndividualBabylonFileParsers;
  120977. /**
  120978. * Adds a parser in the list of available ones
  120979. * @param name Defines the name of the parser
  120980. * @param parser Defines the parser to add
  120981. */
  120982. static AddParser(name: string, parser: BabylonFileParser): void;
  120983. /**
  120984. * Gets a general parser from the list of avaialble ones
  120985. * @param name Defines the name of the parser
  120986. * @returns the requested parser or null
  120987. */
  120988. static GetParser(name: string): Nullable<BabylonFileParser>;
  120989. /**
  120990. * Adds n individual parser in the list of available ones
  120991. * @param name Defines the name of the parser
  120992. * @param parser Defines the parser to add
  120993. */
  120994. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120995. /**
  120996. * Gets an individual parser from the list of avaialble ones
  120997. * @param name Defines the name of the parser
  120998. * @returns the requested parser or null
  120999. */
  121000. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  121001. /**
  121002. * Parser json data and populate both a scene and its associated container object
  121003. * @param jsonData Defines the data to parse
  121004. * @param scene Defines the scene to parse the data for
  121005. * @param container Defines the container attached to the parsing sequence
  121006. * @param rootUrl Defines the root url of the data
  121007. */
  121008. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  121009. /**
  121010. * Gets the list of root nodes (ie. nodes with no parent)
  121011. */
  121012. rootNodes: Node[];
  121013. /** All of the cameras added to this scene
  121014. * @see https://doc.babylonjs.com/babylon101/cameras
  121015. */
  121016. cameras: Camera[];
  121017. /**
  121018. * All of the lights added to this scene
  121019. * @see https://doc.babylonjs.com/babylon101/lights
  121020. */
  121021. lights: Light[];
  121022. /**
  121023. * All of the (abstract) meshes added to this scene
  121024. */
  121025. meshes: AbstractMesh[];
  121026. /**
  121027. * The list of skeletons added to the scene
  121028. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121029. */
  121030. skeletons: Skeleton[];
  121031. /**
  121032. * All of the particle systems added to this scene
  121033. * @see https://doc.babylonjs.com/babylon101/particles
  121034. */
  121035. particleSystems: IParticleSystem[];
  121036. /**
  121037. * Gets a list of Animations associated with the scene
  121038. */
  121039. animations: Animation[];
  121040. /**
  121041. * All of the animation groups added to this scene
  121042. * @see https://doc.babylonjs.com/how_to/group
  121043. */
  121044. animationGroups: AnimationGroup[];
  121045. /**
  121046. * All of the multi-materials added to this scene
  121047. * @see https://doc.babylonjs.com/how_to/multi_materials
  121048. */
  121049. multiMaterials: MultiMaterial[];
  121050. /**
  121051. * All of the materials added to this scene
  121052. * In the context of a Scene, it is not supposed to be modified manually.
  121053. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121054. * Note also that the order of the Material within the array is not significant and might change.
  121055. * @see https://doc.babylonjs.com/babylon101/materials
  121056. */
  121057. materials: Material[];
  121058. /**
  121059. * The list of morph target managers added to the scene
  121060. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121061. */
  121062. morphTargetManagers: MorphTargetManager[];
  121063. /**
  121064. * The list of geometries used in the scene.
  121065. */
  121066. geometries: Geometry[];
  121067. /**
  121068. * All of the tranform nodes added to this scene
  121069. * In the context of a Scene, it is not supposed to be modified manually.
  121070. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121071. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121072. * @see https://doc.babylonjs.com/how_to/transformnode
  121073. */
  121074. transformNodes: TransformNode[];
  121075. /**
  121076. * ActionManagers available on the scene.
  121077. */
  121078. actionManagers: AbstractActionManager[];
  121079. /**
  121080. * Textures to keep.
  121081. */
  121082. textures: BaseTexture[];
  121083. /** @hidden */
  121084. protected _environmentTexture: Nullable<BaseTexture>;
  121085. /**
  121086. * Texture used in all pbr material as the reflection texture.
  121087. * As in the majority of the scene they are the same (exception for multi room and so on),
  121088. * this is easier to reference from here than from all the materials.
  121089. */
  121090. get environmentTexture(): Nullable<BaseTexture>;
  121091. set environmentTexture(value: Nullable<BaseTexture>);
  121092. /**
  121093. * The list of postprocesses added to the scene
  121094. */
  121095. postProcesses: PostProcess[];
  121096. /**
  121097. * @returns all meshes, lights, cameras, transformNodes and bones
  121098. */
  121099. getNodes(): Array<Node>;
  121100. }
  121101. }
  121102. declare module BABYLON {
  121103. /**
  121104. * Interface used to define options for Sound class
  121105. */
  121106. export interface ISoundOptions {
  121107. /**
  121108. * Does the sound autoplay once loaded.
  121109. */
  121110. autoplay?: boolean;
  121111. /**
  121112. * Does the sound loop after it finishes playing once.
  121113. */
  121114. loop?: boolean;
  121115. /**
  121116. * Sound's volume
  121117. */
  121118. volume?: number;
  121119. /**
  121120. * Is it a spatial sound?
  121121. */
  121122. spatialSound?: boolean;
  121123. /**
  121124. * Maximum distance to hear that sound
  121125. */
  121126. maxDistance?: number;
  121127. /**
  121128. * Uses user defined attenuation function
  121129. */
  121130. useCustomAttenuation?: boolean;
  121131. /**
  121132. * Define the roll off factor of spatial sounds.
  121133. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121134. */
  121135. rolloffFactor?: number;
  121136. /**
  121137. * Define the reference distance the sound should be heard perfectly.
  121138. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121139. */
  121140. refDistance?: number;
  121141. /**
  121142. * Define the distance attenuation model the sound will follow.
  121143. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121144. */
  121145. distanceModel?: string;
  121146. /**
  121147. * Defines the playback speed (1 by default)
  121148. */
  121149. playbackRate?: number;
  121150. /**
  121151. * Defines if the sound is from a streaming source
  121152. */
  121153. streaming?: boolean;
  121154. /**
  121155. * Defines an optional length (in seconds) inside the sound file
  121156. */
  121157. length?: number;
  121158. /**
  121159. * Defines an optional offset (in seconds) inside the sound file
  121160. */
  121161. offset?: number;
  121162. /**
  121163. * If true, URLs will not be required to state the audio file codec to use.
  121164. */
  121165. skipCodecCheck?: boolean;
  121166. }
  121167. /**
  121168. * Defines a sound that can be played in the application.
  121169. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121170. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121171. */
  121172. export class Sound {
  121173. /**
  121174. * The name of the sound in the scene.
  121175. */
  121176. name: string;
  121177. /**
  121178. * Does the sound autoplay once loaded.
  121179. */
  121180. autoplay: boolean;
  121181. /**
  121182. * Does the sound loop after it finishes playing once.
  121183. */
  121184. loop: boolean;
  121185. /**
  121186. * Does the sound use a custom attenuation curve to simulate the falloff
  121187. * happening when the source gets further away from the camera.
  121188. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121189. */
  121190. useCustomAttenuation: boolean;
  121191. /**
  121192. * The sound track id this sound belongs to.
  121193. */
  121194. soundTrackId: number;
  121195. /**
  121196. * Is this sound currently played.
  121197. */
  121198. isPlaying: boolean;
  121199. /**
  121200. * Is this sound currently paused.
  121201. */
  121202. isPaused: boolean;
  121203. /**
  121204. * Does this sound enables spatial sound.
  121205. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121206. */
  121207. spatialSound: boolean;
  121208. /**
  121209. * Define the reference distance the sound should be heard perfectly.
  121210. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121211. */
  121212. refDistance: number;
  121213. /**
  121214. * Define the roll off factor of spatial sounds.
  121215. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121216. */
  121217. rolloffFactor: number;
  121218. /**
  121219. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121220. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121221. */
  121222. maxDistance: number;
  121223. /**
  121224. * Define the distance attenuation model the sound will follow.
  121225. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121226. */
  121227. distanceModel: string;
  121228. /**
  121229. * @hidden
  121230. * Back Compat
  121231. **/
  121232. onended: () => any;
  121233. /**
  121234. * Gets or sets an object used to store user defined information for the sound.
  121235. */
  121236. metadata: any;
  121237. /**
  121238. * Observable event when the current playing sound finishes.
  121239. */
  121240. onEndedObservable: Observable<Sound>;
  121241. private _panningModel;
  121242. private _playbackRate;
  121243. private _streaming;
  121244. private _startTime;
  121245. private _startOffset;
  121246. private _position;
  121247. /** @hidden */
  121248. _positionInEmitterSpace: boolean;
  121249. private _localDirection;
  121250. private _volume;
  121251. private _isReadyToPlay;
  121252. private _isDirectional;
  121253. private _readyToPlayCallback;
  121254. private _audioBuffer;
  121255. private _soundSource;
  121256. private _streamingSource;
  121257. private _soundPanner;
  121258. private _soundGain;
  121259. private _inputAudioNode;
  121260. private _outputAudioNode;
  121261. private _coneInnerAngle;
  121262. private _coneOuterAngle;
  121263. private _coneOuterGain;
  121264. private _scene;
  121265. private _connectedTransformNode;
  121266. private _customAttenuationFunction;
  121267. private _registerFunc;
  121268. private _isOutputConnected;
  121269. private _htmlAudioElement;
  121270. private _urlType;
  121271. private _length?;
  121272. private _offset?;
  121273. /** @hidden */
  121274. static _SceneComponentInitialization: (scene: Scene) => void;
  121275. /**
  121276. * Create a sound and attach it to a scene
  121277. * @param name Name of your sound
  121278. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121279. * @param scene defines the scene the sound belongs to
  121280. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121281. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121282. */
  121283. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121284. /**
  121285. * Release the sound and its associated resources
  121286. */
  121287. dispose(): void;
  121288. /**
  121289. * Gets if the sounds is ready to be played or not.
  121290. * @returns true if ready, otherwise false
  121291. */
  121292. isReady(): boolean;
  121293. private _soundLoaded;
  121294. /**
  121295. * Sets the data of the sound from an audiobuffer
  121296. * @param audioBuffer The audioBuffer containing the data
  121297. */
  121298. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121299. /**
  121300. * Updates the current sounds options such as maxdistance, loop...
  121301. * @param options A JSON object containing values named as the object properties
  121302. */
  121303. updateOptions(options: ISoundOptions): void;
  121304. private _createSpatialParameters;
  121305. private _updateSpatialParameters;
  121306. /**
  121307. * Switch the panning model to HRTF:
  121308. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121309. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121310. */
  121311. switchPanningModelToHRTF(): void;
  121312. /**
  121313. * Switch the panning model to Equal Power:
  121314. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121315. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121316. */
  121317. switchPanningModelToEqualPower(): void;
  121318. private _switchPanningModel;
  121319. /**
  121320. * Connect this sound to a sound track audio node like gain...
  121321. * @param soundTrackAudioNode the sound track audio node to connect to
  121322. */
  121323. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121324. /**
  121325. * Transform this sound into a directional source
  121326. * @param coneInnerAngle Size of the inner cone in degree
  121327. * @param coneOuterAngle Size of the outer cone in degree
  121328. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121329. */
  121330. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121331. /**
  121332. * Gets or sets the inner angle for the directional cone.
  121333. */
  121334. get directionalConeInnerAngle(): number;
  121335. /**
  121336. * Gets or sets the inner angle for the directional cone.
  121337. */
  121338. set directionalConeInnerAngle(value: number);
  121339. /**
  121340. * Gets or sets the outer angle for the directional cone.
  121341. */
  121342. get directionalConeOuterAngle(): number;
  121343. /**
  121344. * Gets or sets the outer angle for the directional cone.
  121345. */
  121346. set directionalConeOuterAngle(value: number);
  121347. /**
  121348. * Sets the position of the emitter if spatial sound is enabled
  121349. * @param newPosition Defines the new posisiton
  121350. */
  121351. setPosition(newPosition: Vector3): void;
  121352. /**
  121353. * Sets the local direction of the emitter if spatial sound is enabled
  121354. * @param newLocalDirection Defines the new local direction
  121355. */
  121356. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121357. private _updateDirection;
  121358. /** @hidden */
  121359. updateDistanceFromListener(): void;
  121360. /**
  121361. * Sets a new custom attenuation function for the sound.
  121362. * @param callback Defines the function used for the attenuation
  121363. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121364. */
  121365. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121366. /**
  121367. * Play the sound
  121368. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121369. * @param offset (optional) Start the sound at a specific time in seconds
  121370. * @param length (optional) Sound duration (in seconds)
  121371. */
  121372. play(time?: number, offset?: number, length?: number): void;
  121373. private _onended;
  121374. /**
  121375. * Stop the sound
  121376. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121377. */
  121378. stop(time?: number): void;
  121379. /**
  121380. * Put the sound in pause
  121381. */
  121382. pause(): void;
  121383. /**
  121384. * Sets a dedicated volume for this sounds
  121385. * @param newVolume Define the new volume of the sound
  121386. * @param time Define time for gradual change to new volume
  121387. */
  121388. setVolume(newVolume: number, time?: number): void;
  121389. /**
  121390. * Set the sound play back rate
  121391. * @param newPlaybackRate Define the playback rate the sound should be played at
  121392. */
  121393. setPlaybackRate(newPlaybackRate: number): void;
  121394. /**
  121395. * Gets the volume of the sound.
  121396. * @returns the volume of the sound
  121397. */
  121398. getVolume(): number;
  121399. /**
  121400. * Attach the sound to a dedicated mesh
  121401. * @param transformNode The transform node to connect the sound with
  121402. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121403. */
  121404. attachToMesh(transformNode: TransformNode): void;
  121405. /**
  121406. * Detach the sound from the previously attached mesh
  121407. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121408. */
  121409. detachFromMesh(): void;
  121410. private _onRegisterAfterWorldMatrixUpdate;
  121411. /**
  121412. * Clone the current sound in the scene.
  121413. * @returns the new sound clone
  121414. */
  121415. clone(): Nullable<Sound>;
  121416. /**
  121417. * Gets the current underlying audio buffer containing the data
  121418. * @returns the audio buffer
  121419. */
  121420. getAudioBuffer(): Nullable<AudioBuffer>;
  121421. /**
  121422. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121423. * @returns the source node
  121424. */
  121425. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121426. /**
  121427. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121428. * @returns the gain node
  121429. */
  121430. getSoundGain(): Nullable<GainNode>;
  121431. /**
  121432. * Serializes the Sound in a JSON representation
  121433. * @returns the JSON representation of the sound
  121434. */
  121435. serialize(): any;
  121436. /**
  121437. * Parse a JSON representation of a sound to innstantiate in a given scene
  121438. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121439. * @param scene Define the scene the new parsed sound should be created in
  121440. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121441. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121442. * @returns the newly parsed sound
  121443. */
  121444. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121445. }
  121446. }
  121447. declare module BABYLON {
  121448. /**
  121449. * This defines an action helpful to play a defined sound on a triggered action.
  121450. */
  121451. export class PlaySoundAction extends Action {
  121452. private _sound;
  121453. /**
  121454. * Instantiate the action
  121455. * @param triggerOptions defines the trigger options
  121456. * @param sound defines the sound to play
  121457. * @param condition defines the trigger related conditions
  121458. */
  121459. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121460. /** @hidden */
  121461. _prepare(): void;
  121462. /**
  121463. * Execute the action and play the sound.
  121464. */
  121465. execute(): void;
  121466. /**
  121467. * Serializes the actions and its related information.
  121468. * @param parent defines the object to serialize in
  121469. * @returns the serialized object
  121470. */
  121471. serialize(parent: any): any;
  121472. }
  121473. /**
  121474. * This defines an action helpful to stop a defined sound on a triggered action.
  121475. */
  121476. export class StopSoundAction extends Action {
  121477. private _sound;
  121478. /**
  121479. * Instantiate the action
  121480. * @param triggerOptions defines the trigger options
  121481. * @param sound defines the sound to stop
  121482. * @param condition defines the trigger related conditions
  121483. */
  121484. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121485. /** @hidden */
  121486. _prepare(): void;
  121487. /**
  121488. * Execute the action and stop the sound.
  121489. */
  121490. execute(): void;
  121491. /**
  121492. * Serializes the actions and its related information.
  121493. * @param parent defines the object to serialize in
  121494. * @returns the serialized object
  121495. */
  121496. serialize(parent: any): any;
  121497. }
  121498. }
  121499. declare module BABYLON {
  121500. /**
  121501. * This defines an action responsible to change the value of a property
  121502. * by interpolating between its current value and the newly set one once triggered.
  121503. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121504. */
  121505. export class InterpolateValueAction extends Action {
  121506. /**
  121507. * Defines the path of the property where the value should be interpolated
  121508. */
  121509. propertyPath: string;
  121510. /**
  121511. * Defines the target value at the end of the interpolation.
  121512. */
  121513. value: any;
  121514. /**
  121515. * Defines the time it will take for the property to interpolate to the value.
  121516. */
  121517. duration: number;
  121518. /**
  121519. * Defines if the other scene animations should be stopped when the action has been triggered
  121520. */
  121521. stopOtherAnimations?: boolean;
  121522. /**
  121523. * Defines a callback raised once the interpolation animation has been done.
  121524. */
  121525. onInterpolationDone?: () => void;
  121526. /**
  121527. * Observable triggered once the interpolation animation has been done.
  121528. */
  121529. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121530. private _target;
  121531. private _effectiveTarget;
  121532. private _property;
  121533. /**
  121534. * Instantiate the action
  121535. * @param triggerOptions defines the trigger options
  121536. * @param target defines the object containing the value to interpolate
  121537. * @param propertyPath defines the path to the property in the target object
  121538. * @param value defines the target value at the end of the interpolation
  121539. * @param duration deines the time it will take for the property to interpolate to the value.
  121540. * @param condition defines the trigger related conditions
  121541. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121542. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121543. */
  121544. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121545. /** @hidden */
  121546. _prepare(): void;
  121547. /**
  121548. * Execute the action starts the value interpolation.
  121549. */
  121550. execute(): void;
  121551. /**
  121552. * Serializes the actions and its related information.
  121553. * @param parent defines the object to serialize in
  121554. * @returns the serialized object
  121555. */
  121556. serialize(parent: any): any;
  121557. }
  121558. }
  121559. declare module BABYLON {
  121560. /**
  121561. * Options allowed during the creation of a sound track.
  121562. */
  121563. export interface ISoundTrackOptions {
  121564. /**
  121565. * The volume the sound track should take during creation
  121566. */
  121567. volume?: number;
  121568. /**
  121569. * Define if the sound track is the main sound track of the scene
  121570. */
  121571. mainTrack?: boolean;
  121572. }
  121573. /**
  121574. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121575. * It will be also used in a future release to apply effects on a specific track.
  121576. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121577. */
  121578. export class SoundTrack {
  121579. /**
  121580. * The unique identifier of the sound track in the scene.
  121581. */
  121582. id: number;
  121583. /**
  121584. * The list of sounds included in the sound track.
  121585. */
  121586. soundCollection: Array<Sound>;
  121587. private _outputAudioNode;
  121588. private _scene;
  121589. private _connectedAnalyser;
  121590. private _options;
  121591. private _isInitialized;
  121592. /**
  121593. * Creates a new sound track.
  121594. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121595. * @param scene Define the scene the sound track belongs to
  121596. * @param options
  121597. */
  121598. constructor(scene: Scene, options?: ISoundTrackOptions);
  121599. private _initializeSoundTrackAudioGraph;
  121600. /**
  121601. * Release the sound track and its associated resources
  121602. */
  121603. dispose(): void;
  121604. /**
  121605. * Adds a sound to this sound track
  121606. * @param sound define the cound to add
  121607. * @ignoreNaming
  121608. */
  121609. AddSound(sound: Sound): void;
  121610. /**
  121611. * Removes a sound to this sound track
  121612. * @param sound define the cound to remove
  121613. * @ignoreNaming
  121614. */
  121615. RemoveSound(sound: Sound): void;
  121616. /**
  121617. * Set a global volume for the full sound track.
  121618. * @param newVolume Define the new volume of the sound track
  121619. */
  121620. setVolume(newVolume: number): void;
  121621. /**
  121622. * Switch the panning model to HRTF:
  121623. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121624. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121625. */
  121626. switchPanningModelToHRTF(): void;
  121627. /**
  121628. * Switch the panning model to Equal Power:
  121629. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121630. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121631. */
  121632. switchPanningModelToEqualPower(): void;
  121633. /**
  121634. * Connect the sound track to an audio analyser allowing some amazing
  121635. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121636. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121637. * @param analyser The analyser to connect to the engine
  121638. */
  121639. connectToAnalyser(analyser: Analyser): void;
  121640. }
  121641. }
  121642. declare module BABYLON {
  121643. interface AbstractScene {
  121644. /**
  121645. * The list of sounds used in the scene.
  121646. */
  121647. sounds: Nullable<Array<Sound>>;
  121648. }
  121649. interface Scene {
  121650. /**
  121651. * @hidden
  121652. * Backing field
  121653. */
  121654. _mainSoundTrack: SoundTrack;
  121655. /**
  121656. * The main sound track played by the scene.
  121657. * It cotains your primary collection of sounds.
  121658. */
  121659. mainSoundTrack: SoundTrack;
  121660. /**
  121661. * The list of sound tracks added to the scene
  121662. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121663. */
  121664. soundTracks: Nullable<Array<SoundTrack>>;
  121665. /**
  121666. * Gets a sound using a given name
  121667. * @param name defines the name to search for
  121668. * @return the found sound or null if not found at all.
  121669. */
  121670. getSoundByName(name: string): Nullable<Sound>;
  121671. /**
  121672. * Gets or sets if audio support is enabled
  121673. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121674. */
  121675. audioEnabled: boolean;
  121676. /**
  121677. * Gets or sets if audio will be output to headphones
  121678. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121679. */
  121680. headphone: boolean;
  121681. /**
  121682. * Gets or sets custom audio listener position provider
  121683. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121684. */
  121685. audioListenerPositionProvider: Nullable<() => Vector3>;
  121686. /**
  121687. * Gets or sets a refresh rate when using 3D audio positioning
  121688. */
  121689. audioPositioningRefreshRate: number;
  121690. }
  121691. /**
  121692. * Defines the sound scene component responsible to manage any sounds
  121693. * in a given scene.
  121694. */
  121695. export class AudioSceneComponent implements ISceneSerializableComponent {
  121696. private static _CameraDirectionLH;
  121697. private static _CameraDirectionRH;
  121698. /**
  121699. * The component name helpfull to identify the component in the list of scene components.
  121700. */
  121701. readonly name: string;
  121702. /**
  121703. * The scene the component belongs to.
  121704. */
  121705. scene: Scene;
  121706. private _audioEnabled;
  121707. /**
  121708. * Gets whether audio is enabled or not.
  121709. * Please use related enable/disable method to switch state.
  121710. */
  121711. get audioEnabled(): boolean;
  121712. private _headphone;
  121713. /**
  121714. * Gets whether audio is outputing to headphone or not.
  121715. * Please use the according Switch methods to change output.
  121716. */
  121717. get headphone(): boolean;
  121718. /**
  121719. * Gets or sets a refresh rate when using 3D audio positioning
  121720. */
  121721. audioPositioningRefreshRate: number;
  121722. private _audioListenerPositionProvider;
  121723. /**
  121724. * Gets the current audio listener position provider
  121725. */
  121726. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121727. /**
  121728. * Sets a custom listener position for all sounds in the scene
  121729. * By default, this is the position of the first active camera
  121730. */
  121731. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121732. /**
  121733. * Creates a new instance of the component for the given scene
  121734. * @param scene Defines the scene to register the component in
  121735. */
  121736. constructor(scene: Scene);
  121737. /**
  121738. * Registers the component in a given scene
  121739. */
  121740. register(): void;
  121741. /**
  121742. * Rebuilds the elements related to this component in case of
  121743. * context lost for instance.
  121744. */
  121745. rebuild(): void;
  121746. /**
  121747. * Serializes the component data to the specified json object
  121748. * @param serializationObject The object to serialize to
  121749. */
  121750. serialize(serializationObject: any): void;
  121751. /**
  121752. * Adds all the elements from the container to the scene
  121753. * @param container the container holding the elements
  121754. */
  121755. addFromContainer(container: AbstractScene): void;
  121756. /**
  121757. * Removes all the elements in the container from the scene
  121758. * @param container contains the elements to remove
  121759. * @param dispose if the removed element should be disposed (default: false)
  121760. */
  121761. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121762. /**
  121763. * Disposes the component and the associated ressources.
  121764. */
  121765. dispose(): void;
  121766. /**
  121767. * Disables audio in the associated scene.
  121768. */
  121769. disableAudio(): void;
  121770. /**
  121771. * Enables audio in the associated scene.
  121772. */
  121773. enableAudio(): void;
  121774. /**
  121775. * Switch audio to headphone output.
  121776. */
  121777. switchAudioModeForHeadphones(): void;
  121778. /**
  121779. * Switch audio to normal speakers.
  121780. */
  121781. switchAudioModeForNormalSpeakers(): void;
  121782. private _cachedCameraDirection;
  121783. private _cachedCameraPosition;
  121784. private _lastCheck;
  121785. private _afterRender;
  121786. }
  121787. }
  121788. declare module BABYLON {
  121789. /**
  121790. * Wraps one or more Sound objects and selects one with random weight for playback.
  121791. */
  121792. export class WeightedSound {
  121793. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121794. loop: boolean;
  121795. private _coneInnerAngle;
  121796. private _coneOuterAngle;
  121797. private _volume;
  121798. /** A Sound is currently playing. */
  121799. isPlaying: boolean;
  121800. /** A Sound is currently paused. */
  121801. isPaused: boolean;
  121802. private _sounds;
  121803. private _weights;
  121804. private _currentIndex?;
  121805. /**
  121806. * Creates a new WeightedSound from the list of sounds given.
  121807. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121808. * @param sounds Array of Sounds that will be selected from.
  121809. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121810. */
  121811. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121812. /**
  121813. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121814. */
  121815. get directionalConeInnerAngle(): number;
  121816. /**
  121817. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121818. */
  121819. set directionalConeInnerAngle(value: number);
  121820. /**
  121821. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121822. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121823. */
  121824. get directionalConeOuterAngle(): number;
  121825. /**
  121826. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121827. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121828. */
  121829. set directionalConeOuterAngle(value: number);
  121830. /**
  121831. * Playback volume.
  121832. */
  121833. get volume(): number;
  121834. /**
  121835. * Playback volume.
  121836. */
  121837. set volume(value: number);
  121838. private _onended;
  121839. /**
  121840. * Suspend playback
  121841. */
  121842. pause(): void;
  121843. /**
  121844. * Stop playback
  121845. */
  121846. stop(): void;
  121847. /**
  121848. * Start playback.
  121849. * @param startOffset Position the clip head at a specific time in seconds.
  121850. */
  121851. play(startOffset?: number): void;
  121852. }
  121853. }
  121854. declare module BABYLON {
  121855. /**
  121856. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121857. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121858. */
  121859. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121860. /**
  121861. * Gets the name of the behavior.
  121862. */
  121863. get name(): string;
  121864. /**
  121865. * The easing function used by animations
  121866. */
  121867. static EasingFunction: BackEase;
  121868. /**
  121869. * The easing mode used by animations
  121870. */
  121871. static EasingMode: number;
  121872. /**
  121873. * The duration of the animation, in milliseconds
  121874. */
  121875. transitionDuration: number;
  121876. /**
  121877. * Length of the distance animated by the transition when lower radius is reached
  121878. */
  121879. lowerRadiusTransitionRange: number;
  121880. /**
  121881. * Length of the distance animated by the transition when upper radius is reached
  121882. */
  121883. upperRadiusTransitionRange: number;
  121884. private _autoTransitionRange;
  121885. /**
  121886. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121887. */
  121888. get autoTransitionRange(): boolean;
  121889. /**
  121890. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121891. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121892. */
  121893. set autoTransitionRange(value: boolean);
  121894. private _attachedCamera;
  121895. private _onAfterCheckInputsObserver;
  121896. private _onMeshTargetChangedObserver;
  121897. /**
  121898. * Initializes the behavior.
  121899. */
  121900. init(): void;
  121901. /**
  121902. * Attaches the behavior to its arc rotate camera.
  121903. * @param camera Defines the camera to attach the behavior to
  121904. */
  121905. attach(camera: ArcRotateCamera): void;
  121906. /**
  121907. * Detaches the behavior from its current arc rotate camera.
  121908. */
  121909. detach(): void;
  121910. private _radiusIsAnimating;
  121911. private _radiusBounceTransition;
  121912. private _animatables;
  121913. private _cachedWheelPrecision;
  121914. /**
  121915. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121916. * @param radiusLimit The limit to check against.
  121917. * @return Bool to indicate if at limit.
  121918. */
  121919. private _isRadiusAtLimit;
  121920. /**
  121921. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121922. * @param radiusDelta The delta by which to animate to. Can be negative.
  121923. */
  121924. private _applyBoundRadiusAnimation;
  121925. /**
  121926. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121927. */
  121928. protected _clearAnimationLocks(): void;
  121929. /**
  121930. * Stops and removes all animations that have been applied to the camera
  121931. */
  121932. stopAllAnimations(): void;
  121933. }
  121934. }
  121935. declare module BABYLON {
  121936. /**
  121937. * 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.
  121938. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121939. */
  121940. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121941. /**
  121942. * Gets the name of the behavior.
  121943. */
  121944. get name(): string;
  121945. private _mode;
  121946. private _radiusScale;
  121947. private _positionScale;
  121948. private _defaultElevation;
  121949. private _elevationReturnTime;
  121950. private _elevationReturnWaitTime;
  121951. private _zoomStopsAnimation;
  121952. private _framingTime;
  121953. /**
  121954. * The easing function used by animations
  121955. */
  121956. static EasingFunction: ExponentialEase;
  121957. /**
  121958. * The easing mode used by animations
  121959. */
  121960. static EasingMode: number;
  121961. /**
  121962. * Sets the current mode used by the behavior
  121963. */
  121964. set mode(mode: number);
  121965. /**
  121966. * Gets current mode used by the behavior.
  121967. */
  121968. get mode(): number;
  121969. /**
  121970. * Sets the scale applied to the radius (1 by default)
  121971. */
  121972. set radiusScale(radius: number);
  121973. /**
  121974. * Gets the scale applied to the radius
  121975. */
  121976. get radiusScale(): number;
  121977. /**
  121978. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121979. */
  121980. set positionScale(scale: number);
  121981. /**
  121982. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121983. */
  121984. get positionScale(): number;
  121985. /**
  121986. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121987. * behaviour is triggered, in radians.
  121988. */
  121989. set defaultElevation(elevation: number);
  121990. /**
  121991. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121992. * behaviour is triggered, in radians.
  121993. */
  121994. get defaultElevation(): number;
  121995. /**
  121996. * Sets the time (in milliseconds) taken to return to the default beta position.
  121997. * Negative value indicates camera should not return to default.
  121998. */
  121999. set elevationReturnTime(speed: number);
  122000. /**
  122001. * Gets the time (in milliseconds) taken to return to the default beta position.
  122002. * Negative value indicates camera should not return to default.
  122003. */
  122004. get elevationReturnTime(): number;
  122005. /**
  122006. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122007. */
  122008. set elevationReturnWaitTime(time: number);
  122009. /**
  122010. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122011. */
  122012. get elevationReturnWaitTime(): number;
  122013. /**
  122014. * Sets the flag that indicates if user zooming should stop animation.
  122015. */
  122016. set zoomStopsAnimation(flag: boolean);
  122017. /**
  122018. * Gets the flag that indicates if user zooming should stop animation.
  122019. */
  122020. get zoomStopsAnimation(): boolean;
  122021. /**
  122022. * Sets the transition time when framing the mesh, in milliseconds
  122023. */
  122024. set framingTime(time: number);
  122025. /**
  122026. * Gets the transition time when framing the mesh, in milliseconds
  122027. */
  122028. get framingTime(): number;
  122029. /**
  122030. * Define if the behavior should automatically change the configured
  122031. * camera limits and sensibilities.
  122032. */
  122033. autoCorrectCameraLimitsAndSensibility: boolean;
  122034. private _onPrePointerObservableObserver;
  122035. private _onAfterCheckInputsObserver;
  122036. private _onMeshTargetChangedObserver;
  122037. private _attachedCamera;
  122038. private _isPointerDown;
  122039. private _lastInteractionTime;
  122040. /**
  122041. * Initializes the behavior.
  122042. */
  122043. init(): void;
  122044. /**
  122045. * Attaches the behavior to its arc rotate camera.
  122046. * @param camera Defines the camera to attach the behavior to
  122047. */
  122048. attach(camera: ArcRotateCamera): void;
  122049. /**
  122050. * Detaches the behavior from its current arc rotate camera.
  122051. */
  122052. detach(): void;
  122053. private _animatables;
  122054. private _betaIsAnimating;
  122055. private _betaTransition;
  122056. private _radiusTransition;
  122057. private _vectorTransition;
  122058. /**
  122059. * Targets the given mesh and updates zoom level accordingly.
  122060. * @param mesh The mesh to target.
  122061. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122062. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122063. */
  122064. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122065. /**
  122066. * Targets the given mesh with its children and updates zoom level accordingly.
  122067. * @param mesh The mesh to target.
  122068. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122069. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122070. */
  122071. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122072. /**
  122073. * Targets the given meshes with their children and updates zoom level accordingly.
  122074. * @param meshes The mesh to target.
  122075. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122076. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122077. */
  122078. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122079. /**
  122080. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122081. * @param minimumWorld Determines the smaller position of the bounding box extend
  122082. * @param maximumWorld Determines the bigger position of the bounding box extend
  122083. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122084. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122085. */
  122086. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122087. /**
  122088. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122089. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122090. * frustum width.
  122091. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122092. * to fully enclose the mesh in the viewing frustum.
  122093. */
  122094. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122095. /**
  122096. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122097. * is automatically returned to its default position (expected to be above ground plane).
  122098. */
  122099. private _maintainCameraAboveGround;
  122100. /**
  122101. * Returns the frustum slope based on the canvas ratio and camera FOV
  122102. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122103. */
  122104. private _getFrustumSlope;
  122105. /**
  122106. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122107. */
  122108. private _clearAnimationLocks;
  122109. /**
  122110. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122111. */
  122112. private _applyUserInteraction;
  122113. /**
  122114. * Stops and removes all animations that have been applied to the camera
  122115. */
  122116. stopAllAnimations(): void;
  122117. /**
  122118. * Gets a value indicating if the user is moving the camera
  122119. */
  122120. get isUserIsMoving(): boolean;
  122121. /**
  122122. * The camera can move all the way towards the mesh.
  122123. */
  122124. static IgnoreBoundsSizeMode: number;
  122125. /**
  122126. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122127. */
  122128. static FitFrustumSidesMode: number;
  122129. }
  122130. }
  122131. declare module BABYLON {
  122132. /**
  122133. * Base class for Camera Pointer Inputs.
  122134. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122135. * for example usage.
  122136. */
  122137. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122138. /**
  122139. * Defines the camera the input is attached to.
  122140. */
  122141. abstract camera: Camera;
  122142. /**
  122143. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122144. */
  122145. protected _altKey: boolean;
  122146. protected _ctrlKey: boolean;
  122147. protected _metaKey: boolean;
  122148. protected _shiftKey: boolean;
  122149. /**
  122150. * Which mouse buttons were pressed at time of last mouse event.
  122151. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122152. */
  122153. protected _buttonsPressed: number;
  122154. /**
  122155. * Defines the buttons associated with the input to handle camera move.
  122156. */
  122157. buttons: number[];
  122158. /**
  122159. * Attach the input controls to a specific dom element to get the input from.
  122160. * @param element Defines the element the controls should be listened from
  122161. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122162. */
  122163. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122164. /**
  122165. * Detach the current controls from the specified dom element.
  122166. * @param element Defines the element to stop listening the inputs from
  122167. */
  122168. detachControl(element: Nullable<HTMLElement>): void;
  122169. /**
  122170. * Gets the class name of the current input.
  122171. * @returns the class name
  122172. */
  122173. getClassName(): string;
  122174. /**
  122175. * Get the friendly name associated with the input class.
  122176. * @returns the input friendly name
  122177. */
  122178. getSimpleName(): string;
  122179. /**
  122180. * Called on pointer POINTERDOUBLETAP event.
  122181. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122182. */
  122183. protected onDoubleTap(type: string): void;
  122184. /**
  122185. * Called on pointer POINTERMOVE event if only a single touch is active.
  122186. * Override this method to provide functionality.
  122187. */
  122188. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122189. /**
  122190. * Called on pointer POINTERMOVE event if multiple touches are active.
  122191. * Override this method to provide functionality.
  122192. */
  122193. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122194. /**
  122195. * Called on JS contextmenu event.
  122196. * Override this method to provide functionality.
  122197. */
  122198. protected onContextMenu(evt: PointerEvent): void;
  122199. /**
  122200. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122201. * press.
  122202. * Override this method to provide functionality.
  122203. */
  122204. protected onButtonDown(evt: PointerEvent): void;
  122205. /**
  122206. * Called each time a new POINTERUP event occurs. Ie, for each button
  122207. * release.
  122208. * Override this method to provide functionality.
  122209. */
  122210. protected onButtonUp(evt: PointerEvent): void;
  122211. /**
  122212. * Called when window becomes inactive.
  122213. * Override this method to provide functionality.
  122214. */
  122215. protected onLostFocus(): void;
  122216. private _pointerInput;
  122217. private _observer;
  122218. private _onLostFocus;
  122219. private pointA;
  122220. private pointB;
  122221. }
  122222. }
  122223. declare module BABYLON {
  122224. /**
  122225. * Manage the pointers inputs to control an arc rotate camera.
  122226. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122227. */
  122228. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122229. /**
  122230. * Defines the camera the input is attached to.
  122231. */
  122232. camera: ArcRotateCamera;
  122233. /**
  122234. * Gets the class name of the current input.
  122235. * @returns the class name
  122236. */
  122237. getClassName(): string;
  122238. /**
  122239. * Defines the buttons associated with the input to handle camera move.
  122240. */
  122241. buttons: number[];
  122242. /**
  122243. * Defines the pointer angular sensibility along the X axis or how fast is
  122244. * the camera rotating.
  122245. */
  122246. angularSensibilityX: number;
  122247. /**
  122248. * Defines the pointer angular sensibility along the Y axis or how fast is
  122249. * the camera rotating.
  122250. */
  122251. angularSensibilityY: number;
  122252. /**
  122253. * Defines the pointer pinch precision or how fast is the camera zooming.
  122254. */
  122255. pinchPrecision: number;
  122256. /**
  122257. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122258. * from 0.
  122259. * It defines the percentage of current camera.radius to use as delta when
  122260. * pinch zoom is used.
  122261. */
  122262. pinchDeltaPercentage: number;
  122263. /**
  122264. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122265. * that any object in the plane at the camera's target point will scale
  122266. * perfectly with finger motion.
  122267. * Overrides pinchDeltaPercentage and pinchPrecision.
  122268. */
  122269. useNaturalPinchZoom: boolean;
  122270. /**
  122271. * Defines the pointer panning sensibility or how fast is the camera moving.
  122272. */
  122273. panningSensibility: number;
  122274. /**
  122275. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122276. */
  122277. multiTouchPanning: boolean;
  122278. /**
  122279. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122280. * zoom (pinch) through multitouch.
  122281. */
  122282. multiTouchPanAndZoom: boolean;
  122283. /**
  122284. * Revers pinch action direction.
  122285. */
  122286. pinchInwards: boolean;
  122287. private _isPanClick;
  122288. private _twoFingerActivityCount;
  122289. private _isPinching;
  122290. /**
  122291. * Called on pointer POINTERMOVE event if only a single touch is active.
  122292. */
  122293. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122294. /**
  122295. * Called on pointer POINTERDOUBLETAP event.
  122296. */
  122297. protected onDoubleTap(type: string): void;
  122298. /**
  122299. * Called on pointer POINTERMOVE event if multiple touches are active.
  122300. */
  122301. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122302. /**
  122303. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122304. * press.
  122305. */
  122306. protected onButtonDown(evt: PointerEvent): void;
  122307. /**
  122308. * Called each time a new POINTERUP event occurs. Ie, for each button
  122309. * release.
  122310. */
  122311. protected onButtonUp(evt: PointerEvent): void;
  122312. /**
  122313. * Called when window becomes inactive.
  122314. */
  122315. protected onLostFocus(): void;
  122316. }
  122317. }
  122318. declare module BABYLON {
  122319. /**
  122320. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122321. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122322. */
  122323. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122324. /**
  122325. * Defines the camera the input is attached to.
  122326. */
  122327. camera: ArcRotateCamera;
  122328. /**
  122329. * Defines the list of key codes associated with the up action (increase alpha)
  122330. */
  122331. keysUp: number[];
  122332. /**
  122333. * Defines the list of key codes associated with the down action (decrease alpha)
  122334. */
  122335. keysDown: number[];
  122336. /**
  122337. * Defines the list of key codes associated with the left action (increase beta)
  122338. */
  122339. keysLeft: number[];
  122340. /**
  122341. * Defines the list of key codes associated with the right action (decrease beta)
  122342. */
  122343. keysRight: number[];
  122344. /**
  122345. * Defines the list of key codes associated with the reset action.
  122346. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122347. */
  122348. keysReset: number[];
  122349. /**
  122350. * Defines the panning sensibility of the inputs.
  122351. * (How fast is the camera panning)
  122352. */
  122353. panningSensibility: number;
  122354. /**
  122355. * Defines the zooming sensibility of the inputs.
  122356. * (How fast is the camera zooming)
  122357. */
  122358. zoomingSensibility: number;
  122359. /**
  122360. * Defines whether maintaining the alt key down switch the movement mode from
  122361. * orientation to zoom.
  122362. */
  122363. useAltToZoom: boolean;
  122364. /**
  122365. * Rotation speed of the camera
  122366. */
  122367. angularSpeed: number;
  122368. private _keys;
  122369. private _ctrlPressed;
  122370. private _altPressed;
  122371. private _onCanvasBlurObserver;
  122372. private _onKeyboardObserver;
  122373. private _engine;
  122374. private _scene;
  122375. /**
  122376. * Attach the input controls to a specific dom element to get the input from.
  122377. * @param element Defines the element the controls should be listened from
  122378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122379. */
  122380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122381. /**
  122382. * Detach the current controls from the specified dom element.
  122383. * @param element Defines the element to stop listening the inputs from
  122384. */
  122385. detachControl(element: Nullable<HTMLElement>): void;
  122386. /**
  122387. * Update the current camera state depending on the inputs that have been used this frame.
  122388. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122389. */
  122390. checkInputs(): void;
  122391. /**
  122392. * Gets the class name of the current intput.
  122393. * @returns the class name
  122394. */
  122395. getClassName(): string;
  122396. /**
  122397. * Get the friendly name associated with the input class.
  122398. * @returns the input friendly name
  122399. */
  122400. getSimpleName(): string;
  122401. }
  122402. }
  122403. declare module BABYLON {
  122404. /**
  122405. * Manage the mouse wheel inputs to control an arc rotate camera.
  122406. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122407. */
  122408. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122409. /**
  122410. * Defines the camera the input is attached to.
  122411. */
  122412. camera: ArcRotateCamera;
  122413. /**
  122414. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122415. */
  122416. wheelPrecision: number;
  122417. /**
  122418. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122419. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122420. */
  122421. wheelDeltaPercentage: number;
  122422. private _wheel;
  122423. private _observer;
  122424. private computeDeltaFromMouseWheelLegacyEvent;
  122425. /**
  122426. * Attach the input controls to a specific dom element to get the input from.
  122427. * @param element Defines the element the controls should be listened from
  122428. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122429. */
  122430. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122431. /**
  122432. * Detach the current controls from the specified dom element.
  122433. * @param element Defines the element to stop listening the inputs from
  122434. */
  122435. detachControl(element: Nullable<HTMLElement>): void;
  122436. /**
  122437. * Gets the class name of the current intput.
  122438. * @returns the class name
  122439. */
  122440. getClassName(): string;
  122441. /**
  122442. * Get the friendly name associated with the input class.
  122443. * @returns the input friendly name
  122444. */
  122445. getSimpleName(): string;
  122446. }
  122447. }
  122448. declare module BABYLON {
  122449. /**
  122450. * Default Inputs manager for the ArcRotateCamera.
  122451. * It groups all the default supported inputs for ease of use.
  122452. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122453. */
  122454. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122455. /**
  122456. * Instantiates a new ArcRotateCameraInputsManager.
  122457. * @param camera Defines the camera the inputs belong to
  122458. */
  122459. constructor(camera: ArcRotateCamera);
  122460. /**
  122461. * Add mouse wheel input support to the input manager.
  122462. * @returns the current input manager
  122463. */
  122464. addMouseWheel(): ArcRotateCameraInputsManager;
  122465. /**
  122466. * Add pointers input support to the input manager.
  122467. * @returns the current input manager
  122468. */
  122469. addPointers(): ArcRotateCameraInputsManager;
  122470. /**
  122471. * Add keyboard input support to the input manager.
  122472. * @returns the current input manager
  122473. */
  122474. addKeyboard(): ArcRotateCameraInputsManager;
  122475. }
  122476. }
  122477. declare module BABYLON {
  122478. /**
  122479. * This represents an orbital type of camera.
  122480. *
  122481. * 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.
  122482. * 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.
  122483. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122484. */
  122485. export class ArcRotateCamera extends TargetCamera {
  122486. /**
  122487. * Defines the rotation angle of the camera along the longitudinal axis.
  122488. */
  122489. alpha: number;
  122490. /**
  122491. * Defines the rotation angle of the camera along the latitudinal axis.
  122492. */
  122493. beta: number;
  122494. /**
  122495. * Defines the radius of the camera from it s target point.
  122496. */
  122497. radius: number;
  122498. protected _target: Vector3;
  122499. protected _targetHost: Nullable<AbstractMesh>;
  122500. /**
  122501. * Defines the target point of the camera.
  122502. * The camera looks towards it form the radius distance.
  122503. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122504. */
  122505. get target(): Vector3;
  122506. set target(value: Vector3);
  122507. /**
  122508. * Define the current local position of the camera in the scene
  122509. */
  122510. get position(): Vector3;
  122511. set position(newPosition: Vector3);
  122512. protected _upToYMatrix: Matrix;
  122513. protected _YToUpMatrix: Matrix;
  122514. /**
  122515. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122516. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122517. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122518. */
  122519. set upVector(vec: Vector3);
  122520. get upVector(): Vector3;
  122521. /**
  122522. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122523. */
  122524. setMatUp(): void;
  122525. /**
  122526. * Current inertia value on the longitudinal axis.
  122527. * The bigger this number the longer it will take for the camera to stop.
  122528. */
  122529. inertialAlphaOffset: number;
  122530. /**
  122531. * Current inertia value on the latitudinal axis.
  122532. * The bigger this number the longer it will take for the camera to stop.
  122533. */
  122534. inertialBetaOffset: number;
  122535. /**
  122536. * Current inertia value on the radius axis.
  122537. * The bigger this number the longer it will take for the camera to stop.
  122538. */
  122539. inertialRadiusOffset: number;
  122540. /**
  122541. * Minimum allowed angle on the longitudinal axis.
  122542. * This can help limiting how the Camera is able to move in the scene.
  122543. */
  122544. lowerAlphaLimit: Nullable<number>;
  122545. /**
  122546. * Maximum allowed angle on the longitudinal axis.
  122547. * This can help limiting how the Camera is able to move in the scene.
  122548. */
  122549. upperAlphaLimit: Nullable<number>;
  122550. /**
  122551. * Minimum allowed angle on the latitudinal axis.
  122552. * This can help limiting how the Camera is able to move in the scene.
  122553. */
  122554. lowerBetaLimit: number;
  122555. /**
  122556. * Maximum allowed angle on the latitudinal axis.
  122557. * This can help limiting how the Camera is able to move in the scene.
  122558. */
  122559. upperBetaLimit: number;
  122560. /**
  122561. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122562. * This can help limiting how the Camera is able to move in the scene.
  122563. */
  122564. lowerRadiusLimit: Nullable<number>;
  122565. /**
  122566. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122567. * This can help limiting how the Camera is able to move in the scene.
  122568. */
  122569. upperRadiusLimit: Nullable<number>;
  122570. /**
  122571. * Defines the current inertia value used during panning of the camera along the X axis.
  122572. */
  122573. inertialPanningX: number;
  122574. /**
  122575. * Defines the current inertia value used during panning of the camera along the Y axis.
  122576. */
  122577. inertialPanningY: number;
  122578. /**
  122579. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122580. * Basically if your fingers moves away from more than this distance you will be considered
  122581. * in pinch mode.
  122582. */
  122583. pinchToPanMaxDistance: number;
  122584. /**
  122585. * Defines the maximum distance the camera can pan.
  122586. * This could help keeping the cammera always in your scene.
  122587. */
  122588. panningDistanceLimit: Nullable<number>;
  122589. /**
  122590. * Defines the target of the camera before paning.
  122591. */
  122592. panningOriginTarget: Vector3;
  122593. /**
  122594. * Defines the value of the inertia used during panning.
  122595. * 0 would mean stop inertia and one would mean no decelleration at all.
  122596. */
  122597. panningInertia: number;
  122598. /**
  122599. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122600. */
  122601. get angularSensibilityX(): number;
  122602. set angularSensibilityX(value: number);
  122603. /**
  122604. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122605. */
  122606. get angularSensibilityY(): number;
  122607. set angularSensibilityY(value: number);
  122608. /**
  122609. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122610. */
  122611. get pinchPrecision(): number;
  122612. set pinchPrecision(value: number);
  122613. /**
  122614. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122615. * It will be used instead of pinchDeltaPrecision if different from 0.
  122616. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122617. */
  122618. get pinchDeltaPercentage(): number;
  122619. set pinchDeltaPercentage(value: number);
  122620. /**
  122621. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122622. * and pinch delta percentage.
  122623. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122624. * that any object in the plane at the camera's target point will scale
  122625. * perfectly with finger motion.
  122626. */
  122627. get useNaturalPinchZoom(): boolean;
  122628. set useNaturalPinchZoom(value: boolean);
  122629. /**
  122630. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122631. */
  122632. get panningSensibility(): number;
  122633. set panningSensibility(value: number);
  122634. /**
  122635. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122636. */
  122637. get keysUp(): number[];
  122638. set keysUp(value: number[]);
  122639. /**
  122640. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122641. */
  122642. get keysDown(): number[];
  122643. set keysDown(value: number[]);
  122644. /**
  122645. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122646. */
  122647. get keysLeft(): number[];
  122648. set keysLeft(value: number[]);
  122649. /**
  122650. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122651. */
  122652. get keysRight(): number[];
  122653. set keysRight(value: number[]);
  122654. /**
  122655. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122656. */
  122657. get wheelPrecision(): number;
  122658. set wheelPrecision(value: number);
  122659. /**
  122660. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122661. * It will be used instead of pinchDeltaPrecision if different from 0.
  122662. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122663. */
  122664. get wheelDeltaPercentage(): number;
  122665. set wheelDeltaPercentage(value: number);
  122666. /**
  122667. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122668. */
  122669. zoomOnFactor: number;
  122670. /**
  122671. * Defines a screen offset for the camera position.
  122672. */
  122673. targetScreenOffset: Vector2;
  122674. /**
  122675. * Allows the camera to be completely reversed.
  122676. * If false the camera can not arrive upside down.
  122677. */
  122678. allowUpsideDown: boolean;
  122679. /**
  122680. * Define if double tap/click is used to restore the previously saved state of the camera.
  122681. */
  122682. useInputToRestoreState: boolean;
  122683. /** @hidden */
  122684. _viewMatrix: Matrix;
  122685. /** @hidden */
  122686. _useCtrlForPanning: boolean;
  122687. /** @hidden */
  122688. _panningMouseButton: number;
  122689. /**
  122690. * Defines the input associated to the camera.
  122691. */
  122692. inputs: ArcRotateCameraInputsManager;
  122693. /** @hidden */
  122694. _reset: () => void;
  122695. /**
  122696. * Defines the allowed panning axis.
  122697. */
  122698. panningAxis: Vector3;
  122699. protected _localDirection: Vector3;
  122700. protected _transformedDirection: Vector3;
  122701. private _bouncingBehavior;
  122702. /**
  122703. * Gets the bouncing behavior of the camera if it has been enabled.
  122704. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122705. */
  122706. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122707. /**
  122708. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122709. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122710. */
  122711. get useBouncingBehavior(): boolean;
  122712. set useBouncingBehavior(value: boolean);
  122713. private _framingBehavior;
  122714. /**
  122715. * Gets the framing behavior of the camera if it has been enabled.
  122716. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122717. */
  122718. get framingBehavior(): Nullable<FramingBehavior>;
  122719. /**
  122720. * Defines if the framing behavior of the camera is enabled on the camera.
  122721. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122722. */
  122723. get useFramingBehavior(): boolean;
  122724. set useFramingBehavior(value: boolean);
  122725. private _autoRotationBehavior;
  122726. /**
  122727. * Gets the auto rotation behavior of the camera if it has been enabled.
  122728. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122729. */
  122730. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122731. /**
  122732. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122733. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122734. */
  122735. get useAutoRotationBehavior(): boolean;
  122736. set useAutoRotationBehavior(value: boolean);
  122737. /**
  122738. * Observable triggered when the mesh target has been changed on the camera.
  122739. */
  122740. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122741. /**
  122742. * Event raised when the camera is colliding with a mesh.
  122743. */
  122744. onCollide: (collidedMesh: AbstractMesh) => void;
  122745. /**
  122746. * Defines whether the camera should check collision with the objects oh the scene.
  122747. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122748. */
  122749. checkCollisions: boolean;
  122750. /**
  122751. * Defines the collision radius of the camera.
  122752. * This simulates a sphere around the camera.
  122753. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122754. */
  122755. collisionRadius: Vector3;
  122756. protected _collider: Collider;
  122757. protected _previousPosition: Vector3;
  122758. protected _collisionVelocity: Vector3;
  122759. protected _newPosition: Vector3;
  122760. protected _previousAlpha: number;
  122761. protected _previousBeta: number;
  122762. protected _previousRadius: number;
  122763. protected _collisionTriggered: boolean;
  122764. protected _targetBoundingCenter: Nullable<Vector3>;
  122765. private _computationVector;
  122766. /**
  122767. * Instantiates a new ArcRotateCamera in a given scene
  122768. * @param name Defines the name of the camera
  122769. * @param alpha Defines the camera rotation along the logitudinal axis
  122770. * @param beta Defines the camera rotation along the latitudinal axis
  122771. * @param radius Defines the camera distance from its target
  122772. * @param target Defines the camera target
  122773. * @param scene Defines the scene the camera belongs to
  122774. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122775. */
  122776. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122777. /** @hidden */
  122778. _initCache(): void;
  122779. /** @hidden */
  122780. _updateCache(ignoreParentClass?: boolean): void;
  122781. protected _getTargetPosition(): Vector3;
  122782. private _storedAlpha;
  122783. private _storedBeta;
  122784. private _storedRadius;
  122785. private _storedTarget;
  122786. private _storedTargetScreenOffset;
  122787. /**
  122788. * Stores the current state of the camera (alpha, beta, radius and target)
  122789. * @returns the camera itself
  122790. */
  122791. storeState(): Camera;
  122792. /**
  122793. * @hidden
  122794. * Restored camera state. You must call storeState() first
  122795. */
  122796. _restoreStateValues(): boolean;
  122797. /** @hidden */
  122798. _isSynchronizedViewMatrix(): boolean;
  122799. /**
  122800. * Attached controls to the current camera.
  122801. * @param element Defines the element the controls should be listened from
  122802. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122803. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122804. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122805. */
  122806. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122807. /**
  122808. * Detach the current controls from the camera.
  122809. * The camera will stop reacting to inputs.
  122810. * @param element Defines the element to stop listening the inputs from
  122811. */
  122812. detachControl(element: HTMLElement): void;
  122813. /** @hidden */
  122814. _checkInputs(): void;
  122815. protected _checkLimits(): void;
  122816. /**
  122817. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122818. */
  122819. rebuildAnglesAndRadius(): void;
  122820. /**
  122821. * Use a position to define the current camera related information like alpha, beta and radius
  122822. * @param position Defines the position to set the camera at
  122823. */
  122824. setPosition(position: Vector3): void;
  122825. /**
  122826. * Defines the target the camera should look at.
  122827. * This will automatically adapt alpha beta and radius to fit within the new target.
  122828. * @param target Defines the new target as a Vector or a mesh
  122829. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122830. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122831. */
  122832. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122833. /** @hidden */
  122834. _getViewMatrix(): Matrix;
  122835. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122836. /**
  122837. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122838. * @param meshes Defines the mesh to zoom on
  122839. * @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)
  122840. */
  122841. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122842. /**
  122843. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122844. * The target will be changed but the radius
  122845. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122846. * @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)
  122847. */
  122848. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122849. min: Vector3;
  122850. max: Vector3;
  122851. distance: number;
  122852. }, doNotUpdateMaxZ?: boolean): void;
  122853. /**
  122854. * @override
  122855. * Override Camera.createRigCamera
  122856. */
  122857. createRigCamera(name: string, cameraIndex: number): Camera;
  122858. /**
  122859. * @hidden
  122860. * @override
  122861. * Override Camera._updateRigCameras
  122862. */
  122863. _updateRigCameras(): void;
  122864. /**
  122865. * Destroy the camera and release the current resources hold by it.
  122866. */
  122867. dispose(): void;
  122868. /**
  122869. * Gets the current object class name.
  122870. * @return the class name
  122871. */
  122872. getClassName(): string;
  122873. }
  122874. }
  122875. declare module BABYLON {
  122876. /**
  122877. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122878. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122879. */
  122880. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122881. /**
  122882. * Gets the name of the behavior.
  122883. */
  122884. get name(): string;
  122885. private _zoomStopsAnimation;
  122886. private _idleRotationSpeed;
  122887. private _idleRotationWaitTime;
  122888. private _idleRotationSpinupTime;
  122889. /**
  122890. * Sets the flag that indicates if user zooming should stop animation.
  122891. */
  122892. set zoomStopsAnimation(flag: boolean);
  122893. /**
  122894. * Gets the flag that indicates if user zooming should stop animation.
  122895. */
  122896. get zoomStopsAnimation(): boolean;
  122897. /**
  122898. * Sets the default speed at which the camera rotates around the model.
  122899. */
  122900. set idleRotationSpeed(speed: number);
  122901. /**
  122902. * Gets the default speed at which the camera rotates around the model.
  122903. */
  122904. get idleRotationSpeed(): number;
  122905. /**
  122906. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122907. */
  122908. set idleRotationWaitTime(time: number);
  122909. /**
  122910. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122911. */
  122912. get idleRotationWaitTime(): number;
  122913. /**
  122914. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122915. */
  122916. set idleRotationSpinupTime(time: number);
  122917. /**
  122918. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122919. */
  122920. get idleRotationSpinupTime(): number;
  122921. /**
  122922. * Gets a value indicating if the camera is currently rotating because of this behavior
  122923. */
  122924. get rotationInProgress(): boolean;
  122925. private _onPrePointerObservableObserver;
  122926. private _onAfterCheckInputsObserver;
  122927. private _attachedCamera;
  122928. private _isPointerDown;
  122929. private _lastFrameTime;
  122930. private _lastInteractionTime;
  122931. private _cameraRotationSpeed;
  122932. /**
  122933. * Initializes the behavior.
  122934. */
  122935. init(): void;
  122936. /**
  122937. * Attaches the behavior to its arc rotate camera.
  122938. * @param camera Defines the camera to attach the behavior to
  122939. */
  122940. attach(camera: ArcRotateCamera): void;
  122941. /**
  122942. * Detaches the behavior from its current arc rotate camera.
  122943. */
  122944. detach(): void;
  122945. /**
  122946. * Returns true if user is scrolling.
  122947. * @return true if user is scrolling.
  122948. */
  122949. private _userIsZooming;
  122950. private _lastFrameRadius;
  122951. private _shouldAnimationStopForInteraction;
  122952. /**
  122953. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122954. */
  122955. private _applyUserInteraction;
  122956. private _userIsMoving;
  122957. }
  122958. }
  122959. declare module BABYLON {
  122960. /**
  122961. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122962. */
  122963. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122964. private ui;
  122965. /**
  122966. * The name of the behavior
  122967. */
  122968. name: string;
  122969. /**
  122970. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122971. */
  122972. distanceAwayFromFace: number;
  122973. /**
  122974. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122975. */
  122976. distanceAwayFromBottomOfFace: number;
  122977. private _faceVectors;
  122978. private _target;
  122979. private _scene;
  122980. private _onRenderObserver;
  122981. private _tmpMatrix;
  122982. private _tmpVector;
  122983. /**
  122984. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122985. * @param ui The transform node that should be attched to the mesh
  122986. */
  122987. constructor(ui: TransformNode);
  122988. /**
  122989. * Initializes the behavior
  122990. */
  122991. init(): void;
  122992. private _closestFace;
  122993. private _zeroVector;
  122994. private _lookAtTmpMatrix;
  122995. private _lookAtToRef;
  122996. /**
  122997. * Attaches the AttachToBoxBehavior to the passed in mesh
  122998. * @param target The mesh that the specified node will be attached to
  122999. */
  123000. attach(target: Mesh): void;
  123001. /**
  123002. * Detaches the behavior from the mesh
  123003. */
  123004. detach(): void;
  123005. }
  123006. }
  123007. declare module BABYLON {
  123008. /**
  123009. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  123010. */
  123011. export class FadeInOutBehavior implements Behavior<Mesh> {
  123012. /**
  123013. * Time in milliseconds to delay before fading in (Default: 0)
  123014. */
  123015. delay: number;
  123016. /**
  123017. * Time in milliseconds for the mesh to fade in (Default: 300)
  123018. */
  123019. fadeInTime: number;
  123020. private _millisecondsPerFrame;
  123021. private _hovered;
  123022. private _hoverValue;
  123023. private _ownerNode;
  123024. /**
  123025. * Instatiates the FadeInOutBehavior
  123026. */
  123027. constructor();
  123028. /**
  123029. * The name of the behavior
  123030. */
  123031. get name(): string;
  123032. /**
  123033. * Initializes the behavior
  123034. */
  123035. init(): void;
  123036. /**
  123037. * Attaches the fade behavior on the passed in mesh
  123038. * @param ownerNode The mesh that will be faded in/out once attached
  123039. */
  123040. attach(ownerNode: Mesh): void;
  123041. /**
  123042. * Detaches the behavior from the mesh
  123043. */
  123044. detach(): void;
  123045. /**
  123046. * Triggers the mesh to begin fading in or out
  123047. * @param value if the object should fade in or out (true to fade in)
  123048. */
  123049. fadeIn(value: boolean): void;
  123050. private _update;
  123051. private _setAllVisibility;
  123052. }
  123053. }
  123054. declare module BABYLON {
  123055. /**
  123056. * Class containing a set of static utilities functions for managing Pivots
  123057. * @hidden
  123058. */
  123059. export class PivotTools {
  123060. private static _PivotCached;
  123061. private static _OldPivotPoint;
  123062. private static _PivotTranslation;
  123063. private static _PivotTmpVector;
  123064. /** @hidden */
  123065. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123066. /** @hidden */
  123067. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123068. }
  123069. }
  123070. declare module BABYLON {
  123071. /**
  123072. * Class containing static functions to help procedurally build meshes
  123073. */
  123074. export class PlaneBuilder {
  123075. /**
  123076. * Creates a plane mesh
  123077. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123078. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123079. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123080. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123081. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123082. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123083. * @param name defines the name of the mesh
  123084. * @param options defines the options used to create the mesh
  123085. * @param scene defines the hosting scene
  123086. * @returns the plane mesh
  123087. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123088. */
  123089. static CreatePlane(name: string, options: {
  123090. size?: number;
  123091. width?: number;
  123092. height?: number;
  123093. sideOrientation?: number;
  123094. frontUVs?: Vector4;
  123095. backUVs?: Vector4;
  123096. updatable?: boolean;
  123097. sourcePlane?: Plane;
  123098. }, scene?: Nullable<Scene>): Mesh;
  123099. }
  123100. }
  123101. declare module BABYLON {
  123102. /**
  123103. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123104. */
  123105. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123106. private static _AnyMouseID;
  123107. /**
  123108. * Abstract mesh the behavior is set on
  123109. */
  123110. attachedNode: AbstractMesh;
  123111. private _dragPlane;
  123112. private _scene;
  123113. private _pointerObserver;
  123114. private _beforeRenderObserver;
  123115. private static _planeScene;
  123116. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123117. /**
  123118. * 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)
  123119. */
  123120. maxDragAngle: number;
  123121. /**
  123122. * @hidden
  123123. */
  123124. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123125. /**
  123126. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123127. */
  123128. currentDraggingPointerID: number;
  123129. /**
  123130. * The last position where the pointer hit the drag plane in world space
  123131. */
  123132. lastDragPosition: Vector3;
  123133. /**
  123134. * If the behavior is currently in a dragging state
  123135. */
  123136. dragging: boolean;
  123137. /**
  123138. * 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)
  123139. */
  123140. dragDeltaRatio: number;
  123141. /**
  123142. * If the drag plane orientation should be updated during the dragging (Default: true)
  123143. */
  123144. updateDragPlane: boolean;
  123145. private _debugMode;
  123146. private _moving;
  123147. /**
  123148. * Fires each time the attached mesh is dragged with the pointer
  123149. * * delta between last drag position and current drag position in world space
  123150. * * dragDistance along the drag axis
  123151. * * dragPlaneNormal normal of the current drag plane used during the drag
  123152. * * dragPlanePoint in world space where the drag intersects the drag plane
  123153. */
  123154. onDragObservable: Observable<{
  123155. delta: Vector3;
  123156. dragPlanePoint: Vector3;
  123157. dragPlaneNormal: Vector3;
  123158. dragDistance: number;
  123159. pointerId: number;
  123160. }>;
  123161. /**
  123162. * Fires each time a drag begins (eg. mouse down on mesh)
  123163. */
  123164. onDragStartObservable: Observable<{
  123165. dragPlanePoint: Vector3;
  123166. pointerId: number;
  123167. }>;
  123168. /**
  123169. * Fires each time a drag ends (eg. mouse release after drag)
  123170. */
  123171. onDragEndObservable: Observable<{
  123172. dragPlanePoint: Vector3;
  123173. pointerId: number;
  123174. }>;
  123175. /**
  123176. * If the attached mesh should be moved when dragged
  123177. */
  123178. moveAttached: boolean;
  123179. /**
  123180. * If the drag behavior will react to drag events (Default: true)
  123181. */
  123182. enabled: boolean;
  123183. /**
  123184. * If pointer events should start and release the drag (Default: true)
  123185. */
  123186. startAndReleaseDragOnPointerEvents: boolean;
  123187. /**
  123188. * If camera controls should be detached during the drag
  123189. */
  123190. detachCameraControls: boolean;
  123191. /**
  123192. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123193. */
  123194. useObjectOrientationForDragging: boolean;
  123195. private _options;
  123196. /**
  123197. * Gets the options used by the behavior
  123198. */
  123199. get options(): {
  123200. dragAxis?: Vector3;
  123201. dragPlaneNormal?: Vector3;
  123202. };
  123203. /**
  123204. * Sets the options used by the behavior
  123205. */
  123206. set options(options: {
  123207. dragAxis?: Vector3;
  123208. dragPlaneNormal?: Vector3;
  123209. });
  123210. /**
  123211. * Creates a pointer drag behavior that can be attached to a mesh
  123212. * @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)
  123213. */
  123214. constructor(options?: {
  123215. dragAxis?: Vector3;
  123216. dragPlaneNormal?: Vector3;
  123217. });
  123218. /**
  123219. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123220. */
  123221. validateDrag: (targetPosition: Vector3) => boolean;
  123222. /**
  123223. * The name of the behavior
  123224. */
  123225. get name(): string;
  123226. /**
  123227. * Initializes the behavior
  123228. */
  123229. init(): void;
  123230. private _tmpVector;
  123231. private _alternatePickedPoint;
  123232. private _worldDragAxis;
  123233. private _targetPosition;
  123234. private _attachedElement;
  123235. /**
  123236. * Attaches the drag behavior the passed in mesh
  123237. * @param ownerNode The mesh that will be dragged around once attached
  123238. * @param predicate Predicate to use for pick filtering
  123239. */
  123240. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123241. /**
  123242. * Force relase the drag action by code.
  123243. */
  123244. releaseDrag(): void;
  123245. private _startDragRay;
  123246. private _lastPointerRay;
  123247. /**
  123248. * Simulates the start of a pointer drag event on the behavior
  123249. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123250. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123251. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123252. */
  123253. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123254. private _startDrag;
  123255. private _dragDelta;
  123256. private _moveDrag;
  123257. private _pickWithRayOnDragPlane;
  123258. private _pointA;
  123259. private _pointC;
  123260. private _localAxis;
  123261. private _lookAt;
  123262. private _updateDragPlanePosition;
  123263. /**
  123264. * Detaches the behavior from the mesh
  123265. */
  123266. detach(): void;
  123267. }
  123268. }
  123269. declare module BABYLON {
  123270. /**
  123271. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123272. */
  123273. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123274. private _dragBehaviorA;
  123275. private _dragBehaviorB;
  123276. private _startDistance;
  123277. private _initialScale;
  123278. private _targetScale;
  123279. private _ownerNode;
  123280. private _sceneRenderObserver;
  123281. /**
  123282. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123283. */
  123284. constructor();
  123285. /**
  123286. * The name of the behavior
  123287. */
  123288. get name(): string;
  123289. /**
  123290. * Initializes the behavior
  123291. */
  123292. init(): void;
  123293. private _getCurrentDistance;
  123294. /**
  123295. * Attaches the scale behavior the passed in mesh
  123296. * @param ownerNode The mesh that will be scaled around once attached
  123297. */
  123298. attach(ownerNode: Mesh): void;
  123299. /**
  123300. * Detaches the behavior from the mesh
  123301. */
  123302. detach(): void;
  123303. }
  123304. }
  123305. declare module BABYLON {
  123306. /**
  123307. * 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
  123308. */
  123309. export class SixDofDragBehavior implements Behavior<Mesh> {
  123310. private static _virtualScene;
  123311. private _ownerNode;
  123312. private _sceneRenderObserver;
  123313. private _scene;
  123314. private _targetPosition;
  123315. private _virtualOriginMesh;
  123316. private _virtualDragMesh;
  123317. private _pointerObserver;
  123318. private _moving;
  123319. private _startingOrientation;
  123320. private _attachedElement;
  123321. /**
  123322. * 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)
  123323. */
  123324. private zDragFactor;
  123325. /**
  123326. * If the object should rotate to face the drag origin
  123327. */
  123328. rotateDraggedObject: boolean;
  123329. /**
  123330. * If the behavior is currently in a dragging state
  123331. */
  123332. dragging: boolean;
  123333. /**
  123334. * 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)
  123335. */
  123336. dragDeltaRatio: number;
  123337. /**
  123338. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123339. */
  123340. currentDraggingPointerID: number;
  123341. /**
  123342. * If camera controls should be detached during the drag
  123343. */
  123344. detachCameraControls: boolean;
  123345. /**
  123346. * Fires each time a drag starts
  123347. */
  123348. onDragStartObservable: Observable<{}>;
  123349. /**
  123350. * Fires each time a drag ends (eg. mouse release after drag)
  123351. */
  123352. onDragEndObservable: Observable<{}>;
  123353. /**
  123354. * 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
  123355. */
  123356. constructor();
  123357. /**
  123358. * The name of the behavior
  123359. */
  123360. get name(): string;
  123361. /**
  123362. * Initializes the behavior
  123363. */
  123364. init(): void;
  123365. /**
  123366. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123367. */
  123368. private get _pointerCamera();
  123369. /**
  123370. * Attaches the scale behavior the passed in mesh
  123371. * @param ownerNode The mesh that will be scaled around once attached
  123372. */
  123373. attach(ownerNode: Mesh): void;
  123374. /**
  123375. * Detaches the behavior from the mesh
  123376. */
  123377. detach(): void;
  123378. }
  123379. }
  123380. declare module BABYLON {
  123381. /**
  123382. * Class used to apply inverse kinematics to bones
  123383. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123384. */
  123385. export class BoneIKController {
  123386. private static _tmpVecs;
  123387. private static _tmpQuat;
  123388. private static _tmpMats;
  123389. /**
  123390. * Gets or sets the target mesh
  123391. */
  123392. targetMesh: AbstractMesh;
  123393. /** Gets or sets the mesh used as pole */
  123394. poleTargetMesh: AbstractMesh;
  123395. /**
  123396. * Gets or sets the bone used as pole
  123397. */
  123398. poleTargetBone: Nullable<Bone>;
  123399. /**
  123400. * Gets or sets the target position
  123401. */
  123402. targetPosition: Vector3;
  123403. /**
  123404. * Gets or sets the pole target position
  123405. */
  123406. poleTargetPosition: Vector3;
  123407. /**
  123408. * Gets or sets the pole target local offset
  123409. */
  123410. poleTargetLocalOffset: Vector3;
  123411. /**
  123412. * Gets or sets the pole angle
  123413. */
  123414. poleAngle: number;
  123415. /**
  123416. * Gets or sets the mesh associated with the controller
  123417. */
  123418. mesh: AbstractMesh;
  123419. /**
  123420. * 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)
  123421. */
  123422. slerpAmount: number;
  123423. private _bone1Quat;
  123424. private _bone1Mat;
  123425. private _bone2Ang;
  123426. private _bone1;
  123427. private _bone2;
  123428. private _bone1Length;
  123429. private _bone2Length;
  123430. private _maxAngle;
  123431. private _maxReach;
  123432. private _rightHandedSystem;
  123433. private _bendAxis;
  123434. private _slerping;
  123435. private _adjustRoll;
  123436. /**
  123437. * Gets or sets maximum allowed angle
  123438. */
  123439. get maxAngle(): number;
  123440. set maxAngle(value: number);
  123441. /**
  123442. * Creates a new BoneIKController
  123443. * @param mesh defines the mesh to control
  123444. * @param bone defines the bone to control
  123445. * @param options defines options to set up the controller
  123446. */
  123447. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123448. targetMesh?: AbstractMesh;
  123449. poleTargetMesh?: AbstractMesh;
  123450. poleTargetBone?: Bone;
  123451. poleTargetLocalOffset?: Vector3;
  123452. poleAngle?: number;
  123453. bendAxis?: Vector3;
  123454. maxAngle?: number;
  123455. slerpAmount?: number;
  123456. });
  123457. private _setMaxAngle;
  123458. /**
  123459. * Force the controller to update the bones
  123460. */
  123461. update(): void;
  123462. }
  123463. }
  123464. declare module BABYLON {
  123465. /**
  123466. * Class used to make a bone look toward a point in space
  123467. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123468. */
  123469. export class BoneLookController {
  123470. private static _tmpVecs;
  123471. private static _tmpQuat;
  123472. private static _tmpMats;
  123473. /**
  123474. * The target Vector3 that the bone will look at
  123475. */
  123476. target: Vector3;
  123477. /**
  123478. * The mesh that the bone is attached to
  123479. */
  123480. mesh: AbstractMesh;
  123481. /**
  123482. * The bone that will be looking to the target
  123483. */
  123484. bone: Bone;
  123485. /**
  123486. * The up axis of the coordinate system that is used when the bone is rotated
  123487. */
  123488. upAxis: Vector3;
  123489. /**
  123490. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123491. */
  123492. upAxisSpace: Space;
  123493. /**
  123494. * Used to make an adjustment to the yaw of the bone
  123495. */
  123496. adjustYaw: number;
  123497. /**
  123498. * Used to make an adjustment to the pitch of the bone
  123499. */
  123500. adjustPitch: number;
  123501. /**
  123502. * Used to make an adjustment to the roll of the bone
  123503. */
  123504. adjustRoll: number;
  123505. /**
  123506. * 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)
  123507. */
  123508. slerpAmount: number;
  123509. private _minYaw;
  123510. private _maxYaw;
  123511. private _minPitch;
  123512. private _maxPitch;
  123513. private _minYawSin;
  123514. private _minYawCos;
  123515. private _maxYawSin;
  123516. private _maxYawCos;
  123517. private _midYawConstraint;
  123518. private _minPitchTan;
  123519. private _maxPitchTan;
  123520. private _boneQuat;
  123521. private _slerping;
  123522. private _transformYawPitch;
  123523. private _transformYawPitchInv;
  123524. private _firstFrameSkipped;
  123525. private _yawRange;
  123526. private _fowardAxis;
  123527. /**
  123528. * Gets or sets the minimum yaw angle that the bone can look to
  123529. */
  123530. get minYaw(): number;
  123531. set minYaw(value: number);
  123532. /**
  123533. * Gets or sets the maximum yaw angle that the bone can look to
  123534. */
  123535. get maxYaw(): number;
  123536. set maxYaw(value: number);
  123537. /**
  123538. * Gets or sets the minimum pitch angle that the bone can look to
  123539. */
  123540. get minPitch(): number;
  123541. set minPitch(value: number);
  123542. /**
  123543. * Gets or sets the maximum pitch angle that the bone can look to
  123544. */
  123545. get maxPitch(): number;
  123546. set maxPitch(value: number);
  123547. /**
  123548. * Create a BoneLookController
  123549. * @param mesh the mesh that the bone belongs to
  123550. * @param bone the bone that will be looking to the target
  123551. * @param target the target Vector3 to look at
  123552. * @param options optional settings:
  123553. * * maxYaw: the maximum angle the bone will yaw to
  123554. * * minYaw: the minimum angle the bone will yaw to
  123555. * * maxPitch: the maximum angle the bone will pitch to
  123556. * * minPitch: the minimum angle the bone will yaw to
  123557. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123558. * * upAxis: the up axis of the coordinate system
  123559. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123560. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123561. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123562. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123563. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123564. * * adjustRoll: used to make an adjustment to the roll of the bone
  123565. **/
  123566. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123567. maxYaw?: number;
  123568. minYaw?: number;
  123569. maxPitch?: number;
  123570. minPitch?: number;
  123571. slerpAmount?: number;
  123572. upAxis?: Vector3;
  123573. upAxisSpace?: Space;
  123574. yawAxis?: Vector3;
  123575. pitchAxis?: Vector3;
  123576. adjustYaw?: number;
  123577. adjustPitch?: number;
  123578. adjustRoll?: number;
  123579. });
  123580. /**
  123581. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123582. */
  123583. update(): void;
  123584. private _getAngleDiff;
  123585. private _getAngleBetween;
  123586. private _isAngleBetween;
  123587. }
  123588. }
  123589. declare module BABYLON {
  123590. /**
  123591. * Manage the gamepad inputs to control an arc rotate camera.
  123592. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123593. */
  123594. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123595. /**
  123596. * Defines the camera the input is attached to.
  123597. */
  123598. camera: ArcRotateCamera;
  123599. /**
  123600. * Defines the gamepad the input is gathering event from.
  123601. */
  123602. gamepad: Nullable<Gamepad>;
  123603. /**
  123604. * Defines the gamepad rotation sensiblity.
  123605. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123606. */
  123607. gamepadRotationSensibility: number;
  123608. /**
  123609. * Defines the gamepad move sensiblity.
  123610. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123611. */
  123612. gamepadMoveSensibility: number;
  123613. private _yAxisScale;
  123614. /**
  123615. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123616. */
  123617. get invertYAxis(): boolean;
  123618. set invertYAxis(value: boolean);
  123619. private _onGamepadConnectedObserver;
  123620. private _onGamepadDisconnectedObserver;
  123621. /**
  123622. * Attach the input controls to a specific dom element to get the input from.
  123623. * @param element Defines the element the controls should be listened from
  123624. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123625. */
  123626. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123627. /**
  123628. * Detach the current controls from the specified dom element.
  123629. * @param element Defines the element to stop listening the inputs from
  123630. */
  123631. detachControl(element: Nullable<HTMLElement>): void;
  123632. /**
  123633. * Update the current camera state depending on the inputs that have been used this frame.
  123634. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123635. */
  123636. checkInputs(): void;
  123637. /**
  123638. * Gets the class name of the current intput.
  123639. * @returns the class name
  123640. */
  123641. getClassName(): string;
  123642. /**
  123643. * Get the friendly name associated with the input class.
  123644. * @returns the input friendly name
  123645. */
  123646. getSimpleName(): string;
  123647. }
  123648. }
  123649. declare module BABYLON {
  123650. interface ArcRotateCameraInputsManager {
  123651. /**
  123652. * Add orientation input support to the input manager.
  123653. * @returns the current input manager
  123654. */
  123655. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123656. }
  123657. /**
  123658. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123659. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123660. */
  123661. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123662. /**
  123663. * Defines the camera the input is attached to.
  123664. */
  123665. camera: ArcRotateCamera;
  123666. /**
  123667. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123668. */
  123669. alphaCorrection: number;
  123670. /**
  123671. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123672. */
  123673. gammaCorrection: number;
  123674. private _alpha;
  123675. private _gamma;
  123676. private _dirty;
  123677. private _deviceOrientationHandler;
  123678. /**
  123679. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123680. */
  123681. constructor();
  123682. /**
  123683. * Attach the input controls to a specific dom element to get the input from.
  123684. * @param element Defines the element the controls should be listened from
  123685. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123686. */
  123687. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123688. /** @hidden */
  123689. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123690. /**
  123691. * Update the current camera state depending on the inputs that have been used this frame.
  123692. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123693. */
  123694. checkInputs(): void;
  123695. /**
  123696. * Detach the current controls from the specified dom element.
  123697. * @param element Defines the element to stop listening the inputs from
  123698. */
  123699. detachControl(element: Nullable<HTMLElement>): void;
  123700. /**
  123701. * Gets the class name of the current intput.
  123702. * @returns the class name
  123703. */
  123704. getClassName(): string;
  123705. /**
  123706. * Get the friendly name associated with the input class.
  123707. * @returns the input friendly name
  123708. */
  123709. getSimpleName(): string;
  123710. }
  123711. }
  123712. declare module BABYLON {
  123713. /**
  123714. * Listen to mouse events to control the camera.
  123715. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123716. */
  123717. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123718. /**
  123719. * Defines the camera the input is attached to.
  123720. */
  123721. camera: FlyCamera;
  123722. /**
  123723. * Defines if touch is enabled. (Default is true.)
  123724. */
  123725. touchEnabled: boolean;
  123726. /**
  123727. * Defines the buttons associated with the input to handle camera rotation.
  123728. */
  123729. buttons: number[];
  123730. /**
  123731. * Assign buttons for Yaw control.
  123732. */
  123733. buttonsYaw: number[];
  123734. /**
  123735. * Assign buttons for Pitch control.
  123736. */
  123737. buttonsPitch: number[];
  123738. /**
  123739. * Assign buttons for Roll control.
  123740. */
  123741. buttonsRoll: number[];
  123742. /**
  123743. * Detect if any button is being pressed while mouse is moved.
  123744. * -1 = Mouse locked.
  123745. * 0 = Left button.
  123746. * 1 = Middle Button.
  123747. * 2 = Right Button.
  123748. */
  123749. activeButton: number;
  123750. /**
  123751. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123752. * Higher values reduce its sensitivity.
  123753. */
  123754. angularSensibility: number;
  123755. private _mousemoveCallback;
  123756. private _observer;
  123757. private _rollObserver;
  123758. private previousPosition;
  123759. private noPreventDefault;
  123760. private element;
  123761. /**
  123762. * Listen to mouse events to control the camera.
  123763. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123764. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123765. */
  123766. constructor(touchEnabled?: boolean);
  123767. /**
  123768. * Attach the mouse control to the HTML DOM element.
  123769. * @param element Defines the element that listens to the input events.
  123770. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123771. */
  123772. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123773. /**
  123774. * Detach the current controls from the specified dom element.
  123775. * @param element Defines the element to stop listening the inputs from
  123776. */
  123777. detachControl(element: Nullable<HTMLElement>): void;
  123778. /**
  123779. * Gets the class name of the current input.
  123780. * @returns the class name.
  123781. */
  123782. getClassName(): string;
  123783. /**
  123784. * Get the friendly name associated with the input class.
  123785. * @returns the input's friendly name.
  123786. */
  123787. getSimpleName(): string;
  123788. private _pointerInput;
  123789. private _onMouseMove;
  123790. /**
  123791. * Rotate camera by mouse offset.
  123792. */
  123793. private rotateCamera;
  123794. }
  123795. }
  123796. declare module BABYLON {
  123797. /**
  123798. * Default Inputs manager for the FlyCamera.
  123799. * It groups all the default supported inputs for ease of use.
  123800. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123801. */
  123802. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123803. /**
  123804. * Instantiates a new FlyCameraInputsManager.
  123805. * @param camera Defines the camera the inputs belong to.
  123806. */
  123807. constructor(camera: FlyCamera);
  123808. /**
  123809. * Add keyboard input support to the input manager.
  123810. * @returns the new FlyCameraKeyboardMoveInput().
  123811. */
  123812. addKeyboard(): FlyCameraInputsManager;
  123813. /**
  123814. * Add mouse input support to the input manager.
  123815. * @param touchEnabled Enable touch screen support.
  123816. * @returns the new FlyCameraMouseInput().
  123817. */
  123818. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123819. }
  123820. }
  123821. declare module BABYLON {
  123822. /**
  123823. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123824. * such as in a 3D Space Shooter or a Flight Simulator.
  123825. */
  123826. export class FlyCamera extends TargetCamera {
  123827. /**
  123828. * Define the collision ellipsoid of the camera.
  123829. * This is helpful for simulating a camera body, like a player's body.
  123830. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123831. */
  123832. ellipsoid: Vector3;
  123833. /**
  123834. * Define an offset for the position of the ellipsoid around the camera.
  123835. * This can be helpful if the camera is attached away from the player's body center,
  123836. * such as at its head.
  123837. */
  123838. ellipsoidOffset: Vector3;
  123839. /**
  123840. * Enable or disable collisions of the camera with the rest of the scene objects.
  123841. */
  123842. checkCollisions: boolean;
  123843. /**
  123844. * Enable or disable gravity on the camera.
  123845. */
  123846. applyGravity: boolean;
  123847. /**
  123848. * Define the current direction the camera is moving to.
  123849. */
  123850. cameraDirection: Vector3;
  123851. /**
  123852. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123853. * This overrides and empties cameraRotation.
  123854. */
  123855. rotationQuaternion: Quaternion;
  123856. /**
  123857. * Track Roll to maintain the wanted Rolling when looking around.
  123858. */
  123859. _trackRoll: number;
  123860. /**
  123861. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123862. */
  123863. rollCorrect: number;
  123864. /**
  123865. * Mimic a banked turn, Rolling the camera when Yawing.
  123866. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123867. */
  123868. bankedTurn: boolean;
  123869. /**
  123870. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123871. */
  123872. bankedTurnLimit: number;
  123873. /**
  123874. * Value of 0 disables the banked Roll.
  123875. * Value of 1 is equal to the Yaw angle in radians.
  123876. */
  123877. bankedTurnMultiplier: number;
  123878. /**
  123879. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123880. */
  123881. inputs: FlyCameraInputsManager;
  123882. /**
  123883. * Gets the input sensibility for mouse input.
  123884. * Higher values reduce sensitivity.
  123885. */
  123886. get angularSensibility(): number;
  123887. /**
  123888. * Sets the input sensibility for a mouse input.
  123889. * Higher values reduce sensitivity.
  123890. */
  123891. set angularSensibility(value: number);
  123892. /**
  123893. * Get the keys for camera movement forward.
  123894. */
  123895. get keysForward(): number[];
  123896. /**
  123897. * Set the keys for camera movement forward.
  123898. */
  123899. set keysForward(value: number[]);
  123900. /**
  123901. * Get the keys for camera movement backward.
  123902. */
  123903. get keysBackward(): number[];
  123904. set keysBackward(value: number[]);
  123905. /**
  123906. * Get the keys for camera movement up.
  123907. */
  123908. get keysUp(): number[];
  123909. /**
  123910. * Set the keys for camera movement up.
  123911. */
  123912. set keysUp(value: number[]);
  123913. /**
  123914. * Get the keys for camera movement down.
  123915. */
  123916. get keysDown(): number[];
  123917. /**
  123918. * Set the keys for camera movement down.
  123919. */
  123920. set keysDown(value: number[]);
  123921. /**
  123922. * Get the keys for camera movement left.
  123923. */
  123924. get keysLeft(): number[];
  123925. /**
  123926. * Set the keys for camera movement left.
  123927. */
  123928. set keysLeft(value: number[]);
  123929. /**
  123930. * Set the keys for camera movement right.
  123931. */
  123932. get keysRight(): number[];
  123933. /**
  123934. * Set the keys for camera movement right.
  123935. */
  123936. set keysRight(value: number[]);
  123937. /**
  123938. * Event raised when the camera collides with a mesh in the scene.
  123939. */
  123940. onCollide: (collidedMesh: AbstractMesh) => void;
  123941. private _collider;
  123942. private _needMoveForGravity;
  123943. private _oldPosition;
  123944. private _diffPosition;
  123945. private _newPosition;
  123946. /** @hidden */
  123947. _localDirection: Vector3;
  123948. /** @hidden */
  123949. _transformedDirection: Vector3;
  123950. /**
  123951. * Instantiates a FlyCamera.
  123952. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123953. * such as in a 3D Space Shooter or a Flight Simulator.
  123954. * @param name Define the name of the camera in the scene.
  123955. * @param position Define the starting position of the camera in the scene.
  123956. * @param scene Define the scene the camera belongs to.
  123957. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123958. */
  123959. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123960. /**
  123961. * Attach a control to the HTML DOM element.
  123962. * @param element Defines the element that listens to the input events.
  123963. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123964. */
  123965. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123966. /**
  123967. * Detach a control from the HTML DOM element.
  123968. * The camera will stop reacting to that input.
  123969. * @param element Defines the element that listens to the input events.
  123970. */
  123971. detachControl(element: HTMLElement): void;
  123972. private _collisionMask;
  123973. /**
  123974. * Get the mask that the camera ignores in collision events.
  123975. */
  123976. get collisionMask(): number;
  123977. /**
  123978. * Set the mask that the camera ignores in collision events.
  123979. */
  123980. set collisionMask(mask: number);
  123981. /** @hidden */
  123982. _collideWithWorld(displacement: Vector3): void;
  123983. /** @hidden */
  123984. private _onCollisionPositionChange;
  123985. /** @hidden */
  123986. _checkInputs(): void;
  123987. /** @hidden */
  123988. _decideIfNeedsToMove(): boolean;
  123989. /** @hidden */
  123990. _updatePosition(): void;
  123991. /**
  123992. * Restore the Roll to its target value at the rate specified.
  123993. * @param rate - Higher means slower restoring.
  123994. * @hidden
  123995. */
  123996. restoreRoll(rate: number): void;
  123997. /**
  123998. * Destroy the camera and release the current resources held by it.
  123999. */
  124000. dispose(): void;
  124001. /**
  124002. * Get the current object class name.
  124003. * @returns the class name.
  124004. */
  124005. getClassName(): string;
  124006. }
  124007. }
  124008. declare module BABYLON {
  124009. /**
  124010. * Listen to keyboard events to control the camera.
  124011. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124012. */
  124013. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  124014. /**
  124015. * Defines the camera the input is attached to.
  124016. */
  124017. camera: FlyCamera;
  124018. /**
  124019. * The list of keyboard keys used to control the forward move of the camera.
  124020. */
  124021. keysForward: number[];
  124022. /**
  124023. * The list of keyboard keys used to control the backward move of the camera.
  124024. */
  124025. keysBackward: number[];
  124026. /**
  124027. * The list of keyboard keys used to control the forward move of the camera.
  124028. */
  124029. keysUp: number[];
  124030. /**
  124031. * The list of keyboard keys used to control the backward move of the camera.
  124032. */
  124033. keysDown: number[];
  124034. /**
  124035. * The list of keyboard keys used to control the right strafe move of the camera.
  124036. */
  124037. keysRight: number[];
  124038. /**
  124039. * The list of keyboard keys used to control the left strafe move of the camera.
  124040. */
  124041. keysLeft: number[];
  124042. private _keys;
  124043. private _onCanvasBlurObserver;
  124044. private _onKeyboardObserver;
  124045. private _engine;
  124046. private _scene;
  124047. /**
  124048. * Attach the input controls to a specific dom element to get the input from.
  124049. * @param element Defines the element the controls should be listened from
  124050. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124051. */
  124052. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124053. /**
  124054. * Detach the current controls from the specified dom element.
  124055. * @param element Defines the element to stop listening the inputs from
  124056. */
  124057. detachControl(element: Nullable<HTMLElement>): void;
  124058. /**
  124059. * Gets the class name of the current intput.
  124060. * @returns the class name
  124061. */
  124062. getClassName(): string;
  124063. /** @hidden */
  124064. _onLostFocus(e: FocusEvent): void;
  124065. /**
  124066. * Get the friendly name associated with the input class.
  124067. * @returns the input friendly name
  124068. */
  124069. getSimpleName(): string;
  124070. /**
  124071. * Update the current camera state depending on the inputs that have been used this frame.
  124072. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124073. */
  124074. checkInputs(): void;
  124075. }
  124076. }
  124077. declare module BABYLON {
  124078. /**
  124079. * Manage the mouse wheel inputs to control a follow camera.
  124080. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124081. */
  124082. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124083. /**
  124084. * Defines the camera the input is attached to.
  124085. */
  124086. camera: FollowCamera;
  124087. /**
  124088. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124089. */
  124090. axisControlRadius: boolean;
  124091. /**
  124092. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124093. */
  124094. axisControlHeight: boolean;
  124095. /**
  124096. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124097. */
  124098. axisControlRotation: boolean;
  124099. /**
  124100. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124101. * relation to mouseWheel events.
  124102. */
  124103. wheelPrecision: number;
  124104. /**
  124105. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124106. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124107. */
  124108. wheelDeltaPercentage: number;
  124109. private _wheel;
  124110. private _observer;
  124111. /**
  124112. * Attach the input controls to a specific dom element to get the input from.
  124113. * @param element Defines the element the controls should be listened from
  124114. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124115. */
  124116. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124117. /**
  124118. * Detach the current controls from the specified dom element.
  124119. * @param element Defines the element to stop listening the inputs from
  124120. */
  124121. detachControl(element: Nullable<HTMLElement>): void;
  124122. /**
  124123. * Gets the class name of the current intput.
  124124. * @returns the class name
  124125. */
  124126. getClassName(): string;
  124127. /**
  124128. * Get the friendly name associated with the input class.
  124129. * @returns the input friendly name
  124130. */
  124131. getSimpleName(): string;
  124132. }
  124133. }
  124134. declare module BABYLON {
  124135. /**
  124136. * Manage the pointers inputs to control an follow camera.
  124137. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124138. */
  124139. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124140. /**
  124141. * Defines the camera the input is attached to.
  124142. */
  124143. camera: FollowCamera;
  124144. /**
  124145. * Gets the class name of the current input.
  124146. * @returns the class name
  124147. */
  124148. getClassName(): string;
  124149. /**
  124150. * Defines the pointer angular sensibility along the X axis or how fast is
  124151. * the camera rotating.
  124152. * A negative number will reverse the axis direction.
  124153. */
  124154. angularSensibilityX: number;
  124155. /**
  124156. * Defines the pointer angular sensibility along the Y axis or how fast is
  124157. * the camera rotating.
  124158. * A negative number will reverse the axis direction.
  124159. */
  124160. angularSensibilityY: number;
  124161. /**
  124162. * Defines the pointer pinch precision or how fast is the camera zooming.
  124163. * A negative number will reverse the axis direction.
  124164. */
  124165. pinchPrecision: number;
  124166. /**
  124167. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124168. * from 0.
  124169. * It defines the percentage of current camera.radius to use as delta when
  124170. * pinch zoom is used.
  124171. */
  124172. pinchDeltaPercentage: number;
  124173. /**
  124174. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124175. */
  124176. axisXControlRadius: boolean;
  124177. /**
  124178. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124179. */
  124180. axisXControlHeight: boolean;
  124181. /**
  124182. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124183. */
  124184. axisXControlRotation: boolean;
  124185. /**
  124186. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124187. */
  124188. axisYControlRadius: boolean;
  124189. /**
  124190. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124191. */
  124192. axisYControlHeight: boolean;
  124193. /**
  124194. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124195. */
  124196. axisYControlRotation: boolean;
  124197. /**
  124198. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124199. */
  124200. axisPinchControlRadius: boolean;
  124201. /**
  124202. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124203. */
  124204. axisPinchControlHeight: boolean;
  124205. /**
  124206. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124207. */
  124208. axisPinchControlRotation: boolean;
  124209. /**
  124210. * Log error messages if basic misconfiguration has occurred.
  124211. */
  124212. warningEnable: boolean;
  124213. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124214. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124215. private _warningCounter;
  124216. private _warning;
  124217. }
  124218. }
  124219. declare module BABYLON {
  124220. /**
  124221. * Default Inputs manager for the FollowCamera.
  124222. * It groups all the default supported inputs for ease of use.
  124223. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124224. */
  124225. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124226. /**
  124227. * Instantiates a new FollowCameraInputsManager.
  124228. * @param camera Defines the camera the inputs belong to
  124229. */
  124230. constructor(camera: FollowCamera);
  124231. /**
  124232. * Add keyboard input support to the input manager.
  124233. * @returns the current input manager
  124234. */
  124235. addKeyboard(): FollowCameraInputsManager;
  124236. /**
  124237. * Add mouse wheel input support to the input manager.
  124238. * @returns the current input manager
  124239. */
  124240. addMouseWheel(): FollowCameraInputsManager;
  124241. /**
  124242. * Add pointers input support to the input manager.
  124243. * @returns the current input manager
  124244. */
  124245. addPointers(): FollowCameraInputsManager;
  124246. /**
  124247. * Add orientation input support to the input manager.
  124248. * @returns the current input manager
  124249. */
  124250. addVRDeviceOrientation(): FollowCameraInputsManager;
  124251. }
  124252. }
  124253. declare module BABYLON {
  124254. /**
  124255. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124256. * an arc rotate version arcFollowCamera are available.
  124257. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124258. */
  124259. export class FollowCamera extends TargetCamera {
  124260. /**
  124261. * Distance the follow camera should follow an object at
  124262. */
  124263. radius: number;
  124264. /**
  124265. * Minimum allowed distance of the camera to the axis of rotation
  124266. * (The camera can not get closer).
  124267. * This can help limiting how the Camera is able to move in the scene.
  124268. */
  124269. lowerRadiusLimit: Nullable<number>;
  124270. /**
  124271. * Maximum allowed distance of the camera to the axis of rotation
  124272. * (The camera can not get further).
  124273. * This can help limiting how the Camera is able to move in the scene.
  124274. */
  124275. upperRadiusLimit: Nullable<number>;
  124276. /**
  124277. * Define a rotation offset between the camera and the object it follows
  124278. */
  124279. rotationOffset: number;
  124280. /**
  124281. * Minimum allowed angle to camera position relative to target object.
  124282. * This can help limiting how the Camera is able to move in the scene.
  124283. */
  124284. lowerRotationOffsetLimit: Nullable<number>;
  124285. /**
  124286. * Maximum allowed angle to camera position relative to target object.
  124287. * This can help limiting how the Camera is able to move in the scene.
  124288. */
  124289. upperRotationOffsetLimit: Nullable<number>;
  124290. /**
  124291. * Define a height offset between the camera and the object it follows.
  124292. * It can help following an object from the top (like a car chaing a plane)
  124293. */
  124294. heightOffset: number;
  124295. /**
  124296. * Minimum allowed height of camera position relative to target object.
  124297. * This can help limiting how the Camera is able to move in the scene.
  124298. */
  124299. lowerHeightOffsetLimit: Nullable<number>;
  124300. /**
  124301. * Maximum allowed height of camera position relative to target object.
  124302. * This can help limiting how the Camera is able to move in the scene.
  124303. */
  124304. upperHeightOffsetLimit: Nullable<number>;
  124305. /**
  124306. * Define how fast the camera can accelerate to follow it s target.
  124307. */
  124308. cameraAcceleration: number;
  124309. /**
  124310. * Define the speed limit of the camera following an object.
  124311. */
  124312. maxCameraSpeed: number;
  124313. /**
  124314. * Define the target of the camera.
  124315. */
  124316. lockedTarget: Nullable<AbstractMesh>;
  124317. /**
  124318. * Defines the input associated with the camera.
  124319. */
  124320. inputs: FollowCameraInputsManager;
  124321. /**
  124322. * Instantiates the follow camera.
  124323. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124324. * @param name Define the name of the camera in the scene
  124325. * @param position Define the position of the camera
  124326. * @param scene Define the scene the camera belong to
  124327. * @param lockedTarget Define the target of the camera
  124328. */
  124329. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124330. private _follow;
  124331. /**
  124332. * Attached controls to the current camera.
  124333. * @param element Defines the element the controls should be listened from
  124334. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124335. */
  124336. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124337. /**
  124338. * Detach the current controls from the camera.
  124339. * The camera will stop reacting to inputs.
  124340. * @param element Defines the element to stop listening the inputs from
  124341. */
  124342. detachControl(element: HTMLElement): void;
  124343. /** @hidden */
  124344. _checkInputs(): void;
  124345. private _checkLimits;
  124346. /**
  124347. * Gets the camera class name.
  124348. * @returns the class name
  124349. */
  124350. getClassName(): string;
  124351. }
  124352. /**
  124353. * Arc Rotate version of the follow camera.
  124354. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124355. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124356. */
  124357. export class ArcFollowCamera extends TargetCamera {
  124358. /** The longitudinal angle of the camera */
  124359. alpha: number;
  124360. /** The latitudinal angle of the camera */
  124361. beta: number;
  124362. /** The radius of the camera from its target */
  124363. radius: number;
  124364. private _cartesianCoordinates;
  124365. /** Define the camera target (the mesh it should follow) */
  124366. private _meshTarget;
  124367. /**
  124368. * Instantiates a new ArcFollowCamera
  124369. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124370. * @param name Define the name of the camera
  124371. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124372. * @param beta Define the rotation angle of the camera around the elevation axis
  124373. * @param radius Define the radius of the camera from its target point
  124374. * @param target Define the target of the camera
  124375. * @param scene Define the scene the camera belongs to
  124376. */
  124377. constructor(name: string,
  124378. /** The longitudinal angle of the camera */
  124379. alpha: number,
  124380. /** The latitudinal angle of the camera */
  124381. beta: number,
  124382. /** The radius of the camera from its target */
  124383. radius: number,
  124384. /** Define the camera target (the mesh it should follow) */
  124385. target: Nullable<AbstractMesh>, scene: Scene);
  124386. private _follow;
  124387. /** @hidden */
  124388. _checkInputs(): void;
  124389. /**
  124390. * Returns the class name of the object.
  124391. * It is mostly used internally for serialization purposes.
  124392. */
  124393. getClassName(): string;
  124394. }
  124395. }
  124396. declare module BABYLON {
  124397. /**
  124398. * Manage the keyboard inputs to control the movement of a follow camera.
  124399. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124400. */
  124401. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124402. /**
  124403. * Defines the camera the input is attached to.
  124404. */
  124405. camera: FollowCamera;
  124406. /**
  124407. * Defines the list of key codes associated with the up action (increase heightOffset)
  124408. */
  124409. keysHeightOffsetIncr: number[];
  124410. /**
  124411. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124412. */
  124413. keysHeightOffsetDecr: number[];
  124414. /**
  124415. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124416. */
  124417. keysHeightOffsetModifierAlt: boolean;
  124418. /**
  124419. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124420. */
  124421. keysHeightOffsetModifierCtrl: boolean;
  124422. /**
  124423. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124424. */
  124425. keysHeightOffsetModifierShift: boolean;
  124426. /**
  124427. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124428. */
  124429. keysRotationOffsetIncr: number[];
  124430. /**
  124431. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124432. */
  124433. keysRotationOffsetDecr: number[];
  124434. /**
  124435. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124436. */
  124437. keysRotationOffsetModifierAlt: boolean;
  124438. /**
  124439. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124440. */
  124441. keysRotationOffsetModifierCtrl: boolean;
  124442. /**
  124443. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124444. */
  124445. keysRotationOffsetModifierShift: boolean;
  124446. /**
  124447. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124448. */
  124449. keysRadiusIncr: number[];
  124450. /**
  124451. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124452. */
  124453. keysRadiusDecr: number[];
  124454. /**
  124455. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124456. */
  124457. keysRadiusModifierAlt: boolean;
  124458. /**
  124459. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124460. */
  124461. keysRadiusModifierCtrl: boolean;
  124462. /**
  124463. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124464. */
  124465. keysRadiusModifierShift: boolean;
  124466. /**
  124467. * Defines the rate of change of heightOffset.
  124468. */
  124469. heightSensibility: number;
  124470. /**
  124471. * Defines the rate of change of rotationOffset.
  124472. */
  124473. rotationSensibility: number;
  124474. /**
  124475. * Defines the rate of change of radius.
  124476. */
  124477. radiusSensibility: number;
  124478. private _keys;
  124479. private _ctrlPressed;
  124480. private _altPressed;
  124481. private _shiftPressed;
  124482. private _onCanvasBlurObserver;
  124483. private _onKeyboardObserver;
  124484. private _engine;
  124485. private _scene;
  124486. /**
  124487. * Attach the input controls to a specific dom element to get the input from.
  124488. * @param element Defines the element the controls should be listened from
  124489. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124490. */
  124491. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124492. /**
  124493. * Detach the current controls from the specified dom element.
  124494. * @param element Defines the element to stop listening the inputs from
  124495. */
  124496. detachControl(element: Nullable<HTMLElement>): void;
  124497. /**
  124498. * Update the current camera state depending on the inputs that have been used this frame.
  124499. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124500. */
  124501. checkInputs(): void;
  124502. /**
  124503. * Gets the class name of the current input.
  124504. * @returns the class name
  124505. */
  124506. getClassName(): string;
  124507. /**
  124508. * Get the friendly name associated with the input class.
  124509. * @returns the input friendly name
  124510. */
  124511. getSimpleName(): string;
  124512. /**
  124513. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124514. * allow modification of the heightOffset value.
  124515. */
  124516. private _modifierHeightOffset;
  124517. /**
  124518. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124519. * allow modification of the rotationOffset value.
  124520. */
  124521. private _modifierRotationOffset;
  124522. /**
  124523. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124524. * allow modification of the radius value.
  124525. */
  124526. private _modifierRadius;
  124527. }
  124528. }
  124529. declare module BABYLON {
  124530. interface FreeCameraInputsManager {
  124531. /**
  124532. * @hidden
  124533. */
  124534. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124535. /**
  124536. * Add orientation input support to the input manager.
  124537. * @returns the current input manager
  124538. */
  124539. addDeviceOrientation(): FreeCameraInputsManager;
  124540. }
  124541. /**
  124542. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124543. * Screen rotation is taken into account.
  124544. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124545. */
  124546. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124547. private _camera;
  124548. private _screenOrientationAngle;
  124549. private _constantTranform;
  124550. private _screenQuaternion;
  124551. private _alpha;
  124552. private _beta;
  124553. private _gamma;
  124554. /**
  124555. * Can be used to detect if a device orientation sensor is available on a device
  124556. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124557. * @returns a promise that will resolve on orientation change
  124558. */
  124559. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124560. /**
  124561. * @hidden
  124562. */
  124563. _onDeviceOrientationChangedObservable: Observable<void>;
  124564. /**
  124565. * Instantiates a new input
  124566. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124567. */
  124568. constructor();
  124569. /**
  124570. * Define the camera controlled by the input.
  124571. */
  124572. get camera(): FreeCamera;
  124573. set camera(camera: FreeCamera);
  124574. /**
  124575. * Attach the input controls to a specific dom element to get the input from.
  124576. * @param element Defines the element the controls should be listened from
  124577. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124578. */
  124579. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124580. private _orientationChanged;
  124581. private _deviceOrientation;
  124582. /**
  124583. * Detach the current controls from the specified dom element.
  124584. * @param element Defines the element to stop listening the inputs from
  124585. */
  124586. detachControl(element: Nullable<HTMLElement>): void;
  124587. /**
  124588. * Update the current camera state depending on the inputs that have been used this frame.
  124589. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124590. */
  124591. checkInputs(): void;
  124592. /**
  124593. * Gets the class name of the current intput.
  124594. * @returns the class name
  124595. */
  124596. getClassName(): string;
  124597. /**
  124598. * Get the friendly name associated with the input class.
  124599. * @returns the input friendly name
  124600. */
  124601. getSimpleName(): string;
  124602. }
  124603. }
  124604. declare module BABYLON {
  124605. /**
  124606. * Manage the gamepad inputs to control a free camera.
  124607. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124608. */
  124609. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124610. /**
  124611. * Define the camera the input is attached to.
  124612. */
  124613. camera: FreeCamera;
  124614. /**
  124615. * Define the Gamepad controlling the input
  124616. */
  124617. gamepad: Nullable<Gamepad>;
  124618. /**
  124619. * Defines the gamepad rotation sensiblity.
  124620. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124621. */
  124622. gamepadAngularSensibility: number;
  124623. /**
  124624. * Defines the gamepad move sensiblity.
  124625. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124626. */
  124627. gamepadMoveSensibility: number;
  124628. private _yAxisScale;
  124629. /**
  124630. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124631. */
  124632. get invertYAxis(): boolean;
  124633. set invertYAxis(value: boolean);
  124634. private _onGamepadConnectedObserver;
  124635. private _onGamepadDisconnectedObserver;
  124636. private _cameraTransform;
  124637. private _deltaTransform;
  124638. private _vector3;
  124639. private _vector2;
  124640. /**
  124641. * Attach the input controls to a specific dom element to get the input from.
  124642. * @param element Defines the element the controls should be listened from
  124643. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124644. */
  124645. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124646. /**
  124647. * Detach the current controls from the specified dom element.
  124648. * @param element Defines the element to stop listening the inputs from
  124649. */
  124650. detachControl(element: Nullable<HTMLElement>): void;
  124651. /**
  124652. * Update the current camera state depending on the inputs that have been used this frame.
  124653. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124654. */
  124655. checkInputs(): void;
  124656. /**
  124657. * Gets the class name of the current intput.
  124658. * @returns the class name
  124659. */
  124660. getClassName(): string;
  124661. /**
  124662. * Get the friendly name associated with the input class.
  124663. * @returns the input friendly name
  124664. */
  124665. getSimpleName(): string;
  124666. }
  124667. }
  124668. declare module BABYLON {
  124669. /**
  124670. * Defines the potential axis of a Joystick
  124671. */
  124672. export enum JoystickAxis {
  124673. /** X axis */
  124674. X = 0,
  124675. /** Y axis */
  124676. Y = 1,
  124677. /** Z axis */
  124678. Z = 2
  124679. }
  124680. /**
  124681. * Represents the different customization options available
  124682. * for VirtualJoystick
  124683. */
  124684. interface VirtualJoystickCustomizations {
  124685. /**
  124686. * Size of the joystick's puck
  124687. */
  124688. puckSize: number;
  124689. /**
  124690. * Size of the joystick's container
  124691. */
  124692. containerSize: number;
  124693. /**
  124694. * Color of the joystick && puck
  124695. */
  124696. color: string;
  124697. /**
  124698. * Image URL for the joystick's puck
  124699. */
  124700. puckImage?: string;
  124701. /**
  124702. * Image URL for the joystick's container
  124703. */
  124704. containerImage?: string;
  124705. /**
  124706. * Defines the unmoving position of the joystick container
  124707. */
  124708. position?: {
  124709. x: number;
  124710. y: number;
  124711. };
  124712. /**
  124713. * Defines whether or not the joystick container is always visible
  124714. */
  124715. alwaysVisible: boolean;
  124716. /**
  124717. * Defines whether or not to limit the movement of the puck to the joystick's container
  124718. */
  124719. limitToContainer: boolean;
  124720. }
  124721. /**
  124722. * Class used to define virtual joystick (used in touch mode)
  124723. */
  124724. export class VirtualJoystick {
  124725. /**
  124726. * Gets or sets a boolean indicating that left and right values must be inverted
  124727. */
  124728. reverseLeftRight: boolean;
  124729. /**
  124730. * Gets or sets a boolean indicating that up and down values must be inverted
  124731. */
  124732. reverseUpDown: boolean;
  124733. /**
  124734. * Gets the offset value for the position (ie. the change of the position value)
  124735. */
  124736. deltaPosition: Vector3;
  124737. /**
  124738. * Gets a boolean indicating if the virtual joystick was pressed
  124739. */
  124740. pressed: boolean;
  124741. /**
  124742. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124743. */
  124744. static Canvas: Nullable<HTMLCanvasElement>;
  124745. /**
  124746. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124747. */
  124748. limitToContainer: boolean;
  124749. private static _globalJoystickIndex;
  124750. private static _alwaysVisibleSticks;
  124751. private static vjCanvasContext;
  124752. private static vjCanvasWidth;
  124753. private static vjCanvasHeight;
  124754. private static halfWidth;
  124755. private static _GetDefaultOptions;
  124756. private _action;
  124757. private _axisTargetedByLeftAndRight;
  124758. private _axisTargetedByUpAndDown;
  124759. private _joystickSensibility;
  124760. private _inversedSensibility;
  124761. private _joystickPointerID;
  124762. private _joystickColor;
  124763. private _joystickPointerPos;
  124764. private _joystickPreviousPointerPos;
  124765. private _joystickPointerStartPos;
  124766. private _deltaJoystickVector;
  124767. private _leftJoystick;
  124768. private _touches;
  124769. private _joystickPosition;
  124770. private _alwaysVisible;
  124771. private _puckImage;
  124772. private _containerImage;
  124773. private _joystickPuckSize;
  124774. private _joystickContainerSize;
  124775. private _clearPuckSize;
  124776. private _clearContainerSize;
  124777. private _clearPuckSizeOffset;
  124778. private _clearContainerSizeOffset;
  124779. private _onPointerDownHandlerRef;
  124780. private _onPointerMoveHandlerRef;
  124781. private _onPointerUpHandlerRef;
  124782. private _onResize;
  124783. /**
  124784. * Creates a new virtual joystick
  124785. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124786. * @param customizations Defines the options we want to customize the VirtualJoystick
  124787. */
  124788. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124789. /**
  124790. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124791. * @param newJoystickSensibility defines the new sensibility
  124792. */
  124793. setJoystickSensibility(newJoystickSensibility: number): void;
  124794. private _onPointerDown;
  124795. private _onPointerMove;
  124796. private _onPointerUp;
  124797. /**
  124798. * Change the color of the virtual joystick
  124799. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124800. */
  124801. setJoystickColor(newColor: string): void;
  124802. /**
  124803. * Size of the joystick's container
  124804. */
  124805. set containerSize(newSize: number);
  124806. get containerSize(): number;
  124807. /**
  124808. * Size of the joystick's puck
  124809. */
  124810. set puckSize(newSize: number);
  124811. get puckSize(): number;
  124812. /**
  124813. * Clears the set position of the joystick
  124814. */
  124815. clearPosition(): void;
  124816. /**
  124817. * Defines whether or not the joystick container is always visible
  124818. */
  124819. set alwaysVisible(value: boolean);
  124820. get alwaysVisible(): boolean;
  124821. /**
  124822. * Sets the constant position of the Joystick container
  124823. * @param x X axis coordinate
  124824. * @param y Y axis coordinate
  124825. */
  124826. setPosition(x: number, y: number): void;
  124827. /**
  124828. * Defines a callback to call when the joystick is touched
  124829. * @param action defines the callback
  124830. */
  124831. setActionOnTouch(action: () => any): void;
  124832. /**
  124833. * Defines which axis you'd like to control for left & right
  124834. * @param axis defines the axis to use
  124835. */
  124836. setAxisForLeftRight(axis: JoystickAxis): void;
  124837. /**
  124838. * Defines which axis you'd like to control for up & down
  124839. * @param axis defines the axis to use
  124840. */
  124841. setAxisForUpDown(axis: JoystickAxis): void;
  124842. /**
  124843. * Clears the canvas from the previous puck / container draw
  124844. */
  124845. private _clearPreviousDraw;
  124846. /**
  124847. * Loads `urlPath` to be used for the container's image
  124848. * @param urlPath defines the urlPath of an image to use
  124849. */
  124850. setContainerImage(urlPath: string): void;
  124851. /**
  124852. * Loads `urlPath` to be used for the puck's image
  124853. * @param urlPath defines the urlPath of an image to use
  124854. */
  124855. setPuckImage(urlPath: string): void;
  124856. /**
  124857. * Draws the Virtual Joystick's container
  124858. */
  124859. private _drawContainer;
  124860. /**
  124861. * Draws the Virtual Joystick's puck
  124862. */
  124863. private _drawPuck;
  124864. private _drawVirtualJoystick;
  124865. /**
  124866. * Release internal HTML canvas
  124867. */
  124868. releaseCanvas(): void;
  124869. }
  124870. }
  124871. declare module BABYLON {
  124872. interface FreeCameraInputsManager {
  124873. /**
  124874. * Add virtual joystick input support to the input manager.
  124875. * @returns the current input manager
  124876. */
  124877. addVirtualJoystick(): FreeCameraInputsManager;
  124878. }
  124879. /**
  124880. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124881. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124882. */
  124883. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124884. /**
  124885. * Defines the camera the input is attached to.
  124886. */
  124887. camera: FreeCamera;
  124888. private _leftjoystick;
  124889. private _rightjoystick;
  124890. /**
  124891. * Gets the left stick of the virtual joystick.
  124892. * @returns The virtual Joystick
  124893. */
  124894. getLeftJoystick(): VirtualJoystick;
  124895. /**
  124896. * Gets the right stick of the virtual joystick.
  124897. * @returns The virtual Joystick
  124898. */
  124899. getRightJoystick(): VirtualJoystick;
  124900. /**
  124901. * Update the current camera state depending on the inputs that have been used this frame.
  124902. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124903. */
  124904. checkInputs(): void;
  124905. /**
  124906. * Attach the input controls to a specific dom element to get the input from.
  124907. * @param element Defines the element the controls should be listened from
  124908. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124909. */
  124910. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124911. /**
  124912. * Detach the current controls from the specified dom element.
  124913. * @param element Defines the element to stop listening the inputs from
  124914. */
  124915. detachControl(element: Nullable<HTMLElement>): void;
  124916. /**
  124917. * Gets the class name of the current intput.
  124918. * @returns the class name
  124919. */
  124920. getClassName(): string;
  124921. /**
  124922. * Get the friendly name associated with the input class.
  124923. * @returns the input friendly name
  124924. */
  124925. getSimpleName(): string;
  124926. }
  124927. }
  124928. declare module BABYLON {
  124929. /**
  124930. * This represents a FPS type of camera controlled by touch.
  124931. * This is like a universal camera minus the Gamepad controls.
  124932. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124933. */
  124934. export class TouchCamera extends FreeCamera {
  124935. /**
  124936. * Defines the touch sensibility for rotation.
  124937. * The higher the faster.
  124938. */
  124939. get touchAngularSensibility(): number;
  124940. set touchAngularSensibility(value: number);
  124941. /**
  124942. * Defines the touch sensibility for move.
  124943. * The higher the faster.
  124944. */
  124945. get touchMoveSensibility(): number;
  124946. set touchMoveSensibility(value: number);
  124947. /**
  124948. * Instantiates a new touch camera.
  124949. * This represents a FPS type of camera controlled by touch.
  124950. * This is like a universal camera minus the Gamepad controls.
  124951. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124952. * @param name Define the name of the camera in the scene
  124953. * @param position Define the start position of the camera in the scene
  124954. * @param scene Define the scene the camera belongs to
  124955. */
  124956. constructor(name: string, position: Vector3, scene: Scene);
  124957. /**
  124958. * Gets the current object class name.
  124959. * @return the class name
  124960. */
  124961. getClassName(): string;
  124962. /** @hidden */
  124963. _setupInputs(): void;
  124964. }
  124965. }
  124966. declare module BABYLON {
  124967. /**
  124968. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124969. * being tilted forward or back and left or right.
  124970. */
  124971. export class DeviceOrientationCamera extends FreeCamera {
  124972. private _initialQuaternion;
  124973. private _quaternionCache;
  124974. private _tmpDragQuaternion;
  124975. private _disablePointerInputWhenUsingDeviceOrientation;
  124976. /**
  124977. * Creates a new device orientation camera
  124978. * @param name The name of the camera
  124979. * @param position The start position camera
  124980. * @param scene The scene the camera belongs to
  124981. */
  124982. constructor(name: string, position: Vector3, scene: Scene);
  124983. /**
  124984. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124985. */
  124986. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124987. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124988. private _dragFactor;
  124989. /**
  124990. * Enabled turning on the y axis when the orientation sensor is active
  124991. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124992. */
  124993. enableHorizontalDragging(dragFactor?: number): void;
  124994. /**
  124995. * Gets the current instance class name ("DeviceOrientationCamera").
  124996. * This helps avoiding instanceof at run time.
  124997. * @returns the class name
  124998. */
  124999. getClassName(): string;
  125000. /**
  125001. * @hidden
  125002. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  125003. */
  125004. _checkInputs(): void;
  125005. /**
  125006. * Reset the camera to its default orientation on the specified axis only.
  125007. * @param axis The axis to reset
  125008. */
  125009. resetToCurrentRotation(axis?: Axis): void;
  125010. }
  125011. }
  125012. declare module BABYLON {
  125013. /**
  125014. * Defines supported buttons for XBox360 compatible gamepads
  125015. */
  125016. export enum Xbox360Button {
  125017. /** A */
  125018. A = 0,
  125019. /** B */
  125020. B = 1,
  125021. /** X */
  125022. X = 2,
  125023. /** Y */
  125024. Y = 3,
  125025. /** Left button */
  125026. LB = 4,
  125027. /** Right button */
  125028. RB = 5,
  125029. /** Back */
  125030. Back = 8,
  125031. /** Start */
  125032. Start = 9,
  125033. /** Left stick */
  125034. LeftStick = 10,
  125035. /** Right stick */
  125036. RightStick = 11
  125037. }
  125038. /** Defines values for XBox360 DPad */
  125039. export enum Xbox360Dpad {
  125040. /** Up */
  125041. Up = 12,
  125042. /** Down */
  125043. Down = 13,
  125044. /** Left */
  125045. Left = 14,
  125046. /** Right */
  125047. Right = 15
  125048. }
  125049. /**
  125050. * Defines a XBox360 gamepad
  125051. */
  125052. export class Xbox360Pad extends Gamepad {
  125053. private _leftTrigger;
  125054. private _rightTrigger;
  125055. private _onlefttriggerchanged;
  125056. private _onrighttriggerchanged;
  125057. private _onbuttondown;
  125058. private _onbuttonup;
  125059. private _ondpaddown;
  125060. private _ondpadup;
  125061. /** Observable raised when a button is pressed */
  125062. onButtonDownObservable: Observable<Xbox360Button>;
  125063. /** Observable raised when a button is released */
  125064. onButtonUpObservable: Observable<Xbox360Button>;
  125065. /** Observable raised when a pad is pressed */
  125066. onPadDownObservable: Observable<Xbox360Dpad>;
  125067. /** Observable raised when a pad is released */
  125068. onPadUpObservable: Observable<Xbox360Dpad>;
  125069. private _buttonA;
  125070. private _buttonB;
  125071. private _buttonX;
  125072. private _buttonY;
  125073. private _buttonBack;
  125074. private _buttonStart;
  125075. private _buttonLB;
  125076. private _buttonRB;
  125077. private _buttonLeftStick;
  125078. private _buttonRightStick;
  125079. private _dPadUp;
  125080. private _dPadDown;
  125081. private _dPadLeft;
  125082. private _dPadRight;
  125083. private _isXboxOnePad;
  125084. /**
  125085. * Creates a new XBox360 gamepad object
  125086. * @param id defines the id of this gamepad
  125087. * @param index defines its index
  125088. * @param gamepad defines the internal HTML gamepad object
  125089. * @param xboxOne defines if it is a XBox One gamepad
  125090. */
  125091. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125092. /**
  125093. * Defines the callback to call when left trigger is pressed
  125094. * @param callback defines the callback to use
  125095. */
  125096. onlefttriggerchanged(callback: (value: number) => void): void;
  125097. /**
  125098. * Defines the callback to call when right trigger is pressed
  125099. * @param callback defines the callback to use
  125100. */
  125101. onrighttriggerchanged(callback: (value: number) => void): void;
  125102. /**
  125103. * Gets the left trigger value
  125104. */
  125105. get leftTrigger(): number;
  125106. /**
  125107. * Sets the left trigger value
  125108. */
  125109. set leftTrigger(newValue: number);
  125110. /**
  125111. * Gets the right trigger value
  125112. */
  125113. get rightTrigger(): number;
  125114. /**
  125115. * Sets the right trigger value
  125116. */
  125117. set rightTrigger(newValue: number);
  125118. /**
  125119. * Defines the callback to call when a button is pressed
  125120. * @param callback defines the callback to use
  125121. */
  125122. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125123. /**
  125124. * Defines the callback to call when a button is released
  125125. * @param callback defines the callback to use
  125126. */
  125127. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125128. /**
  125129. * Defines the callback to call when a pad is pressed
  125130. * @param callback defines the callback to use
  125131. */
  125132. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125133. /**
  125134. * Defines the callback to call when a pad is released
  125135. * @param callback defines the callback to use
  125136. */
  125137. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125138. private _setButtonValue;
  125139. private _setDPadValue;
  125140. /**
  125141. * Gets the value of the `A` button
  125142. */
  125143. get buttonA(): number;
  125144. /**
  125145. * Sets the value of the `A` button
  125146. */
  125147. set buttonA(value: number);
  125148. /**
  125149. * Gets the value of the `B` button
  125150. */
  125151. get buttonB(): number;
  125152. /**
  125153. * Sets the value of the `B` button
  125154. */
  125155. set buttonB(value: number);
  125156. /**
  125157. * Gets the value of the `X` button
  125158. */
  125159. get buttonX(): number;
  125160. /**
  125161. * Sets the value of the `X` button
  125162. */
  125163. set buttonX(value: number);
  125164. /**
  125165. * Gets the value of the `Y` button
  125166. */
  125167. get buttonY(): number;
  125168. /**
  125169. * Sets the value of the `Y` button
  125170. */
  125171. set buttonY(value: number);
  125172. /**
  125173. * Gets the value of the `Start` button
  125174. */
  125175. get buttonStart(): number;
  125176. /**
  125177. * Sets the value of the `Start` button
  125178. */
  125179. set buttonStart(value: number);
  125180. /**
  125181. * Gets the value of the `Back` button
  125182. */
  125183. get buttonBack(): number;
  125184. /**
  125185. * Sets the value of the `Back` button
  125186. */
  125187. set buttonBack(value: number);
  125188. /**
  125189. * Gets the value of the `Left` button
  125190. */
  125191. get buttonLB(): number;
  125192. /**
  125193. * Sets the value of the `Left` button
  125194. */
  125195. set buttonLB(value: number);
  125196. /**
  125197. * Gets the value of the `Right` button
  125198. */
  125199. get buttonRB(): number;
  125200. /**
  125201. * Sets the value of the `Right` button
  125202. */
  125203. set buttonRB(value: number);
  125204. /**
  125205. * Gets the value of the Left joystick
  125206. */
  125207. get buttonLeftStick(): number;
  125208. /**
  125209. * Sets the value of the Left joystick
  125210. */
  125211. set buttonLeftStick(value: number);
  125212. /**
  125213. * Gets the value of the Right joystick
  125214. */
  125215. get buttonRightStick(): number;
  125216. /**
  125217. * Sets the value of the Right joystick
  125218. */
  125219. set buttonRightStick(value: number);
  125220. /**
  125221. * Gets the value of D-pad up
  125222. */
  125223. get dPadUp(): number;
  125224. /**
  125225. * Sets the value of D-pad up
  125226. */
  125227. set dPadUp(value: number);
  125228. /**
  125229. * Gets the value of D-pad down
  125230. */
  125231. get dPadDown(): number;
  125232. /**
  125233. * Sets the value of D-pad down
  125234. */
  125235. set dPadDown(value: number);
  125236. /**
  125237. * Gets the value of D-pad left
  125238. */
  125239. get dPadLeft(): number;
  125240. /**
  125241. * Sets the value of D-pad left
  125242. */
  125243. set dPadLeft(value: number);
  125244. /**
  125245. * Gets the value of D-pad right
  125246. */
  125247. get dPadRight(): number;
  125248. /**
  125249. * Sets the value of D-pad right
  125250. */
  125251. set dPadRight(value: number);
  125252. /**
  125253. * Force the gamepad to synchronize with device values
  125254. */
  125255. update(): void;
  125256. /**
  125257. * Disposes the gamepad
  125258. */
  125259. dispose(): void;
  125260. }
  125261. }
  125262. declare module BABYLON {
  125263. /**
  125264. * Defines supported buttons for DualShock compatible gamepads
  125265. */
  125266. export enum DualShockButton {
  125267. /** Cross */
  125268. Cross = 0,
  125269. /** Circle */
  125270. Circle = 1,
  125271. /** Square */
  125272. Square = 2,
  125273. /** Triangle */
  125274. Triangle = 3,
  125275. /** L1 */
  125276. L1 = 4,
  125277. /** R1 */
  125278. R1 = 5,
  125279. /** Share */
  125280. Share = 8,
  125281. /** Options */
  125282. Options = 9,
  125283. /** Left stick */
  125284. LeftStick = 10,
  125285. /** Right stick */
  125286. RightStick = 11
  125287. }
  125288. /** Defines values for DualShock DPad */
  125289. export enum DualShockDpad {
  125290. /** Up */
  125291. Up = 12,
  125292. /** Down */
  125293. Down = 13,
  125294. /** Left */
  125295. Left = 14,
  125296. /** Right */
  125297. Right = 15
  125298. }
  125299. /**
  125300. * Defines a DualShock gamepad
  125301. */
  125302. export class DualShockPad extends Gamepad {
  125303. private _leftTrigger;
  125304. private _rightTrigger;
  125305. private _onlefttriggerchanged;
  125306. private _onrighttriggerchanged;
  125307. private _onbuttondown;
  125308. private _onbuttonup;
  125309. private _ondpaddown;
  125310. private _ondpadup;
  125311. /** Observable raised when a button is pressed */
  125312. onButtonDownObservable: Observable<DualShockButton>;
  125313. /** Observable raised when a button is released */
  125314. onButtonUpObservable: Observable<DualShockButton>;
  125315. /** Observable raised when a pad is pressed */
  125316. onPadDownObservable: Observable<DualShockDpad>;
  125317. /** Observable raised when a pad is released */
  125318. onPadUpObservable: Observable<DualShockDpad>;
  125319. private _buttonCross;
  125320. private _buttonCircle;
  125321. private _buttonSquare;
  125322. private _buttonTriangle;
  125323. private _buttonShare;
  125324. private _buttonOptions;
  125325. private _buttonL1;
  125326. private _buttonR1;
  125327. private _buttonLeftStick;
  125328. private _buttonRightStick;
  125329. private _dPadUp;
  125330. private _dPadDown;
  125331. private _dPadLeft;
  125332. private _dPadRight;
  125333. /**
  125334. * Creates a new DualShock gamepad object
  125335. * @param id defines the id of this gamepad
  125336. * @param index defines its index
  125337. * @param gamepad defines the internal HTML gamepad object
  125338. */
  125339. constructor(id: string, index: number, gamepad: any);
  125340. /**
  125341. * Defines the callback to call when left trigger is pressed
  125342. * @param callback defines the callback to use
  125343. */
  125344. onlefttriggerchanged(callback: (value: number) => void): void;
  125345. /**
  125346. * Defines the callback to call when right trigger is pressed
  125347. * @param callback defines the callback to use
  125348. */
  125349. onrighttriggerchanged(callback: (value: number) => void): void;
  125350. /**
  125351. * Gets the left trigger value
  125352. */
  125353. get leftTrigger(): number;
  125354. /**
  125355. * Sets the left trigger value
  125356. */
  125357. set leftTrigger(newValue: number);
  125358. /**
  125359. * Gets the right trigger value
  125360. */
  125361. get rightTrigger(): number;
  125362. /**
  125363. * Sets the right trigger value
  125364. */
  125365. set rightTrigger(newValue: number);
  125366. /**
  125367. * Defines the callback to call when a button is pressed
  125368. * @param callback defines the callback to use
  125369. */
  125370. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125371. /**
  125372. * Defines the callback to call when a button is released
  125373. * @param callback defines the callback to use
  125374. */
  125375. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125376. /**
  125377. * Defines the callback to call when a pad is pressed
  125378. * @param callback defines the callback to use
  125379. */
  125380. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125381. /**
  125382. * Defines the callback to call when a pad is released
  125383. * @param callback defines the callback to use
  125384. */
  125385. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125386. private _setButtonValue;
  125387. private _setDPadValue;
  125388. /**
  125389. * Gets the value of the `Cross` button
  125390. */
  125391. get buttonCross(): number;
  125392. /**
  125393. * Sets the value of the `Cross` button
  125394. */
  125395. set buttonCross(value: number);
  125396. /**
  125397. * Gets the value of the `Circle` button
  125398. */
  125399. get buttonCircle(): number;
  125400. /**
  125401. * Sets the value of the `Circle` button
  125402. */
  125403. set buttonCircle(value: number);
  125404. /**
  125405. * Gets the value of the `Square` button
  125406. */
  125407. get buttonSquare(): number;
  125408. /**
  125409. * Sets the value of the `Square` button
  125410. */
  125411. set buttonSquare(value: number);
  125412. /**
  125413. * Gets the value of the `Triangle` button
  125414. */
  125415. get buttonTriangle(): number;
  125416. /**
  125417. * Sets the value of the `Triangle` button
  125418. */
  125419. set buttonTriangle(value: number);
  125420. /**
  125421. * Gets the value of the `Options` button
  125422. */
  125423. get buttonOptions(): number;
  125424. /**
  125425. * Sets the value of the `Options` button
  125426. */
  125427. set buttonOptions(value: number);
  125428. /**
  125429. * Gets the value of the `Share` button
  125430. */
  125431. get buttonShare(): number;
  125432. /**
  125433. * Sets the value of the `Share` button
  125434. */
  125435. set buttonShare(value: number);
  125436. /**
  125437. * Gets the value of the `L1` button
  125438. */
  125439. get buttonL1(): number;
  125440. /**
  125441. * Sets the value of the `L1` button
  125442. */
  125443. set buttonL1(value: number);
  125444. /**
  125445. * Gets the value of the `R1` button
  125446. */
  125447. get buttonR1(): number;
  125448. /**
  125449. * Sets the value of the `R1` button
  125450. */
  125451. set buttonR1(value: number);
  125452. /**
  125453. * Gets the value of the Left joystick
  125454. */
  125455. get buttonLeftStick(): number;
  125456. /**
  125457. * Sets the value of the Left joystick
  125458. */
  125459. set buttonLeftStick(value: number);
  125460. /**
  125461. * Gets the value of the Right joystick
  125462. */
  125463. get buttonRightStick(): number;
  125464. /**
  125465. * Sets the value of the Right joystick
  125466. */
  125467. set buttonRightStick(value: number);
  125468. /**
  125469. * Gets the value of D-pad up
  125470. */
  125471. get dPadUp(): number;
  125472. /**
  125473. * Sets the value of D-pad up
  125474. */
  125475. set dPadUp(value: number);
  125476. /**
  125477. * Gets the value of D-pad down
  125478. */
  125479. get dPadDown(): number;
  125480. /**
  125481. * Sets the value of D-pad down
  125482. */
  125483. set dPadDown(value: number);
  125484. /**
  125485. * Gets the value of D-pad left
  125486. */
  125487. get dPadLeft(): number;
  125488. /**
  125489. * Sets the value of D-pad left
  125490. */
  125491. set dPadLeft(value: number);
  125492. /**
  125493. * Gets the value of D-pad right
  125494. */
  125495. get dPadRight(): number;
  125496. /**
  125497. * Sets the value of D-pad right
  125498. */
  125499. set dPadRight(value: number);
  125500. /**
  125501. * Force the gamepad to synchronize with device values
  125502. */
  125503. update(): void;
  125504. /**
  125505. * Disposes the gamepad
  125506. */
  125507. dispose(): void;
  125508. }
  125509. }
  125510. declare module BABYLON {
  125511. /**
  125512. * Manager for handling gamepads
  125513. */
  125514. export class GamepadManager {
  125515. private _scene?;
  125516. private _babylonGamepads;
  125517. private _oneGamepadConnected;
  125518. /** @hidden */
  125519. _isMonitoring: boolean;
  125520. private _gamepadEventSupported;
  125521. private _gamepadSupport?;
  125522. /**
  125523. * observable to be triggered when the gamepad controller has been connected
  125524. */
  125525. onGamepadConnectedObservable: Observable<Gamepad>;
  125526. /**
  125527. * observable to be triggered when the gamepad controller has been disconnected
  125528. */
  125529. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125530. private _onGamepadConnectedEvent;
  125531. private _onGamepadDisconnectedEvent;
  125532. /**
  125533. * Initializes the gamepad manager
  125534. * @param _scene BabylonJS scene
  125535. */
  125536. constructor(_scene?: Scene | undefined);
  125537. /**
  125538. * The gamepads in the game pad manager
  125539. */
  125540. get gamepads(): Gamepad[];
  125541. /**
  125542. * Get the gamepad controllers based on type
  125543. * @param type The type of gamepad controller
  125544. * @returns Nullable gamepad
  125545. */
  125546. getGamepadByType(type?: number): Nullable<Gamepad>;
  125547. /**
  125548. * Disposes the gamepad manager
  125549. */
  125550. dispose(): void;
  125551. private _addNewGamepad;
  125552. private _startMonitoringGamepads;
  125553. private _stopMonitoringGamepads;
  125554. /** @hidden */
  125555. _checkGamepadsStatus(): void;
  125556. private _updateGamepadObjects;
  125557. }
  125558. }
  125559. declare module BABYLON {
  125560. interface Scene {
  125561. /** @hidden */
  125562. _gamepadManager: Nullable<GamepadManager>;
  125563. /**
  125564. * Gets the gamepad manager associated with the scene
  125565. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125566. */
  125567. gamepadManager: GamepadManager;
  125568. }
  125569. /**
  125570. * Interface representing a free camera inputs manager
  125571. */
  125572. interface FreeCameraInputsManager {
  125573. /**
  125574. * Adds gamepad input support to the FreeCameraInputsManager.
  125575. * @returns the FreeCameraInputsManager
  125576. */
  125577. addGamepad(): FreeCameraInputsManager;
  125578. }
  125579. /**
  125580. * Interface representing an arc rotate camera inputs manager
  125581. */
  125582. interface ArcRotateCameraInputsManager {
  125583. /**
  125584. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125585. * @returns the camera inputs manager
  125586. */
  125587. addGamepad(): ArcRotateCameraInputsManager;
  125588. }
  125589. /**
  125590. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125591. */
  125592. export class GamepadSystemSceneComponent implements ISceneComponent {
  125593. /**
  125594. * The component name helpfull to identify the component in the list of scene components.
  125595. */
  125596. readonly name: string;
  125597. /**
  125598. * The scene the component belongs to.
  125599. */
  125600. scene: Scene;
  125601. /**
  125602. * Creates a new instance of the component for the given scene
  125603. * @param scene Defines the scene to register the component in
  125604. */
  125605. constructor(scene: Scene);
  125606. /**
  125607. * Registers the component in a given scene
  125608. */
  125609. register(): void;
  125610. /**
  125611. * Rebuilds the elements related to this component in case of
  125612. * context lost for instance.
  125613. */
  125614. rebuild(): void;
  125615. /**
  125616. * Disposes the component and the associated ressources
  125617. */
  125618. dispose(): void;
  125619. private _beforeCameraUpdate;
  125620. }
  125621. }
  125622. declare module BABYLON {
  125623. /**
  125624. * 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,
  125625. * which still works and will still be found in many Playgrounds.
  125626. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125627. */
  125628. export class UniversalCamera extends TouchCamera {
  125629. /**
  125630. * Defines the gamepad rotation sensiblity.
  125631. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125632. */
  125633. get gamepadAngularSensibility(): number;
  125634. set gamepadAngularSensibility(value: number);
  125635. /**
  125636. * Defines the gamepad move sensiblity.
  125637. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125638. */
  125639. get gamepadMoveSensibility(): number;
  125640. set gamepadMoveSensibility(value: number);
  125641. /**
  125642. * 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,
  125643. * which still works and will still be found in many Playgrounds.
  125644. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125645. * @param name Define the name of the camera in the scene
  125646. * @param position Define the start position of the camera in the scene
  125647. * @param scene Define the scene the camera belongs to
  125648. */
  125649. constructor(name: string, position: Vector3, scene: Scene);
  125650. /**
  125651. * Gets the current object class name.
  125652. * @return the class name
  125653. */
  125654. getClassName(): string;
  125655. }
  125656. }
  125657. declare module BABYLON {
  125658. /**
  125659. * This represents a FPS type of camera. This is only here for back compat purpose.
  125660. * Please use the UniversalCamera instead as both are identical.
  125661. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125662. */
  125663. export class GamepadCamera extends UniversalCamera {
  125664. /**
  125665. * Instantiates a new Gamepad Camera
  125666. * This represents a FPS type of camera. This is only here for back compat purpose.
  125667. * Please use the UniversalCamera instead as both are identical.
  125668. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125669. * @param name Define the name of the camera in the scene
  125670. * @param position Define the start position of the camera in the scene
  125671. * @param scene Define the scene the camera belongs to
  125672. */
  125673. constructor(name: string, position: Vector3, scene: Scene);
  125674. /**
  125675. * Gets the current object class name.
  125676. * @return the class name
  125677. */
  125678. getClassName(): string;
  125679. }
  125680. }
  125681. declare module BABYLON {
  125682. /** @hidden */
  125683. export var passPixelShader: {
  125684. name: string;
  125685. shader: string;
  125686. };
  125687. }
  125688. declare module BABYLON {
  125689. /** @hidden */
  125690. export var passCubePixelShader: {
  125691. name: string;
  125692. shader: string;
  125693. };
  125694. }
  125695. declare module BABYLON {
  125696. /**
  125697. * PassPostProcess which produces an output the same as it's input
  125698. */
  125699. export class PassPostProcess extends PostProcess {
  125700. /**
  125701. * Gets a string identifying the name of the class
  125702. * @returns "PassPostProcess" string
  125703. */
  125704. getClassName(): string;
  125705. /**
  125706. * Creates the PassPostProcess
  125707. * @param name The name of the effect.
  125708. * @param options The required width/height ratio to downsize to before computing the render pass.
  125709. * @param camera The camera to apply the render pass to.
  125710. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125711. * @param engine The engine which the post process will be applied. (default: current engine)
  125712. * @param reusable If the post process can be reused on the same frame. (default: false)
  125713. * @param textureType The type of texture to be used when performing the post processing.
  125714. * @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)
  125715. */
  125716. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125717. /** @hidden */
  125718. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125719. }
  125720. /**
  125721. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125722. */
  125723. export class PassCubePostProcess extends PostProcess {
  125724. private _face;
  125725. /**
  125726. * Gets or sets the cube face to display.
  125727. * * 0 is +X
  125728. * * 1 is -X
  125729. * * 2 is +Y
  125730. * * 3 is -Y
  125731. * * 4 is +Z
  125732. * * 5 is -Z
  125733. */
  125734. get face(): number;
  125735. set face(value: number);
  125736. /**
  125737. * Gets a string identifying the name of the class
  125738. * @returns "PassCubePostProcess" string
  125739. */
  125740. getClassName(): string;
  125741. /**
  125742. * Creates the PassCubePostProcess
  125743. * @param name The name of the effect.
  125744. * @param options The required width/height ratio to downsize to before computing the render pass.
  125745. * @param camera The camera to apply the render pass to.
  125746. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125747. * @param engine The engine which the post process will be applied. (default: current engine)
  125748. * @param reusable If the post process can be reused on the same frame. (default: false)
  125749. * @param textureType The type of texture to be used when performing the post processing.
  125750. * @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)
  125751. */
  125752. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125753. /** @hidden */
  125754. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125755. }
  125756. }
  125757. declare module BABYLON {
  125758. /** @hidden */
  125759. export var anaglyphPixelShader: {
  125760. name: string;
  125761. shader: string;
  125762. };
  125763. }
  125764. declare module BABYLON {
  125765. /**
  125766. * Postprocess used to generate anaglyphic rendering
  125767. */
  125768. export class AnaglyphPostProcess extends PostProcess {
  125769. private _passedProcess;
  125770. /**
  125771. * Gets a string identifying the name of the class
  125772. * @returns "AnaglyphPostProcess" string
  125773. */
  125774. getClassName(): string;
  125775. /**
  125776. * Creates a new AnaglyphPostProcess
  125777. * @param name defines postprocess name
  125778. * @param options defines creation options or target ratio scale
  125779. * @param rigCameras defines cameras using this postprocess
  125780. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125781. * @param engine defines hosting engine
  125782. * @param reusable defines if the postprocess will be reused multiple times per frame
  125783. */
  125784. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125785. }
  125786. }
  125787. declare module BABYLON {
  125788. /**
  125789. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125790. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125791. */
  125792. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125793. /**
  125794. * Creates a new AnaglyphArcRotateCamera
  125795. * @param name defines camera name
  125796. * @param alpha defines alpha angle (in radians)
  125797. * @param beta defines beta angle (in radians)
  125798. * @param radius defines radius
  125799. * @param target defines camera target
  125800. * @param interaxialDistance defines distance between each color axis
  125801. * @param scene defines the hosting scene
  125802. */
  125803. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125804. /**
  125805. * Gets camera class name
  125806. * @returns AnaglyphArcRotateCamera
  125807. */
  125808. getClassName(): string;
  125809. }
  125810. }
  125811. declare module BABYLON {
  125812. /**
  125813. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125814. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125815. */
  125816. export class AnaglyphFreeCamera extends FreeCamera {
  125817. /**
  125818. * Creates a new AnaglyphFreeCamera
  125819. * @param name defines camera name
  125820. * @param position defines initial position
  125821. * @param interaxialDistance defines distance between each color axis
  125822. * @param scene defines the hosting scene
  125823. */
  125824. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125825. /**
  125826. * Gets camera class name
  125827. * @returns AnaglyphFreeCamera
  125828. */
  125829. getClassName(): string;
  125830. }
  125831. }
  125832. declare module BABYLON {
  125833. /**
  125834. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125835. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125836. */
  125837. export class AnaglyphGamepadCamera extends GamepadCamera {
  125838. /**
  125839. * Creates a new AnaglyphGamepadCamera
  125840. * @param name defines camera name
  125841. * @param position defines initial position
  125842. * @param interaxialDistance defines distance between each color axis
  125843. * @param scene defines the hosting scene
  125844. */
  125845. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125846. /**
  125847. * Gets camera class name
  125848. * @returns AnaglyphGamepadCamera
  125849. */
  125850. getClassName(): string;
  125851. }
  125852. }
  125853. declare module BABYLON {
  125854. /**
  125855. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125856. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125857. */
  125858. export class AnaglyphUniversalCamera extends UniversalCamera {
  125859. /**
  125860. * Creates a new AnaglyphUniversalCamera
  125861. * @param name defines camera name
  125862. * @param position defines initial position
  125863. * @param interaxialDistance defines distance between each color axis
  125864. * @param scene defines the hosting scene
  125865. */
  125866. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125867. /**
  125868. * Gets camera class name
  125869. * @returns AnaglyphUniversalCamera
  125870. */
  125871. getClassName(): string;
  125872. }
  125873. }
  125874. declare module BABYLON {
  125875. /**
  125876. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125877. * @see https://doc.babylonjs.com/features/cameras
  125878. */
  125879. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125880. /**
  125881. * Creates a new StereoscopicArcRotateCamera
  125882. * @param name defines camera name
  125883. * @param alpha defines alpha angle (in radians)
  125884. * @param beta defines beta angle (in radians)
  125885. * @param radius defines radius
  125886. * @param target defines camera target
  125887. * @param interaxialDistance defines distance between each color axis
  125888. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125889. * @param scene defines the hosting scene
  125890. */
  125891. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125892. /**
  125893. * Gets camera class name
  125894. * @returns StereoscopicArcRotateCamera
  125895. */
  125896. getClassName(): string;
  125897. }
  125898. }
  125899. declare module BABYLON {
  125900. /**
  125901. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125902. * @see https://doc.babylonjs.com/features/cameras
  125903. */
  125904. export class StereoscopicFreeCamera extends FreeCamera {
  125905. /**
  125906. * Creates a new StereoscopicFreeCamera
  125907. * @param name defines camera name
  125908. * @param position defines initial position
  125909. * @param interaxialDistance defines distance between each color axis
  125910. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125911. * @param scene defines the hosting scene
  125912. */
  125913. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125914. /**
  125915. * Gets camera class name
  125916. * @returns StereoscopicFreeCamera
  125917. */
  125918. getClassName(): string;
  125919. }
  125920. }
  125921. declare module BABYLON {
  125922. /**
  125923. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125924. * @see https://doc.babylonjs.com/features/cameras
  125925. */
  125926. export class StereoscopicGamepadCamera extends GamepadCamera {
  125927. /**
  125928. * Creates a new StereoscopicGamepadCamera
  125929. * @param name defines camera name
  125930. * @param position defines initial position
  125931. * @param interaxialDistance defines distance between each color axis
  125932. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125933. * @param scene defines the hosting scene
  125934. */
  125935. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125936. /**
  125937. * Gets camera class name
  125938. * @returns StereoscopicGamepadCamera
  125939. */
  125940. getClassName(): string;
  125941. }
  125942. }
  125943. declare module BABYLON {
  125944. /**
  125945. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125946. * @see https://doc.babylonjs.com/features/cameras
  125947. */
  125948. export class StereoscopicUniversalCamera extends UniversalCamera {
  125949. /**
  125950. * Creates a new StereoscopicUniversalCamera
  125951. * @param name defines camera name
  125952. * @param position defines initial position
  125953. * @param interaxialDistance defines distance between each color axis
  125954. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125955. * @param scene defines the hosting scene
  125956. */
  125957. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125958. /**
  125959. * Gets camera class name
  125960. * @returns StereoscopicUniversalCamera
  125961. */
  125962. getClassName(): string;
  125963. }
  125964. }
  125965. declare module BABYLON {
  125966. /**
  125967. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125968. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125969. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125970. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125971. */
  125972. export class VirtualJoysticksCamera extends FreeCamera {
  125973. /**
  125974. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125975. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125976. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125977. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125978. * @param name Define the name of the camera in the scene
  125979. * @param position Define the start position of the camera in the scene
  125980. * @param scene Define the scene the camera belongs to
  125981. */
  125982. constructor(name: string, position: Vector3, scene: Scene);
  125983. /**
  125984. * Gets the current object class name.
  125985. * @return the class name
  125986. */
  125987. getClassName(): string;
  125988. }
  125989. }
  125990. declare module BABYLON {
  125991. /**
  125992. * This represents all the required metrics to create a VR camera.
  125993. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125994. */
  125995. export class VRCameraMetrics {
  125996. /**
  125997. * Define the horizontal resolution off the screen.
  125998. */
  125999. hResolution: number;
  126000. /**
  126001. * Define the vertical resolution off the screen.
  126002. */
  126003. vResolution: number;
  126004. /**
  126005. * Define the horizontal screen size.
  126006. */
  126007. hScreenSize: number;
  126008. /**
  126009. * Define the vertical screen size.
  126010. */
  126011. vScreenSize: number;
  126012. /**
  126013. * Define the vertical screen center position.
  126014. */
  126015. vScreenCenter: number;
  126016. /**
  126017. * Define the distance of the eyes to the screen.
  126018. */
  126019. eyeToScreenDistance: number;
  126020. /**
  126021. * Define the distance between both lenses
  126022. */
  126023. lensSeparationDistance: number;
  126024. /**
  126025. * Define the distance between both viewer's eyes.
  126026. */
  126027. interpupillaryDistance: number;
  126028. /**
  126029. * Define the distortion factor of the VR postprocess.
  126030. * Please, touch with care.
  126031. */
  126032. distortionK: number[];
  126033. /**
  126034. * Define the chromatic aberration correction factors for the VR post process.
  126035. */
  126036. chromaAbCorrection: number[];
  126037. /**
  126038. * Define the scale factor of the post process.
  126039. * The smaller the better but the slower.
  126040. */
  126041. postProcessScaleFactor: number;
  126042. /**
  126043. * Define an offset for the lens center.
  126044. */
  126045. lensCenterOffset: number;
  126046. /**
  126047. * Define if the current vr camera should compensate the distortion of the lense or not.
  126048. */
  126049. compensateDistortion: boolean;
  126050. /**
  126051. * Defines if multiview should be enabled when rendering (Default: false)
  126052. */
  126053. multiviewEnabled: boolean;
  126054. /**
  126055. * Gets the rendering aspect ratio based on the provided resolutions.
  126056. */
  126057. get aspectRatio(): number;
  126058. /**
  126059. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126060. */
  126061. get aspectRatioFov(): number;
  126062. /**
  126063. * @hidden
  126064. */
  126065. get leftHMatrix(): Matrix;
  126066. /**
  126067. * @hidden
  126068. */
  126069. get rightHMatrix(): Matrix;
  126070. /**
  126071. * @hidden
  126072. */
  126073. get leftPreViewMatrix(): Matrix;
  126074. /**
  126075. * @hidden
  126076. */
  126077. get rightPreViewMatrix(): Matrix;
  126078. /**
  126079. * Get the default VRMetrics based on the most generic setup.
  126080. * @returns the default vr metrics
  126081. */
  126082. static GetDefault(): VRCameraMetrics;
  126083. }
  126084. }
  126085. declare module BABYLON {
  126086. /** @hidden */
  126087. export var vrDistortionCorrectionPixelShader: {
  126088. name: string;
  126089. shader: string;
  126090. };
  126091. }
  126092. declare module BABYLON {
  126093. /**
  126094. * VRDistortionCorrectionPostProcess used for mobile VR
  126095. */
  126096. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126097. private _isRightEye;
  126098. private _distortionFactors;
  126099. private _postProcessScaleFactor;
  126100. private _lensCenterOffset;
  126101. private _scaleIn;
  126102. private _scaleFactor;
  126103. private _lensCenter;
  126104. /**
  126105. * Gets a string identifying the name of the class
  126106. * @returns "VRDistortionCorrectionPostProcess" string
  126107. */
  126108. getClassName(): string;
  126109. /**
  126110. * Initializes the VRDistortionCorrectionPostProcess
  126111. * @param name The name of the effect.
  126112. * @param camera The camera to apply the render pass to.
  126113. * @param isRightEye If this is for the right eye distortion
  126114. * @param vrMetrics All the required metrics for the VR camera
  126115. */
  126116. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126117. }
  126118. }
  126119. declare module BABYLON {
  126120. /**
  126121. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126122. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126123. */
  126124. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126125. /**
  126126. * Creates a new VRDeviceOrientationArcRotateCamera
  126127. * @param name defines camera name
  126128. * @param alpha defines the camera rotation along the logitudinal axis
  126129. * @param beta defines the camera rotation along the latitudinal axis
  126130. * @param radius defines the camera distance from its target
  126131. * @param target defines the camera target
  126132. * @param scene defines the scene the camera belongs to
  126133. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126134. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126135. */
  126136. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126137. /**
  126138. * Gets camera class name
  126139. * @returns VRDeviceOrientationArcRotateCamera
  126140. */
  126141. getClassName(): string;
  126142. }
  126143. }
  126144. declare module BABYLON {
  126145. /**
  126146. * Camera used to simulate VR rendering (based on FreeCamera)
  126147. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126148. */
  126149. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126150. /**
  126151. * Creates a new VRDeviceOrientationFreeCamera
  126152. * @param name defines camera name
  126153. * @param position defines the start position of the camera
  126154. * @param scene defines the scene the camera belongs to
  126155. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126156. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126157. */
  126158. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126159. /**
  126160. * Gets camera class name
  126161. * @returns VRDeviceOrientationFreeCamera
  126162. */
  126163. getClassName(): string;
  126164. }
  126165. }
  126166. declare module BABYLON {
  126167. /**
  126168. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126169. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126170. */
  126171. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126172. /**
  126173. * Creates a new VRDeviceOrientationGamepadCamera
  126174. * @param name defines camera name
  126175. * @param position defines the start position of the camera
  126176. * @param scene defines the scene the camera belongs to
  126177. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126178. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126179. */
  126180. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126181. /**
  126182. * Gets camera class name
  126183. * @returns VRDeviceOrientationGamepadCamera
  126184. */
  126185. getClassName(): string;
  126186. }
  126187. }
  126188. declare module BABYLON {
  126189. /**
  126190. * A class extending Texture allowing drawing on a texture
  126191. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126192. */
  126193. export class DynamicTexture extends Texture {
  126194. private _generateMipMaps;
  126195. private _canvas;
  126196. private _context;
  126197. /**
  126198. * Creates a DynamicTexture
  126199. * @param name defines the name of the texture
  126200. * @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
  126201. * @param scene defines the scene where you want the texture
  126202. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126203. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126204. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126205. */
  126206. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126207. /**
  126208. * Get the current class name of the texture useful for serialization or dynamic coding.
  126209. * @returns "DynamicTexture"
  126210. */
  126211. getClassName(): string;
  126212. /**
  126213. * Gets the current state of canRescale
  126214. */
  126215. get canRescale(): boolean;
  126216. private _recreate;
  126217. /**
  126218. * Scales the texture
  126219. * @param ratio the scale factor to apply to both width and height
  126220. */
  126221. scale(ratio: number): void;
  126222. /**
  126223. * Resizes the texture
  126224. * @param width the new width
  126225. * @param height the new height
  126226. */
  126227. scaleTo(width: number, height: number): void;
  126228. /**
  126229. * Gets the context of the canvas used by the texture
  126230. * @returns the canvas context of the dynamic texture
  126231. */
  126232. getContext(): CanvasRenderingContext2D;
  126233. /**
  126234. * Clears the texture
  126235. */
  126236. clear(): void;
  126237. /**
  126238. * Updates the texture
  126239. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126240. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126241. */
  126242. update(invertY?: boolean, premulAlpha?: boolean): void;
  126243. /**
  126244. * Draws text onto the texture
  126245. * @param text defines the text to be drawn
  126246. * @param x defines the placement of the text from the left
  126247. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126248. * @param font defines the font to be used with font-style, font-size, font-name
  126249. * @param color defines the color used for the text
  126250. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126251. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126252. * @param update defines whether texture is immediately update (default is true)
  126253. */
  126254. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126255. /**
  126256. * Clones the texture
  126257. * @returns the clone of the texture.
  126258. */
  126259. clone(): DynamicTexture;
  126260. /**
  126261. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126262. * @returns a serialized dynamic texture object
  126263. */
  126264. serialize(): any;
  126265. private _IsCanvasElement;
  126266. /** @hidden */
  126267. _rebuild(): void;
  126268. }
  126269. }
  126270. declare module BABYLON {
  126271. /**
  126272. * Class containing static functions to help procedurally build meshes
  126273. */
  126274. export class GroundBuilder {
  126275. /**
  126276. * Creates a ground mesh
  126277. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126278. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126279. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126280. * @param name defines the name of the mesh
  126281. * @param options defines the options used to create the mesh
  126282. * @param scene defines the hosting scene
  126283. * @returns the ground mesh
  126284. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126285. */
  126286. static CreateGround(name: string, options: {
  126287. width?: number;
  126288. height?: number;
  126289. subdivisions?: number;
  126290. subdivisionsX?: number;
  126291. subdivisionsY?: number;
  126292. updatable?: boolean;
  126293. }, scene: any): Mesh;
  126294. /**
  126295. * Creates a tiled ground mesh
  126296. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126297. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126298. * * 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
  126299. * * 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
  126300. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126301. * @param name defines the name of the mesh
  126302. * @param options defines the options used to create the mesh
  126303. * @param scene defines the hosting scene
  126304. * @returns the tiled ground mesh
  126305. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126306. */
  126307. static CreateTiledGround(name: string, options: {
  126308. xmin: number;
  126309. zmin: number;
  126310. xmax: number;
  126311. zmax: number;
  126312. subdivisions?: {
  126313. w: number;
  126314. h: number;
  126315. };
  126316. precision?: {
  126317. w: number;
  126318. h: number;
  126319. };
  126320. updatable?: boolean;
  126321. }, scene?: Nullable<Scene>): Mesh;
  126322. /**
  126323. * Creates a ground mesh from a height map
  126324. * * The parameter `url` sets the URL of the height map image resource.
  126325. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126326. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126327. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126328. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126329. * * 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.
  126330. * * 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).
  126331. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126332. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126333. * @param name defines the name of the mesh
  126334. * @param url defines the url to the height map
  126335. * @param options defines the options used to create the mesh
  126336. * @param scene defines the hosting scene
  126337. * @returns the ground mesh
  126338. * @see https://doc.babylonjs.com/babylon101/height_map
  126339. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126340. */
  126341. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126342. width?: number;
  126343. height?: number;
  126344. subdivisions?: number;
  126345. minHeight?: number;
  126346. maxHeight?: number;
  126347. colorFilter?: Color3;
  126348. alphaFilter?: number;
  126349. updatable?: boolean;
  126350. onReady?: (mesh: GroundMesh) => void;
  126351. }, scene?: Nullable<Scene>): GroundMesh;
  126352. }
  126353. }
  126354. declare module BABYLON {
  126355. /**
  126356. * Class containing static functions to help procedurally build meshes
  126357. */
  126358. export class TorusBuilder {
  126359. /**
  126360. * Creates a torus mesh
  126361. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126362. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126363. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126364. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126365. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126366. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126367. * @param name defines the name of the mesh
  126368. * @param options defines the options used to create the mesh
  126369. * @param scene defines the hosting scene
  126370. * @returns the torus mesh
  126371. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126372. */
  126373. static CreateTorus(name: string, options: {
  126374. diameter?: number;
  126375. thickness?: number;
  126376. tessellation?: number;
  126377. updatable?: boolean;
  126378. sideOrientation?: number;
  126379. frontUVs?: Vector4;
  126380. backUVs?: Vector4;
  126381. }, scene: any): Mesh;
  126382. }
  126383. }
  126384. declare module BABYLON {
  126385. /**
  126386. * Class containing static functions to help procedurally build meshes
  126387. */
  126388. export class CylinderBuilder {
  126389. /**
  126390. * Creates a cylinder or a cone mesh
  126391. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126392. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126393. * * 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.
  126394. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126395. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126396. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126397. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126398. * * 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).
  126399. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126400. * * 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).
  126401. * * 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
  126402. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126403. * * 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
  126404. * * 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.
  126405. * * If `enclose` is false, a ring surface is one element.
  126406. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126407. * * 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
  126408. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126409. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126410. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126411. * @param name defines the name of the mesh
  126412. * @param options defines the options used to create the mesh
  126413. * @param scene defines the hosting scene
  126414. * @returns the cylinder mesh
  126415. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126416. */
  126417. static CreateCylinder(name: string, options: {
  126418. height?: number;
  126419. diameterTop?: number;
  126420. diameterBottom?: number;
  126421. diameter?: number;
  126422. tessellation?: number;
  126423. subdivisions?: number;
  126424. arc?: number;
  126425. faceColors?: Color4[];
  126426. faceUV?: Vector4[];
  126427. updatable?: boolean;
  126428. hasRings?: boolean;
  126429. enclose?: boolean;
  126430. cap?: number;
  126431. sideOrientation?: number;
  126432. frontUVs?: Vector4;
  126433. backUVs?: Vector4;
  126434. }, scene: any): Mesh;
  126435. }
  126436. }
  126437. declare module BABYLON {
  126438. /**
  126439. * States of the webXR experience
  126440. */
  126441. export enum WebXRState {
  126442. /**
  126443. * Transitioning to being in XR mode
  126444. */
  126445. ENTERING_XR = 0,
  126446. /**
  126447. * Transitioning to non XR mode
  126448. */
  126449. EXITING_XR = 1,
  126450. /**
  126451. * In XR mode and presenting
  126452. */
  126453. IN_XR = 2,
  126454. /**
  126455. * Not entered XR mode
  126456. */
  126457. NOT_IN_XR = 3
  126458. }
  126459. /**
  126460. * Abstraction of the XR render target
  126461. */
  126462. export interface WebXRRenderTarget extends IDisposable {
  126463. /**
  126464. * xrpresent context of the canvas which can be used to display/mirror xr content
  126465. */
  126466. canvasContext: WebGLRenderingContext;
  126467. /**
  126468. * xr layer for the canvas
  126469. */
  126470. xrLayer: Nullable<XRWebGLLayer>;
  126471. /**
  126472. * Initializes the xr layer for the session
  126473. * @param xrSession xr session
  126474. * @returns a promise that will resolve once the XR Layer has been created
  126475. */
  126476. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126477. }
  126478. }
  126479. declare module BABYLON {
  126480. /**
  126481. * COnfiguration object for WebXR output canvas
  126482. */
  126483. export class WebXRManagedOutputCanvasOptions {
  126484. /**
  126485. * An optional canvas in case you wish to create it yourself and provide it here.
  126486. * If not provided, a new canvas will be created
  126487. */
  126488. canvasElement?: HTMLCanvasElement;
  126489. /**
  126490. * Options for this XR Layer output
  126491. */
  126492. canvasOptions?: XRWebGLLayerOptions;
  126493. /**
  126494. * CSS styling for a newly created canvas (if not provided)
  126495. */
  126496. newCanvasCssStyle?: string;
  126497. /**
  126498. * Get the default values of the configuration object
  126499. * @param engine defines the engine to use (can be null)
  126500. * @returns default values of this configuration object
  126501. */
  126502. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126503. }
  126504. /**
  126505. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126506. */
  126507. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126508. private _options;
  126509. private _canvas;
  126510. private _engine;
  126511. private _originalCanvasSize;
  126512. /**
  126513. * Rendering context of the canvas which can be used to display/mirror xr content
  126514. */
  126515. canvasContext: WebGLRenderingContext;
  126516. /**
  126517. * xr layer for the canvas
  126518. */
  126519. xrLayer: Nullable<XRWebGLLayer>;
  126520. /**
  126521. * Obseervers registered here will be triggered when the xr layer was initialized
  126522. */
  126523. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126524. /**
  126525. * Initializes the canvas to be added/removed upon entering/exiting xr
  126526. * @param _xrSessionManager The XR Session manager
  126527. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126528. */
  126529. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126530. /**
  126531. * Disposes of the object
  126532. */
  126533. dispose(): void;
  126534. /**
  126535. * Initializes the xr layer for the session
  126536. * @param xrSession xr session
  126537. * @returns a promise that will resolve once the XR Layer has been created
  126538. */
  126539. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126540. private _addCanvas;
  126541. private _removeCanvas;
  126542. private _setCanvasSize;
  126543. private _setManagedOutputCanvas;
  126544. }
  126545. }
  126546. declare module BABYLON {
  126547. /**
  126548. * Manages an XRSession to work with Babylon's engine
  126549. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126550. */
  126551. export class WebXRSessionManager implements IDisposable {
  126552. /** The scene which the session should be created for */
  126553. scene: Scene;
  126554. private _referenceSpace;
  126555. private _rttProvider;
  126556. private _sessionEnded;
  126557. private _xrNavigator;
  126558. private baseLayer;
  126559. /**
  126560. * The base reference space from which the session started. good if you want to reset your
  126561. * reference space
  126562. */
  126563. baseReferenceSpace: XRReferenceSpace;
  126564. /**
  126565. * Current XR frame
  126566. */
  126567. currentFrame: Nullable<XRFrame>;
  126568. /** WebXR timestamp updated every frame */
  126569. currentTimestamp: number;
  126570. /**
  126571. * Used just in case of a failure to initialize an immersive session.
  126572. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126573. */
  126574. defaultHeightCompensation: number;
  126575. /**
  126576. * Fires every time a new xrFrame arrives which can be used to update the camera
  126577. */
  126578. onXRFrameObservable: Observable<XRFrame>;
  126579. /**
  126580. * Fires when the reference space changed
  126581. */
  126582. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126583. /**
  126584. * Fires when the xr session is ended either by the device or manually done
  126585. */
  126586. onXRSessionEnded: Observable<any>;
  126587. /**
  126588. * Fires when the xr session is ended either by the device or manually done
  126589. */
  126590. onXRSessionInit: Observable<XRSession>;
  126591. /**
  126592. * Underlying xr session
  126593. */
  126594. session: XRSession;
  126595. /**
  126596. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126597. * or get the offset the player is currently at.
  126598. */
  126599. viewerReferenceSpace: XRReferenceSpace;
  126600. /**
  126601. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126602. * @param scene The scene which the session should be created for
  126603. */
  126604. constructor(
  126605. /** The scene which the session should be created for */
  126606. scene: Scene);
  126607. /**
  126608. * The current reference space used in this session. This reference space can constantly change!
  126609. * It is mainly used to offset the camera's position.
  126610. */
  126611. get referenceSpace(): XRReferenceSpace;
  126612. /**
  126613. * Set a new reference space and triggers the observable
  126614. */
  126615. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126616. /**
  126617. * Disposes of the session manager
  126618. */
  126619. dispose(): void;
  126620. /**
  126621. * Stops the xrSession and restores the render loop
  126622. * @returns Promise which resolves after it exits XR
  126623. */
  126624. exitXRAsync(): Promise<void>;
  126625. /**
  126626. * Gets the correct render target texture to be rendered this frame for this eye
  126627. * @param eye the eye for which to get the render target
  126628. * @returns the render target for the specified eye
  126629. */
  126630. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126631. /**
  126632. * Creates a WebXRRenderTarget object for the XR session
  126633. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126634. * @param options optional options to provide when creating a new render target
  126635. * @returns a WebXR render target to which the session can render
  126636. */
  126637. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126638. /**
  126639. * Initializes the manager
  126640. * After initialization enterXR can be called to start an XR session
  126641. * @returns Promise which resolves after it is initialized
  126642. */
  126643. initializeAsync(): Promise<void>;
  126644. /**
  126645. * Initializes an xr session
  126646. * @param xrSessionMode mode to initialize
  126647. * @param xrSessionInit defines optional and required values to pass to the session builder
  126648. * @returns a promise which will resolve once the session has been initialized
  126649. */
  126650. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126651. /**
  126652. * Checks if a session would be supported for the creation options specified
  126653. * @param sessionMode session mode to check if supported eg. immersive-vr
  126654. * @returns A Promise that resolves to true if supported and false if not
  126655. */
  126656. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126657. /**
  126658. * Resets the reference space to the one started the session
  126659. */
  126660. resetReferenceSpace(): void;
  126661. /**
  126662. * Starts rendering to the xr layer
  126663. */
  126664. runXRRenderLoop(): void;
  126665. /**
  126666. * Sets the reference space on the xr session
  126667. * @param referenceSpaceType space to set
  126668. * @returns a promise that will resolve once the reference space has been set
  126669. */
  126670. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126671. /**
  126672. * Updates the render state of the session
  126673. * @param state state to set
  126674. * @returns a promise that resolves once the render state has been updated
  126675. */
  126676. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126677. /**
  126678. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126679. * @param sessionMode defines the session to test
  126680. * @returns a promise with boolean as final value
  126681. */
  126682. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126683. private _createRenderTargetTexture;
  126684. }
  126685. }
  126686. declare module BABYLON {
  126687. /**
  126688. * WebXR Camera which holds the views for the xrSession
  126689. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126690. */
  126691. export class WebXRCamera extends FreeCamera {
  126692. private _xrSessionManager;
  126693. private _firstFrame;
  126694. private _referenceQuaternion;
  126695. private _referencedPosition;
  126696. private _xrInvPositionCache;
  126697. private _xrInvQuaternionCache;
  126698. /**
  126699. * Observable raised before camera teleportation
  126700. */
  126701. onBeforeCameraTeleport: Observable<Vector3>;
  126702. /**
  126703. * Observable raised after camera teleportation
  126704. */
  126705. onAfterCameraTeleport: Observable<Vector3>;
  126706. /**
  126707. * Should position compensation execute on first frame.
  126708. * This is used when copying the position from a native (non XR) camera
  126709. */
  126710. compensateOnFirstFrame: boolean;
  126711. /**
  126712. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126713. * @param name the name of the camera
  126714. * @param scene the scene to add the camera to
  126715. * @param _xrSessionManager a constructed xr session manager
  126716. */
  126717. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126718. /**
  126719. * Return the user's height, unrelated to the current ground.
  126720. * This will be the y position of this camera, when ground level is 0.
  126721. */
  126722. get realWorldHeight(): number;
  126723. /** @hidden */
  126724. _updateForDualEyeDebugging(): void;
  126725. /**
  126726. * Sets this camera's transformation based on a non-vr camera
  126727. * @param otherCamera the non-vr camera to copy the transformation from
  126728. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126729. */
  126730. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126731. /**
  126732. * Gets the current instance class name ("WebXRCamera").
  126733. * @returns the class name
  126734. */
  126735. getClassName(): string;
  126736. private _rotate180;
  126737. private _updateFromXRSession;
  126738. private _updateNumberOfRigCameras;
  126739. private _updateReferenceSpace;
  126740. private _updateReferenceSpaceOffset;
  126741. }
  126742. }
  126743. declare module BABYLON {
  126744. /**
  126745. * Defining the interface required for a (webxr) feature
  126746. */
  126747. export interface IWebXRFeature extends IDisposable {
  126748. /**
  126749. * Is this feature attached
  126750. */
  126751. attached: boolean;
  126752. /**
  126753. * Should auto-attach be disabled?
  126754. */
  126755. disableAutoAttach: boolean;
  126756. /**
  126757. * Attach the feature to the session
  126758. * Will usually be called by the features manager
  126759. *
  126760. * @param force should attachment be forced (even when already attached)
  126761. * @returns true if successful.
  126762. */
  126763. attach(force?: boolean): boolean;
  126764. /**
  126765. * Detach the feature from the session
  126766. * Will usually be called by the features manager
  126767. *
  126768. * @returns true if successful.
  126769. */
  126770. detach(): boolean;
  126771. /**
  126772. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126773. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126774. *
  126775. * @returns whether or not the feature is compatible in this environment
  126776. */
  126777. isCompatible(): boolean;
  126778. /**
  126779. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126780. */
  126781. xrNativeFeatureName?: string;
  126782. /**
  126783. * A list of (Babylon WebXR) features this feature depends on
  126784. */
  126785. dependsOn?: string[];
  126786. }
  126787. /**
  126788. * A list of the currently available features without referencing them
  126789. */
  126790. export class WebXRFeatureName {
  126791. /**
  126792. * The name of the anchor system feature
  126793. */
  126794. static readonly ANCHOR_SYSTEM: string;
  126795. /**
  126796. * The name of the background remover feature
  126797. */
  126798. static readonly BACKGROUND_REMOVER: string;
  126799. /**
  126800. * The name of the hit test feature
  126801. */
  126802. static readonly HIT_TEST: string;
  126803. /**
  126804. * physics impostors for xr controllers feature
  126805. */
  126806. static readonly PHYSICS_CONTROLLERS: string;
  126807. /**
  126808. * The name of the plane detection feature
  126809. */
  126810. static readonly PLANE_DETECTION: string;
  126811. /**
  126812. * The name of the pointer selection feature
  126813. */
  126814. static readonly POINTER_SELECTION: string;
  126815. /**
  126816. * The name of the teleportation feature
  126817. */
  126818. static readonly TELEPORTATION: string;
  126819. /**
  126820. * The name of the feature points feature.
  126821. */
  126822. static readonly FEATURE_POINTS: string;
  126823. /**
  126824. * The name of the hand tracking feature.
  126825. */
  126826. static readonly HAND_TRACKING: string;
  126827. }
  126828. /**
  126829. * Defining the constructor of a feature. Used to register the modules.
  126830. */
  126831. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126832. /**
  126833. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126834. * It is mainly used in AR sessions.
  126835. *
  126836. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126837. */
  126838. export class WebXRFeaturesManager implements IDisposable {
  126839. private _xrSessionManager;
  126840. private static readonly _AvailableFeatures;
  126841. private _features;
  126842. /**
  126843. * constructs a new features manages.
  126844. *
  126845. * @param _xrSessionManager an instance of WebXRSessionManager
  126846. */
  126847. constructor(_xrSessionManager: WebXRSessionManager);
  126848. /**
  126849. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126850. * Mainly used internally.
  126851. *
  126852. * @param featureName the name of the feature to register
  126853. * @param constructorFunction the function used to construct the module
  126854. * @param version the (babylon) version of the module
  126855. * @param stable is that a stable version of this module
  126856. */
  126857. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126858. /**
  126859. * Returns a constructor of a specific feature.
  126860. *
  126861. * @param featureName the name of the feature to construct
  126862. * @param version the version of the feature to load
  126863. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126864. * @param options optional options provided to the module.
  126865. * @returns a function that, when called, will return a new instance of this feature
  126866. */
  126867. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126868. /**
  126869. * Can be used to return the list of features currently registered
  126870. *
  126871. * @returns an Array of available features
  126872. */
  126873. static GetAvailableFeatures(): string[];
  126874. /**
  126875. * Gets the versions available for a specific feature
  126876. * @param featureName the name of the feature
  126877. * @returns an array with the available versions
  126878. */
  126879. static GetAvailableVersions(featureName: string): string[];
  126880. /**
  126881. * Return the latest unstable version of this feature
  126882. * @param featureName the name of the feature to search
  126883. * @returns the version number. if not found will return -1
  126884. */
  126885. static GetLatestVersionOfFeature(featureName: string): number;
  126886. /**
  126887. * Return the latest stable version of this feature
  126888. * @param featureName the name of the feature to search
  126889. * @returns the version number. if not found will return -1
  126890. */
  126891. static GetStableVersionOfFeature(featureName: string): number;
  126892. /**
  126893. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126894. * Can be used during a session to start a feature
  126895. * @param featureName the name of feature to attach
  126896. */
  126897. attachFeature(featureName: string): void;
  126898. /**
  126899. * Can be used inside a session or when the session ends to detach a specific feature
  126900. * @param featureName the name of the feature to detach
  126901. */
  126902. detachFeature(featureName: string): void;
  126903. /**
  126904. * Used to disable an already-enabled feature
  126905. * The feature will be disposed and will be recreated once enabled.
  126906. * @param featureName the feature to disable
  126907. * @returns true if disable was successful
  126908. */
  126909. disableFeature(featureName: string | {
  126910. Name: string;
  126911. }): boolean;
  126912. /**
  126913. * dispose this features manager
  126914. */
  126915. dispose(): void;
  126916. /**
  126917. * 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.
  126918. * 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.
  126919. *
  126920. * @param featureName the name of the feature to load or the class of the feature
  126921. * @param version optional version to load. if not provided the latest version will be enabled
  126922. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126923. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126924. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126925. * @returns a new constructed feature or throws an error if feature not found.
  126926. */
  126927. enableFeature(featureName: string | {
  126928. Name: string;
  126929. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126930. /**
  126931. * get the implementation of an enabled feature.
  126932. * @param featureName the name of the feature to load
  126933. * @returns the feature class, if found
  126934. */
  126935. getEnabledFeature(featureName: string): IWebXRFeature;
  126936. /**
  126937. * Get the list of enabled features
  126938. * @returns an array of enabled features
  126939. */
  126940. getEnabledFeatures(): string[];
  126941. /**
  126942. * This function will exten the session creation configuration object with enabled features.
  126943. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126944. * according to the defined "required" variable, provided during enableFeature call
  126945. * @param xrSessionInit the xr Session init object to extend
  126946. *
  126947. * @returns an extended XRSessionInit object
  126948. */
  126949. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126950. }
  126951. }
  126952. declare module BABYLON {
  126953. /**
  126954. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126955. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126956. */
  126957. export class WebXRExperienceHelper implements IDisposable {
  126958. private scene;
  126959. private _nonVRCamera;
  126960. private _originalSceneAutoClear;
  126961. private _supported;
  126962. /**
  126963. * Camera used to render xr content
  126964. */
  126965. camera: WebXRCamera;
  126966. /** A features manager for this xr session */
  126967. featuresManager: WebXRFeaturesManager;
  126968. /**
  126969. * Observers registered here will be triggered after the camera's initial transformation is set
  126970. * This can be used to set a different ground level or an extra rotation.
  126971. *
  126972. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126973. * to the position set after this observable is done executing.
  126974. */
  126975. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126976. /**
  126977. * Fires when the state of the experience helper has changed
  126978. */
  126979. onStateChangedObservable: Observable<WebXRState>;
  126980. /** Session manager used to keep track of xr session */
  126981. sessionManager: WebXRSessionManager;
  126982. /**
  126983. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126984. */
  126985. state: WebXRState;
  126986. /**
  126987. * Creates a WebXRExperienceHelper
  126988. * @param scene The scene the helper should be created in
  126989. */
  126990. private constructor();
  126991. /**
  126992. * Creates the experience helper
  126993. * @param scene the scene to attach the experience helper to
  126994. * @returns a promise for the experience helper
  126995. */
  126996. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126997. /**
  126998. * Disposes of the experience helper
  126999. */
  127000. dispose(): void;
  127001. /**
  127002. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  127003. * @param sessionMode options for the XR session
  127004. * @param referenceSpaceType frame of reference of the XR session
  127005. * @param renderTarget the output canvas that will be used to enter XR mode
  127006. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  127007. * @returns promise that resolves after xr mode has entered
  127008. */
  127009. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  127010. /**
  127011. * Exits XR mode and returns the scene to its original state
  127012. * @returns promise that resolves after xr mode has exited
  127013. */
  127014. exitXRAsync(): Promise<void>;
  127015. private _nonXRToXRCamera;
  127016. private _setState;
  127017. }
  127018. }
  127019. declare module BABYLON {
  127020. /**
  127021. * X-Y values for axes in WebXR
  127022. */
  127023. export interface IWebXRMotionControllerAxesValue {
  127024. /**
  127025. * The value of the x axis
  127026. */
  127027. x: number;
  127028. /**
  127029. * The value of the y-axis
  127030. */
  127031. y: number;
  127032. }
  127033. /**
  127034. * changed / previous values for the values of this component
  127035. */
  127036. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127037. /**
  127038. * current (this frame) value
  127039. */
  127040. current: T;
  127041. /**
  127042. * previous (last change) value
  127043. */
  127044. previous: T;
  127045. }
  127046. /**
  127047. * Represents changes in the component between current frame and last values recorded
  127048. */
  127049. export interface IWebXRMotionControllerComponentChanges {
  127050. /**
  127051. * will be populated with previous and current values if axes changed
  127052. */
  127053. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127054. /**
  127055. * will be populated with previous and current values if pressed changed
  127056. */
  127057. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127058. /**
  127059. * will be populated with previous and current values if touched changed
  127060. */
  127061. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127062. /**
  127063. * will be populated with previous and current values if value changed
  127064. */
  127065. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127066. }
  127067. /**
  127068. * This class represents a single component (for example button or thumbstick) of a motion controller
  127069. */
  127070. export class WebXRControllerComponent implements IDisposable {
  127071. /**
  127072. * the id of this component
  127073. */
  127074. id: string;
  127075. /**
  127076. * the type of the component
  127077. */
  127078. type: MotionControllerComponentType;
  127079. private _buttonIndex;
  127080. private _axesIndices;
  127081. private _axes;
  127082. private _changes;
  127083. private _currentValue;
  127084. private _hasChanges;
  127085. private _pressed;
  127086. private _touched;
  127087. /**
  127088. * button component type
  127089. */
  127090. static BUTTON_TYPE: MotionControllerComponentType;
  127091. /**
  127092. * squeeze component type
  127093. */
  127094. static SQUEEZE_TYPE: MotionControllerComponentType;
  127095. /**
  127096. * Thumbstick component type
  127097. */
  127098. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127099. /**
  127100. * Touchpad component type
  127101. */
  127102. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127103. /**
  127104. * trigger component type
  127105. */
  127106. static TRIGGER_TYPE: MotionControllerComponentType;
  127107. /**
  127108. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127109. * the axes data changes
  127110. */
  127111. onAxisValueChangedObservable: Observable<{
  127112. x: number;
  127113. y: number;
  127114. }>;
  127115. /**
  127116. * Observers registered here will be triggered when the state of a button changes
  127117. * State change is either pressed / touched / value
  127118. */
  127119. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127120. /**
  127121. * Creates a new component for a motion controller.
  127122. * It is created by the motion controller itself
  127123. *
  127124. * @param id the id of this component
  127125. * @param type the type of the component
  127126. * @param _buttonIndex index in the buttons array of the gamepad
  127127. * @param _axesIndices indices of the values in the axes array of the gamepad
  127128. */
  127129. constructor(
  127130. /**
  127131. * the id of this component
  127132. */
  127133. id: string,
  127134. /**
  127135. * the type of the component
  127136. */
  127137. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127138. /**
  127139. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127140. */
  127141. get axes(): IWebXRMotionControllerAxesValue;
  127142. /**
  127143. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127144. */
  127145. get changes(): IWebXRMotionControllerComponentChanges;
  127146. /**
  127147. * Return whether or not the component changed the last frame
  127148. */
  127149. get hasChanges(): boolean;
  127150. /**
  127151. * is the button currently pressed
  127152. */
  127153. get pressed(): boolean;
  127154. /**
  127155. * is the button currently touched
  127156. */
  127157. get touched(): boolean;
  127158. /**
  127159. * Get the current value of this component
  127160. */
  127161. get value(): number;
  127162. /**
  127163. * Dispose this component
  127164. */
  127165. dispose(): void;
  127166. /**
  127167. * Are there axes correlating to this component
  127168. * @return true is axes data is available
  127169. */
  127170. isAxes(): boolean;
  127171. /**
  127172. * Is this component a button (hence - pressable)
  127173. * @returns true if can be pressed
  127174. */
  127175. isButton(): boolean;
  127176. /**
  127177. * update this component using the gamepad object it is in. Called on every frame
  127178. * @param nativeController the native gamepad controller object
  127179. */
  127180. update(nativeController: IMinimalMotionControllerObject): void;
  127181. }
  127182. }
  127183. declare module BABYLON {
  127184. /**
  127185. * Interface used to represent data loading progression
  127186. */
  127187. export interface ISceneLoaderProgressEvent {
  127188. /**
  127189. * Defines if data length to load can be evaluated
  127190. */
  127191. readonly lengthComputable: boolean;
  127192. /**
  127193. * Defines the loaded data length
  127194. */
  127195. readonly loaded: number;
  127196. /**
  127197. * Defines the data length to load
  127198. */
  127199. readonly total: number;
  127200. }
  127201. /**
  127202. * Interface used by SceneLoader plugins to define supported file extensions
  127203. */
  127204. export interface ISceneLoaderPluginExtensions {
  127205. /**
  127206. * Defines the list of supported extensions
  127207. */
  127208. [extension: string]: {
  127209. isBinary: boolean;
  127210. };
  127211. }
  127212. /**
  127213. * Interface used by SceneLoader plugin factory
  127214. */
  127215. export interface ISceneLoaderPluginFactory {
  127216. /**
  127217. * Defines the name of the factory
  127218. */
  127219. name: string;
  127220. /**
  127221. * Function called to create a new plugin
  127222. * @return the new plugin
  127223. */
  127224. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127225. /**
  127226. * The callback that returns true if the data can be directly loaded.
  127227. * @param data string containing the file data
  127228. * @returns if the data can be loaded directly
  127229. */
  127230. canDirectLoad?(data: string): boolean;
  127231. }
  127232. /**
  127233. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127234. */
  127235. export interface ISceneLoaderPluginBase {
  127236. /**
  127237. * The friendly name of this plugin.
  127238. */
  127239. name: string;
  127240. /**
  127241. * The file extensions supported by this plugin.
  127242. */
  127243. extensions: string | ISceneLoaderPluginExtensions;
  127244. /**
  127245. * The callback called when loading from a url.
  127246. * @param scene scene loading this url
  127247. * @param url url to load
  127248. * @param onSuccess callback called when the file successfully loads
  127249. * @param onProgress callback called while file is loading (if the server supports this mode)
  127250. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127251. * @param onError callback called when the file fails to load
  127252. * @returns a file request object
  127253. */
  127254. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127255. /**
  127256. * The callback called when loading from a file object.
  127257. * @param scene scene loading this file
  127258. * @param file defines the file to load
  127259. * @param onSuccess defines the callback to call when data is loaded
  127260. * @param onProgress defines the callback to call during loading process
  127261. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127262. * @param onError defines the callback to call when an error occurs
  127263. * @returns a file request object
  127264. */
  127265. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127266. /**
  127267. * The callback that returns true if the data can be directly loaded.
  127268. * @param data string containing the file data
  127269. * @returns if the data can be loaded directly
  127270. */
  127271. canDirectLoad?(data: string): boolean;
  127272. /**
  127273. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127274. * @param scene scene loading this data
  127275. * @param data string containing the data
  127276. * @returns data to pass to the plugin
  127277. */
  127278. directLoad?(scene: Scene, data: string): any;
  127279. /**
  127280. * The callback that allows custom handling of the root url based on the response url.
  127281. * @param rootUrl the original root url
  127282. * @param responseURL the response url if available
  127283. * @returns the new root url
  127284. */
  127285. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127286. }
  127287. /**
  127288. * Interface used to define a SceneLoader plugin
  127289. */
  127290. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127291. /**
  127292. * Import meshes into a scene.
  127293. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127294. * @param scene The scene to import into
  127295. * @param data The data to import
  127296. * @param rootUrl The root url for scene and resources
  127297. * @param meshes The meshes array to import into
  127298. * @param particleSystems The particle systems array to import into
  127299. * @param skeletons The skeletons array to import into
  127300. * @param onError The callback when import fails
  127301. * @returns True if successful or false otherwise
  127302. */
  127303. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127304. /**
  127305. * Load into a scene.
  127306. * @param scene The scene to load into
  127307. * @param data The data to import
  127308. * @param rootUrl The root url for scene and resources
  127309. * @param onError The callback when import fails
  127310. * @returns True if successful or false otherwise
  127311. */
  127312. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127313. /**
  127314. * Load into an asset container.
  127315. * @param scene The scene to load into
  127316. * @param data The data to import
  127317. * @param rootUrl The root url for scene and resources
  127318. * @param onError The callback when import fails
  127319. * @returns The loaded asset container
  127320. */
  127321. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127322. }
  127323. /**
  127324. * Interface used to define an async SceneLoader plugin
  127325. */
  127326. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127327. /**
  127328. * Import meshes into a scene.
  127329. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127330. * @param scene The scene to import into
  127331. * @param data The data to import
  127332. * @param rootUrl The root url for scene and resources
  127333. * @param onProgress The callback when the load progresses
  127334. * @param fileName Defines the name of the file to load
  127335. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127336. */
  127337. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127338. meshes: AbstractMesh[];
  127339. particleSystems: IParticleSystem[];
  127340. skeletons: Skeleton[];
  127341. animationGroups: AnimationGroup[];
  127342. }>;
  127343. /**
  127344. * Load into a scene.
  127345. * @param scene The scene to load into
  127346. * @param data The data to import
  127347. * @param rootUrl The root url for scene and resources
  127348. * @param onProgress The callback when the load progresses
  127349. * @param fileName Defines the name of the file to load
  127350. * @returns Nothing
  127351. */
  127352. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127353. /**
  127354. * Load into an asset container.
  127355. * @param scene The scene to load into
  127356. * @param data The data to import
  127357. * @param rootUrl The root url for scene and resources
  127358. * @param onProgress The callback when the load progresses
  127359. * @param fileName Defines the name of the file to load
  127360. * @returns The loaded asset container
  127361. */
  127362. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127363. }
  127364. /**
  127365. * Mode that determines how to handle old animation groups before loading new ones.
  127366. */
  127367. export enum SceneLoaderAnimationGroupLoadingMode {
  127368. /**
  127369. * Reset all old animations to initial state then dispose them.
  127370. */
  127371. Clean = 0,
  127372. /**
  127373. * Stop all old animations.
  127374. */
  127375. Stop = 1,
  127376. /**
  127377. * Restart old animations from first frame.
  127378. */
  127379. Sync = 2,
  127380. /**
  127381. * Old animations remains untouched.
  127382. */
  127383. NoSync = 3
  127384. }
  127385. /**
  127386. * Defines a plugin registered by the SceneLoader
  127387. */
  127388. interface IRegisteredPlugin {
  127389. /**
  127390. * Defines the plugin to use
  127391. */
  127392. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127393. /**
  127394. * Defines if the plugin supports binary data
  127395. */
  127396. isBinary: boolean;
  127397. }
  127398. /**
  127399. * Class used to load scene from various file formats using registered plugins
  127400. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127401. */
  127402. export class SceneLoader {
  127403. /**
  127404. * No logging while loading
  127405. */
  127406. static readonly NO_LOGGING: number;
  127407. /**
  127408. * Minimal logging while loading
  127409. */
  127410. static readonly MINIMAL_LOGGING: number;
  127411. /**
  127412. * Summary logging while loading
  127413. */
  127414. static readonly SUMMARY_LOGGING: number;
  127415. /**
  127416. * Detailled logging while loading
  127417. */
  127418. static readonly DETAILED_LOGGING: number;
  127419. /**
  127420. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127421. */
  127422. static get ForceFullSceneLoadingForIncremental(): boolean;
  127423. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127424. /**
  127425. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127426. */
  127427. static get ShowLoadingScreen(): boolean;
  127428. static set ShowLoadingScreen(value: boolean);
  127429. /**
  127430. * Defines the current logging level (while loading the scene)
  127431. * @ignorenaming
  127432. */
  127433. static get loggingLevel(): number;
  127434. static set loggingLevel(value: number);
  127435. /**
  127436. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127437. */
  127438. static get CleanBoneMatrixWeights(): boolean;
  127439. static set CleanBoneMatrixWeights(value: boolean);
  127440. /**
  127441. * Event raised when a plugin is used to load a scene
  127442. */
  127443. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127444. private static _registeredPlugins;
  127445. private static _showingLoadingScreen;
  127446. /**
  127447. * Gets the default plugin (used to load Babylon files)
  127448. * @returns the .babylon plugin
  127449. */
  127450. static GetDefaultPlugin(): IRegisteredPlugin;
  127451. private static _GetPluginForExtension;
  127452. private static _GetPluginForDirectLoad;
  127453. private static _GetPluginForFilename;
  127454. private static _GetDirectLoad;
  127455. private static _LoadData;
  127456. private static _GetFileInfo;
  127457. /**
  127458. * Gets a plugin that can load the given extension
  127459. * @param extension defines the extension to load
  127460. * @returns a plugin or null if none works
  127461. */
  127462. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127463. /**
  127464. * Gets a boolean indicating that the given extension can be loaded
  127465. * @param extension defines the extension to load
  127466. * @returns true if the extension is supported
  127467. */
  127468. static IsPluginForExtensionAvailable(extension: string): boolean;
  127469. /**
  127470. * Adds a new plugin to the list of registered plugins
  127471. * @param plugin defines the plugin to add
  127472. */
  127473. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127474. /**
  127475. * Import meshes into a scene
  127476. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127477. * @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)
  127478. * @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)
  127479. * @param scene the instance of BABYLON.Scene to append to
  127480. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127481. * @param onProgress a callback with a progress event for each file being loaded
  127482. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127483. * @param pluginExtension the extension used to determine the plugin
  127484. * @returns The loaded plugin
  127485. */
  127486. 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>;
  127487. /**
  127488. * Import meshes into a scene
  127489. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127490. * @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)
  127491. * @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)
  127492. * @param scene the instance of BABYLON.Scene to append to
  127493. * @param onProgress a callback with a progress event for each file being loaded
  127494. * @param pluginExtension the extension used to determine the plugin
  127495. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127496. */
  127497. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127498. meshes: AbstractMesh[];
  127499. particleSystems: IParticleSystem[];
  127500. skeletons: Skeleton[];
  127501. animationGroups: AnimationGroup[];
  127502. }>;
  127503. /**
  127504. * Load a scene
  127505. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  127506. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  127507. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127508. * @param onSuccess a callback with the scene when import succeeds
  127509. * @param onProgress a callback with a progress event for each file being loaded
  127510. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127511. * @param pluginExtension the extension used to determine the plugin
  127512. * @returns The loaded plugin
  127513. */
  127514. 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>;
  127515. /**
  127516. * Load a scene
  127517. * @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)
  127518. * @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)
  127519. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127520. * @param onProgress a callback with a progress event for each file being loaded
  127521. * @param pluginExtension the extension used to determine the plugin
  127522. * @returns The loaded scene
  127523. */
  127524. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127525. /**
  127526. * Append a scene
  127527. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  127528. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  127529. * @param scene is the instance of BABYLON.Scene to append to
  127530. * @param onSuccess a callback with the scene when import succeeds
  127531. * @param onProgress a callback with a progress event for each file being loaded
  127532. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127533. * @param pluginExtension the extension used to determine the plugin
  127534. * @returns The loaded plugin
  127535. */
  127536. 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>;
  127537. /**
  127538. * Append a scene
  127539. * @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)
  127540. * @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)
  127541. * @param scene is the instance of BABYLON.Scene to append to
  127542. * @param onProgress a callback with a progress event for each file being loaded
  127543. * @param pluginExtension the extension used to determine the plugin
  127544. * @returns The given scene
  127545. */
  127546. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127547. /**
  127548. * Load a scene into an asset container
  127549. * @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)
  127550. * @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)
  127551. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127552. * @param onSuccess a callback with the scene when import succeeds
  127553. * @param onProgress a callback with a progress event for each file being loaded
  127554. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127555. * @param pluginExtension the extension used to determine the plugin
  127556. * @returns The loaded plugin
  127557. */
  127558. 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>;
  127559. /**
  127560. * Load a scene into an asset container
  127561. * @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)
  127562. * @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)
  127563. * @param scene is the instance of Scene to append to
  127564. * @param onProgress a callback with a progress event for each file being loaded
  127565. * @param pluginExtension the extension used to determine the plugin
  127566. * @returns The loaded asset container
  127567. */
  127568. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127569. /**
  127570. * Import animations from a file into a scene
  127571. * @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)
  127572. * @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)
  127573. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127574. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127575. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127576. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127577. * @param onSuccess a callback with the scene when import succeeds
  127578. * @param onProgress a callback with a progress event for each file being loaded
  127579. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127580. * @param pluginExtension the extension used to determine the plugin
  127581. */
  127582. 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;
  127583. /**
  127584. * Import animations from a file into a scene
  127585. * @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)
  127586. * @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)
  127587. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127588. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127589. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127590. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127591. * @param onSuccess a callback with the scene when import succeeds
  127592. * @param onProgress a callback with a progress event for each file being loaded
  127593. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127594. * @param pluginExtension the extension used to determine the plugin
  127595. * @returns the updated scene with imported animations
  127596. */
  127597. 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>;
  127598. }
  127599. }
  127600. declare module BABYLON {
  127601. /**
  127602. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127603. */
  127604. export type MotionControllerHandedness = "none" | "left" | "right";
  127605. /**
  127606. * The type of components available in motion controllers.
  127607. * This is not the name of the component.
  127608. */
  127609. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127610. /**
  127611. * The state of a controller component
  127612. */
  127613. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127614. /**
  127615. * The schema of motion controller layout.
  127616. * No object will be initialized using this interface
  127617. * This is used just to define the profile.
  127618. */
  127619. export interface IMotionControllerLayout {
  127620. /**
  127621. * Path to load the assets. Usually relative to the base path
  127622. */
  127623. assetPath: string;
  127624. /**
  127625. * Available components (unsorted)
  127626. */
  127627. components: {
  127628. /**
  127629. * A map of component Ids
  127630. */
  127631. [componentId: string]: {
  127632. /**
  127633. * The type of input the component outputs
  127634. */
  127635. type: MotionControllerComponentType;
  127636. /**
  127637. * The indices of this component in the gamepad object
  127638. */
  127639. gamepadIndices: {
  127640. /**
  127641. * Index of button
  127642. */
  127643. button?: number;
  127644. /**
  127645. * If available, index of x-axis
  127646. */
  127647. xAxis?: number;
  127648. /**
  127649. * If available, index of y-axis
  127650. */
  127651. yAxis?: number;
  127652. };
  127653. /**
  127654. * The mesh's root node name
  127655. */
  127656. rootNodeName: string;
  127657. /**
  127658. * Animation definitions for this model
  127659. */
  127660. visualResponses: {
  127661. [stateKey: string]: {
  127662. /**
  127663. * What property will be animated
  127664. */
  127665. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127666. /**
  127667. * What states influence this visual response
  127668. */
  127669. states: MotionControllerComponentStateType[];
  127670. /**
  127671. * Type of animation - movement or visibility
  127672. */
  127673. valueNodeProperty: "transform" | "visibility";
  127674. /**
  127675. * Base node name to move. Its position will be calculated according to the min and max nodes
  127676. */
  127677. valueNodeName?: string;
  127678. /**
  127679. * Minimum movement node
  127680. */
  127681. minNodeName?: string;
  127682. /**
  127683. * Max movement node
  127684. */
  127685. maxNodeName?: string;
  127686. };
  127687. };
  127688. /**
  127689. * If touch enabled, what is the name of node to display user feedback
  127690. */
  127691. touchPointNodeName?: string;
  127692. };
  127693. };
  127694. /**
  127695. * Is it xr standard mapping or not
  127696. */
  127697. gamepadMapping: "" | "xr-standard";
  127698. /**
  127699. * Base root node of this entire model
  127700. */
  127701. rootNodeName: string;
  127702. /**
  127703. * Defines the main button component id
  127704. */
  127705. selectComponentId: string;
  127706. }
  127707. /**
  127708. * A definition for the layout map in the input profile
  127709. */
  127710. export interface IMotionControllerLayoutMap {
  127711. /**
  127712. * Layouts with handedness type as a key
  127713. */
  127714. [handedness: string]: IMotionControllerLayout;
  127715. }
  127716. /**
  127717. * The XR Input profile schema
  127718. * Profiles can be found here:
  127719. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127720. */
  127721. export interface IMotionControllerProfile {
  127722. /**
  127723. * fallback profiles for this profileId
  127724. */
  127725. fallbackProfileIds: string[];
  127726. /**
  127727. * The layout map, with handedness as key
  127728. */
  127729. layouts: IMotionControllerLayoutMap;
  127730. /**
  127731. * The id of this profile
  127732. * correlates to the profile(s) in the xrInput.profiles array
  127733. */
  127734. profileId: string;
  127735. }
  127736. /**
  127737. * A helper-interface for the 3 meshes needed for controller button animation
  127738. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127739. */
  127740. export interface IMotionControllerButtonMeshMap {
  127741. /**
  127742. * the mesh that defines the pressed value mesh position.
  127743. * This is used to find the max-position of this button
  127744. */
  127745. pressedMesh: AbstractMesh;
  127746. /**
  127747. * the mesh that defines the unpressed value mesh position.
  127748. * This is used to find the min (or initial) position of this button
  127749. */
  127750. unpressedMesh: AbstractMesh;
  127751. /**
  127752. * The mesh that will be changed when value changes
  127753. */
  127754. valueMesh: AbstractMesh;
  127755. }
  127756. /**
  127757. * A helper-interface for the 3 meshes needed for controller axis animation.
  127758. * This will be expanded when touchpad animations are fully supported
  127759. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127760. */
  127761. export interface IMotionControllerMeshMap {
  127762. /**
  127763. * the mesh that defines the maximum value mesh position.
  127764. */
  127765. maxMesh?: AbstractMesh;
  127766. /**
  127767. * the mesh that defines the minimum value mesh position.
  127768. */
  127769. minMesh?: AbstractMesh;
  127770. /**
  127771. * The mesh that will be changed when axis value changes
  127772. */
  127773. valueMesh?: AbstractMesh;
  127774. }
  127775. /**
  127776. * The elements needed for change-detection of the gamepad objects in motion controllers
  127777. */
  127778. export interface IMinimalMotionControllerObject {
  127779. /**
  127780. * Available axes of this controller
  127781. */
  127782. axes: number[];
  127783. /**
  127784. * An array of available buttons
  127785. */
  127786. buttons: Array<{
  127787. /**
  127788. * Value of the button/trigger
  127789. */
  127790. value: number;
  127791. /**
  127792. * If the button/trigger is currently touched
  127793. */
  127794. touched: boolean;
  127795. /**
  127796. * If the button/trigger is currently pressed
  127797. */
  127798. pressed: boolean;
  127799. }>;
  127800. /**
  127801. * EXPERIMENTAL haptic support.
  127802. */
  127803. hapticActuators?: Array<{
  127804. pulse: (value: number, duration: number) => Promise<boolean>;
  127805. }>;
  127806. }
  127807. /**
  127808. * An Abstract Motion controller
  127809. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127810. * Each component has an observable to check for changes in value and state
  127811. */
  127812. export abstract class WebXRAbstractMotionController implements IDisposable {
  127813. protected scene: Scene;
  127814. protected layout: IMotionControllerLayout;
  127815. /**
  127816. * The gamepad object correlating to this controller
  127817. */
  127818. gamepadObject: IMinimalMotionControllerObject;
  127819. /**
  127820. * handedness (left/right/none) of this controller
  127821. */
  127822. handedness: MotionControllerHandedness;
  127823. private _initComponent;
  127824. private _modelReady;
  127825. /**
  127826. * A map of components (WebXRControllerComponent) in this motion controller
  127827. * Components have a ComponentType and can also have both button and axis definitions
  127828. */
  127829. readonly components: {
  127830. [id: string]: WebXRControllerComponent;
  127831. };
  127832. /**
  127833. * Disable the model's animation. Can be set at any time.
  127834. */
  127835. disableAnimation: boolean;
  127836. /**
  127837. * Observers registered here will be triggered when the model of this controller is done loading
  127838. */
  127839. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127840. /**
  127841. * The profile id of this motion controller
  127842. */
  127843. abstract profileId: string;
  127844. /**
  127845. * The root mesh of the model. It is null if the model was not yet initialized
  127846. */
  127847. rootMesh: Nullable<AbstractMesh>;
  127848. /**
  127849. * constructs a new abstract motion controller
  127850. * @param scene the scene to which the model of the controller will be added
  127851. * @param layout The profile layout to load
  127852. * @param gamepadObject The gamepad object correlating to this controller
  127853. * @param handedness handedness (left/right/none) of this controller
  127854. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127855. */
  127856. constructor(scene: Scene, layout: IMotionControllerLayout,
  127857. /**
  127858. * The gamepad object correlating to this controller
  127859. */
  127860. gamepadObject: IMinimalMotionControllerObject,
  127861. /**
  127862. * handedness (left/right/none) of this controller
  127863. */
  127864. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127865. /**
  127866. * Dispose this controller, the model mesh and all its components
  127867. */
  127868. dispose(): void;
  127869. /**
  127870. * Returns all components of specific type
  127871. * @param type the type to search for
  127872. * @return an array of components with this type
  127873. */
  127874. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127875. /**
  127876. * get a component based an its component id as defined in layout.components
  127877. * @param id the id of the component
  127878. * @returns the component correlates to the id or undefined if not found
  127879. */
  127880. getComponent(id: string): WebXRControllerComponent;
  127881. /**
  127882. * Get the list of components available in this motion controller
  127883. * @returns an array of strings correlating to available components
  127884. */
  127885. getComponentIds(): string[];
  127886. /**
  127887. * Get the first component of specific type
  127888. * @param type type of component to find
  127889. * @return a controller component or null if not found
  127890. */
  127891. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127892. /**
  127893. * Get the main (Select) component of this controller as defined in the layout
  127894. * @returns the main component of this controller
  127895. */
  127896. getMainComponent(): WebXRControllerComponent;
  127897. /**
  127898. * Loads the model correlating to this controller
  127899. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127900. * @returns A promise fulfilled with the result of the model loading
  127901. */
  127902. loadModel(): Promise<boolean>;
  127903. /**
  127904. * Update this model using the current XRFrame
  127905. * @param xrFrame the current xr frame to use and update the model
  127906. */
  127907. updateFromXRFrame(xrFrame: XRFrame): void;
  127908. /**
  127909. * Backwards compatibility due to a deeply-integrated typo
  127910. */
  127911. get handness(): XREye;
  127912. /**
  127913. * Pulse (vibrate) this controller
  127914. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127915. * Consecutive calls to this function will cancel the last pulse call
  127916. *
  127917. * @param value the strength of the pulse in 0.0...1.0 range
  127918. * @param duration Duration of the pulse in milliseconds
  127919. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127920. * @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
  127921. */
  127922. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127923. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127924. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127925. /**
  127926. * Moves the axis on the controller mesh based on its current state
  127927. * @param axis the index of the axis
  127928. * @param axisValue the value of the axis which determines the meshes new position
  127929. * @hidden
  127930. */
  127931. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127932. /**
  127933. * Update the model itself with the current frame data
  127934. * @param xrFrame the frame to use for updating the model mesh
  127935. */
  127936. protected updateModel(xrFrame: XRFrame): void;
  127937. /**
  127938. * Get the filename and path for this controller's model
  127939. * @returns a map of filename and path
  127940. */
  127941. protected abstract _getFilenameAndPath(): {
  127942. filename: string;
  127943. path: string;
  127944. };
  127945. /**
  127946. * This function is called before the mesh is loaded. It checks for loading constraints.
  127947. * For example, this function can check if the GLB loader is available
  127948. * If this function returns false, the generic controller will be loaded instead
  127949. * @returns Is the client ready to load the mesh
  127950. */
  127951. protected abstract _getModelLoadingConstraints(): boolean;
  127952. /**
  127953. * This function will be called after the model was successfully loaded and can be used
  127954. * for mesh transformations before it is available for the user
  127955. * @param meshes the loaded meshes
  127956. */
  127957. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127958. /**
  127959. * Set the root mesh for this controller. Important for the WebXR controller class
  127960. * @param meshes the loaded meshes
  127961. */
  127962. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127963. /**
  127964. * A function executed each frame that updates the mesh (if needed)
  127965. * @param xrFrame the current xrFrame
  127966. */
  127967. protected abstract _updateModel(xrFrame: XRFrame): void;
  127968. private _getGenericFilenameAndPath;
  127969. private _getGenericParentMesh;
  127970. }
  127971. }
  127972. declare module BABYLON {
  127973. /**
  127974. * A generic trigger-only motion controller for WebXR
  127975. */
  127976. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127977. /**
  127978. * Static version of the profile id of this controller
  127979. */
  127980. static ProfileId: string;
  127981. profileId: string;
  127982. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127983. protected _getFilenameAndPath(): {
  127984. filename: string;
  127985. path: string;
  127986. };
  127987. protected _getModelLoadingConstraints(): boolean;
  127988. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127989. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127990. protected _updateModel(): void;
  127991. }
  127992. }
  127993. declare module BABYLON {
  127994. /**
  127995. * Class containing static functions to help procedurally build meshes
  127996. */
  127997. export class SphereBuilder {
  127998. /**
  127999. * Creates a sphere mesh
  128000. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  128001. * * 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`)
  128002. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  128003. * * 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
  128004. * * 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)
  128005. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  128006. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  128007. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128008. * @param name defines the name of the mesh
  128009. * @param options defines the options used to create the mesh
  128010. * @param scene defines the hosting scene
  128011. * @returns the sphere mesh
  128012. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  128013. */
  128014. static CreateSphere(name: string, options: {
  128015. segments?: number;
  128016. diameter?: number;
  128017. diameterX?: number;
  128018. diameterY?: number;
  128019. diameterZ?: number;
  128020. arc?: number;
  128021. slice?: number;
  128022. sideOrientation?: number;
  128023. frontUVs?: Vector4;
  128024. backUVs?: Vector4;
  128025. updatable?: boolean;
  128026. }, scene?: Nullable<Scene>): Mesh;
  128027. }
  128028. }
  128029. declare module BABYLON {
  128030. /**
  128031. * A profiled motion controller has its profile loaded from an online repository.
  128032. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128033. */
  128034. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128035. private _repositoryUrl;
  128036. private _buttonMeshMapping;
  128037. private _touchDots;
  128038. /**
  128039. * The profile ID of this controller. Will be populated when the controller initializes.
  128040. */
  128041. profileId: string;
  128042. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128043. dispose(): void;
  128044. protected _getFilenameAndPath(): {
  128045. filename: string;
  128046. path: string;
  128047. };
  128048. protected _getModelLoadingConstraints(): boolean;
  128049. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128050. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128051. protected _updateModel(_xrFrame: XRFrame): void;
  128052. }
  128053. }
  128054. declare module BABYLON {
  128055. /**
  128056. * A construction function type to create a new controller based on an xrInput object
  128057. */
  128058. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128059. /**
  128060. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128061. *
  128062. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128063. * it should be replaced with auto-loaded controllers.
  128064. *
  128065. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128066. */
  128067. export class WebXRMotionControllerManager {
  128068. private static _AvailableControllers;
  128069. private static _Fallbacks;
  128070. private static _ProfileLoadingPromises;
  128071. private static _ProfilesList;
  128072. /**
  128073. * The base URL of the online controller repository. Can be changed at any time.
  128074. */
  128075. static BaseRepositoryUrl: string;
  128076. /**
  128077. * Which repository gets priority - local or online
  128078. */
  128079. static PrioritizeOnlineRepository: boolean;
  128080. /**
  128081. * Use the online repository, or use only locally-defined controllers
  128082. */
  128083. static UseOnlineRepository: boolean;
  128084. /**
  128085. * Clear the cache used for profile loading and reload when requested again
  128086. */
  128087. static ClearProfilesCache(): void;
  128088. /**
  128089. * Register the default fallbacks.
  128090. * This function is called automatically when this file is imported.
  128091. */
  128092. static DefaultFallbacks(): void;
  128093. /**
  128094. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128095. * @param profileId the profile to which a fallback needs to be found
  128096. * @return an array with corresponding fallback profiles
  128097. */
  128098. static FindFallbackWithProfileId(profileId: string): string[];
  128099. /**
  128100. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128101. * The order of search:
  128102. *
  128103. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128104. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128105. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128106. * 4) return the generic trigger controller if none were found
  128107. *
  128108. * @param xrInput the xrInput to which a new controller is initialized
  128109. * @param scene the scene to which the model will be added
  128110. * @param forceProfile force a certain profile for this controller
  128111. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128112. */
  128113. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128114. /**
  128115. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128116. *
  128117. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128118. *
  128119. * @param type the profile type to register
  128120. * @param constructFunction the function to be called when loading this profile
  128121. */
  128122. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128123. /**
  128124. * Register a fallback to a specific profile.
  128125. * @param profileId the profileId that will receive the fallbacks
  128126. * @param fallbacks A list of fallback profiles
  128127. */
  128128. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128129. /**
  128130. * Will update the list of profiles available in the repository
  128131. * @return a promise that resolves to a map of profiles available online
  128132. */
  128133. static UpdateProfilesList(): Promise<{
  128134. [profile: string]: string;
  128135. }>;
  128136. private static _LoadProfileFromRepository;
  128137. private static _LoadProfilesFromAvailableControllers;
  128138. }
  128139. }
  128140. declare module BABYLON {
  128141. /**
  128142. * Configuration options for the WebXR controller creation
  128143. */
  128144. export interface IWebXRControllerOptions {
  128145. /**
  128146. * Should the controller mesh be animated when a user interacts with it
  128147. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128148. */
  128149. disableMotionControllerAnimation?: boolean;
  128150. /**
  128151. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128152. */
  128153. doNotLoadControllerMesh?: boolean;
  128154. /**
  128155. * Force a specific controller type for this controller.
  128156. * This can be used when creating your own profile or when testing different controllers
  128157. */
  128158. forceControllerProfile?: string;
  128159. /**
  128160. * Defines a rendering group ID for meshes that will be loaded.
  128161. * This is for the default controllers only.
  128162. */
  128163. renderingGroupId?: number;
  128164. }
  128165. /**
  128166. * Represents an XR controller
  128167. */
  128168. export class WebXRInputSource {
  128169. private _scene;
  128170. /** The underlying input source for the controller */
  128171. inputSource: XRInputSource;
  128172. private _options;
  128173. private _tmpVector;
  128174. private _uniqueId;
  128175. private _disposed;
  128176. /**
  128177. * 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
  128178. */
  128179. grip?: AbstractMesh;
  128180. /**
  128181. * If available, this is the gamepad object related to this controller.
  128182. * Using this object it is possible to get click events and trackpad changes of the
  128183. * webxr controller that is currently being used.
  128184. */
  128185. motionController?: WebXRAbstractMotionController;
  128186. /**
  128187. * Event that fires when the controller is removed/disposed.
  128188. * The object provided as event data is this controller, after associated assets were disposed.
  128189. * uniqueId is still available.
  128190. */
  128191. onDisposeObservable: Observable<WebXRInputSource>;
  128192. /**
  128193. * Will be triggered when the mesh associated with the motion controller is done loading.
  128194. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128195. * A shortened version of controller -> motion controller -> on mesh loaded.
  128196. */
  128197. onMeshLoadedObservable: Observable<AbstractMesh>;
  128198. /**
  128199. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128200. */
  128201. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128202. /**
  128203. * Pointer which can be used to select objects or attach a visible laser to
  128204. */
  128205. pointer: AbstractMesh;
  128206. /**
  128207. * Creates the input source object
  128208. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128209. * @param _scene the scene which the controller should be associated to
  128210. * @param inputSource the underlying input source for the controller
  128211. * @param _options options for this controller creation
  128212. */
  128213. constructor(_scene: Scene,
  128214. /** The underlying input source for the controller */
  128215. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128216. /**
  128217. * Get this controllers unique id
  128218. */
  128219. get uniqueId(): string;
  128220. /**
  128221. * Disposes of the object
  128222. */
  128223. dispose(): void;
  128224. /**
  128225. * Gets a world space ray coming from the pointer or grip
  128226. * @param result the resulting ray
  128227. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128228. */
  128229. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128230. /**
  128231. * Updates the controller pose based on the given XRFrame
  128232. * @param xrFrame xr frame to update the pose with
  128233. * @param referenceSpace reference space to use
  128234. */
  128235. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128236. }
  128237. }
  128238. declare module BABYLON {
  128239. /**
  128240. * The schema for initialization options of the XR Input class
  128241. */
  128242. export interface IWebXRInputOptions {
  128243. /**
  128244. * If set to true no model will be automatically loaded
  128245. */
  128246. doNotLoadControllerMeshes?: boolean;
  128247. /**
  128248. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128249. * If not found, the xr input profile data will be used.
  128250. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128251. */
  128252. forceInputProfile?: string;
  128253. /**
  128254. * Do not send a request to the controller repository to load the profile.
  128255. *
  128256. * Instead, use the controllers available in babylon itself.
  128257. */
  128258. disableOnlineControllerRepository?: boolean;
  128259. /**
  128260. * A custom URL for the controllers repository
  128261. */
  128262. customControllersRepositoryURL?: string;
  128263. /**
  128264. * Should the controller model's components not move according to the user input
  128265. */
  128266. disableControllerAnimation?: boolean;
  128267. /**
  128268. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128269. */
  128270. controllerOptions?: IWebXRControllerOptions;
  128271. }
  128272. /**
  128273. * XR input used to track XR inputs such as controllers/rays
  128274. */
  128275. export class WebXRInput implements IDisposable {
  128276. /**
  128277. * the xr session manager for this session
  128278. */
  128279. xrSessionManager: WebXRSessionManager;
  128280. /**
  128281. * the WebXR camera for this session. Mainly used for teleportation
  128282. */
  128283. xrCamera: WebXRCamera;
  128284. private readonly options;
  128285. /**
  128286. * XR controllers being tracked
  128287. */
  128288. controllers: Array<WebXRInputSource>;
  128289. private _frameObserver;
  128290. private _sessionEndedObserver;
  128291. private _sessionInitObserver;
  128292. /**
  128293. * Event when a controller has been connected/added
  128294. */
  128295. onControllerAddedObservable: Observable<WebXRInputSource>;
  128296. /**
  128297. * Event when a controller has been removed/disconnected
  128298. */
  128299. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128300. /**
  128301. * Initializes the WebXRInput
  128302. * @param xrSessionManager the xr session manager for this session
  128303. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128304. * @param options = initialization options for this xr input
  128305. */
  128306. constructor(
  128307. /**
  128308. * the xr session manager for this session
  128309. */
  128310. xrSessionManager: WebXRSessionManager,
  128311. /**
  128312. * the WebXR camera for this session. Mainly used for teleportation
  128313. */
  128314. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128315. private _onInputSourcesChange;
  128316. private _addAndRemoveControllers;
  128317. /**
  128318. * Disposes of the object
  128319. */
  128320. dispose(): void;
  128321. }
  128322. }
  128323. declare module BABYLON {
  128324. /**
  128325. * This is the base class for all WebXR features.
  128326. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128327. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128328. */
  128329. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128330. protected _xrSessionManager: WebXRSessionManager;
  128331. private _attached;
  128332. private _removeOnDetach;
  128333. /**
  128334. * Should auto-attach be disabled?
  128335. */
  128336. disableAutoAttach: boolean;
  128337. /**
  128338. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128339. */
  128340. xrNativeFeatureName: string;
  128341. /**
  128342. * Construct a new (abstract) WebXR feature
  128343. * @param _xrSessionManager the xr session manager for this feature
  128344. */
  128345. constructor(_xrSessionManager: WebXRSessionManager);
  128346. /**
  128347. * Is this feature attached
  128348. */
  128349. get attached(): boolean;
  128350. /**
  128351. * attach this feature
  128352. *
  128353. * @param force should attachment be forced (even when already attached)
  128354. * @returns true if successful, false is failed or already attached
  128355. */
  128356. attach(force?: boolean): boolean;
  128357. /**
  128358. * detach this feature.
  128359. *
  128360. * @returns true if successful, false if failed or already detached
  128361. */
  128362. detach(): boolean;
  128363. /**
  128364. * Dispose this feature and all of the resources attached
  128365. */
  128366. dispose(): void;
  128367. /**
  128368. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128369. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128370. *
  128371. * @returns whether or not the feature is compatible in this environment
  128372. */
  128373. isCompatible(): boolean;
  128374. /**
  128375. * This is used to register callbacks that will automatically be removed when detach is called.
  128376. * @param observable the observable to which the observer will be attached
  128377. * @param callback the callback to register
  128378. */
  128379. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128380. /**
  128381. * Code in this function will be executed on each xrFrame received from the browser.
  128382. * This function will not execute after the feature is detached.
  128383. * @param _xrFrame the current frame
  128384. */
  128385. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128386. }
  128387. }
  128388. declare module BABYLON {
  128389. /**
  128390. * Renders a layer on top of an existing scene
  128391. */
  128392. export class UtilityLayerRenderer implements IDisposable {
  128393. /** the original scene that will be rendered on top of */
  128394. originalScene: Scene;
  128395. private _pointerCaptures;
  128396. private _lastPointerEvents;
  128397. private static _DefaultUtilityLayer;
  128398. private static _DefaultKeepDepthUtilityLayer;
  128399. private _sharedGizmoLight;
  128400. private _renderCamera;
  128401. /**
  128402. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128403. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128404. * @returns the camera that is used when rendering the utility layer
  128405. */
  128406. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128407. /**
  128408. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128409. * @param cam the camera that should be used when rendering the utility layer
  128410. */
  128411. setRenderCamera(cam: Nullable<Camera>): void;
  128412. /**
  128413. * @hidden
  128414. * Light which used by gizmos to get light shading
  128415. */
  128416. _getSharedGizmoLight(): HemisphericLight;
  128417. /**
  128418. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128419. */
  128420. pickUtilitySceneFirst: boolean;
  128421. /**
  128422. * 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)
  128423. */
  128424. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128425. /**
  128426. * 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)
  128427. */
  128428. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128429. /**
  128430. * The scene that is rendered on top of the original scene
  128431. */
  128432. utilityLayerScene: Scene;
  128433. /**
  128434. * If the utility layer should automatically be rendered on top of existing scene
  128435. */
  128436. shouldRender: boolean;
  128437. /**
  128438. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128439. */
  128440. onlyCheckPointerDownEvents: boolean;
  128441. /**
  128442. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128443. */
  128444. processAllEvents: boolean;
  128445. /**
  128446. * Observable raised when the pointer move from the utility layer scene to the main scene
  128447. */
  128448. onPointerOutObservable: Observable<number>;
  128449. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128450. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128451. private _afterRenderObserver;
  128452. private _sceneDisposeObserver;
  128453. private _originalPointerObserver;
  128454. /**
  128455. * Instantiates a UtilityLayerRenderer
  128456. * @param originalScene the original scene that will be rendered on top of
  128457. * @param handleEvents boolean indicating if the utility layer should handle events
  128458. */
  128459. constructor(
  128460. /** the original scene that will be rendered on top of */
  128461. originalScene: Scene, handleEvents?: boolean);
  128462. private _notifyObservers;
  128463. /**
  128464. * Renders the utility layers scene on top of the original scene
  128465. */
  128466. render(): void;
  128467. /**
  128468. * Disposes of the renderer
  128469. */
  128470. dispose(): void;
  128471. private _updateCamera;
  128472. }
  128473. }
  128474. declare module BABYLON {
  128475. /**
  128476. * Options interface for the pointer selection module
  128477. */
  128478. export interface IWebXRControllerPointerSelectionOptions {
  128479. /**
  128480. * if provided, this scene will be used to render meshes.
  128481. */
  128482. customUtilityLayerScene?: Scene;
  128483. /**
  128484. * 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)
  128485. * If not disabled, the last picked point will be used to execute a pointer up event
  128486. * If disabled, pointer up event will be triggered right after the pointer down event.
  128487. * Used in screen and gaze target ray mode only
  128488. */
  128489. disablePointerUpOnTouchOut: boolean;
  128490. /**
  128491. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128492. */
  128493. forceGazeMode: boolean;
  128494. /**
  128495. * 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
  128496. * to start a new countdown to the pointer down event.
  128497. * Defaults to 1.
  128498. */
  128499. gazeModePointerMovedFactor?: number;
  128500. /**
  128501. * Different button type to use instead of the main component
  128502. */
  128503. overrideButtonId?: string;
  128504. /**
  128505. * use this rendering group id for the meshes (optional)
  128506. */
  128507. renderingGroupId?: number;
  128508. /**
  128509. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128510. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128511. * 3000 means 3 seconds between pointing at something and selecting it
  128512. */
  128513. timeToSelect?: number;
  128514. /**
  128515. * Should meshes created here be added to a utility layer or the main scene
  128516. */
  128517. useUtilityLayer?: boolean;
  128518. /**
  128519. * Optional WebXR camera to be used for gaze selection
  128520. */
  128521. gazeCamera?: WebXRCamera;
  128522. /**
  128523. * the xr input to use with this pointer selection
  128524. */
  128525. xrInput: WebXRInput;
  128526. }
  128527. /**
  128528. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128529. */
  128530. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128531. private readonly _options;
  128532. private static _idCounter;
  128533. private _attachController;
  128534. private _controllers;
  128535. private _scene;
  128536. private _tmpVectorForPickCompare;
  128537. /**
  128538. * The module's name
  128539. */
  128540. static readonly Name: string;
  128541. /**
  128542. * The (Babylon) version of this module.
  128543. * This is an integer representing the implementation version.
  128544. * This number does not correspond to the WebXR specs version
  128545. */
  128546. static readonly Version: number;
  128547. /**
  128548. * Disable lighting on the laser pointer (so it will always be visible)
  128549. */
  128550. disablePointerLighting: boolean;
  128551. /**
  128552. * Disable lighting on the selection mesh (so it will always be visible)
  128553. */
  128554. disableSelectionMeshLighting: boolean;
  128555. /**
  128556. * Should the laser pointer be displayed
  128557. */
  128558. displayLaserPointer: boolean;
  128559. /**
  128560. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128561. */
  128562. displaySelectionMesh: boolean;
  128563. /**
  128564. * This color will be set to the laser pointer when selection is triggered
  128565. */
  128566. laserPointerPickedColor: Color3;
  128567. /**
  128568. * Default color of the laser pointer
  128569. */
  128570. laserPointerDefaultColor: Color3;
  128571. /**
  128572. * default color of the selection ring
  128573. */
  128574. selectionMeshDefaultColor: Color3;
  128575. /**
  128576. * This color will be applied to the selection ring when selection is triggered
  128577. */
  128578. selectionMeshPickedColor: Color3;
  128579. /**
  128580. * Optional filter to be used for ray selection. This predicate shares behavior with
  128581. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128582. */
  128583. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128584. /**
  128585. * constructs a new background remover module
  128586. * @param _xrSessionManager the session manager for this module
  128587. * @param _options read-only options to be used in this module
  128588. */
  128589. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128590. /**
  128591. * attach this feature
  128592. * Will usually be called by the features manager
  128593. *
  128594. * @returns true if successful.
  128595. */
  128596. attach(): boolean;
  128597. /**
  128598. * detach this feature.
  128599. * Will usually be called by the features manager
  128600. *
  128601. * @returns true if successful.
  128602. */
  128603. detach(): boolean;
  128604. /**
  128605. * Will get the mesh under a specific pointer.
  128606. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128607. * @param controllerId the controllerId to check
  128608. * @returns The mesh under pointer or null if no mesh is under the pointer
  128609. */
  128610. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128611. /**
  128612. * Get the xr controller that correlates to the pointer id in the pointer event
  128613. *
  128614. * @param id the pointer id to search for
  128615. * @returns the controller that correlates to this id or null if not found
  128616. */
  128617. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128618. protected _onXRFrame(_xrFrame: XRFrame): void;
  128619. private _attachGazeMode;
  128620. private _attachScreenRayMode;
  128621. private _attachTrackedPointerRayMode;
  128622. private _convertNormalToDirectionOfRay;
  128623. private _detachController;
  128624. private _generateNewMeshPair;
  128625. private _pickingMoved;
  128626. private _updatePointerDistance;
  128627. /** @hidden */
  128628. get lasterPointerDefaultColor(): Color3;
  128629. }
  128630. }
  128631. declare module BABYLON {
  128632. /**
  128633. * Button which can be used to enter a different mode of XR
  128634. */
  128635. export class WebXREnterExitUIButton {
  128636. /** button element */
  128637. element: HTMLElement;
  128638. /** XR initialization options for the button */
  128639. sessionMode: XRSessionMode;
  128640. /** Reference space type */
  128641. referenceSpaceType: XRReferenceSpaceType;
  128642. /**
  128643. * Creates a WebXREnterExitUIButton
  128644. * @param element button element
  128645. * @param sessionMode XR initialization session mode
  128646. * @param referenceSpaceType the type of reference space to be used
  128647. */
  128648. constructor(
  128649. /** button element */
  128650. element: HTMLElement,
  128651. /** XR initialization options for the button */
  128652. sessionMode: XRSessionMode,
  128653. /** Reference space type */
  128654. referenceSpaceType: XRReferenceSpaceType);
  128655. /**
  128656. * Extendable function which can be used to update the button's visuals when the state changes
  128657. * @param activeButton the current active button in the UI
  128658. */
  128659. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128660. }
  128661. /**
  128662. * Options to create the webXR UI
  128663. */
  128664. export class WebXREnterExitUIOptions {
  128665. /**
  128666. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128667. */
  128668. customButtons?: Array<WebXREnterExitUIButton>;
  128669. /**
  128670. * A reference space type to use when creating the default button.
  128671. * Default is local-floor
  128672. */
  128673. referenceSpaceType?: XRReferenceSpaceType;
  128674. /**
  128675. * Context to enter xr with
  128676. */
  128677. renderTarget?: Nullable<WebXRRenderTarget>;
  128678. /**
  128679. * A session mode to use when creating the default button.
  128680. * Default is immersive-vr
  128681. */
  128682. sessionMode?: XRSessionMode;
  128683. /**
  128684. * A list of optional features to init the session with
  128685. */
  128686. optionalFeatures?: string[];
  128687. /**
  128688. * A list of optional features to init the session with
  128689. */
  128690. requiredFeatures?: string[];
  128691. }
  128692. /**
  128693. * UI to allow the user to enter/exit XR mode
  128694. */
  128695. export class WebXREnterExitUI implements IDisposable {
  128696. private scene;
  128697. /** version of the options passed to this UI */
  128698. options: WebXREnterExitUIOptions;
  128699. private _activeButton;
  128700. private _buttons;
  128701. /**
  128702. * The HTML Div Element to which buttons are added.
  128703. */
  128704. readonly overlay: HTMLDivElement;
  128705. /**
  128706. * Fired every time the active button is changed.
  128707. *
  128708. * When xr is entered via a button that launches xr that button will be the callback parameter
  128709. *
  128710. * When exiting xr the callback parameter will be null)
  128711. */
  128712. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128713. /**
  128714. *
  128715. * @param scene babylon scene object to use
  128716. * @param options (read-only) version of the options passed to this UI
  128717. */
  128718. private constructor();
  128719. /**
  128720. * Creates UI to allow the user to enter/exit XR mode
  128721. * @param scene the scene to add the ui to
  128722. * @param helper the xr experience helper to enter/exit xr with
  128723. * @param options options to configure the UI
  128724. * @returns the created ui
  128725. */
  128726. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128727. /**
  128728. * Disposes of the XR UI component
  128729. */
  128730. dispose(): void;
  128731. private _updateButtons;
  128732. }
  128733. }
  128734. declare module BABYLON {
  128735. /**
  128736. * Class containing static functions to help procedurally build meshes
  128737. */
  128738. export class LinesBuilder {
  128739. /**
  128740. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128741. * * 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
  128742. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128743. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128744. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128745. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128746. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128747. * * 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
  128748. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128749. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128750. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128751. * @param name defines the name of the new line system
  128752. * @param options defines the options used to create the line system
  128753. * @param scene defines the hosting scene
  128754. * @returns a new line system mesh
  128755. */
  128756. static CreateLineSystem(name: string, options: {
  128757. lines: Vector3[][];
  128758. updatable?: boolean;
  128759. instance?: Nullable<LinesMesh>;
  128760. colors?: Nullable<Color4[][]>;
  128761. useVertexAlpha?: boolean;
  128762. }, scene: Nullable<Scene>): LinesMesh;
  128763. /**
  128764. * Creates a line mesh
  128765. * 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
  128766. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128767. * * The parameter `points` is an array successive Vector3
  128768. * * 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
  128769. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128770. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128771. * * When updating an instance, remember that only point positions can change, not the number of points
  128772. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128773. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128774. * @param name defines the name of the new line system
  128775. * @param options defines the options used to create the line system
  128776. * @param scene defines the hosting scene
  128777. * @returns a new line mesh
  128778. */
  128779. static CreateLines(name: string, options: {
  128780. points: Vector3[];
  128781. updatable?: boolean;
  128782. instance?: Nullable<LinesMesh>;
  128783. colors?: Color4[];
  128784. useVertexAlpha?: boolean;
  128785. }, scene?: Nullable<Scene>): LinesMesh;
  128786. /**
  128787. * Creates a dashed line mesh
  128788. * * 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
  128789. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128790. * * The parameter `points` is an array successive Vector3
  128791. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128792. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128793. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128794. * * 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
  128795. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128796. * * When updating an instance, remember that only point positions can change, not the number of points
  128797. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128798. * @param name defines the name of the mesh
  128799. * @param options defines the options used to create the mesh
  128800. * @param scene defines the hosting scene
  128801. * @returns the dashed line mesh
  128802. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128803. */
  128804. static CreateDashedLines(name: string, options: {
  128805. points: Vector3[];
  128806. dashSize?: number;
  128807. gapSize?: number;
  128808. dashNb?: number;
  128809. updatable?: boolean;
  128810. instance?: LinesMesh;
  128811. useVertexAlpha?: boolean;
  128812. }, scene?: Nullable<Scene>): LinesMesh;
  128813. }
  128814. }
  128815. declare module BABYLON {
  128816. /**
  128817. * Construction options for a timer
  128818. */
  128819. export interface ITimerOptions<T> {
  128820. /**
  128821. * Time-to-end
  128822. */
  128823. timeout: number;
  128824. /**
  128825. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128826. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128827. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128828. */
  128829. contextObservable: Observable<T>;
  128830. /**
  128831. * Optional parameters when adding an observer to the observable
  128832. */
  128833. observableParameters?: {
  128834. mask?: number;
  128835. insertFirst?: boolean;
  128836. scope?: any;
  128837. };
  128838. /**
  128839. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128840. */
  128841. breakCondition?: (data?: ITimerData<T>) => boolean;
  128842. /**
  128843. * Will be triggered when the time condition has met
  128844. */
  128845. onEnded?: (data: ITimerData<any>) => void;
  128846. /**
  128847. * Will be triggered when the break condition has met (prematurely ended)
  128848. */
  128849. onAborted?: (data: ITimerData<any>) => void;
  128850. /**
  128851. * Optional function to execute on each tick (or count)
  128852. */
  128853. onTick?: (data: ITimerData<any>) => void;
  128854. }
  128855. /**
  128856. * An interface defining the data sent by the timer
  128857. */
  128858. export interface ITimerData<T> {
  128859. /**
  128860. * When did it start
  128861. */
  128862. startTime: number;
  128863. /**
  128864. * Time now
  128865. */
  128866. currentTime: number;
  128867. /**
  128868. * Time passed since started
  128869. */
  128870. deltaTime: number;
  128871. /**
  128872. * How much is completed, in [0.0...1.0].
  128873. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128874. */
  128875. completeRate: number;
  128876. /**
  128877. * What the registered observable sent in the last count
  128878. */
  128879. payload: T;
  128880. }
  128881. /**
  128882. * The current state of the timer
  128883. */
  128884. export enum TimerState {
  128885. /**
  128886. * Timer initialized, not yet started
  128887. */
  128888. INIT = 0,
  128889. /**
  128890. * Timer started and counting
  128891. */
  128892. STARTED = 1,
  128893. /**
  128894. * Timer ended (whether aborted or time reached)
  128895. */
  128896. ENDED = 2
  128897. }
  128898. /**
  128899. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128900. *
  128901. * @param options options with which to initialize this timer
  128902. */
  128903. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128904. /**
  128905. * An advanced implementation of a timer class
  128906. */
  128907. export class AdvancedTimer<T = any> implements IDisposable {
  128908. /**
  128909. * Will notify each time the timer calculates the remaining time
  128910. */
  128911. onEachCountObservable: Observable<ITimerData<T>>;
  128912. /**
  128913. * Will trigger when the timer was aborted due to the break condition
  128914. */
  128915. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128916. /**
  128917. * Will trigger when the timer ended successfully
  128918. */
  128919. onTimerEndedObservable: Observable<ITimerData<T>>;
  128920. /**
  128921. * Will trigger when the timer state has changed
  128922. */
  128923. onStateChangedObservable: Observable<TimerState>;
  128924. private _observer;
  128925. private _contextObservable;
  128926. private _observableParameters;
  128927. private _startTime;
  128928. private _timer;
  128929. private _state;
  128930. private _breakCondition;
  128931. private _timeToEnd;
  128932. private _breakOnNextTick;
  128933. /**
  128934. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128935. * @param options construction options for this advanced timer
  128936. */
  128937. constructor(options: ITimerOptions<T>);
  128938. /**
  128939. * set a breaking condition for this timer. Default is to never break during count
  128940. * @param predicate the new break condition. Returns true to break, false otherwise
  128941. */
  128942. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128943. /**
  128944. * Reset ALL associated observables in this advanced timer
  128945. */
  128946. clearObservables(): void;
  128947. /**
  128948. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128949. *
  128950. * @param timeToEnd how much time to measure until timer ended
  128951. */
  128952. start(timeToEnd?: number): void;
  128953. /**
  128954. * Will force a stop on the next tick.
  128955. */
  128956. stop(): void;
  128957. /**
  128958. * Dispose this timer, clearing all resources
  128959. */
  128960. dispose(): void;
  128961. private _setState;
  128962. private _tick;
  128963. private _stop;
  128964. }
  128965. }
  128966. declare module BABYLON {
  128967. /**
  128968. * The options container for the teleportation module
  128969. */
  128970. export interface IWebXRTeleportationOptions {
  128971. /**
  128972. * if provided, this scene will be used to render meshes.
  128973. */
  128974. customUtilityLayerScene?: Scene;
  128975. /**
  128976. * Values to configure the default target mesh
  128977. */
  128978. defaultTargetMeshOptions?: {
  128979. /**
  128980. * Fill color of the teleportation area
  128981. */
  128982. teleportationFillColor?: string;
  128983. /**
  128984. * Border color for the teleportation area
  128985. */
  128986. teleportationBorderColor?: string;
  128987. /**
  128988. * Disable the mesh's animation sequence
  128989. */
  128990. disableAnimation?: boolean;
  128991. /**
  128992. * Disable lighting on the material or the ring and arrow
  128993. */
  128994. disableLighting?: boolean;
  128995. /**
  128996. * Override the default material of the torus and arrow
  128997. */
  128998. torusArrowMaterial?: Material;
  128999. };
  129000. /**
  129001. * A list of meshes to use as floor meshes.
  129002. * Meshes can be added and removed after initializing the feature using the
  129003. * addFloorMesh and removeFloorMesh functions
  129004. * If empty, rotation will still work
  129005. */
  129006. floorMeshes?: AbstractMesh[];
  129007. /**
  129008. * use this rendering group id for the meshes (optional)
  129009. */
  129010. renderingGroupId?: number;
  129011. /**
  129012. * Should teleportation move only to snap points
  129013. */
  129014. snapPointsOnly?: boolean;
  129015. /**
  129016. * An array of points to which the teleportation will snap to.
  129017. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129018. */
  129019. snapPositions?: Vector3[];
  129020. /**
  129021. * How close should the teleportation ray be in order to snap to position.
  129022. * Default to 0.8 units (meters)
  129023. */
  129024. snapToPositionRadius?: number;
  129025. /**
  129026. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129027. * If you want to support rotation, make sure your mesh has a direction indicator.
  129028. *
  129029. * When left untouched, the default mesh will be initialized.
  129030. */
  129031. teleportationTargetMesh?: AbstractMesh;
  129032. /**
  129033. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129034. */
  129035. timeToTeleport?: number;
  129036. /**
  129037. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129038. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129039. */
  129040. useMainComponentOnly?: boolean;
  129041. /**
  129042. * Should meshes created here be added to a utility layer or the main scene
  129043. */
  129044. useUtilityLayer?: boolean;
  129045. /**
  129046. * Babylon XR Input class for controller
  129047. */
  129048. xrInput: WebXRInput;
  129049. }
  129050. /**
  129051. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129052. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129053. * the input of the attached controllers.
  129054. */
  129055. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129056. private _options;
  129057. private _controllers;
  129058. private _currentTeleportationControllerId;
  129059. private _floorMeshes;
  129060. private _quadraticBezierCurve;
  129061. private _selectionFeature;
  129062. private _snapToPositions;
  129063. private _snappedToPoint;
  129064. private _teleportationRingMaterial?;
  129065. private _tmpRay;
  129066. private _tmpVector;
  129067. /**
  129068. * The module's name
  129069. */
  129070. static readonly Name: string;
  129071. /**
  129072. * The (Babylon) version of this module.
  129073. * This is an integer representing the implementation version.
  129074. * This number does not correspond to the webxr specs version
  129075. */
  129076. static readonly Version: number;
  129077. /**
  129078. * Is movement backwards enabled
  129079. */
  129080. backwardsMovementEnabled: boolean;
  129081. /**
  129082. * Distance to travel when moving backwards
  129083. */
  129084. backwardsTeleportationDistance: number;
  129085. /**
  129086. * The distance from the user to the inspection point in the direction of the controller
  129087. * A higher number will allow the user to move further
  129088. * defaults to 5 (meters, in xr units)
  129089. */
  129090. parabolicCheckRadius: number;
  129091. /**
  129092. * Should the module support parabolic ray on top of direct ray
  129093. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129094. * Very helpful when moving between floors / different heights
  129095. */
  129096. parabolicRayEnabled: boolean;
  129097. /**
  129098. * How much rotation should be applied when rotating right and left
  129099. */
  129100. rotationAngle: number;
  129101. /**
  129102. * Is rotation enabled when moving forward?
  129103. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129104. */
  129105. rotationEnabled: boolean;
  129106. /**
  129107. * constructs a new anchor system
  129108. * @param _xrSessionManager an instance of WebXRSessionManager
  129109. * @param _options configuration object for this feature
  129110. */
  129111. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129112. /**
  129113. * Get the snapPointsOnly flag
  129114. */
  129115. get snapPointsOnly(): boolean;
  129116. /**
  129117. * Sets the snapPointsOnly flag
  129118. * @param snapToPoints should teleportation be exclusively to snap points
  129119. */
  129120. set snapPointsOnly(snapToPoints: boolean);
  129121. /**
  129122. * Add a new mesh to the floor meshes array
  129123. * @param mesh the mesh to use as floor mesh
  129124. */
  129125. addFloorMesh(mesh: AbstractMesh): void;
  129126. /**
  129127. * Add a new snap-to point to fix teleportation to this position
  129128. * @param newSnapPoint The new Snap-To point
  129129. */
  129130. addSnapPoint(newSnapPoint: Vector3): void;
  129131. attach(): boolean;
  129132. detach(): boolean;
  129133. dispose(): void;
  129134. /**
  129135. * Remove a mesh from the floor meshes array
  129136. * @param mesh the mesh to remove
  129137. */
  129138. removeFloorMesh(mesh: AbstractMesh): void;
  129139. /**
  129140. * Remove a mesh from the floor meshes array using its name
  129141. * @param name the mesh name to remove
  129142. */
  129143. removeFloorMeshByName(name: string): void;
  129144. /**
  129145. * 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
  129146. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129147. * @returns was the point found and removed or not
  129148. */
  129149. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129150. /**
  129151. * This function sets a selection feature that will be disabled when
  129152. * the forward ray is shown and will be reattached when hidden.
  129153. * This is used to remove the selection rays when moving.
  129154. * @param selectionFeature the feature to disable when forward movement is enabled
  129155. */
  129156. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129157. protected _onXRFrame(_xrFrame: XRFrame): void;
  129158. private _attachController;
  129159. private _createDefaultTargetMesh;
  129160. private _detachController;
  129161. private _findClosestSnapPointWithRadius;
  129162. private _setTargetMeshPosition;
  129163. private _setTargetMeshVisibility;
  129164. private _showParabolicPath;
  129165. private _teleportForward;
  129166. }
  129167. }
  129168. declare module BABYLON {
  129169. /**
  129170. * Options for the default xr helper
  129171. */
  129172. export class WebXRDefaultExperienceOptions {
  129173. /**
  129174. * Enable or disable default UI to enter XR
  129175. */
  129176. disableDefaultUI?: boolean;
  129177. /**
  129178. * Should teleportation not initialize. defaults to false.
  129179. */
  129180. disableTeleportation?: boolean;
  129181. /**
  129182. * Floor meshes that will be used for teleport
  129183. */
  129184. floorMeshes?: Array<AbstractMesh>;
  129185. /**
  129186. * If set to true, the first frame will not be used to reset position
  129187. * The first frame is mainly used when copying transformation from the old camera
  129188. * Mainly used in AR
  129189. */
  129190. ignoreNativeCameraTransformation?: boolean;
  129191. /**
  129192. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129193. */
  129194. inputOptions?: IWebXRInputOptions;
  129195. /**
  129196. * optional configuration for the output canvas
  129197. */
  129198. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129199. /**
  129200. * optional UI options. This can be used among other to change session mode and reference space type
  129201. */
  129202. uiOptions?: WebXREnterExitUIOptions;
  129203. /**
  129204. * When loading teleportation and pointer select, use stable versions instead of latest.
  129205. */
  129206. useStablePlugins?: boolean;
  129207. /**
  129208. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129209. */
  129210. renderingGroupId?: number;
  129211. /**
  129212. * A list of optional features to init the session with
  129213. * If set to true, all features we support will be added
  129214. */
  129215. optionalFeatures?: boolean | string[];
  129216. }
  129217. /**
  129218. * Default experience which provides a similar setup to the previous webVRExperience
  129219. */
  129220. export class WebXRDefaultExperience {
  129221. /**
  129222. * Base experience
  129223. */
  129224. baseExperience: WebXRExperienceHelper;
  129225. /**
  129226. * Enables ui for entering/exiting xr
  129227. */
  129228. enterExitUI: WebXREnterExitUI;
  129229. /**
  129230. * Input experience extension
  129231. */
  129232. input: WebXRInput;
  129233. /**
  129234. * Enables laser pointer and selection
  129235. */
  129236. pointerSelection: WebXRControllerPointerSelection;
  129237. /**
  129238. * Default target xr should render to
  129239. */
  129240. renderTarget: WebXRRenderTarget;
  129241. /**
  129242. * Enables teleportation
  129243. */
  129244. teleportation: WebXRMotionControllerTeleportation;
  129245. private constructor();
  129246. /**
  129247. * Creates the default xr experience
  129248. * @param scene scene
  129249. * @param options options for basic configuration
  129250. * @returns resulting WebXRDefaultExperience
  129251. */
  129252. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129253. /**
  129254. * DIsposes of the experience helper
  129255. */
  129256. dispose(): void;
  129257. }
  129258. }
  129259. declare module BABYLON {
  129260. /**
  129261. * Options to modify the vr teleportation behavior.
  129262. */
  129263. export interface VRTeleportationOptions {
  129264. /**
  129265. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129266. */
  129267. floorMeshName?: string;
  129268. /**
  129269. * A list of meshes to be used as the teleportation floor. (default: empty)
  129270. */
  129271. floorMeshes?: Mesh[];
  129272. /**
  129273. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129274. */
  129275. teleportationMode?: number;
  129276. /**
  129277. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129278. */
  129279. teleportationTime?: number;
  129280. /**
  129281. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129282. */
  129283. teleportationSpeed?: number;
  129284. /**
  129285. * The easing function used in the animation or null for Linear. (default CircleEase)
  129286. */
  129287. easingFunction?: EasingFunction;
  129288. }
  129289. /**
  129290. * Options to modify the vr experience helper's behavior.
  129291. */
  129292. export interface VRExperienceHelperOptions extends WebVROptions {
  129293. /**
  129294. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129295. */
  129296. createDeviceOrientationCamera?: boolean;
  129297. /**
  129298. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129299. */
  129300. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129301. /**
  129302. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129303. */
  129304. laserToggle?: boolean;
  129305. /**
  129306. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129307. */
  129308. floorMeshes?: Mesh[];
  129309. /**
  129310. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129311. */
  129312. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129313. /**
  129314. * Defines if WebXR should be used instead of WebVR (if available)
  129315. */
  129316. useXR?: boolean;
  129317. }
  129318. /**
  129319. * Event containing information after VR has been entered
  129320. */
  129321. export class OnAfterEnteringVRObservableEvent {
  129322. /**
  129323. * If entering vr was successful
  129324. */
  129325. success: boolean;
  129326. }
  129327. /**
  129328. * Helps to quickly add VR support to an existing scene.
  129329. * See https://doc.babylonjs.com/how_to/webvr_helper
  129330. */
  129331. export class VRExperienceHelper {
  129332. /** Options to modify the vr experience helper's behavior. */
  129333. webVROptions: VRExperienceHelperOptions;
  129334. private _scene;
  129335. private _position;
  129336. private _btnVR;
  129337. private _btnVRDisplayed;
  129338. private _webVRsupported;
  129339. private _webVRready;
  129340. private _webVRrequesting;
  129341. private _webVRpresenting;
  129342. private _hasEnteredVR;
  129343. private _fullscreenVRpresenting;
  129344. private _inputElement;
  129345. private _webVRCamera;
  129346. private _vrDeviceOrientationCamera;
  129347. private _deviceOrientationCamera;
  129348. private _existingCamera;
  129349. private _onKeyDown;
  129350. private _onVrDisplayPresentChange;
  129351. private _onVRDisplayChanged;
  129352. private _onVRRequestPresentStart;
  129353. private _onVRRequestPresentComplete;
  129354. /**
  129355. * 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)
  129356. */
  129357. enableGazeEvenWhenNoPointerLock: boolean;
  129358. /**
  129359. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129360. */
  129361. exitVROnDoubleTap: boolean;
  129362. /**
  129363. * Observable raised right before entering VR.
  129364. */
  129365. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129366. /**
  129367. * Observable raised when entering VR has completed.
  129368. */
  129369. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129370. /**
  129371. * Observable raised when exiting VR.
  129372. */
  129373. onExitingVRObservable: Observable<VRExperienceHelper>;
  129374. /**
  129375. * Observable raised when controller mesh is loaded.
  129376. */
  129377. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129378. /** Return this.onEnteringVRObservable
  129379. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129380. */
  129381. get onEnteringVR(): Observable<VRExperienceHelper>;
  129382. /** Return this.onExitingVRObservable
  129383. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129384. */
  129385. get onExitingVR(): Observable<VRExperienceHelper>;
  129386. /** Return this.onControllerMeshLoadedObservable
  129387. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129388. */
  129389. get onControllerMeshLoaded(): Observable<WebVRController>;
  129390. private _rayLength;
  129391. private _useCustomVRButton;
  129392. private _teleportationRequested;
  129393. private _teleportActive;
  129394. private _floorMeshName;
  129395. private _floorMeshesCollection;
  129396. private _teleportationMode;
  129397. private _teleportationTime;
  129398. private _teleportationSpeed;
  129399. private _teleportationEasing;
  129400. private _rotationAllowed;
  129401. private _teleportBackwardsVector;
  129402. private _teleportationTarget;
  129403. private _isDefaultTeleportationTarget;
  129404. private _postProcessMove;
  129405. private _teleportationFillColor;
  129406. private _teleportationBorderColor;
  129407. private _rotationAngle;
  129408. private _haloCenter;
  129409. private _cameraGazer;
  129410. private _padSensibilityUp;
  129411. private _padSensibilityDown;
  129412. private _leftController;
  129413. private _rightController;
  129414. private _gazeColor;
  129415. private _laserColor;
  129416. private _pickedLaserColor;
  129417. private _pickedGazeColor;
  129418. /**
  129419. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129420. */
  129421. onNewMeshSelected: Observable<AbstractMesh>;
  129422. /**
  129423. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129424. * This observable will provide the mesh and the controller used to select the mesh
  129425. */
  129426. onMeshSelectedWithController: Observable<{
  129427. mesh: AbstractMesh;
  129428. controller: WebVRController;
  129429. }>;
  129430. /**
  129431. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129432. */
  129433. onNewMeshPicked: Observable<PickingInfo>;
  129434. private _circleEase;
  129435. /**
  129436. * Observable raised before camera teleportation
  129437. */
  129438. onBeforeCameraTeleport: Observable<Vector3>;
  129439. /**
  129440. * Observable raised after camera teleportation
  129441. */
  129442. onAfterCameraTeleport: Observable<Vector3>;
  129443. /**
  129444. * Observable raised when current selected mesh gets unselected
  129445. */
  129446. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129447. private _raySelectionPredicate;
  129448. /**
  129449. * To be optionaly changed by user to define custom ray selection
  129450. */
  129451. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129452. /**
  129453. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129454. */
  129455. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129456. /**
  129457. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129458. */
  129459. teleportationEnabled: boolean;
  129460. private _defaultHeight;
  129461. private _teleportationInitialized;
  129462. private _interactionsEnabled;
  129463. private _interactionsRequested;
  129464. private _displayGaze;
  129465. private _displayLaserPointer;
  129466. /**
  129467. * The mesh used to display where the user is going to teleport.
  129468. */
  129469. get teleportationTarget(): Mesh;
  129470. /**
  129471. * Sets the mesh to be used to display where the user is going to teleport.
  129472. */
  129473. set teleportationTarget(value: Mesh);
  129474. /**
  129475. * 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
  129476. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129477. * See https://doc.babylonjs.com/resources/baking_transformations
  129478. */
  129479. get gazeTrackerMesh(): Mesh;
  129480. set gazeTrackerMesh(value: Mesh);
  129481. /**
  129482. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129483. */
  129484. updateGazeTrackerScale: boolean;
  129485. /**
  129486. * If the gaze trackers color should be updated when selecting meshes
  129487. */
  129488. updateGazeTrackerColor: boolean;
  129489. /**
  129490. * If the controller laser color should be updated when selecting meshes
  129491. */
  129492. updateControllerLaserColor: boolean;
  129493. /**
  129494. * The gaze tracking mesh corresponding to the left controller
  129495. */
  129496. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129497. /**
  129498. * The gaze tracking mesh corresponding to the right controller
  129499. */
  129500. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129501. /**
  129502. * If the ray of the gaze should be displayed.
  129503. */
  129504. get displayGaze(): boolean;
  129505. /**
  129506. * Sets if the ray of the gaze should be displayed.
  129507. */
  129508. set displayGaze(value: boolean);
  129509. /**
  129510. * If the ray of the LaserPointer should be displayed.
  129511. */
  129512. get displayLaserPointer(): boolean;
  129513. /**
  129514. * Sets if the ray of the LaserPointer should be displayed.
  129515. */
  129516. set displayLaserPointer(value: boolean);
  129517. /**
  129518. * The deviceOrientationCamera used as the camera when not in VR.
  129519. */
  129520. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129521. /**
  129522. * Based on the current WebVR support, returns the current VR camera used.
  129523. */
  129524. get currentVRCamera(): Nullable<Camera>;
  129525. /**
  129526. * The webVRCamera which is used when in VR.
  129527. */
  129528. get webVRCamera(): WebVRFreeCamera;
  129529. /**
  129530. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129531. */
  129532. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129533. /**
  129534. * The html button that is used to trigger entering into VR.
  129535. */
  129536. get vrButton(): Nullable<HTMLButtonElement>;
  129537. private get _teleportationRequestInitiated();
  129538. /**
  129539. * Defines whether or not Pointer lock should be requested when switching to
  129540. * full screen.
  129541. */
  129542. requestPointerLockOnFullScreen: boolean;
  129543. /**
  129544. * If asking to force XR, this will be populated with the default xr experience
  129545. */
  129546. xr: WebXRDefaultExperience;
  129547. /**
  129548. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129549. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129550. */
  129551. xrTestDone: boolean;
  129552. /**
  129553. * Instantiates a VRExperienceHelper.
  129554. * Helps to quickly add VR support to an existing scene.
  129555. * @param scene The scene the VRExperienceHelper belongs to.
  129556. * @param webVROptions Options to modify the vr experience helper's behavior.
  129557. */
  129558. constructor(scene: Scene,
  129559. /** Options to modify the vr experience helper's behavior. */
  129560. webVROptions?: VRExperienceHelperOptions);
  129561. private completeVRInit;
  129562. private _onDefaultMeshLoaded;
  129563. private _onResize;
  129564. private _onFullscreenChange;
  129565. /**
  129566. * Gets a value indicating if we are currently in VR mode.
  129567. */
  129568. get isInVRMode(): boolean;
  129569. private onVrDisplayPresentChange;
  129570. private onVRDisplayChanged;
  129571. private moveButtonToBottomRight;
  129572. private displayVRButton;
  129573. private updateButtonVisibility;
  129574. private _cachedAngularSensibility;
  129575. /**
  129576. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129577. * Otherwise, will use the fullscreen API.
  129578. */
  129579. enterVR(): void;
  129580. /**
  129581. * Attempt to exit VR, or fullscreen.
  129582. */
  129583. exitVR(): void;
  129584. /**
  129585. * The position of the vr experience helper.
  129586. */
  129587. get position(): Vector3;
  129588. /**
  129589. * Sets the position of the vr experience helper.
  129590. */
  129591. set position(value: Vector3);
  129592. /**
  129593. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129594. */
  129595. enableInteractions(): void;
  129596. private get _noControllerIsActive();
  129597. private beforeRender;
  129598. private _isTeleportationFloor;
  129599. /**
  129600. * Adds a floor mesh to be used for teleportation.
  129601. * @param floorMesh the mesh to be used for teleportation.
  129602. */
  129603. addFloorMesh(floorMesh: Mesh): void;
  129604. /**
  129605. * Removes a floor mesh from being used for teleportation.
  129606. * @param floorMesh the mesh to be removed.
  129607. */
  129608. removeFloorMesh(floorMesh: Mesh): void;
  129609. /**
  129610. * Enables interactions and teleportation using the VR controllers and gaze.
  129611. * @param vrTeleportationOptions options to modify teleportation behavior.
  129612. */
  129613. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129614. private _onNewGamepadConnected;
  129615. private _tryEnableInteractionOnController;
  129616. private _onNewGamepadDisconnected;
  129617. private _enableInteractionOnController;
  129618. private _checkTeleportWithRay;
  129619. private _checkRotate;
  129620. private _checkTeleportBackwards;
  129621. private _enableTeleportationOnController;
  129622. private _createTeleportationCircles;
  129623. private _displayTeleportationTarget;
  129624. private _hideTeleportationTarget;
  129625. private _rotateCamera;
  129626. private _moveTeleportationSelectorTo;
  129627. private _workingVector;
  129628. private _workingQuaternion;
  129629. private _workingMatrix;
  129630. /**
  129631. * Time Constant Teleportation Mode
  129632. */
  129633. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129634. /**
  129635. * Speed Constant Teleportation Mode
  129636. */
  129637. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129638. /**
  129639. * Teleports the users feet to the desired location
  129640. * @param location The location where the user's feet should be placed
  129641. */
  129642. teleportCamera(location: Vector3): void;
  129643. private _convertNormalToDirectionOfRay;
  129644. private _castRayAndSelectObject;
  129645. private _notifySelectedMeshUnselected;
  129646. /**
  129647. * Permanently set new colors for the laser pointer
  129648. * @param color the new laser color
  129649. * @param pickedColor the new laser color when picked mesh detected
  129650. */
  129651. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129652. /**
  129653. * Set lighting enabled / disabled on the laser pointer of both controllers
  129654. * @param enabled should the lighting be enabled on the laser pointer
  129655. */
  129656. setLaserLightingState(enabled?: boolean): void;
  129657. /**
  129658. * Permanently set new colors for the gaze pointer
  129659. * @param color the new gaze color
  129660. * @param pickedColor the new gaze color when picked mesh detected
  129661. */
  129662. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129663. /**
  129664. * Sets the color of the laser ray from the vr controllers.
  129665. * @param color new color for the ray.
  129666. */
  129667. changeLaserColor(color: Color3): void;
  129668. /**
  129669. * Sets the color of the ray from the vr headsets gaze.
  129670. * @param color new color for the ray.
  129671. */
  129672. changeGazeColor(color: Color3): void;
  129673. /**
  129674. * Exits VR and disposes of the vr experience helper
  129675. */
  129676. dispose(): void;
  129677. /**
  129678. * Gets the name of the VRExperienceHelper class
  129679. * @returns "VRExperienceHelper"
  129680. */
  129681. getClassName(): string;
  129682. }
  129683. }
  129684. declare module BABYLON {
  129685. /**
  129686. * Contains an array of blocks representing the octree
  129687. */
  129688. export interface IOctreeContainer<T> {
  129689. /**
  129690. * Blocks within the octree
  129691. */
  129692. blocks: Array<OctreeBlock<T>>;
  129693. }
  129694. /**
  129695. * Class used to store a cell in an octree
  129696. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129697. */
  129698. export class OctreeBlock<T> {
  129699. /**
  129700. * Gets the content of the current block
  129701. */
  129702. entries: T[];
  129703. /**
  129704. * Gets the list of block children
  129705. */
  129706. blocks: Array<OctreeBlock<T>>;
  129707. private _depth;
  129708. private _maxDepth;
  129709. private _capacity;
  129710. private _minPoint;
  129711. private _maxPoint;
  129712. private _boundingVectors;
  129713. private _creationFunc;
  129714. /**
  129715. * Creates a new block
  129716. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129717. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129718. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129719. * @param depth defines the current depth of this block in the octree
  129720. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129721. * @param creationFunc defines a callback to call when an element is added to the block
  129722. */
  129723. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129724. /**
  129725. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129726. */
  129727. get capacity(): number;
  129728. /**
  129729. * Gets the minimum vector (in world space) of the block's bounding box
  129730. */
  129731. get minPoint(): Vector3;
  129732. /**
  129733. * Gets the maximum vector (in world space) of the block's bounding box
  129734. */
  129735. get maxPoint(): Vector3;
  129736. /**
  129737. * Add a new element to this block
  129738. * @param entry defines the element to add
  129739. */
  129740. addEntry(entry: T): void;
  129741. /**
  129742. * Remove an element from this block
  129743. * @param entry defines the element to remove
  129744. */
  129745. removeEntry(entry: T): void;
  129746. /**
  129747. * Add an array of elements to this block
  129748. * @param entries defines the array of elements to add
  129749. */
  129750. addEntries(entries: T[]): void;
  129751. /**
  129752. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129753. * @param frustumPlanes defines the frustum planes to test
  129754. * @param selection defines the array to store current content if selection is positive
  129755. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129756. */
  129757. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129758. /**
  129759. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129760. * @param sphereCenter defines the bounding sphere center
  129761. * @param sphereRadius defines the bounding sphere radius
  129762. * @param selection defines the array to store current content if selection is positive
  129763. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129764. */
  129765. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129766. /**
  129767. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129768. * @param ray defines the ray to test with
  129769. * @param selection defines the array to store current content if selection is positive
  129770. */
  129771. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129772. /**
  129773. * Subdivide the content into child blocks (this block will then be empty)
  129774. */
  129775. createInnerBlocks(): void;
  129776. /**
  129777. * @hidden
  129778. */
  129779. 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;
  129780. }
  129781. }
  129782. declare module BABYLON {
  129783. /**
  129784. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129785. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129786. */
  129787. export class Octree<T> {
  129788. /** 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.) */
  129789. maxDepth: number;
  129790. /**
  129791. * Blocks within the octree containing objects
  129792. */
  129793. blocks: Array<OctreeBlock<T>>;
  129794. /**
  129795. * Content stored in the octree
  129796. */
  129797. dynamicContent: T[];
  129798. private _maxBlockCapacity;
  129799. private _selectionContent;
  129800. private _creationFunc;
  129801. /**
  129802. * Creates a octree
  129803. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129804. * @param creationFunc function to be used to instatiate the octree
  129805. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129806. * @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.)
  129807. */
  129808. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129809. /** 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.) */
  129810. maxDepth?: number);
  129811. /**
  129812. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129813. * @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);
  129814. * @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);
  129815. * @param entries meshes to be added to the octree blocks
  129816. */
  129817. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129818. /**
  129819. * Adds a mesh to the octree
  129820. * @param entry Mesh to add to the octree
  129821. */
  129822. addMesh(entry: T): void;
  129823. /**
  129824. * Remove an element from the octree
  129825. * @param entry defines the element to remove
  129826. */
  129827. removeMesh(entry: T): void;
  129828. /**
  129829. * Selects an array of meshes within the frustum
  129830. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129831. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129832. * @returns array of meshes within the frustum
  129833. */
  129834. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129835. /**
  129836. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129837. * @param sphereCenter defines the bounding sphere center
  129838. * @param sphereRadius defines the bounding sphere radius
  129839. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129840. * @returns an array of objects that intersect the sphere
  129841. */
  129842. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129843. /**
  129844. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129845. * @param ray defines the ray to test with
  129846. * @returns array of intersected objects
  129847. */
  129848. intersectsRay(ray: Ray): SmartArray<T>;
  129849. /**
  129850. * Adds a mesh into the octree block if it intersects the block
  129851. */
  129852. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129853. /**
  129854. * Adds a submesh into the octree block if it intersects the block
  129855. */
  129856. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129857. }
  129858. }
  129859. declare module BABYLON {
  129860. interface Scene {
  129861. /**
  129862. * @hidden
  129863. * Backing Filed
  129864. */
  129865. _selectionOctree: Octree<AbstractMesh>;
  129866. /**
  129867. * Gets the octree used to boost mesh selection (picking)
  129868. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129869. */
  129870. selectionOctree: Octree<AbstractMesh>;
  129871. /**
  129872. * Creates or updates the octree used to boost selection (picking)
  129873. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129874. * @param maxCapacity defines the maximum capacity per leaf
  129875. * @param maxDepth defines the maximum depth of the octree
  129876. * @returns an octree of AbstractMesh
  129877. */
  129878. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129879. }
  129880. interface AbstractMesh {
  129881. /**
  129882. * @hidden
  129883. * Backing Field
  129884. */
  129885. _submeshesOctree: Octree<SubMesh>;
  129886. /**
  129887. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129888. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129889. * @param maxCapacity defines the maximum size of each block (64 by default)
  129890. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129891. * @returns the new octree
  129892. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129893. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129894. */
  129895. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129896. }
  129897. /**
  129898. * Defines the octree scene component responsible to manage any octrees
  129899. * in a given scene.
  129900. */
  129901. export class OctreeSceneComponent {
  129902. /**
  129903. * The component name help to identify the component in the list of scene components.
  129904. */
  129905. readonly name: string;
  129906. /**
  129907. * The scene the component belongs to.
  129908. */
  129909. scene: Scene;
  129910. /**
  129911. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129912. */
  129913. readonly checksIsEnabled: boolean;
  129914. /**
  129915. * Creates a new instance of the component for the given scene
  129916. * @param scene Defines the scene to register the component in
  129917. */
  129918. constructor(scene: Scene);
  129919. /**
  129920. * Registers the component in a given scene
  129921. */
  129922. register(): void;
  129923. /**
  129924. * Return the list of active meshes
  129925. * @returns the list of active meshes
  129926. */
  129927. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129928. /**
  129929. * Return the list of active sub meshes
  129930. * @param mesh The mesh to get the candidates sub meshes from
  129931. * @returns the list of active sub meshes
  129932. */
  129933. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129934. private _tempRay;
  129935. /**
  129936. * Return the list of sub meshes intersecting with a given local ray
  129937. * @param mesh defines the mesh to find the submesh for
  129938. * @param localRay defines the ray in local space
  129939. * @returns the list of intersecting sub meshes
  129940. */
  129941. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129942. /**
  129943. * Return the list of sub meshes colliding with a collider
  129944. * @param mesh defines the mesh to find the submesh for
  129945. * @param collider defines the collider to evaluate the collision against
  129946. * @returns the list of colliding sub meshes
  129947. */
  129948. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129949. /**
  129950. * Rebuilds the elements related to this component in case of
  129951. * context lost for instance.
  129952. */
  129953. rebuild(): void;
  129954. /**
  129955. * Disposes the component and the associated ressources.
  129956. */
  129957. dispose(): void;
  129958. }
  129959. }
  129960. declare module BABYLON {
  129961. /**
  129962. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129963. */
  129964. export class Gizmo implements IDisposable {
  129965. /** The utility layer the gizmo will be added to */
  129966. gizmoLayer: UtilityLayerRenderer;
  129967. /**
  129968. * The root mesh of the gizmo
  129969. */
  129970. _rootMesh: Mesh;
  129971. private _attachedMesh;
  129972. private _attachedNode;
  129973. /**
  129974. * Ratio for the scale of the gizmo (Default: 1)
  129975. */
  129976. protected _scaleRatio: number;
  129977. /**
  129978. * Ratio for the scale of the gizmo (Default: 1)
  129979. */
  129980. set scaleRatio(value: number);
  129981. get scaleRatio(): number;
  129982. /**
  129983. * If a custom mesh has been set (Default: false)
  129984. */
  129985. protected _customMeshSet: boolean;
  129986. /**
  129987. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129988. * * When set, interactions will be enabled
  129989. */
  129990. get attachedMesh(): Nullable<AbstractMesh>;
  129991. set attachedMesh(value: Nullable<AbstractMesh>);
  129992. /**
  129993. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129994. * * When set, interactions will be enabled
  129995. */
  129996. get attachedNode(): Nullable<Node>;
  129997. set attachedNode(value: Nullable<Node>);
  129998. /**
  129999. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  130000. * @param mesh The mesh to replace the default mesh of the gizmo
  130001. */
  130002. setCustomMesh(mesh: Mesh): void;
  130003. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  130004. /**
  130005. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  130006. */
  130007. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130008. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130009. /**
  130010. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  130011. */
  130012. updateGizmoPositionToMatchAttachedMesh: boolean;
  130013. /**
  130014. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  130015. */
  130016. updateScale: boolean;
  130017. protected _interactionsEnabled: boolean;
  130018. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130019. private _beforeRenderObserver;
  130020. private _tempQuaternion;
  130021. private _tempVector;
  130022. private _tempVector2;
  130023. private _tempMatrix1;
  130024. private _tempMatrix2;
  130025. private _rightHandtoLeftHandMatrix;
  130026. /**
  130027. * Creates a gizmo
  130028. * @param gizmoLayer The utility layer the gizmo will be added to
  130029. */
  130030. constructor(
  130031. /** The utility layer the gizmo will be added to */
  130032. gizmoLayer?: UtilityLayerRenderer);
  130033. /**
  130034. * Updates the gizmo to match the attached mesh's position/rotation
  130035. */
  130036. protected _update(): void;
  130037. /**
  130038. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130039. * @param value Node, TransformNode or mesh
  130040. */
  130041. protected _matrixChanged(): void;
  130042. /**
  130043. * Disposes of the gizmo
  130044. */
  130045. dispose(): void;
  130046. }
  130047. }
  130048. declare module BABYLON {
  130049. /**
  130050. * Single plane drag gizmo
  130051. */
  130052. export class PlaneDragGizmo extends Gizmo {
  130053. /**
  130054. * Drag behavior responsible for the gizmos dragging interactions
  130055. */
  130056. dragBehavior: PointerDragBehavior;
  130057. private _pointerObserver;
  130058. /**
  130059. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130060. */
  130061. snapDistance: number;
  130062. /**
  130063. * Event that fires each time the gizmo snaps to a new location.
  130064. * * snapDistance is the the change in distance
  130065. */
  130066. onSnapObservable: Observable<{
  130067. snapDistance: number;
  130068. }>;
  130069. private _plane;
  130070. private _coloredMaterial;
  130071. private _hoverMaterial;
  130072. private _isEnabled;
  130073. private _parent;
  130074. /** @hidden */
  130075. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130076. /** @hidden */
  130077. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130078. /**
  130079. * Creates a PlaneDragGizmo
  130080. * @param gizmoLayer The utility layer the gizmo will be added to
  130081. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130082. * @param color The color of the gizmo
  130083. */
  130084. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130085. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130086. /**
  130087. * If the gizmo is enabled
  130088. */
  130089. set isEnabled(value: boolean);
  130090. get isEnabled(): boolean;
  130091. /**
  130092. * Disposes of the gizmo
  130093. */
  130094. dispose(): void;
  130095. }
  130096. }
  130097. declare module BABYLON {
  130098. /**
  130099. * Gizmo that enables dragging a mesh along 3 axis
  130100. */
  130101. export class PositionGizmo extends Gizmo {
  130102. /**
  130103. * Internal gizmo used for interactions on the x axis
  130104. */
  130105. xGizmo: AxisDragGizmo;
  130106. /**
  130107. * Internal gizmo used for interactions on the y axis
  130108. */
  130109. yGizmo: AxisDragGizmo;
  130110. /**
  130111. * Internal gizmo used for interactions on the z axis
  130112. */
  130113. zGizmo: AxisDragGizmo;
  130114. /**
  130115. * Internal gizmo used for interactions on the yz plane
  130116. */
  130117. xPlaneGizmo: PlaneDragGizmo;
  130118. /**
  130119. * Internal gizmo used for interactions on the xz plane
  130120. */
  130121. yPlaneGizmo: PlaneDragGizmo;
  130122. /**
  130123. * Internal gizmo used for interactions on the xy plane
  130124. */
  130125. zPlaneGizmo: PlaneDragGizmo;
  130126. /**
  130127. * private variables
  130128. */
  130129. private _meshAttached;
  130130. private _nodeAttached;
  130131. private _snapDistance;
  130132. /** Fires an event when any of it's sub gizmos are dragged */
  130133. onDragStartObservable: Observable<unknown>;
  130134. /** Fires an event when any of it's sub gizmos are released from dragging */
  130135. onDragEndObservable: Observable<unknown>;
  130136. /**
  130137. * If set to true, planar drag is enabled
  130138. */
  130139. private _planarGizmoEnabled;
  130140. get attachedMesh(): Nullable<AbstractMesh>;
  130141. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130142. get attachedNode(): Nullable<Node>;
  130143. set attachedNode(node: Nullable<Node>);
  130144. /**
  130145. * Creates a PositionGizmo
  130146. * @param gizmoLayer The utility layer the gizmo will be added to
  130147. @param thickness display gizmo axis thickness
  130148. */
  130149. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130150. /**
  130151. * If the planar drag gizmo is enabled
  130152. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130153. */
  130154. set planarGizmoEnabled(value: boolean);
  130155. get planarGizmoEnabled(): boolean;
  130156. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130157. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130158. /**
  130159. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130160. */
  130161. set snapDistance(value: number);
  130162. get snapDistance(): number;
  130163. /**
  130164. * Ratio for the scale of the gizmo (Default: 1)
  130165. */
  130166. set scaleRatio(value: number);
  130167. get scaleRatio(): number;
  130168. /**
  130169. * Disposes of the gizmo
  130170. */
  130171. dispose(): void;
  130172. /**
  130173. * CustomMeshes are not supported by this gizmo
  130174. * @param mesh The mesh to replace the default mesh of the gizmo
  130175. */
  130176. setCustomMesh(mesh: Mesh): void;
  130177. }
  130178. }
  130179. declare module BABYLON {
  130180. /**
  130181. * Single axis drag gizmo
  130182. */
  130183. export class AxisDragGizmo extends Gizmo {
  130184. /**
  130185. * Drag behavior responsible for the gizmos dragging interactions
  130186. */
  130187. dragBehavior: PointerDragBehavior;
  130188. private _pointerObserver;
  130189. /**
  130190. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130191. */
  130192. snapDistance: number;
  130193. /**
  130194. * Event that fires each time the gizmo snaps to a new location.
  130195. * * snapDistance is the the change in distance
  130196. */
  130197. onSnapObservable: Observable<{
  130198. snapDistance: number;
  130199. }>;
  130200. private _isEnabled;
  130201. private _parent;
  130202. private _arrow;
  130203. private _coloredMaterial;
  130204. private _hoverMaterial;
  130205. /** @hidden */
  130206. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130207. /** @hidden */
  130208. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130209. /**
  130210. * Creates an AxisDragGizmo
  130211. * @param gizmoLayer The utility layer the gizmo will be added to
  130212. * @param dragAxis The axis which the gizmo will be able to drag on
  130213. * @param color The color of the gizmo
  130214. * @param thickness display gizmo axis thickness
  130215. */
  130216. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130217. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130218. /**
  130219. * If the gizmo is enabled
  130220. */
  130221. set isEnabled(value: boolean);
  130222. get isEnabled(): boolean;
  130223. /**
  130224. * Disposes of the gizmo
  130225. */
  130226. dispose(): void;
  130227. }
  130228. }
  130229. declare module BABYLON.Debug {
  130230. /**
  130231. * The Axes viewer will show 3 axes in a specific point in space
  130232. */
  130233. export class AxesViewer {
  130234. private _xAxis;
  130235. private _yAxis;
  130236. private _zAxis;
  130237. private _scaleLinesFactor;
  130238. private _instanced;
  130239. /**
  130240. * Gets the hosting scene
  130241. */
  130242. scene: Nullable<Scene>;
  130243. /**
  130244. * Gets or sets a number used to scale line length
  130245. */
  130246. scaleLines: number;
  130247. /** Gets the node hierarchy used to render x-axis */
  130248. get xAxis(): TransformNode;
  130249. /** Gets the node hierarchy used to render y-axis */
  130250. get yAxis(): TransformNode;
  130251. /** Gets the node hierarchy used to render z-axis */
  130252. get zAxis(): TransformNode;
  130253. /**
  130254. * Creates a new AxesViewer
  130255. * @param scene defines the hosting scene
  130256. * @param scaleLines defines a number used to scale line length (1 by default)
  130257. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130258. * @param xAxis defines the node hierarchy used to render the x-axis
  130259. * @param yAxis defines the node hierarchy used to render the y-axis
  130260. * @param zAxis defines the node hierarchy used to render the z-axis
  130261. */
  130262. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130263. /**
  130264. * Force the viewer to update
  130265. * @param position defines the position of the viewer
  130266. * @param xaxis defines the x axis of the viewer
  130267. * @param yaxis defines the y axis of the viewer
  130268. * @param zaxis defines the z axis of the viewer
  130269. */
  130270. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130271. /**
  130272. * Creates an instance of this axes viewer.
  130273. * @returns a new axes viewer with instanced meshes
  130274. */
  130275. createInstance(): AxesViewer;
  130276. /** Releases resources */
  130277. dispose(): void;
  130278. private static _SetRenderingGroupId;
  130279. }
  130280. }
  130281. declare module BABYLON.Debug {
  130282. /**
  130283. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130284. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130285. */
  130286. export class BoneAxesViewer extends AxesViewer {
  130287. /**
  130288. * Gets or sets the target mesh where to display the axes viewer
  130289. */
  130290. mesh: Nullable<Mesh>;
  130291. /**
  130292. * Gets or sets the target bone where to display the axes viewer
  130293. */
  130294. bone: Nullable<Bone>;
  130295. /** Gets current position */
  130296. pos: Vector3;
  130297. /** Gets direction of X axis */
  130298. xaxis: Vector3;
  130299. /** Gets direction of Y axis */
  130300. yaxis: Vector3;
  130301. /** Gets direction of Z axis */
  130302. zaxis: Vector3;
  130303. /**
  130304. * Creates a new BoneAxesViewer
  130305. * @param scene defines the hosting scene
  130306. * @param bone defines the target bone
  130307. * @param mesh defines the target mesh
  130308. * @param scaleLines defines a scaling factor for line length (1 by default)
  130309. */
  130310. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130311. /**
  130312. * Force the viewer to update
  130313. */
  130314. update(): void;
  130315. /** Releases resources */
  130316. dispose(): void;
  130317. }
  130318. }
  130319. declare module BABYLON {
  130320. /**
  130321. * Interface used to define scene explorer extensibility option
  130322. */
  130323. export interface IExplorerExtensibilityOption {
  130324. /**
  130325. * Define the option label
  130326. */
  130327. label: string;
  130328. /**
  130329. * Defines the action to execute on click
  130330. */
  130331. action: (entity: any) => void;
  130332. }
  130333. /**
  130334. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130335. */
  130336. export interface IExplorerExtensibilityGroup {
  130337. /**
  130338. * Defines a predicate to test if a given type mut be extended
  130339. */
  130340. predicate: (entity: any) => boolean;
  130341. /**
  130342. * Gets the list of options added to a type
  130343. */
  130344. entries: IExplorerExtensibilityOption[];
  130345. }
  130346. /**
  130347. * Interface used to define the options to use to create the Inspector
  130348. */
  130349. export interface IInspectorOptions {
  130350. /**
  130351. * Display in overlay mode (default: false)
  130352. */
  130353. overlay?: boolean;
  130354. /**
  130355. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130356. */
  130357. globalRoot?: HTMLElement;
  130358. /**
  130359. * Display the Scene explorer
  130360. */
  130361. showExplorer?: boolean;
  130362. /**
  130363. * Display the property inspector
  130364. */
  130365. showInspector?: boolean;
  130366. /**
  130367. * Display in embed mode (both panes on the right)
  130368. */
  130369. embedMode?: boolean;
  130370. /**
  130371. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130372. */
  130373. handleResize?: boolean;
  130374. /**
  130375. * Allow the panes to popup (default: true)
  130376. */
  130377. enablePopup?: boolean;
  130378. /**
  130379. * Allow the panes to be closed by users (default: true)
  130380. */
  130381. enableClose?: boolean;
  130382. /**
  130383. * Optional list of extensibility entries
  130384. */
  130385. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130386. /**
  130387. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130388. */
  130389. inspectorURL?: string;
  130390. /**
  130391. * Optional initial tab (default to DebugLayerTab.Properties)
  130392. */
  130393. initialTab?: DebugLayerTab;
  130394. }
  130395. interface Scene {
  130396. /**
  130397. * @hidden
  130398. * Backing field
  130399. */
  130400. _debugLayer: DebugLayer;
  130401. /**
  130402. * Gets the debug layer (aka Inspector) associated with the scene
  130403. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130404. */
  130405. debugLayer: DebugLayer;
  130406. }
  130407. /**
  130408. * Enum of inspector action tab
  130409. */
  130410. export enum DebugLayerTab {
  130411. /**
  130412. * Properties tag (default)
  130413. */
  130414. Properties = 0,
  130415. /**
  130416. * Debug tab
  130417. */
  130418. Debug = 1,
  130419. /**
  130420. * Statistics tab
  130421. */
  130422. Statistics = 2,
  130423. /**
  130424. * Tools tab
  130425. */
  130426. Tools = 3,
  130427. /**
  130428. * Settings tab
  130429. */
  130430. Settings = 4
  130431. }
  130432. /**
  130433. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130434. * what is happening in your scene
  130435. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130436. */
  130437. export class DebugLayer {
  130438. /**
  130439. * Define the url to get the inspector script from.
  130440. * By default it uses the babylonjs CDN.
  130441. * @ignoreNaming
  130442. */
  130443. static InspectorURL: string;
  130444. private _scene;
  130445. private BJSINSPECTOR;
  130446. private _onPropertyChangedObservable?;
  130447. /**
  130448. * Observable triggered when a property is changed through the inspector.
  130449. */
  130450. get onPropertyChangedObservable(): any;
  130451. /**
  130452. * Instantiates a new debug layer.
  130453. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130454. * what is happening in your scene
  130455. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130456. * @param scene Defines the scene to inspect
  130457. */
  130458. constructor(scene: Scene);
  130459. /** Creates the inspector window. */
  130460. private _createInspector;
  130461. /**
  130462. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130463. * @param entity defines the entity to select
  130464. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130465. */
  130466. select(entity: any, lineContainerTitles?: string | string[]): void;
  130467. /** Get the inspector from bundle or global */
  130468. private _getGlobalInspector;
  130469. /**
  130470. * Get if the inspector is visible or not.
  130471. * @returns true if visible otherwise, false
  130472. */
  130473. isVisible(): boolean;
  130474. /**
  130475. * Hide the inspector and close its window.
  130476. */
  130477. hide(): void;
  130478. /**
  130479. * Update the scene in the inspector
  130480. */
  130481. setAsActiveScene(): void;
  130482. /**
  130483. * Launch the debugLayer.
  130484. * @param config Define the configuration of the inspector
  130485. * @return a promise fulfilled when the debug layer is visible
  130486. */
  130487. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130488. }
  130489. }
  130490. declare module BABYLON {
  130491. /**
  130492. * Class containing static functions to help procedurally build meshes
  130493. */
  130494. export class BoxBuilder {
  130495. /**
  130496. * Creates a box mesh
  130497. * * The parameter `size` sets the size (float) of each box side (default 1)
  130498. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130499. * * 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)
  130500. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130501. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130502. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130503. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130504. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130505. * @param name defines the name of the mesh
  130506. * @param options defines the options used to create the mesh
  130507. * @param scene defines the hosting scene
  130508. * @returns the box mesh
  130509. */
  130510. static CreateBox(name: string, options: {
  130511. size?: number;
  130512. width?: number;
  130513. height?: number;
  130514. depth?: number;
  130515. faceUV?: Vector4[];
  130516. faceColors?: Color4[];
  130517. sideOrientation?: number;
  130518. frontUVs?: Vector4;
  130519. backUVs?: Vector4;
  130520. wrap?: boolean;
  130521. topBaseAt?: number;
  130522. bottomBaseAt?: number;
  130523. updatable?: boolean;
  130524. }, scene?: Nullable<Scene>): Mesh;
  130525. }
  130526. }
  130527. declare module BABYLON.Debug {
  130528. /**
  130529. * Used to show the physics impostor around the specific mesh
  130530. */
  130531. export class PhysicsViewer {
  130532. /** @hidden */
  130533. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130534. /** @hidden */
  130535. protected _meshes: Array<Nullable<AbstractMesh>>;
  130536. /** @hidden */
  130537. protected _scene: Nullable<Scene>;
  130538. /** @hidden */
  130539. protected _numMeshes: number;
  130540. /** @hidden */
  130541. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130542. private _renderFunction;
  130543. private _utilityLayer;
  130544. private _debugBoxMesh;
  130545. private _debugSphereMesh;
  130546. private _debugCylinderMesh;
  130547. private _debugMaterial;
  130548. private _debugMeshMeshes;
  130549. /**
  130550. * Creates a new PhysicsViewer
  130551. * @param scene defines the hosting scene
  130552. */
  130553. constructor(scene: Scene);
  130554. /** @hidden */
  130555. protected _updateDebugMeshes(): void;
  130556. /**
  130557. * Renders a specified physic impostor
  130558. * @param impostor defines the impostor to render
  130559. * @param targetMesh defines the mesh represented by the impostor
  130560. * @returns the new debug mesh used to render the impostor
  130561. */
  130562. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130563. /**
  130564. * Hides a specified physic impostor
  130565. * @param impostor defines the impostor to hide
  130566. */
  130567. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130568. private _getDebugMaterial;
  130569. private _getDebugBoxMesh;
  130570. private _getDebugSphereMesh;
  130571. private _getDebugCylinderMesh;
  130572. private _getDebugMeshMesh;
  130573. private _getDebugMesh;
  130574. /** Releases all resources */
  130575. dispose(): void;
  130576. }
  130577. }
  130578. declare module BABYLON {
  130579. /**
  130580. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130581. * in order to better appreciate the issue one might have.
  130582. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130583. */
  130584. export class RayHelper {
  130585. /**
  130586. * Defines the ray we are currently tryin to visualize.
  130587. */
  130588. ray: Nullable<Ray>;
  130589. private _renderPoints;
  130590. private _renderLine;
  130591. private _renderFunction;
  130592. private _scene;
  130593. private _onAfterRenderObserver;
  130594. private _onAfterStepObserver;
  130595. private _attachedToMesh;
  130596. private _meshSpaceDirection;
  130597. private _meshSpaceOrigin;
  130598. /**
  130599. * Helper function to create a colored helper in a scene in one line.
  130600. * @param ray Defines the ray we are currently tryin to visualize
  130601. * @param scene Defines the scene the ray is used in
  130602. * @param color Defines the color we want to see the ray in
  130603. * @returns The newly created ray helper.
  130604. */
  130605. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130606. /**
  130607. * Instantiate a new ray helper.
  130608. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130609. * in order to better appreciate the issue one might have.
  130610. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130611. * @param ray Defines the ray we are currently tryin to visualize
  130612. */
  130613. constructor(ray: Ray);
  130614. /**
  130615. * Shows the ray we are willing to debug.
  130616. * @param scene Defines the scene the ray needs to be rendered in
  130617. * @param color Defines the color the ray needs to be rendered in
  130618. */
  130619. show(scene: Scene, color?: Color3): void;
  130620. /**
  130621. * Hides the ray we are debugging.
  130622. */
  130623. hide(): void;
  130624. private _render;
  130625. /**
  130626. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130627. * @param mesh Defines the mesh we want the helper attached to
  130628. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130629. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130630. * @param length Defines the length of the ray
  130631. */
  130632. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130633. /**
  130634. * Detach the ray helper from the mesh it has previously been attached to.
  130635. */
  130636. detachFromMesh(): void;
  130637. private _updateToMesh;
  130638. /**
  130639. * Dispose the helper and release its associated resources.
  130640. */
  130641. dispose(): void;
  130642. }
  130643. }
  130644. declare module BABYLON {
  130645. /**
  130646. * Defines the options associated with the creation of a SkeletonViewer.
  130647. */
  130648. export interface ISkeletonViewerOptions {
  130649. /** Should the system pause animations before building the Viewer? */
  130650. pauseAnimations: boolean;
  130651. /** Should the system return the skeleton to rest before building? */
  130652. returnToRest: boolean;
  130653. /** public Display Mode of the Viewer */
  130654. displayMode: number;
  130655. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130656. displayOptions: ISkeletonViewerDisplayOptions;
  130657. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130658. computeBonesUsingShaders: boolean;
  130659. }
  130660. /**
  130661. * Defines how to display the various bone meshes for the viewer.
  130662. */
  130663. export interface ISkeletonViewerDisplayOptions {
  130664. /** How far down to start tapering the bone spurs */
  130665. midStep?: number;
  130666. /** How big is the midStep? */
  130667. midStepFactor?: number;
  130668. /** Base for the Sphere Size */
  130669. sphereBaseSize?: number;
  130670. /** The ratio of the sphere to the longest bone in units */
  130671. sphereScaleUnit?: number;
  130672. /** Ratio for the Sphere Size */
  130673. sphereFactor?: number;
  130674. }
  130675. }
  130676. declare module BABYLON {
  130677. /**
  130678. * Class containing static functions to help procedurally build meshes
  130679. */
  130680. export class RibbonBuilder {
  130681. /**
  130682. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130683. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130684. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130685. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130686. * * 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
  130687. * * 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
  130688. * * 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
  130689. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130690. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130691. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130692. * * 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
  130693. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130694. * * 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
  130695. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130696. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130697. * @param name defines the name of the mesh
  130698. * @param options defines the options used to create the mesh
  130699. * @param scene defines the hosting scene
  130700. * @returns the ribbon mesh
  130701. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130702. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130703. */
  130704. static CreateRibbon(name: string, options: {
  130705. pathArray: Vector3[][];
  130706. closeArray?: boolean;
  130707. closePath?: boolean;
  130708. offset?: number;
  130709. updatable?: boolean;
  130710. sideOrientation?: number;
  130711. frontUVs?: Vector4;
  130712. backUVs?: Vector4;
  130713. instance?: Mesh;
  130714. invertUV?: boolean;
  130715. uvs?: Vector2[];
  130716. colors?: Color4[];
  130717. }, scene?: Nullable<Scene>): Mesh;
  130718. }
  130719. }
  130720. declare module BABYLON {
  130721. /**
  130722. * Class containing static functions to help procedurally build meshes
  130723. */
  130724. export class ShapeBuilder {
  130725. /**
  130726. * 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.
  130727. * * 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.
  130728. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130729. * * 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.
  130730. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130731. * * 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
  130732. * * 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
  130733. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130734. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130735. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130736. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130738. * @param name defines the name of the mesh
  130739. * @param options defines the options used to create the mesh
  130740. * @param scene defines the hosting scene
  130741. * @returns the extruded shape mesh
  130742. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130743. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130744. */
  130745. static ExtrudeShape(name: string, options: {
  130746. shape: Vector3[];
  130747. path: Vector3[];
  130748. scale?: number;
  130749. rotation?: number;
  130750. cap?: number;
  130751. updatable?: boolean;
  130752. sideOrientation?: number;
  130753. frontUVs?: Vector4;
  130754. backUVs?: Vector4;
  130755. instance?: Mesh;
  130756. invertUV?: boolean;
  130757. }, scene?: Nullable<Scene>): Mesh;
  130758. /**
  130759. * Creates an custom extruded shape mesh.
  130760. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130761. * * 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.
  130762. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130763. * * 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
  130764. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130765. * * 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
  130766. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130767. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130768. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130769. * * 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
  130770. * * 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
  130771. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130772. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130773. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130774. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130775. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130776. * @param name defines the name of the mesh
  130777. * @param options defines the options used to create the mesh
  130778. * @param scene defines the hosting scene
  130779. * @returns the custom extruded shape mesh
  130780. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130781. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130782. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130783. */
  130784. static ExtrudeShapeCustom(name: string, options: {
  130785. shape: Vector3[];
  130786. path: Vector3[];
  130787. scaleFunction?: any;
  130788. rotationFunction?: any;
  130789. ribbonCloseArray?: boolean;
  130790. ribbonClosePath?: boolean;
  130791. cap?: number;
  130792. updatable?: boolean;
  130793. sideOrientation?: number;
  130794. frontUVs?: Vector4;
  130795. backUVs?: Vector4;
  130796. instance?: Mesh;
  130797. invertUV?: boolean;
  130798. }, scene?: Nullable<Scene>): Mesh;
  130799. private static _ExtrudeShapeGeneric;
  130800. }
  130801. }
  130802. declare module BABYLON.Debug {
  130803. /**
  130804. * Class used to render a debug view of a given skeleton
  130805. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130806. */
  130807. export class SkeletonViewer {
  130808. /** defines the skeleton to render */
  130809. skeleton: Skeleton;
  130810. /** defines the mesh attached to the skeleton */
  130811. mesh: AbstractMesh;
  130812. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130813. autoUpdateBonesMatrices: boolean;
  130814. /** defines the rendering group id to use with the viewer */
  130815. renderingGroupId: number;
  130816. /** is the options for the viewer */
  130817. options: Partial<ISkeletonViewerOptions>;
  130818. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130819. static readonly DISPLAY_LINES: number;
  130820. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130821. static readonly DISPLAY_SPHERES: number;
  130822. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130823. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130824. /** If SkeletonViewer scene scope. */
  130825. private _scene;
  130826. /** Gets or sets the color used to render the skeleton */
  130827. color: Color3;
  130828. /** Array of the points of the skeleton fo the line view. */
  130829. private _debugLines;
  130830. /** The SkeletonViewers Mesh. */
  130831. private _debugMesh;
  130832. /** If SkeletonViewer is enabled. */
  130833. private _isEnabled;
  130834. /** If SkeletonViewer is ready. */
  130835. private _ready;
  130836. /** SkeletonViewer render observable. */
  130837. private _obs;
  130838. /** The Utility Layer to render the gizmos in. */
  130839. private _utilityLayer;
  130840. private _boneIndices;
  130841. /** Gets the Scene. */
  130842. get scene(): Scene;
  130843. /** Gets the utilityLayer. */
  130844. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130845. /** Checks Ready Status. */
  130846. get isReady(): Boolean;
  130847. /** Sets Ready Status. */
  130848. set ready(value: boolean);
  130849. /** Gets the debugMesh */
  130850. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130851. /** Sets the debugMesh */
  130852. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130853. /** Gets the material */
  130854. get material(): StandardMaterial;
  130855. /** Sets the material */
  130856. set material(value: StandardMaterial);
  130857. /** Gets the material */
  130858. get displayMode(): number;
  130859. /** Sets the material */
  130860. set displayMode(value: number);
  130861. /**
  130862. * Creates a new SkeletonViewer
  130863. * @param skeleton defines the skeleton to render
  130864. * @param mesh defines the mesh attached to the skeleton
  130865. * @param scene defines the hosting scene
  130866. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130867. * @param renderingGroupId defines the rendering group id to use with the viewer
  130868. * @param options All of the extra constructor options for the SkeletonViewer
  130869. */
  130870. constructor(
  130871. /** defines the skeleton to render */
  130872. skeleton: Skeleton,
  130873. /** defines the mesh attached to the skeleton */
  130874. mesh: AbstractMesh,
  130875. /** The Scene scope*/
  130876. scene: Scene,
  130877. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130878. autoUpdateBonesMatrices?: boolean,
  130879. /** defines the rendering group id to use with the viewer */
  130880. renderingGroupId?: number,
  130881. /** is the options for the viewer */
  130882. options?: Partial<ISkeletonViewerOptions>);
  130883. /** The Dynamic bindings for the update functions */
  130884. private _bindObs;
  130885. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130886. update(): void;
  130887. /** Gets or sets a boolean indicating if the viewer is enabled */
  130888. set isEnabled(value: boolean);
  130889. get isEnabled(): boolean;
  130890. private _getBonePosition;
  130891. private _getLinesForBonesWithLength;
  130892. private _getLinesForBonesNoLength;
  130893. /** function to revert the mesh and scene back to the initial state. */
  130894. private _revert;
  130895. /** function to build and bind sphere joint points and spur bone representations. */
  130896. private _buildSpheresAndSpurs;
  130897. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130898. private _displayLinesUpdate;
  130899. /** Changes the displayMode of the skeleton viewer
  130900. * @param mode The displayMode numerical value
  130901. */
  130902. changeDisplayMode(mode: number): void;
  130903. /** Changes the displayMode of the skeleton viewer
  130904. * @param option String of the option name
  130905. * @param value The numerical option value
  130906. */
  130907. changeDisplayOptions(option: string, value: number): void;
  130908. /** Release associated resources */
  130909. dispose(): void;
  130910. }
  130911. }
  130912. declare module BABYLON {
  130913. /**
  130914. * Enum for Device Types
  130915. */
  130916. export enum DeviceType {
  130917. /** Generic */
  130918. Generic = 0,
  130919. /** Keyboard */
  130920. Keyboard = 1,
  130921. /** Mouse */
  130922. Mouse = 2,
  130923. /** Touch Pointers */
  130924. Touch = 3,
  130925. /** PS4 Dual Shock */
  130926. DualShock = 4,
  130927. /** Xbox */
  130928. Xbox = 5,
  130929. /** Switch Controller */
  130930. Switch = 6
  130931. }
  130932. /**
  130933. * Enum for All Pointers (Touch/Mouse)
  130934. */
  130935. export enum PointerInput {
  130936. /** Horizontal Axis */
  130937. Horizontal = 0,
  130938. /** Vertical Axis */
  130939. Vertical = 1,
  130940. /** Left Click or Touch */
  130941. LeftClick = 2,
  130942. /** Middle Click */
  130943. MiddleClick = 3,
  130944. /** Right Click */
  130945. RightClick = 4,
  130946. /** Browser Back */
  130947. BrowserBack = 5,
  130948. /** Browser Forward */
  130949. BrowserForward = 6
  130950. }
  130951. /**
  130952. * Enum for Dual Shock Gamepad
  130953. */
  130954. export enum DualShockInput {
  130955. /** Cross */
  130956. Cross = 0,
  130957. /** Circle */
  130958. Circle = 1,
  130959. /** Square */
  130960. Square = 2,
  130961. /** Triangle */
  130962. Triangle = 3,
  130963. /** L1 */
  130964. L1 = 4,
  130965. /** R1 */
  130966. R1 = 5,
  130967. /** L2 */
  130968. L2 = 6,
  130969. /** R2 */
  130970. R2 = 7,
  130971. /** Share */
  130972. Share = 8,
  130973. /** Options */
  130974. Options = 9,
  130975. /** L3 */
  130976. L3 = 10,
  130977. /** R3 */
  130978. R3 = 11,
  130979. /** DPadUp */
  130980. DPadUp = 12,
  130981. /** DPadDown */
  130982. DPadDown = 13,
  130983. /** DPadLeft */
  130984. DPadLeft = 14,
  130985. /** DRight */
  130986. DPadRight = 15,
  130987. /** Home */
  130988. Home = 16,
  130989. /** TouchPad */
  130990. TouchPad = 17,
  130991. /** LStickXAxis */
  130992. LStickXAxis = 18,
  130993. /** LStickYAxis */
  130994. LStickYAxis = 19,
  130995. /** RStickXAxis */
  130996. RStickXAxis = 20,
  130997. /** RStickYAxis */
  130998. RStickYAxis = 21
  130999. }
  131000. /**
  131001. * Enum for Xbox Gamepad
  131002. */
  131003. export enum XboxInput {
  131004. /** A */
  131005. A = 0,
  131006. /** B */
  131007. B = 1,
  131008. /** X */
  131009. X = 2,
  131010. /** Y */
  131011. Y = 3,
  131012. /** LB */
  131013. LB = 4,
  131014. /** RB */
  131015. RB = 5,
  131016. /** LT */
  131017. LT = 6,
  131018. /** RT */
  131019. RT = 7,
  131020. /** Back */
  131021. Back = 8,
  131022. /** Start */
  131023. Start = 9,
  131024. /** LS */
  131025. LS = 10,
  131026. /** RS */
  131027. RS = 11,
  131028. /** DPadUp */
  131029. DPadUp = 12,
  131030. /** DPadDown */
  131031. DPadDown = 13,
  131032. /** DPadLeft */
  131033. DPadLeft = 14,
  131034. /** DRight */
  131035. DPadRight = 15,
  131036. /** Home */
  131037. Home = 16,
  131038. /** LStickXAxis */
  131039. LStickXAxis = 17,
  131040. /** LStickYAxis */
  131041. LStickYAxis = 18,
  131042. /** RStickXAxis */
  131043. RStickXAxis = 19,
  131044. /** RStickYAxis */
  131045. RStickYAxis = 20
  131046. }
  131047. /**
  131048. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131049. */
  131050. export enum SwitchInput {
  131051. /** B */
  131052. B = 0,
  131053. /** A */
  131054. A = 1,
  131055. /** Y */
  131056. Y = 2,
  131057. /** X */
  131058. X = 3,
  131059. /** L */
  131060. L = 4,
  131061. /** R */
  131062. R = 5,
  131063. /** ZL */
  131064. ZL = 6,
  131065. /** ZR */
  131066. ZR = 7,
  131067. /** Minus */
  131068. Minus = 8,
  131069. /** Plus */
  131070. Plus = 9,
  131071. /** LS */
  131072. LS = 10,
  131073. /** RS */
  131074. RS = 11,
  131075. /** DPadUp */
  131076. DPadUp = 12,
  131077. /** DPadDown */
  131078. DPadDown = 13,
  131079. /** DPadLeft */
  131080. DPadLeft = 14,
  131081. /** DRight */
  131082. DPadRight = 15,
  131083. /** Home */
  131084. Home = 16,
  131085. /** Capture */
  131086. Capture = 17,
  131087. /** LStickXAxis */
  131088. LStickXAxis = 18,
  131089. /** LStickYAxis */
  131090. LStickYAxis = 19,
  131091. /** RStickXAxis */
  131092. RStickXAxis = 20,
  131093. /** RStickYAxis */
  131094. RStickYAxis = 21
  131095. }
  131096. }
  131097. declare module BABYLON {
  131098. /**
  131099. * This class will take all inputs from Keyboard, Pointer, and
  131100. * any Gamepads and provide a polling system that all devices
  131101. * will use. This class assumes that there will only be one
  131102. * pointer device and one keyboard.
  131103. */
  131104. export class DeviceInputSystem implements IDisposable {
  131105. /**
  131106. * Callback to be triggered when a device is connected
  131107. */
  131108. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131109. /**
  131110. * Callback to be triggered when a device is disconnected
  131111. */
  131112. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131113. /**
  131114. * Callback to be triggered when event driven input is updated
  131115. */
  131116. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131117. private _inputs;
  131118. private _gamepads;
  131119. private _keyboardActive;
  131120. private _pointerActive;
  131121. private _elementToAttachTo;
  131122. private _keyboardDownEvent;
  131123. private _keyboardUpEvent;
  131124. private _pointerMoveEvent;
  131125. private _pointerDownEvent;
  131126. private _pointerUpEvent;
  131127. private _gamepadConnectedEvent;
  131128. private _gamepadDisconnectedEvent;
  131129. private static _MAX_KEYCODES;
  131130. private static _MAX_POINTER_INPUTS;
  131131. private constructor();
  131132. /**
  131133. * Creates a new DeviceInputSystem instance
  131134. * @param engine Engine to pull input element from
  131135. * @returns The new instance
  131136. */
  131137. static Create(engine: Engine): DeviceInputSystem;
  131138. /**
  131139. * Checks for current device input value, given an id and input index
  131140. * @param deviceName Id of connected device
  131141. * @param inputIndex Index of device input
  131142. * @returns Current value of input
  131143. */
  131144. /**
  131145. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131146. * @param deviceType Enum specifiying device type
  131147. * @param deviceSlot "Slot" or index that device is referenced in
  131148. * @param inputIndex Id of input to be checked
  131149. * @returns Current value of input
  131150. */
  131151. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131152. /**
  131153. * Dispose of all the eventlisteners
  131154. */
  131155. dispose(): void;
  131156. /**
  131157. * Add device and inputs to device array
  131158. * @param deviceType Enum specifiying device type
  131159. * @param deviceSlot "Slot" or index that device is referenced in
  131160. * @param numberOfInputs Number of input entries to create for given device
  131161. */
  131162. private _registerDevice;
  131163. /**
  131164. * Given a specific device name, remove that device from the device map
  131165. * @param deviceType Enum specifiying device type
  131166. * @param deviceSlot "Slot" or index that device is referenced in
  131167. */
  131168. private _unregisterDevice;
  131169. /**
  131170. * Handle all actions that come from keyboard interaction
  131171. */
  131172. private _handleKeyActions;
  131173. /**
  131174. * Handle all actions that come from pointer interaction
  131175. */
  131176. private _handlePointerActions;
  131177. /**
  131178. * Handle all actions that come from gamepad interaction
  131179. */
  131180. private _handleGamepadActions;
  131181. /**
  131182. * Update all non-event based devices with each frame
  131183. * @param deviceType Enum specifiying device type
  131184. * @param deviceSlot "Slot" or index that device is referenced in
  131185. * @param inputIndex Id of input to be checked
  131186. */
  131187. private _updateDevice;
  131188. /**
  131189. * Gets DeviceType from the device name
  131190. * @param deviceName Name of Device from DeviceInputSystem
  131191. * @returns DeviceType enum value
  131192. */
  131193. private _getGamepadDeviceType;
  131194. }
  131195. }
  131196. declare module BABYLON {
  131197. /**
  131198. * Type to handle enforcement of inputs
  131199. */
  131200. 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;
  131201. }
  131202. declare module BABYLON {
  131203. /**
  131204. * Class that handles all input for a specific device
  131205. */
  131206. export class DeviceSource<T extends DeviceType> {
  131207. /** Type of device */
  131208. readonly deviceType: DeviceType;
  131209. /** "Slot" or index that device is referenced in */
  131210. readonly deviceSlot: number;
  131211. /**
  131212. * Observable to handle device input changes per device
  131213. */
  131214. readonly onInputChangedObservable: Observable<{
  131215. inputIndex: DeviceInput<T>;
  131216. previousState: Nullable<number>;
  131217. currentState: Nullable<number>;
  131218. }>;
  131219. private readonly _deviceInputSystem;
  131220. /**
  131221. * Default Constructor
  131222. * @param deviceInputSystem Reference to DeviceInputSystem
  131223. * @param deviceType Type of device
  131224. * @param deviceSlot "Slot" or index that device is referenced in
  131225. */
  131226. constructor(deviceInputSystem: DeviceInputSystem,
  131227. /** Type of device */
  131228. deviceType: DeviceType,
  131229. /** "Slot" or index that device is referenced in */
  131230. deviceSlot?: number);
  131231. /**
  131232. * Get input for specific input
  131233. * @param inputIndex index of specific input on device
  131234. * @returns Input value from DeviceInputSystem
  131235. */
  131236. getInput(inputIndex: DeviceInput<T>): number;
  131237. }
  131238. /**
  131239. * Class to keep track of devices
  131240. */
  131241. export class DeviceSourceManager implements IDisposable {
  131242. /**
  131243. * Observable to be triggered when before a device is connected
  131244. */
  131245. readonly onBeforeDeviceConnectedObservable: Observable<{
  131246. deviceType: DeviceType;
  131247. deviceSlot: number;
  131248. }>;
  131249. /**
  131250. * Observable to be triggered when before a device is disconnected
  131251. */
  131252. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131253. deviceType: DeviceType;
  131254. deviceSlot: number;
  131255. }>;
  131256. /**
  131257. * Observable to be triggered when after a device is connected
  131258. */
  131259. readonly onAfterDeviceConnectedObservable: Observable<{
  131260. deviceType: DeviceType;
  131261. deviceSlot: number;
  131262. }>;
  131263. /**
  131264. * Observable to be triggered when after a device is disconnected
  131265. */
  131266. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131267. deviceType: DeviceType;
  131268. deviceSlot: number;
  131269. }>;
  131270. private readonly _devices;
  131271. private readonly _firstDevice;
  131272. private readonly _deviceInputSystem;
  131273. /**
  131274. * Default Constructor
  131275. * @param engine engine to pull input element from
  131276. */
  131277. constructor(engine: Engine);
  131278. /**
  131279. * Gets a DeviceSource, given a type and slot
  131280. * @param deviceType Enum specifying device type
  131281. * @param deviceSlot "Slot" or index that device is referenced in
  131282. * @returns DeviceSource object
  131283. */
  131284. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131285. /**
  131286. * Gets an array of DeviceSource objects for a given device type
  131287. * @param deviceType Enum specifying device type
  131288. * @returns Array of DeviceSource objects
  131289. */
  131290. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131291. /**
  131292. * Dispose of DeviceInputSystem and other parts
  131293. */
  131294. dispose(): void;
  131295. /**
  131296. * Function to add device name to device list
  131297. * @param deviceType Enum specifying device type
  131298. * @param deviceSlot "Slot" or index that device is referenced in
  131299. */
  131300. private _addDevice;
  131301. /**
  131302. * Function to remove device name to device list
  131303. * @param deviceType Enum specifying device type
  131304. * @param deviceSlot "Slot" or index that device is referenced in
  131305. */
  131306. private _removeDevice;
  131307. /**
  131308. * Updates array storing first connected device of each type
  131309. * @param type Type of Device
  131310. */
  131311. private _updateFirstDevices;
  131312. }
  131313. }
  131314. declare module BABYLON {
  131315. /**
  131316. * Options to create the null engine
  131317. */
  131318. export class NullEngineOptions {
  131319. /**
  131320. * Render width (Default: 512)
  131321. */
  131322. renderWidth: number;
  131323. /**
  131324. * Render height (Default: 256)
  131325. */
  131326. renderHeight: number;
  131327. /**
  131328. * Texture size (Default: 512)
  131329. */
  131330. textureSize: number;
  131331. /**
  131332. * If delta time between frames should be constant
  131333. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131334. */
  131335. deterministicLockstep: boolean;
  131336. /**
  131337. * Maximum about of steps between frames (Default: 4)
  131338. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131339. */
  131340. lockstepMaxSteps: number;
  131341. /**
  131342. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131343. */
  131344. useHighPrecisionMatrix?: boolean;
  131345. }
  131346. /**
  131347. * The null engine class provides support for headless version of babylon.js.
  131348. * This can be used in server side scenario or for testing purposes
  131349. */
  131350. export class NullEngine extends Engine {
  131351. private _options;
  131352. /**
  131353. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131354. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131355. * @returns true if engine is in deterministic lock step mode
  131356. */
  131357. isDeterministicLockStep(): boolean;
  131358. /**
  131359. * Gets the max steps when engine is running in deterministic lock step
  131360. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131361. * @returns the max steps
  131362. */
  131363. getLockstepMaxSteps(): number;
  131364. /**
  131365. * Gets the current hardware scaling level.
  131366. * By default the hardware scaling level is computed from the window device ratio.
  131367. * 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.
  131368. * @returns a number indicating the current hardware scaling level
  131369. */
  131370. getHardwareScalingLevel(): number;
  131371. constructor(options?: NullEngineOptions);
  131372. /**
  131373. * Creates a vertex buffer
  131374. * @param vertices the data for the vertex buffer
  131375. * @returns the new WebGL static buffer
  131376. */
  131377. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131378. /**
  131379. * Creates a new index buffer
  131380. * @param indices defines the content of the index buffer
  131381. * @param updatable defines if the index buffer must be updatable
  131382. * @returns a new webGL buffer
  131383. */
  131384. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131385. /**
  131386. * Clear the current render buffer or the current render target (if any is set up)
  131387. * @param color defines the color to use
  131388. * @param backBuffer defines if the back buffer must be cleared
  131389. * @param depth defines if the depth buffer must be cleared
  131390. * @param stencil defines if the stencil buffer must be cleared
  131391. */
  131392. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131393. /**
  131394. * Gets the current render width
  131395. * @param useScreen defines if screen size must be used (or the current render target if any)
  131396. * @returns a number defining the current render width
  131397. */
  131398. getRenderWidth(useScreen?: boolean): number;
  131399. /**
  131400. * Gets the current render height
  131401. * @param useScreen defines if screen size must be used (or the current render target if any)
  131402. * @returns a number defining the current render height
  131403. */
  131404. getRenderHeight(useScreen?: boolean): number;
  131405. /**
  131406. * Set the WebGL's viewport
  131407. * @param viewport defines the viewport element to be used
  131408. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131409. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131410. */
  131411. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131412. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131413. /**
  131414. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131415. * @param pipelineContext defines the pipeline context to use
  131416. * @param uniformsNames defines the list of uniform names
  131417. * @returns an array of webGL uniform locations
  131418. */
  131419. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131420. /**
  131421. * Gets the lsit of active attributes for a given webGL program
  131422. * @param pipelineContext defines the pipeline context to use
  131423. * @param attributesNames defines the list of attribute names to get
  131424. * @returns an array of indices indicating the offset of each attribute
  131425. */
  131426. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131427. /**
  131428. * Binds an effect to the webGL context
  131429. * @param effect defines the effect to bind
  131430. */
  131431. bindSamplers(effect: Effect): void;
  131432. /**
  131433. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131434. * @param effect defines the effect to activate
  131435. */
  131436. enableEffect(effect: Effect): void;
  131437. /**
  131438. * Set various states to the webGL context
  131439. * @param culling defines backface culling state
  131440. * @param zOffset defines the value to apply to zOffset (0 by default)
  131441. * @param force defines if states must be applied even if cache is up to date
  131442. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131443. */
  131444. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131445. /**
  131446. * Set the value of an uniform to an array of int32
  131447. * @param uniform defines the webGL uniform location where to store the value
  131448. * @param array defines the array of int32 to store
  131449. */
  131450. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131451. /**
  131452. * Set the value of an uniform to an array of int32 (stored as vec2)
  131453. * @param uniform defines the webGL uniform location where to store the value
  131454. * @param array defines the array of int32 to store
  131455. */
  131456. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131457. /**
  131458. * Set the value of an uniform to an array of int32 (stored as vec3)
  131459. * @param uniform defines the webGL uniform location where to store the value
  131460. * @param array defines the array of int32 to store
  131461. */
  131462. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131463. /**
  131464. * Set the value of an uniform to an array of int32 (stored as vec4)
  131465. * @param uniform defines the webGL uniform location where to store the value
  131466. * @param array defines the array of int32 to store
  131467. */
  131468. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131469. /**
  131470. * Set the value of an uniform to an array of float32
  131471. * @param uniform defines the webGL uniform location where to store the value
  131472. * @param array defines the array of float32 to store
  131473. */
  131474. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131475. /**
  131476. * Set the value of an uniform to an array of float32 (stored as vec2)
  131477. * @param uniform defines the webGL uniform location where to store the value
  131478. * @param array defines the array of float32 to store
  131479. */
  131480. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131481. /**
  131482. * Set the value of an uniform to an array of float32 (stored as vec3)
  131483. * @param uniform defines the webGL uniform location where to store the value
  131484. * @param array defines the array of float32 to store
  131485. */
  131486. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131487. /**
  131488. * Set the value of an uniform to an array of float32 (stored as vec4)
  131489. * @param uniform defines the webGL uniform location where to store the value
  131490. * @param array defines the array of float32 to store
  131491. */
  131492. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131493. /**
  131494. * Set the value of an uniform to an array of number
  131495. * @param uniform defines the webGL uniform location where to store the value
  131496. * @param array defines the array of number to store
  131497. */
  131498. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131499. /**
  131500. * Set the value of an uniform to an array of number (stored as vec2)
  131501. * @param uniform defines the webGL uniform location where to store the value
  131502. * @param array defines the array of number to store
  131503. */
  131504. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131505. /**
  131506. * Set the value of an uniform to an array of number (stored as vec3)
  131507. * @param uniform defines the webGL uniform location where to store the value
  131508. * @param array defines the array of number to store
  131509. */
  131510. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131511. /**
  131512. * Set the value of an uniform to an array of number (stored as vec4)
  131513. * @param uniform defines the webGL uniform location where to store the value
  131514. * @param array defines the array of number to store
  131515. */
  131516. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131517. /**
  131518. * Set the value of an uniform to an array of float32 (stored as matrices)
  131519. * @param uniform defines the webGL uniform location where to store the value
  131520. * @param matrices defines the array of float32 to store
  131521. */
  131522. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131523. /**
  131524. * Set the value of an uniform to a matrix (3x3)
  131525. * @param uniform defines the webGL uniform location where to store the value
  131526. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131527. */
  131528. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131529. /**
  131530. * Set the value of an uniform to a matrix (2x2)
  131531. * @param uniform defines the webGL uniform location where to store the value
  131532. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131533. */
  131534. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131535. /**
  131536. * Set the value of an uniform to a number (float)
  131537. * @param uniform defines the webGL uniform location where to store the value
  131538. * @param value defines the float number to store
  131539. */
  131540. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131541. /**
  131542. * Set the value of an uniform to a vec2
  131543. * @param uniform defines the webGL uniform location where to store the value
  131544. * @param x defines the 1st component of the value
  131545. * @param y defines the 2nd component of the value
  131546. */
  131547. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131548. /**
  131549. * Set the value of an uniform to a vec3
  131550. * @param uniform defines the webGL uniform location where to store the value
  131551. * @param x defines the 1st component of the value
  131552. * @param y defines the 2nd component of the value
  131553. * @param z defines the 3rd component of the value
  131554. */
  131555. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131556. /**
  131557. * Set the value of an uniform to a boolean
  131558. * @param uniform defines the webGL uniform location where to store the value
  131559. * @param bool defines the boolean to store
  131560. */
  131561. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131562. /**
  131563. * Set the value of an uniform to a vec4
  131564. * @param uniform defines the webGL uniform location where to store the value
  131565. * @param x defines the 1st component of the value
  131566. * @param y defines the 2nd component of the value
  131567. * @param z defines the 3rd component of the value
  131568. * @param w defines the 4th component of the value
  131569. */
  131570. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131571. /**
  131572. * Sets the current alpha mode
  131573. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131574. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131575. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131576. */
  131577. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131578. /**
  131579. * Bind webGl buffers directly to the webGL context
  131580. * @param vertexBuffers defines the vertex buffer to bind
  131581. * @param indexBuffer defines the index buffer to bind
  131582. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131583. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131584. * @param effect defines the effect associated with the vertex buffer
  131585. */
  131586. bindBuffers(vertexBuffers: {
  131587. [key: string]: VertexBuffer;
  131588. }, indexBuffer: DataBuffer, effect: Effect): void;
  131589. /**
  131590. * Force the entire cache to be cleared
  131591. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131592. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131593. */
  131594. wipeCaches(bruteForce?: boolean): void;
  131595. /**
  131596. * Send a draw order
  131597. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131598. * @param indexStart defines the starting index
  131599. * @param indexCount defines the number of index to draw
  131600. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131601. */
  131602. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131603. /**
  131604. * Draw a list of indexed primitives
  131605. * @param fillMode defines the primitive to use
  131606. * @param indexStart defines the starting index
  131607. * @param indexCount defines the number of index to draw
  131608. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131609. */
  131610. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131611. /**
  131612. * Draw a list of unindexed primitives
  131613. * @param fillMode defines the primitive to use
  131614. * @param verticesStart defines the index of first vertex to draw
  131615. * @param verticesCount defines the count of vertices to draw
  131616. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131617. */
  131618. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131619. /** @hidden */
  131620. _createTexture(): WebGLTexture;
  131621. /** @hidden */
  131622. _releaseTexture(texture: InternalTexture): void;
  131623. /**
  131624. * Usually called from Texture.ts.
  131625. * Passed information to create a WebGLTexture
  131626. * @param urlArg defines a value which contains one of the following:
  131627. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131628. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131629. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131630. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131631. * @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)
  131632. * @param scene needed for loading to the correct scene
  131633. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131634. * @param onLoad optional callback to be called upon successful completion
  131635. * @param onError optional callback to be called upon failure
  131636. * @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
  131637. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131638. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131639. * @param forcedExtension defines the extension to use to pick the right loader
  131640. * @param mimeType defines an optional mime type
  131641. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131642. */
  131643. 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;
  131644. /**
  131645. * Creates a new render target texture
  131646. * @param size defines the size of the texture
  131647. * @param options defines the options used to create the texture
  131648. * @returns a new render target texture stored in an InternalTexture
  131649. */
  131650. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131651. /**
  131652. * Update the sampling mode of a given texture
  131653. * @param samplingMode defines the required sampling mode
  131654. * @param texture defines the texture to update
  131655. */
  131656. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131657. /**
  131658. * Binds the frame buffer to the specified texture.
  131659. * @param texture The texture to render to or null for the default canvas
  131660. * @param faceIndex The face of the texture to render to in case of cube texture
  131661. * @param requiredWidth The width of the target to render to
  131662. * @param requiredHeight The height of the target to render to
  131663. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131664. * @param lodLevel defines le lod level to bind to the frame buffer
  131665. */
  131666. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131667. /**
  131668. * Unbind the current render target texture from the webGL context
  131669. * @param texture defines the render target texture to unbind
  131670. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131671. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131672. */
  131673. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131674. /**
  131675. * Creates a dynamic vertex buffer
  131676. * @param vertices the data for the dynamic vertex buffer
  131677. * @returns the new WebGL dynamic buffer
  131678. */
  131679. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131680. /**
  131681. * Update the content of a dynamic texture
  131682. * @param texture defines the texture to update
  131683. * @param canvas defines the canvas containing the source
  131684. * @param invertY defines if data must be stored with Y axis inverted
  131685. * @param premulAlpha defines if alpha is stored as premultiplied
  131686. * @param format defines the format of the data
  131687. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131688. */
  131689. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131690. /**
  131691. * Gets a boolean indicating if all created effects are ready
  131692. * @returns true if all effects are ready
  131693. */
  131694. areAllEffectsReady(): boolean;
  131695. /**
  131696. * @hidden
  131697. * Get the current error code of the webGL context
  131698. * @returns the error code
  131699. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131700. */
  131701. getError(): number;
  131702. /** @hidden */
  131703. _getUnpackAlignement(): number;
  131704. /** @hidden */
  131705. _unpackFlipY(value: boolean): void;
  131706. /**
  131707. * Update a dynamic index buffer
  131708. * @param indexBuffer defines the target index buffer
  131709. * @param indices defines the data to update
  131710. * @param offset defines the offset in the target index buffer where update should start
  131711. */
  131712. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131713. /**
  131714. * Updates a dynamic vertex buffer.
  131715. * @param vertexBuffer the vertex buffer to update
  131716. * @param vertices the data used to update the vertex buffer
  131717. * @param byteOffset the byte offset of the data (optional)
  131718. * @param byteLength the byte length of the data (optional)
  131719. */
  131720. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131721. /** @hidden */
  131722. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131723. /** @hidden */
  131724. _bindTexture(channel: number, texture: InternalTexture): void;
  131725. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131726. /**
  131727. * 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
  131728. */
  131729. releaseEffects(): void;
  131730. displayLoadingUI(): void;
  131731. hideLoadingUI(): void;
  131732. /** @hidden */
  131733. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131734. /** @hidden */
  131735. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131736. /** @hidden */
  131737. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131738. /** @hidden */
  131739. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131740. }
  131741. }
  131742. declare module BABYLON {
  131743. /**
  131744. * @hidden
  131745. **/
  131746. export class _TimeToken {
  131747. _startTimeQuery: Nullable<WebGLQuery>;
  131748. _endTimeQuery: Nullable<WebGLQuery>;
  131749. _timeElapsedQuery: Nullable<WebGLQuery>;
  131750. _timeElapsedQueryEnded: boolean;
  131751. }
  131752. }
  131753. declare module BABYLON {
  131754. /** @hidden */
  131755. export class _OcclusionDataStorage {
  131756. /** @hidden */
  131757. occlusionInternalRetryCounter: number;
  131758. /** @hidden */
  131759. isOcclusionQueryInProgress: boolean;
  131760. /** @hidden */
  131761. isOccluded: boolean;
  131762. /** @hidden */
  131763. occlusionRetryCount: number;
  131764. /** @hidden */
  131765. occlusionType: number;
  131766. /** @hidden */
  131767. occlusionQueryAlgorithmType: number;
  131768. }
  131769. interface Engine {
  131770. /**
  131771. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131772. * @return the new query
  131773. */
  131774. createQuery(): WebGLQuery;
  131775. /**
  131776. * Delete and release a webGL query
  131777. * @param query defines the query to delete
  131778. * @return the current engine
  131779. */
  131780. deleteQuery(query: WebGLQuery): Engine;
  131781. /**
  131782. * Check if a given query has resolved and got its value
  131783. * @param query defines the query to check
  131784. * @returns true if the query got its value
  131785. */
  131786. isQueryResultAvailable(query: WebGLQuery): boolean;
  131787. /**
  131788. * Gets the value of a given query
  131789. * @param query defines the query to check
  131790. * @returns the value of the query
  131791. */
  131792. getQueryResult(query: WebGLQuery): number;
  131793. /**
  131794. * Initiates an occlusion query
  131795. * @param algorithmType defines the algorithm to use
  131796. * @param query defines the query to use
  131797. * @returns the current engine
  131798. * @see https://doc.babylonjs.com/features/occlusionquery
  131799. */
  131800. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131801. /**
  131802. * Ends an occlusion query
  131803. * @see https://doc.babylonjs.com/features/occlusionquery
  131804. * @param algorithmType defines the algorithm to use
  131805. * @returns the current engine
  131806. */
  131807. endOcclusionQuery(algorithmType: number): Engine;
  131808. /**
  131809. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131810. * Please note that only one query can be issued at a time
  131811. * @returns a time token used to track the time span
  131812. */
  131813. startTimeQuery(): Nullable<_TimeToken>;
  131814. /**
  131815. * Ends a time query
  131816. * @param token defines the token used to measure the time span
  131817. * @returns the time spent (in ns)
  131818. */
  131819. endTimeQuery(token: _TimeToken): int;
  131820. /** @hidden */
  131821. _currentNonTimestampToken: Nullable<_TimeToken>;
  131822. /** @hidden */
  131823. _createTimeQuery(): WebGLQuery;
  131824. /** @hidden */
  131825. _deleteTimeQuery(query: WebGLQuery): void;
  131826. /** @hidden */
  131827. _getGlAlgorithmType(algorithmType: number): number;
  131828. /** @hidden */
  131829. _getTimeQueryResult(query: WebGLQuery): any;
  131830. /** @hidden */
  131831. _getTimeQueryAvailability(query: WebGLQuery): any;
  131832. }
  131833. interface AbstractMesh {
  131834. /**
  131835. * Backing filed
  131836. * @hidden
  131837. */
  131838. __occlusionDataStorage: _OcclusionDataStorage;
  131839. /**
  131840. * Access property
  131841. * @hidden
  131842. */
  131843. _occlusionDataStorage: _OcclusionDataStorage;
  131844. /**
  131845. * 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.
  131846. * The default value is -1 which means don't break the query and wait till the result
  131847. * @see https://doc.babylonjs.com/features/occlusionquery
  131848. */
  131849. occlusionRetryCount: number;
  131850. /**
  131851. * 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:
  131852. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131853. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131854. * * 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.
  131855. * @see https://doc.babylonjs.com/features/occlusionquery
  131856. */
  131857. occlusionType: number;
  131858. /**
  131859. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131860. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131861. * * 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.
  131862. * @see https://doc.babylonjs.com/features/occlusionquery
  131863. */
  131864. occlusionQueryAlgorithmType: number;
  131865. /**
  131866. * 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
  131867. * @see https://doc.babylonjs.com/features/occlusionquery
  131868. */
  131869. isOccluded: boolean;
  131870. /**
  131871. * Flag to check the progress status of the query
  131872. * @see https://doc.babylonjs.com/features/occlusionquery
  131873. */
  131874. isOcclusionQueryInProgress: boolean;
  131875. }
  131876. }
  131877. declare module BABYLON {
  131878. /** @hidden */
  131879. export var _forceTransformFeedbackToBundle: boolean;
  131880. interface Engine {
  131881. /**
  131882. * Creates a webGL transform feedback object
  131883. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131884. * @returns the webGL transform feedback object
  131885. */
  131886. createTransformFeedback(): WebGLTransformFeedback;
  131887. /**
  131888. * Delete a webGL transform feedback object
  131889. * @param value defines the webGL transform feedback object to delete
  131890. */
  131891. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131892. /**
  131893. * Bind a webGL transform feedback object to the webgl context
  131894. * @param value defines the webGL transform feedback object to bind
  131895. */
  131896. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131897. /**
  131898. * Begins a transform feedback operation
  131899. * @param usePoints defines if points or triangles must be used
  131900. */
  131901. beginTransformFeedback(usePoints: boolean): void;
  131902. /**
  131903. * Ends a transform feedback operation
  131904. */
  131905. endTransformFeedback(): void;
  131906. /**
  131907. * Specify the varyings to use with transform feedback
  131908. * @param program defines the associated webGL program
  131909. * @param value defines the list of strings representing the varying names
  131910. */
  131911. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131912. /**
  131913. * Bind a webGL buffer for a transform feedback operation
  131914. * @param value defines the webGL buffer to bind
  131915. */
  131916. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131917. }
  131918. }
  131919. declare module BABYLON {
  131920. /**
  131921. * Class used to define an additional view for the engine
  131922. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131923. */
  131924. export class EngineView {
  131925. /** Defines the canvas where to render the view */
  131926. target: HTMLCanvasElement;
  131927. /** Defines an optional camera used to render the view (will use active camera else) */
  131928. camera?: Camera;
  131929. }
  131930. interface Engine {
  131931. /**
  131932. * Gets or sets the HTML element to use for attaching events
  131933. */
  131934. inputElement: Nullable<HTMLElement>;
  131935. /**
  131936. * Gets the current engine view
  131937. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131938. */
  131939. activeView: Nullable<EngineView>;
  131940. /** Gets or sets the list of views */
  131941. views: EngineView[];
  131942. /**
  131943. * Register a new child canvas
  131944. * @param canvas defines the canvas to register
  131945. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131946. * @returns the associated view
  131947. */
  131948. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131949. /**
  131950. * Remove a registered child canvas
  131951. * @param canvas defines the canvas to remove
  131952. * @returns the current engine
  131953. */
  131954. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131955. }
  131956. }
  131957. declare module BABYLON {
  131958. interface Engine {
  131959. /** @hidden */
  131960. _excludedCompressedTextures: string[];
  131961. /** @hidden */
  131962. _textureFormatInUse: string;
  131963. /**
  131964. * Gets the list of texture formats supported
  131965. */
  131966. readonly texturesSupported: Array<string>;
  131967. /**
  131968. * Gets the texture format in use
  131969. */
  131970. readonly textureFormatInUse: Nullable<string>;
  131971. /**
  131972. * Set the compressed texture extensions or file names to skip.
  131973. *
  131974. * @param skippedFiles defines the list of those texture files you want to skip
  131975. * Example: [".dds", ".env", "myfile.png"]
  131976. */
  131977. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131978. /**
  131979. * Set the compressed texture format to use, based on the formats you have, and the formats
  131980. * supported by the hardware / browser.
  131981. *
  131982. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131983. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131984. * to API arguments needed to compressed textures. This puts the burden on the container
  131985. * generator to house the arcane code for determining these for current & future formats.
  131986. *
  131987. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131988. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131989. *
  131990. * Note: The result of this call is not taken into account when a texture is base64.
  131991. *
  131992. * @param formatsAvailable defines the list of those format families you have created
  131993. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131994. *
  131995. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131996. * @returns The extension selected.
  131997. */
  131998. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131999. }
  132000. }
  132001. declare module BABYLON {
  132002. /**
  132003. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  132004. */
  132005. export interface CubeMapInfo {
  132006. /**
  132007. * The pixel array for the front face.
  132008. * This is stored in format, left to right, up to down format.
  132009. */
  132010. front: Nullable<ArrayBufferView>;
  132011. /**
  132012. * The pixel array for the back face.
  132013. * This is stored in format, left to right, up to down format.
  132014. */
  132015. back: Nullable<ArrayBufferView>;
  132016. /**
  132017. * The pixel array for the left face.
  132018. * This is stored in format, left to right, up to down format.
  132019. */
  132020. left: Nullable<ArrayBufferView>;
  132021. /**
  132022. * The pixel array for the right face.
  132023. * This is stored in format, left to right, up to down format.
  132024. */
  132025. right: Nullable<ArrayBufferView>;
  132026. /**
  132027. * The pixel array for the up face.
  132028. * This is stored in format, left to right, up to down format.
  132029. */
  132030. up: Nullable<ArrayBufferView>;
  132031. /**
  132032. * The pixel array for the down face.
  132033. * This is stored in format, left to right, up to down format.
  132034. */
  132035. down: Nullable<ArrayBufferView>;
  132036. /**
  132037. * The size of the cubemap stored.
  132038. *
  132039. * Each faces will be size * size pixels.
  132040. */
  132041. size: number;
  132042. /**
  132043. * The format of the texture.
  132044. *
  132045. * RGBA, RGB.
  132046. */
  132047. format: number;
  132048. /**
  132049. * The type of the texture data.
  132050. *
  132051. * UNSIGNED_INT, FLOAT.
  132052. */
  132053. type: number;
  132054. /**
  132055. * Specifies whether the texture is in gamma space.
  132056. */
  132057. gammaSpace: boolean;
  132058. }
  132059. /**
  132060. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132061. */
  132062. export class PanoramaToCubeMapTools {
  132063. private static FACE_LEFT;
  132064. private static FACE_RIGHT;
  132065. private static FACE_FRONT;
  132066. private static FACE_BACK;
  132067. private static FACE_DOWN;
  132068. private static FACE_UP;
  132069. /**
  132070. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132071. *
  132072. * @param float32Array The source data.
  132073. * @param inputWidth The width of the input panorama.
  132074. * @param inputHeight The height of the input panorama.
  132075. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132076. * @return The cubemap data
  132077. */
  132078. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132079. private static CreateCubemapTexture;
  132080. private static CalcProjectionSpherical;
  132081. }
  132082. }
  132083. declare module BABYLON {
  132084. /**
  132085. * Helper class dealing with the extraction of spherical polynomial dataArray
  132086. * from a cube map.
  132087. */
  132088. export class CubeMapToSphericalPolynomialTools {
  132089. private static FileFaces;
  132090. /**
  132091. * Converts a texture to the according Spherical Polynomial data.
  132092. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132093. *
  132094. * @param texture The texture to extract the information from.
  132095. * @return The Spherical Polynomial data.
  132096. */
  132097. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132098. /**
  132099. * Converts a cubemap to the according Spherical Polynomial data.
  132100. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132101. *
  132102. * @param cubeInfo The Cube map to extract the information from.
  132103. * @return The Spherical Polynomial data.
  132104. */
  132105. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132106. }
  132107. }
  132108. declare module BABYLON {
  132109. interface BaseTexture {
  132110. /**
  132111. * Get the polynomial representation of the texture data.
  132112. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132113. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132114. */
  132115. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132116. }
  132117. }
  132118. declare module BABYLON {
  132119. /** @hidden */
  132120. export var rgbdEncodePixelShader: {
  132121. name: string;
  132122. shader: string;
  132123. };
  132124. }
  132125. declare module BABYLON {
  132126. /** @hidden */
  132127. export var rgbdDecodePixelShader: {
  132128. name: string;
  132129. shader: string;
  132130. };
  132131. }
  132132. declare module BABYLON {
  132133. /**
  132134. * Raw texture data and descriptor sufficient for WebGL texture upload
  132135. */
  132136. export interface EnvironmentTextureInfo {
  132137. /**
  132138. * Version of the environment map
  132139. */
  132140. version: number;
  132141. /**
  132142. * Width of image
  132143. */
  132144. width: number;
  132145. /**
  132146. * Irradiance information stored in the file.
  132147. */
  132148. irradiance: any;
  132149. /**
  132150. * Specular information stored in the file.
  132151. */
  132152. specular: any;
  132153. }
  132154. /**
  132155. * Defines One Image in the file. It requires only the position in the file
  132156. * as well as the length.
  132157. */
  132158. interface BufferImageData {
  132159. /**
  132160. * Length of the image data.
  132161. */
  132162. length: number;
  132163. /**
  132164. * Position of the data from the null terminator delimiting the end of the JSON.
  132165. */
  132166. position: number;
  132167. }
  132168. /**
  132169. * Defines the specular data enclosed in the file.
  132170. * This corresponds to the version 1 of the data.
  132171. */
  132172. export interface EnvironmentTextureSpecularInfoV1 {
  132173. /**
  132174. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132175. */
  132176. specularDataPosition?: number;
  132177. /**
  132178. * This contains all the images data needed to reconstruct the cubemap.
  132179. */
  132180. mipmaps: Array<BufferImageData>;
  132181. /**
  132182. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132183. */
  132184. lodGenerationScale: number;
  132185. }
  132186. /**
  132187. * Sets of helpers addressing the serialization and deserialization of environment texture
  132188. * stored in a BabylonJS env file.
  132189. * Those files are usually stored as .env files.
  132190. */
  132191. export class EnvironmentTextureTools {
  132192. /**
  132193. * Magic number identifying the env file.
  132194. */
  132195. private static _MagicBytes;
  132196. /**
  132197. * Gets the environment info from an env file.
  132198. * @param data The array buffer containing the .env bytes.
  132199. * @returns the environment file info (the json header) if successfully parsed.
  132200. */
  132201. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132202. /**
  132203. * Creates an environment texture from a loaded cube texture.
  132204. * @param texture defines the cube texture to convert in env file
  132205. * @return a promise containing the environment data if succesfull.
  132206. */
  132207. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132208. /**
  132209. * Creates a JSON representation of the spherical data.
  132210. * @param texture defines the texture containing the polynomials
  132211. * @return the JSON representation of the spherical info
  132212. */
  132213. private static _CreateEnvTextureIrradiance;
  132214. /**
  132215. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132216. * @param data the image data
  132217. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132218. * @return the views described by info providing access to the underlying buffer
  132219. */
  132220. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132221. /**
  132222. * Uploads the texture info contained in the env file to the GPU.
  132223. * @param texture defines the internal texture to upload to
  132224. * @param data defines the data to load
  132225. * @param info defines the texture info retrieved through the GetEnvInfo method
  132226. * @returns a promise
  132227. */
  132228. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132229. private static _OnImageReadyAsync;
  132230. /**
  132231. * Uploads the levels of image data to the GPU.
  132232. * @param texture defines the internal texture to upload to
  132233. * @param imageData defines the array buffer views of image data [mipmap][face]
  132234. * @returns a promise
  132235. */
  132236. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132237. /**
  132238. * Uploads spherical polynomials information to the texture.
  132239. * @param texture defines the texture we are trying to upload the information to
  132240. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132241. */
  132242. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132243. /** @hidden */
  132244. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132245. }
  132246. }
  132247. declare module BABYLON {
  132248. /**
  132249. * Class used to inline functions in shader code
  132250. */
  132251. export class ShaderCodeInliner {
  132252. private static readonly _RegexpFindFunctionNameAndType;
  132253. private _sourceCode;
  132254. private _functionDescr;
  132255. private _numMaxIterations;
  132256. /** Gets or sets the token used to mark the functions to inline */
  132257. inlineToken: string;
  132258. /** Gets or sets the debug mode */
  132259. debug: boolean;
  132260. /** Gets the code after the inlining process */
  132261. get code(): string;
  132262. /**
  132263. * Initializes the inliner
  132264. * @param sourceCode shader code source to inline
  132265. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132266. */
  132267. constructor(sourceCode: string, numMaxIterations?: number);
  132268. /**
  132269. * Start the processing of the shader code
  132270. */
  132271. processCode(): void;
  132272. private _collectFunctions;
  132273. private _processInlining;
  132274. private _extractBetweenMarkers;
  132275. private _skipWhitespaces;
  132276. private _removeComments;
  132277. private _replaceFunctionCallsByCode;
  132278. private _findBackward;
  132279. private _escapeRegExp;
  132280. private _replaceNames;
  132281. }
  132282. }
  132283. declare module BABYLON {
  132284. /**
  132285. * Container for accessors for natively-stored mesh data buffers.
  132286. */
  132287. class NativeDataBuffer extends DataBuffer {
  132288. /**
  132289. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132290. */
  132291. nativeIndexBuffer?: any;
  132292. /**
  132293. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132294. */
  132295. nativeVertexBuffer?: any;
  132296. }
  132297. /** @hidden */
  132298. class NativeTexture extends InternalTexture {
  132299. getInternalTexture(): InternalTexture;
  132300. getViewCount(): number;
  132301. }
  132302. /** @hidden */
  132303. export class NativeEngine extends Engine {
  132304. private readonly _native;
  132305. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132306. private readonly INVALID_HANDLE;
  132307. private _boundBuffersVertexArray;
  132308. getHardwareScalingLevel(): number;
  132309. constructor();
  132310. dispose(): void;
  132311. /**
  132312. * Can be used to override the current requestAnimationFrame requester.
  132313. * @hidden
  132314. */
  132315. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132316. /**
  132317. * Override default engine behavior.
  132318. * @param color
  132319. * @param backBuffer
  132320. * @param depth
  132321. * @param stencil
  132322. */
  132323. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132324. /**
  132325. * Gets host document
  132326. * @returns the host document object
  132327. */
  132328. getHostDocument(): Nullable<Document>;
  132329. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132330. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132331. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132332. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132333. [key: string]: VertexBuffer;
  132334. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132335. bindBuffers(vertexBuffers: {
  132336. [key: string]: VertexBuffer;
  132337. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132338. recordVertexArrayObject(vertexBuffers: {
  132339. [key: string]: VertexBuffer;
  132340. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132341. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132342. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132343. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132344. /**
  132345. * Draw a list of indexed primitives
  132346. * @param fillMode defines the primitive to use
  132347. * @param indexStart defines the starting index
  132348. * @param indexCount defines the number of index to draw
  132349. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132350. */
  132351. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132352. /**
  132353. * Draw a list of unindexed primitives
  132354. * @param fillMode defines the primitive to use
  132355. * @param verticesStart defines the index of first vertex to draw
  132356. * @param verticesCount defines the count of vertices to draw
  132357. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132358. */
  132359. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132360. createPipelineContext(): IPipelineContext;
  132361. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132362. /** @hidden */
  132363. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132364. /** @hidden */
  132365. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132366. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132367. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132368. protected _setProgram(program: WebGLProgram): void;
  132369. _releaseEffect(effect: Effect): void;
  132370. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132371. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132372. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132373. bindSamplers(effect: Effect): void;
  132374. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132375. getRenderWidth(useScreen?: boolean): number;
  132376. getRenderHeight(useScreen?: boolean): number;
  132377. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132378. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132379. /**
  132380. * Set the z offset to apply to current rendering
  132381. * @param value defines the offset to apply
  132382. */
  132383. setZOffset(value: number): void;
  132384. /**
  132385. * Gets the current value of the zOffset
  132386. * @returns the current zOffset state
  132387. */
  132388. getZOffset(): number;
  132389. /**
  132390. * Enable or disable depth buffering
  132391. * @param enable defines the state to set
  132392. */
  132393. setDepthBuffer(enable: boolean): void;
  132394. /**
  132395. * Gets a boolean indicating if depth writing is enabled
  132396. * @returns the current depth writing state
  132397. */
  132398. getDepthWrite(): boolean;
  132399. /**
  132400. * Enable or disable depth writing
  132401. * @param enable defines the state to set
  132402. */
  132403. setDepthWrite(enable: boolean): void;
  132404. /**
  132405. * Enable or disable color writing
  132406. * @param enable defines the state to set
  132407. */
  132408. setColorWrite(enable: boolean): void;
  132409. /**
  132410. * Gets a boolean indicating if color writing is enabled
  132411. * @returns the current color writing state
  132412. */
  132413. getColorWrite(): boolean;
  132414. /**
  132415. * Sets alpha constants used by some alpha blending modes
  132416. * @param r defines the red component
  132417. * @param g defines the green component
  132418. * @param b defines the blue component
  132419. * @param a defines the alpha component
  132420. */
  132421. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132422. /**
  132423. * Sets the current alpha mode
  132424. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132425. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132426. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132427. */
  132428. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132429. /**
  132430. * Gets the current alpha mode
  132431. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132432. * @returns the current alpha mode
  132433. */
  132434. getAlphaMode(): number;
  132435. setInt(uniform: WebGLUniformLocation, int: number): void;
  132436. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132437. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132438. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132439. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132440. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132441. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132442. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132443. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132444. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132445. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132446. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132447. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132448. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132449. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132450. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132451. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132452. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132453. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132454. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132455. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132456. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132457. wipeCaches(bruteForce?: boolean): void;
  132458. _createTexture(): WebGLTexture;
  132459. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132460. /**
  132461. * Usually called from Texture.ts.
  132462. * Passed information to create a WebGLTexture
  132463. * @param url defines a value which contains one of the following:
  132464. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132465. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132466. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132467. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132468. * @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)
  132469. * @param scene needed for loading to the correct scene
  132470. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132471. * @param onLoad optional callback to be called upon successful completion
  132472. * @param onError optional callback to be called upon failure
  132473. * @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
  132474. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132475. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132476. * @param forcedExtension defines the extension to use to pick the right loader
  132477. * @param mimeType defines an optional mime type
  132478. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132479. */
  132480. 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;
  132481. /**
  132482. * Creates a cube texture
  132483. * @param rootUrl defines the url where the files to load is located
  132484. * @param scene defines the current scene
  132485. * @param files defines the list of files to load (1 per face)
  132486. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132487. * @param onLoad defines an optional callback raised when the texture is loaded
  132488. * @param onError defines an optional callback raised if there is an issue to load the texture
  132489. * @param format defines the format of the data
  132490. * @param forcedExtension defines the extension to use to pick the right loader
  132491. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132492. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132493. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132494. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132495. * @returns the cube texture as an InternalTexture
  132496. */
  132497. 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;
  132498. private _getSamplingFilter;
  132499. private static _GetNativeTextureFormat;
  132500. createRenderTargetTexture(size: number | {
  132501. width: number;
  132502. height: number;
  132503. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132504. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132505. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132506. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132507. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132508. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132509. /**
  132510. * Updates a dynamic vertex buffer.
  132511. * @param vertexBuffer the vertex buffer to update
  132512. * @param data the data used to update the vertex buffer
  132513. * @param byteOffset the byte offset of the data (optional)
  132514. * @param byteLength the byte length of the data (optional)
  132515. */
  132516. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132517. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132518. private _updateAnisotropicLevel;
  132519. private _getAddressMode;
  132520. /** @hidden */
  132521. _bindTexture(channel: number, texture: InternalTexture): void;
  132522. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132523. releaseEffects(): void;
  132524. /** @hidden */
  132525. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132526. /** @hidden */
  132527. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132528. /** @hidden */
  132529. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132530. /** @hidden */
  132531. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132532. }
  132533. }
  132534. declare module BABYLON {
  132535. /**
  132536. * Gather the list of clipboard event types as constants.
  132537. */
  132538. export class ClipboardEventTypes {
  132539. /**
  132540. * The clipboard event is fired when a copy command is active (pressed).
  132541. */
  132542. static readonly COPY: number;
  132543. /**
  132544. * The clipboard event is fired when a cut command is active (pressed).
  132545. */
  132546. static readonly CUT: number;
  132547. /**
  132548. * The clipboard event is fired when a paste command is active (pressed).
  132549. */
  132550. static readonly PASTE: number;
  132551. }
  132552. /**
  132553. * This class is used to store clipboard related info for the onClipboardObservable event.
  132554. */
  132555. export class ClipboardInfo {
  132556. /**
  132557. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132558. */
  132559. type: number;
  132560. /**
  132561. * Defines the related dom event
  132562. */
  132563. event: ClipboardEvent;
  132564. /**
  132565. *Creates an instance of ClipboardInfo.
  132566. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132567. * @param event Defines the related dom event
  132568. */
  132569. constructor(
  132570. /**
  132571. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132572. */
  132573. type: number,
  132574. /**
  132575. * Defines the related dom event
  132576. */
  132577. event: ClipboardEvent);
  132578. /**
  132579. * Get the clipboard event's type from the keycode.
  132580. * @param keyCode Defines the keyCode for the current keyboard event.
  132581. * @return {number}
  132582. */
  132583. static GetTypeFromCharacter(keyCode: number): number;
  132584. }
  132585. }
  132586. declare module BABYLON {
  132587. /**
  132588. * Google Daydream controller
  132589. */
  132590. export class DaydreamController extends WebVRController {
  132591. /**
  132592. * Base Url for the controller model.
  132593. */
  132594. static MODEL_BASE_URL: string;
  132595. /**
  132596. * File name for the controller model.
  132597. */
  132598. static MODEL_FILENAME: string;
  132599. /**
  132600. * Gamepad Id prefix used to identify Daydream Controller.
  132601. */
  132602. static readonly GAMEPAD_ID_PREFIX: string;
  132603. /**
  132604. * Creates a new DaydreamController from a gamepad
  132605. * @param vrGamepad the gamepad that the controller should be created from
  132606. */
  132607. constructor(vrGamepad: any);
  132608. /**
  132609. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132610. * @param scene scene in which to add meshes
  132611. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132612. */
  132613. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132614. /**
  132615. * Called once for each button that changed state since the last frame
  132616. * @param buttonIdx Which button index changed
  132617. * @param state New state of the button
  132618. * @param changes Which properties on the state changed since last frame
  132619. */
  132620. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132621. }
  132622. }
  132623. declare module BABYLON {
  132624. /**
  132625. * Gear VR Controller
  132626. */
  132627. export class GearVRController extends WebVRController {
  132628. /**
  132629. * Base Url for the controller model.
  132630. */
  132631. static MODEL_BASE_URL: string;
  132632. /**
  132633. * File name for the controller model.
  132634. */
  132635. static MODEL_FILENAME: string;
  132636. /**
  132637. * Gamepad Id prefix used to identify this controller.
  132638. */
  132639. static readonly GAMEPAD_ID_PREFIX: string;
  132640. private readonly _buttonIndexToObservableNameMap;
  132641. /**
  132642. * Creates a new GearVRController from a gamepad
  132643. * @param vrGamepad the gamepad that the controller should be created from
  132644. */
  132645. constructor(vrGamepad: any);
  132646. /**
  132647. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132648. * @param scene scene in which to add meshes
  132649. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132650. */
  132651. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132652. /**
  132653. * Called once for each button that changed state since the last frame
  132654. * @param buttonIdx Which button index changed
  132655. * @param state New state of the button
  132656. * @param changes Which properties on the state changed since last frame
  132657. */
  132658. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132659. }
  132660. }
  132661. declare module BABYLON {
  132662. /**
  132663. * Generic Controller
  132664. */
  132665. export class GenericController extends WebVRController {
  132666. /**
  132667. * Base Url for the controller model.
  132668. */
  132669. static readonly MODEL_BASE_URL: string;
  132670. /**
  132671. * File name for the controller model.
  132672. */
  132673. static readonly MODEL_FILENAME: string;
  132674. /**
  132675. * Creates a new GenericController from a gamepad
  132676. * @param vrGamepad the gamepad that the controller should be created from
  132677. */
  132678. constructor(vrGamepad: any);
  132679. /**
  132680. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132681. * @param scene scene in which to add meshes
  132682. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132683. */
  132684. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132685. /**
  132686. * Called once for each button that changed state since the last frame
  132687. * @param buttonIdx Which button index changed
  132688. * @param state New state of the button
  132689. * @param changes Which properties on the state changed since last frame
  132690. */
  132691. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132692. }
  132693. }
  132694. declare module BABYLON {
  132695. /**
  132696. * Oculus Touch Controller
  132697. */
  132698. export class OculusTouchController extends WebVRController {
  132699. /**
  132700. * Base Url for the controller model.
  132701. */
  132702. static MODEL_BASE_URL: string;
  132703. /**
  132704. * File name for the left controller model.
  132705. */
  132706. static MODEL_LEFT_FILENAME: string;
  132707. /**
  132708. * File name for the right controller model.
  132709. */
  132710. static MODEL_RIGHT_FILENAME: string;
  132711. /**
  132712. * Base Url for the Quest controller model.
  132713. */
  132714. static QUEST_MODEL_BASE_URL: string;
  132715. /**
  132716. * @hidden
  132717. * If the controllers are running on a device that needs the updated Quest controller models
  132718. */
  132719. static _IsQuest: boolean;
  132720. /**
  132721. * Fired when the secondary trigger on this controller is modified
  132722. */
  132723. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132724. /**
  132725. * Fired when the thumb rest on this controller is modified
  132726. */
  132727. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132728. /**
  132729. * Creates a new OculusTouchController from a gamepad
  132730. * @param vrGamepad the gamepad that the controller should be created from
  132731. */
  132732. constructor(vrGamepad: any);
  132733. /**
  132734. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132735. * @param scene scene in which to add meshes
  132736. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132737. */
  132738. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132739. /**
  132740. * Fired when the A button on this controller is modified
  132741. */
  132742. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132743. /**
  132744. * Fired when the B button on this controller is modified
  132745. */
  132746. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132747. /**
  132748. * Fired when the X button on this controller is modified
  132749. */
  132750. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132751. /**
  132752. * Fired when the Y button on this controller is modified
  132753. */
  132754. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132755. /**
  132756. * Called once for each button that changed state since the last frame
  132757. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132758. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132759. * 2) secondary trigger (same)
  132760. * 3) A (right) X (left), touch, pressed = value
  132761. * 4) B / Y
  132762. * 5) thumb rest
  132763. * @param buttonIdx Which button index changed
  132764. * @param state New state of the button
  132765. * @param changes Which properties on the state changed since last frame
  132766. */
  132767. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132768. }
  132769. }
  132770. declare module BABYLON {
  132771. /**
  132772. * Vive Controller
  132773. */
  132774. export class ViveController extends WebVRController {
  132775. /**
  132776. * Base Url for the controller model.
  132777. */
  132778. static MODEL_BASE_URL: string;
  132779. /**
  132780. * File name for the controller model.
  132781. */
  132782. static MODEL_FILENAME: string;
  132783. /**
  132784. * Creates a new ViveController from a gamepad
  132785. * @param vrGamepad the gamepad that the controller should be created from
  132786. */
  132787. constructor(vrGamepad: any);
  132788. /**
  132789. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132790. * @param scene scene in which to add meshes
  132791. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132792. */
  132793. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132794. /**
  132795. * Fired when the left button on this controller is modified
  132796. */
  132797. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132798. /**
  132799. * Fired when the right button on this controller is modified
  132800. */
  132801. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132802. /**
  132803. * Fired when the menu button on this controller is modified
  132804. */
  132805. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132806. /**
  132807. * Called once for each button that changed state since the last frame
  132808. * Vive mapping:
  132809. * 0: touchpad
  132810. * 1: trigger
  132811. * 2: left AND right buttons
  132812. * 3: menu button
  132813. * @param buttonIdx Which button index changed
  132814. * @param state New state of the button
  132815. * @param changes Which properties on the state changed since last frame
  132816. */
  132817. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132818. }
  132819. }
  132820. declare module BABYLON {
  132821. /**
  132822. * Defines the WindowsMotionController object that the state of the windows motion controller
  132823. */
  132824. export class WindowsMotionController extends WebVRController {
  132825. /**
  132826. * The base url used to load the left and right controller models
  132827. */
  132828. static MODEL_BASE_URL: string;
  132829. /**
  132830. * The name of the left controller model file
  132831. */
  132832. static MODEL_LEFT_FILENAME: string;
  132833. /**
  132834. * The name of the right controller model file
  132835. */
  132836. static MODEL_RIGHT_FILENAME: string;
  132837. /**
  132838. * The controller name prefix for this controller type
  132839. */
  132840. static readonly GAMEPAD_ID_PREFIX: string;
  132841. /**
  132842. * The controller id pattern for this controller type
  132843. */
  132844. private static readonly GAMEPAD_ID_PATTERN;
  132845. private _loadedMeshInfo;
  132846. protected readonly _mapping: {
  132847. buttons: string[];
  132848. buttonMeshNames: {
  132849. trigger: string;
  132850. menu: string;
  132851. grip: string;
  132852. thumbstick: string;
  132853. trackpad: string;
  132854. };
  132855. buttonObservableNames: {
  132856. trigger: string;
  132857. menu: string;
  132858. grip: string;
  132859. thumbstick: string;
  132860. trackpad: string;
  132861. };
  132862. axisMeshNames: string[];
  132863. pointingPoseMeshName: string;
  132864. };
  132865. /**
  132866. * Fired when the trackpad on this controller is clicked
  132867. */
  132868. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132869. /**
  132870. * Fired when the trackpad on this controller is modified
  132871. */
  132872. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132873. /**
  132874. * The current x and y values of this controller's trackpad
  132875. */
  132876. trackpad: StickValues;
  132877. /**
  132878. * Creates a new WindowsMotionController from a gamepad
  132879. * @param vrGamepad the gamepad that the controller should be created from
  132880. */
  132881. constructor(vrGamepad: any);
  132882. /**
  132883. * Fired when the trigger on this controller is modified
  132884. */
  132885. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132886. /**
  132887. * Fired when the menu button on this controller is modified
  132888. */
  132889. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132890. /**
  132891. * Fired when the grip button on this controller is modified
  132892. */
  132893. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132894. /**
  132895. * Fired when the thumbstick button on this controller is modified
  132896. */
  132897. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132898. /**
  132899. * Fired when the touchpad button on this controller is modified
  132900. */
  132901. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132902. /**
  132903. * Fired when the touchpad values on this controller are modified
  132904. */
  132905. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132906. protected _updateTrackpad(): void;
  132907. /**
  132908. * Called once per frame by the engine.
  132909. */
  132910. update(): void;
  132911. /**
  132912. * Called once for each button that changed state since the last frame
  132913. * @param buttonIdx Which button index changed
  132914. * @param state New state of the button
  132915. * @param changes Which properties on the state changed since last frame
  132916. */
  132917. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132918. /**
  132919. * Moves the buttons on the controller mesh based on their current state
  132920. * @param buttonName the name of the button to move
  132921. * @param buttonValue the value of the button which determines the buttons new position
  132922. */
  132923. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132924. /**
  132925. * Moves the axis on the controller mesh based on its current state
  132926. * @param axis the index of the axis
  132927. * @param axisValue the value of the axis which determines the meshes new position
  132928. * @hidden
  132929. */
  132930. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132931. /**
  132932. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132933. * @param scene scene in which to add meshes
  132934. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132935. */
  132936. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132937. /**
  132938. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132939. * can be transformed by button presses and axes values, based on this._mapping.
  132940. *
  132941. * @param scene scene in which the meshes exist
  132942. * @param meshes list of meshes that make up the controller model to process
  132943. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132944. */
  132945. private processModel;
  132946. private createMeshInfo;
  132947. /**
  132948. * Gets the ray of the controller in the direction the controller is pointing
  132949. * @param length the length the resulting ray should be
  132950. * @returns a ray in the direction the controller is pointing
  132951. */
  132952. getForwardRay(length?: number): Ray;
  132953. /**
  132954. * Disposes of the controller
  132955. */
  132956. dispose(): void;
  132957. }
  132958. /**
  132959. * This class represents a new windows motion controller in XR.
  132960. */
  132961. export class XRWindowsMotionController extends WindowsMotionController {
  132962. /**
  132963. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132964. */
  132965. protected readonly _mapping: {
  132966. buttons: string[];
  132967. buttonMeshNames: {
  132968. trigger: string;
  132969. menu: string;
  132970. grip: string;
  132971. thumbstick: string;
  132972. trackpad: string;
  132973. };
  132974. buttonObservableNames: {
  132975. trigger: string;
  132976. menu: string;
  132977. grip: string;
  132978. thumbstick: string;
  132979. trackpad: string;
  132980. };
  132981. axisMeshNames: string[];
  132982. pointingPoseMeshName: string;
  132983. };
  132984. /**
  132985. * Construct a new XR-Based windows motion controller
  132986. *
  132987. * @param gamepadInfo the gamepad object from the browser
  132988. */
  132989. constructor(gamepadInfo: any);
  132990. /**
  132991. * holds the thumbstick values (X,Y)
  132992. */
  132993. thumbstickValues: StickValues;
  132994. /**
  132995. * Fired when the thumbstick on this controller is clicked
  132996. */
  132997. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132998. /**
  132999. * Fired when the thumbstick on this controller is modified
  133000. */
  133001. onThumbstickValuesChangedObservable: Observable<StickValues>;
  133002. /**
  133003. * Fired when the touchpad button on this controller is modified
  133004. */
  133005. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133006. /**
  133007. * Fired when the touchpad values on this controller are modified
  133008. */
  133009. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133010. /**
  133011. * Fired when the thumbstick button on this controller is modified
  133012. * here to prevent breaking changes
  133013. */
  133014. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133015. /**
  133016. * updating the thumbstick(!) and not the trackpad.
  133017. * This is named this way due to the difference between WebVR and XR and to avoid
  133018. * changing the parent class.
  133019. */
  133020. protected _updateTrackpad(): void;
  133021. /**
  133022. * Disposes the class with joy
  133023. */
  133024. dispose(): void;
  133025. }
  133026. }
  133027. declare module BABYLON {
  133028. /**
  133029. * Class containing static functions to help procedurally build meshes
  133030. */
  133031. export class PolyhedronBuilder {
  133032. /**
  133033. * Creates a polyhedron mesh
  133034. * * 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
  133035. * * The parameter `size` (positive float, default 1) sets the polygon size
  133036. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133037. * * 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`
  133038. * * 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
  133039. * * 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)`)
  133040. * * 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
  133041. * * 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
  133042. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133043. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  133044. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133045. * @param name defines the name of the mesh
  133046. * @param options defines the options used to create the mesh
  133047. * @param scene defines the hosting scene
  133048. * @returns the polyhedron mesh
  133049. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133050. */
  133051. static CreatePolyhedron(name: string, options: {
  133052. type?: number;
  133053. size?: number;
  133054. sizeX?: number;
  133055. sizeY?: number;
  133056. sizeZ?: number;
  133057. custom?: any;
  133058. faceUV?: Vector4[];
  133059. faceColors?: Color4[];
  133060. flat?: boolean;
  133061. updatable?: boolean;
  133062. sideOrientation?: number;
  133063. frontUVs?: Vector4;
  133064. backUVs?: Vector4;
  133065. }, scene?: Nullable<Scene>): Mesh;
  133066. }
  133067. }
  133068. declare module BABYLON {
  133069. /**
  133070. * Gizmo that enables scaling a mesh along 3 axis
  133071. */
  133072. export class ScaleGizmo extends Gizmo {
  133073. /**
  133074. * Internal gizmo used for interactions on the x axis
  133075. */
  133076. xGizmo: AxisScaleGizmo;
  133077. /**
  133078. * Internal gizmo used for interactions on the y axis
  133079. */
  133080. yGizmo: AxisScaleGizmo;
  133081. /**
  133082. * Internal gizmo used for interactions on the z axis
  133083. */
  133084. zGizmo: AxisScaleGizmo;
  133085. /**
  133086. * Internal gizmo used to scale all axis equally
  133087. */
  133088. uniformScaleGizmo: AxisScaleGizmo;
  133089. private _meshAttached;
  133090. private _nodeAttached;
  133091. private _snapDistance;
  133092. private _uniformScalingMesh;
  133093. private _octahedron;
  133094. private _sensitivity;
  133095. /** Fires an event when any of it's sub gizmos are dragged */
  133096. onDragStartObservable: Observable<unknown>;
  133097. /** Fires an event when any of it's sub gizmos are released from dragging */
  133098. onDragEndObservable: Observable<unknown>;
  133099. get attachedMesh(): Nullable<AbstractMesh>;
  133100. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133101. get attachedNode(): Nullable<Node>;
  133102. set attachedNode(node: Nullable<Node>);
  133103. /**
  133104. * Creates a ScaleGizmo
  133105. * @param gizmoLayer The utility layer the gizmo will be added to
  133106. * @param thickness display gizmo axis thickness
  133107. */
  133108. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133109. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133110. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133111. /**
  133112. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133113. */
  133114. set snapDistance(value: number);
  133115. get snapDistance(): number;
  133116. /**
  133117. * Ratio for the scale of the gizmo (Default: 1)
  133118. */
  133119. set scaleRatio(value: number);
  133120. get scaleRatio(): number;
  133121. /**
  133122. * Sensitivity factor for dragging (Default: 1)
  133123. */
  133124. set sensitivity(value: number);
  133125. get sensitivity(): number;
  133126. /**
  133127. * Disposes of the gizmo
  133128. */
  133129. dispose(): void;
  133130. }
  133131. }
  133132. declare module BABYLON {
  133133. /**
  133134. * Single axis scale gizmo
  133135. */
  133136. export class AxisScaleGizmo extends Gizmo {
  133137. /**
  133138. * Drag behavior responsible for the gizmos dragging interactions
  133139. */
  133140. dragBehavior: PointerDragBehavior;
  133141. private _pointerObserver;
  133142. /**
  133143. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133144. */
  133145. snapDistance: number;
  133146. /**
  133147. * Event that fires each time the gizmo snaps to a new location.
  133148. * * snapDistance is the the change in distance
  133149. */
  133150. onSnapObservable: Observable<{
  133151. snapDistance: number;
  133152. }>;
  133153. /**
  133154. * If the scaling operation should be done on all axis (default: false)
  133155. */
  133156. uniformScaling: boolean;
  133157. /**
  133158. * Custom sensitivity value for the drag strength
  133159. */
  133160. sensitivity: number;
  133161. private _isEnabled;
  133162. private _parent;
  133163. private _arrow;
  133164. private _coloredMaterial;
  133165. private _hoverMaterial;
  133166. /**
  133167. * Creates an AxisScaleGizmo
  133168. * @param gizmoLayer The utility layer the gizmo will be added to
  133169. * @param dragAxis The axis which the gizmo will be able to scale on
  133170. * @param color The color of the gizmo
  133171. * @param thickness display gizmo axis thickness
  133172. */
  133173. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133174. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133175. /**
  133176. * If the gizmo is enabled
  133177. */
  133178. set isEnabled(value: boolean);
  133179. get isEnabled(): boolean;
  133180. /**
  133181. * Disposes of the gizmo
  133182. */
  133183. dispose(): void;
  133184. /**
  133185. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133186. * @param mesh The mesh to replace the default mesh of the gizmo
  133187. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133188. */
  133189. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133190. }
  133191. }
  133192. declare module BABYLON {
  133193. /**
  133194. * Bounding box gizmo
  133195. */
  133196. export class BoundingBoxGizmo extends Gizmo {
  133197. private _lineBoundingBox;
  133198. private _rotateSpheresParent;
  133199. private _scaleBoxesParent;
  133200. private _boundingDimensions;
  133201. private _renderObserver;
  133202. private _pointerObserver;
  133203. private _scaleDragSpeed;
  133204. private _tmpQuaternion;
  133205. private _tmpVector;
  133206. private _tmpRotationMatrix;
  133207. /**
  133208. * 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)
  133209. */
  133210. ignoreChildren: boolean;
  133211. /**
  133212. * 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)
  133213. */
  133214. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133215. /**
  133216. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133217. */
  133218. rotationSphereSize: number;
  133219. /**
  133220. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133221. */
  133222. scaleBoxSize: number;
  133223. /**
  133224. * 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)
  133225. */
  133226. fixedDragMeshScreenSize: boolean;
  133227. /**
  133228. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133229. */
  133230. fixedDragMeshScreenSizeDistanceFactor: number;
  133231. /**
  133232. * Fired when a rotation sphere or scale box is dragged
  133233. */
  133234. onDragStartObservable: Observable<{}>;
  133235. /**
  133236. * Fired when a scale box is dragged
  133237. */
  133238. onScaleBoxDragObservable: Observable<{}>;
  133239. /**
  133240. * Fired when a scale box drag is ended
  133241. */
  133242. onScaleBoxDragEndObservable: Observable<{}>;
  133243. /**
  133244. * Fired when a rotation sphere is dragged
  133245. */
  133246. onRotationSphereDragObservable: Observable<{}>;
  133247. /**
  133248. * Fired when a rotation sphere drag is ended
  133249. */
  133250. onRotationSphereDragEndObservable: Observable<{}>;
  133251. /**
  133252. * 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)
  133253. */
  133254. scalePivot: Nullable<Vector3>;
  133255. /**
  133256. * Mesh used as a pivot to rotate the attached node
  133257. */
  133258. private _anchorMesh;
  133259. private _existingMeshScale;
  133260. private _dragMesh;
  133261. private pointerDragBehavior;
  133262. private coloredMaterial;
  133263. private hoverColoredMaterial;
  133264. /**
  133265. * Sets the color of the bounding box gizmo
  133266. * @param color the color to set
  133267. */
  133268. setColor(color: Color3): void;
  133269. /**
  133270. * Creates an BoundingBoxGizmo
  133271. * @param gizmoLayer The utility layer the gizmo will be added to
  133272. * @param color The color of the gizmo
  133273. */
  133274. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133275. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133276. private _selectNode;
  133277. /**
  133278. * Updates the bounding box information for the Gizmo
  133279. */
  133280. updateBoundingBox(): void;
  133281. private _updateRotationSpheres;
  133282. private _updateScaleBoxes;
  133283. /**
  133284. * Enables rotation on the specified axis and disables rotation on the others
  133285. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133286. */
  133287. setEnabledRotationAxis(axis: string): void;
  133288. /**
  133289. * Enables/disables scaling
  133290. * @param enable if scaling should be enabled
  133291. * @param homogeneousScaling defines if scaling should only be homogeneous
  133292. */
  133293. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133294. private _updateDummy;
  133295. /**
  133296. * Enables a pointer drag behavior on the bounding box of the gizmo
  133297. */
  133298. enableDragBehavior(): void;
  133299. /**
  133300. * Disposes of the gizmo
  133301. */
  133302. dispose(): void;
  133303. /**
  133304. * 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)
  133305. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133306. * @returns the bounding box mesh with the passed in mesh as a child
  133307. */
  133308. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133309. /**
  133310. * CustomMeshes are not supported by this gizmo
  133311. * @param mesh The mesh to replace the default mesh of the gizmo
  133312. */
  133313. setCustomMesh(mesh: Mesh): void;
  133314. }
  133315. }
  133316. declare module BABYLON {
  133317. /**
  133318. * Single plane rotation gizmo
  133319. */
  133320. export class PlaneRotationGizmo extends Gizmo {
  133321. /**
  133322. * Drag behavior responsible for the gizmos dragging interactions
  133323. */
  133324. dragBehavior: PointerDragBehavior;
  133325. private _pointerObserver;
  133326. /**
  133327. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133328. */
  133329. snapDistance: number;
  133330. /**
  133331. * Event that fires each time the gizmo snaps to a new location.
  133332. * * snapDistance is the the change in distance
  133333. */
  133334. onSnapObservable: Observable<{
  133335. snapDistance: number;
  133336. }>;
  133337. private _isEnabled;
  133338. private _parent;
  133339. /**
  133340. * Creates a PlaneRotationGizmo
  133341. * @param gizmoLayer The utility layer the gizmo will be added to
  133342. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133343. * @param color The color of the gizmo
  133344. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133345. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133346. * @param thickness display gizmo axis thickness
  133347. */
  133348. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133349. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133350. /**
  133351. * If the gizmo is enabled
  133352. */
  133353. set isEnabled(value: boolean);
  133354. get isEnabled(): boolean;
  133355. /**
  133356. * Disposes of the gizmo
  133357. */
  133358. dispose(): void;
  133359. }
  133360. }
  133361. declare module BABYLON {
  133362. /**
  133363. * Gizmo that enables rotating a mesh along 3 axis
  133364. */
  133365. export class RotationGizmo extends Gizmo {
  133366. /**
  133367. * Internal gizmo used for interactions on the x axis
  133368. */
  133369. xGizmo: PlaneRotationGizmo;
  133370. /**
  133371. * Internal gizmo used for interactions on the y axis
  133372. */
  133373. yGizmo: PlaneRotationGizmo;
  133374. /**
  133375. * Internal gizmo used for interactions on the z axis
  133376. */
  133377. zGizmo: PlaneRotationGizmo;
  133378. /** Fires an event when any of it's sub gizmos are dragged */
  133379. onDragStartObservable: Observable<unknown>;
  133380. /** Fires an event when any of it's sub gizmos are released from dragging */
  133381. onDragEndObservable: Observable<unknown>;
  133382. private _meshAttached;
  133383. private _nodeAttached;
  133384. get attachedMesh(): Nullable<AbstractMesh>;
  133385. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133386. get attachedNode(): Nullable<Node>;
  133387. set attachedNode(node: Nullable<Node>);
  133388. /**
  133389. * Creates a RotationGizmo
  133390. * @param gizmoLayer The utility layer the gizmo will be added to
  133391. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133392. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133393. * @param thickness display gizmo axis thickness
  133394. */
  133395. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133396. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133397. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133398. /**
  133399. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133400. */
  133401. set snapDistance(value: number);
  133402. get snapDistance(): number;
  133403. /**
  133404. * Ratio for the scale of the gizmo (Default: 1)
  133405. */
  133406. set scaleRatio(value: number);
  133407. get scaleRatio(): number;
  133408. /**
  133409. * Disposes of the gizmo
  133410. */
  133411. dispose(): void;
  133412. /**
  133413. * CustomMeshes are not supported by this gizmo
  133414. * @param mesh The mesh to replace the default mesh of the gizmo
  133415. */
  133416. setCustomMesh(mesh: Mesh): void;
  133417. }
  133418. }
  133419. declare module BABYLON {
  133420. /**
  133421. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133422. */
  133423. export class GizmoManager implements IDisposable {
  133424. private scene;
  133425. /**
  133426. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133427. */
  133428. gizmos: {
  133429. positionGizmo: Nullable<PositionGizmo>;
  133430. rotationGizmo: Nullable<RotationGizmo>;
  133431. scaleGizmo: Nullable<ScaleGizmo>;
  133432. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133433. };
  133434. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133435. clearGizmoOnEmptyPointerEvent: boolean;
  133436. /** Fires an event when the manager is attached to a mesh */
  133437. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133438. /** Fires an event when the manager is attached to a node */
  133439. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133440. private _gizmosEnabled;
  133441. private _pointerObserver;
  133442. private _attachedMesh;
  133443. private _attachedNode;
  133444. private _boundingBoxColor;
  133445. private _defaultUtilityLayer;
  133446. private _defaultKeepDepthUtilityLayer;
  133447. private _thickness;
  133448. /**
  133449. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133450. */
  133451. boundingBoxDragBehavior: SixDofDragBehavior;
  133452. /**
  133453. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133454. */
  133455. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133456. /**
  133457. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133458. */
  133459. attachableNodes: Nullable<Array<Node>>;
  133460. /**
  133461. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133462. */
  133463. usePointerToAttachGizmos: boolean;
  133464. /**
  133465. * Utility layer that the bounding box gizmo belongs to
  133466. */
  133467. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133468. /**
  133469. * Utility layer that all gizmos besides bounding box belong to
  133470. */
  133471. get utilityLayer(): UtilityLayerRenderer;
  133472. /**
  133473. * Instatiates a gizmo manager
  133474. * @param scene the scene to overlay the gizmos on top of
  133475. * @param thickness display gizmo axis thickness
  133476. */
  133477. constructor(scene: Scene, thickness?: number);
  133478. /**
  133479. * Attaches a set of gizmos to the specified mesh
  133480. * @param mesh The mesh the gizmo's should be attached to
  133481. */
  133482. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133483. /**
  133484. * Attaches a set of gizmos to the specified node
  133485. * @param node The node the gizmo's should be attached to
  133486. */
  133487. attachToNode(node: Nullable<Node>): void;
  133488. /**
  133489. * If the position gizmo is enabled
  133490. */
  133491. set positionGizmoEnabled(value: boolean);
  133492. get positionGizmoEnabled(): boolean;
  133493. /**
  133494. * If the rotation gizmo is enabled
  133495. */
  133496. set rotationGizmoEnabled(value: boolean);
  133497. get rotationGizmoEnabled(): boolean;
  133498. /**
  133499. * If the scale gizmo is enabled
  133500. */
  133501. set scaleGizmoEnabled(value: boolean);
  133502. get scaleGizmoEnabled(): boolean;
  133503. /**
  133504. * If the boundingBox gizmo is enabled
  133505. */
  133506. set boundingBoxGizmoEnabled(value: boolean);
  133507. get boundingBoxGizmoEnabled(): boolean;
  133508. /**
  133509. * Disposes of the gizmo manager
  133510. */
  133511. dispose(): void;
  133512. }
  133513. }
  133514. declare module BABYLON {
  133515. /**
  133516. * A directional light is defined by a direction (what a surprise!).
  133517. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133518. * 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.
  133519. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133520. */
  133521. export class DirectionalLight extends ShadowLight {
  133522. private _shadowFrustumSize;
  133523. /**
  133524. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133525. */
  133526. get shadowFrustumSize(): number;
  133527. /**
  133528. * Specifies a fix frustum size for the shadow generation.
  133529. */
  133530. set shadowFrustumSize(value: number);
  133531. private _shadowOrthoScale;
  133532. /**
  133533. * Gets the shadow projection scale against the optimal computed one.
  133534. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133535. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133536. */
  133537. get shadowOrthoScale(): number;
  133538. /**
  133539. * Sets the shadow projection scale against the optimal computed one.
  133540. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133541. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133542. */
  133543. set shadowOrthoScale(value: number);
  133544. /**
  133545. * Automatically compute the projection matrix to best fit (including all the casters)
  133546. * on each frame.
  133547. */
  133548. autoUpdateExtends: boolean;
  133549. /**
  133550. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133551. * on each frame. autoUpdateExtends must be set to true for this to work
  133552. */
  133553. autoCalcShadowZBounds: boolean;
  133554. private _orthoLeft;
  133555. private _orthoRight;
  133556. private _orthoTop;
  133557. private _orthoBottom;
  133558. /**
  133559. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133560. * The directional light is emitted from everywhere in the given direction.
  133561. * It can cast shadows.
  133562. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133563. * @param name The friendly name of the light
  133564. * @param direction The direction of the light
  133565. * @param scene The scene the light belongs to
  133566. */
  133567. constructor(name: string, direction: Vector3, scene: Scene);
  133568. /**
  133569. * Returns the string "DirectionalLight".
  133570. * @return The class name
  133571. */
  133572. getClassName(): string;
  133573. /**
  133574. * Returns the integer 1.
  133575. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133576. */
  133577. getTypeID(): number;
  133578. /**
  133579. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133580. * Returns the DirectionalLight Shadow projection matrix.
  133581. */
  133582. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133583. /**
  133584. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133585. * Returns the DirectionalLight Shadow projection matrix.
  133586. */
  133587. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133588. /**
  133589. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133590. * Returns the DirectionalLight Shadow projection matrix.
  133591. */
  133592. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133593. protected _buildUniformLayout(): void;
  133594. /**
  133595. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133596. * @param effect The effect to update
  133597. * @param lightIndex The index of the light in the effect to update
  133598. * @returns The directional light
  133599. */
  133600. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133601. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133602. /**
  133603. * Gets the minZ used for shadow according to both the scene and the light.
  133604. *
  133605. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133606. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133607. * @param activeCamera The camera we are returning the min for
  133608. * @returns the depth min z
  133609. */
  133610. getDepthMinZ(activeCamera: Camera): number;
  133611. /**
  133612. * Gets the maxZ used for shadow according to both the scene and the light.
  133613. *
  133614. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133615. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133616. * @param activeCamera The camera we are returning the max for
  133617. * @returns the depth max z
  133618. */
  133619. getDepthMaxZ(activeCamera: Camera): number;
  133620. /**
  133621. * Prepares the list of defines specific to the light type.
  133622. * @param defines the list of defines
  133623. * @param lightIndex defines the index of the light for the effect
  133624. */
  133625. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133626. }
  133627. }
  133628. declare module BABYLON {
  133629. /**
  133630. * Class containing static functions to help procedurally build meshes
  133631. */
  133632. export class HemisphereBuilder {
  133633. /**
  133634. * Creates a hemisphere mesh
  133635. * @param name defines the name of the mesh
  133636. * @param options defines the options used to create the mesh
  133637. * @param scene defines the hosting scene
  133638. * @returns the hemisphere mesh
  133639. */
  133640. static CreateHemisphere(name: string, options: {
  133641. segments?: number;
  133642. diameter?: number;
  133643. sideOrientation?: number;
  133644. }, scene: any): Mesh;
  133645. }
  133646. }
  133647. declare module BABYLON {
  133648. /**
  133649. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133650. * These values define a cone of light starting from the position, emitting toward the direction.
  133651. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133652. * and the exponent defines the speed of the decay of the light with distance (reach).
  133653. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133654. */
  133655. export class SpotLight extends ShadowLight {
  133656. private _angle;
  133657. private _innerAngle;
  133658. private _cosHalfAngle;
  133659. private _lightAngleScale;
  133660. private _lightAngleOffset;
  133661. /**
  133662. * Gets the cone angle of the spot light in Radians.
  133663. */
  133664. get angle(): number;
  133665. /**
  133666. * Sets the cone angle of the spot light in Radians.
  133667. */
  133668. set angle(value: number);
  133669. /**
  133670. * Only used in gltf falloff mode, this defines the angle where
  133671. * the directional falloff will start before cutting at angle which could be seen
  133672. * as outer angle.
  133673. */
  133674. get innerAngle(): number;
  133675. /**
  133676. * Only used in gltf falloff mode, this defines the angle where
  133677. * the directional falloff will start before cutting at angle which could be seen
  133678. * as outer angle.
  133679. */
  133680. set innerAngle(value: number);
  133681. private _shadowAngleScale;
  133682. /**
  133683. * Allows scaling the angle of the light for shadow generation only.
  133684. */
  133685. get shadowAngleScale(): number;
  133686. /**
  133687. * Allows scaling the angle of the light for shadow generation only.
  133688. */
  133689. set shadowAngleScale(value: number);
  133690. /**
  133691. * The light decay speed with the distance from the emission spot.
  133692. */
  133693. exponent: number;
  133694. private _projectionTextureMatrix;
  133695. /**
  133696. * Allows reading the projecton texture
  133697. */
  133698. get projectionTextureMatrix(): Matrix;
  133699. protected _projectionTextureLightNear: number;
  133700. /**
  133701. * Gets the near clip of the Spotlight for texture projection.
  133702. */
  133703. get projectionTextureLightNear(): number;
  133704. /**
  133705. * Sets the near clip of the Spotlight for texture projection.
  133706. */
  133707. set projectionTextureLightNear(value: number);
  133708. protected _projectionTextureLightFar: number;
  133709. /**
  133710. * Gets the far clip of the Spotlight for texture projection.
  133711. */
  133712. get projectionTextureLightFar(): number;
  133713. /**
  133714. * Sets the far clip of the Spotlight for texture projection.
  133715. */
  133716. set projectionTextureLightFar(value: number);
  133717. protected _projectionTextureUpDirection: Vector3;
  133718. /**
  133719. * Gets the Up vector of the Spotlight for texture projection.
  133720. */
  133721. get projectionTextureUpDirection(): Vector3;
  133722. /**
  133723. * Sets the Up vector of the Spotlight for texture projection.
  133724. */
  133725. set projectionTextureUpDirection(value: Vector3);
  133726. private _projectionTexture;
  133727. /**
  133728. * Gets the projection texture of the light.
  133729. */
  133730. get projectionTexture(): Nullable<BaseTexture>;
  133731. /**
  133732. * Sets the projection texture of the light.
  133733. */
  133734. set projectionTexture(value: Nullable<BaseTexture>);
  133735. private _projectionTextureViewLightDirty;
  133736. private _projectionTextureProjectionLightDirty;
  133737. private _projectionTextureDirty;
  133738. private _projectionTextureViewTargetVector;
  133739. private _projectionTextureViewLightMatrix;
  133740. private _projectionTextureProjectionLightMatrix;
  133741. private _projectionTextureScalingMatrix;
  133742. /**
  133743. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133744. * It can cast shadows.
  133745. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133746. * @param name The light friendly name
  133747. * @param position The position of the spot light in the scene
  133748. * @param direction The direction of the light in the scene
  133749. * @param angle The cone angle of the light in Radians
  133750. * @param exponent The light decay speed with the distance from the emission spot
  133751. * @param scene The scene the lights belongs to
  133752. */
  133753. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133754. /**
  133755. * Returns the string "SpotLight".
  133756. * @returns the class name
  133757. */
  133758. getClassName(): string;
  133759. /**
  133760. * Returns the integer 2.
  133761. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133762. */
  133763. getTypeID(): number;
  133764. /**
  133765. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133766. */
  133767. protected _setDirection(value: Vector3): void;
  133768. /**
  133769. * Overrides the position setter to recompute the projection texture view light Matrix.
  133770. */
  133771. protected _setPosition(value: Vector3): void;
  133772. /**
  133773. * 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.
  133774. * Returns the SpotLight.
  133775. */
  133776. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133777. protected _computeProjectionTextureViewLightMatrix(): void;
  133778. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133779. /**
  133780. * Main function for light texture projection matrix computing.
  133781. */
  133782. protected _computeProjectionTextureMatrix(): void;
  133783. protected _buildUniformLayout(): void;
  133784. private _computeAngleValues;
  133785. /**
  133786. * Sets the passed Effect "effect" with the Light textures.
  133787. * @param effect The effect to update
  133788. * @param lightIndex The index of the light in the effect to update
  133789. * @returns The light
  133790. */
  133791. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133792. /**
  133793. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133794. * @param effect The effect to update
  133795. * @param lightIndex The index of the light in the effect to update
  133796. * @returns The spot light
  133797. */
  133798. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133799. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133800. /**
  133801. * Disposes the light and the associated resources.
  133802. */
  133803. dispose(): void;
  133804. /**
  133805. * Prepares the list of defines specific to the light type.
  133806. * @param defines the list of defines
  133807. * @param lightIndex defines the index of the light for the effect
  133808. */
  133809. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133810. }
  133811. }
  133812. declare module BABYLON {
  133813. /**
  133814. * Gizmo that enables viewing a light
  133815. */
  133816. export class LightGizmo extends Gizmo {
  133817. private _lightMesh;
  133818. private _material;
  133819. private _cachedPosition;
  133820. private _cachedForward;
  133821. private _attachedMeshParent;
  133822. /**
  133823. * Creates a LightGizmo
  133824. * @param gizmoLayer The utility layer the gizmo will be added to
  133825. */
  133826. constructor(gizmoLayer?: UtilityLayerRenderer);
  133827. private _light;
  133828. /**
  133829. * The light that the gizmo is attached to
  133830. */
  133831. set light(light: Nullable<Light>);
  133832. get light(): Nullable<Light>;
  133833. /**
  133834. * Gets the material used to render the light gizmo
  133835. */
  133836. get material(): StandardMaterial;
  133837. /**
  133838. * @hidden
  133839. * Updates the gizmo to match the attached mesh's position/rotation
  133840. */
  133841. protected _update(): void;
  133842. private static _Scale;
  133843. /**
  133844. * Creates the lines for a light mesh
  133845. */
  133846. private static _CreateLightLines;
  133847. /**
  133848. * Disposes of the light gizmo
  133849. */
  133850. dispose(): void;
  133851. private static _CreateHemisphericLightMesh;
  133852. private static _CreatePointLightMesh;
  133853. private static _CreateSpotLightMesh;
  133854. private static _CreateDirectionalLightMesh;
  133855. }
  133856. }
  133857. declare module BABYLON {
  133858. /**
  133859. * Gizmo that enables viewing a camera
  133860. */
  133861. export class CameraGizmo extends Gizmo {
  133862. private _cameraMesh;
  133863. private _cameraLinesMesh;
  133864. private _material;
  133865. /**
  133866. * Creates a CameraGizmo
  133867. * @param gizmoLayer The utility layer the gizmo will be added to
  133868. */
  133869. constructor(gizmoLayer?: UtilityLayerRenderer);
  133870. private _camera;
  133871. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133872. get displayFrustum(): boolean;
  133873. set displayFrustum(value: boolean);
  133874. /**
  133875. * The camera that the gizmo is attached to
  133876. */
  133877. set camera(camera: Nullable<Camera>);
  133878. get camera(): Nullable<Camera>;
  133879. /**
  133880. * Gets the material used to render the camera gizmo
  133881. */
  133882. get material(): StandardMaterial;
  133883. /**
  133884. * @hidden
  133885. * Updates the gizmo to match the attached mesh's position/rotation
  133886. */
  133887. protected _update(): void;
  133888. private static _Scale;
  133889. private _invProjection;
  133890. /**
  133891. * Disposes of the camera gizmo
  133892. */
  133893. dispose(): void;
  133894. private static _CreateCameraMesh;
  133895. private static _CreateCameraFrustum;
  133896. }
  133897. }
  133898. declare module BABYLON {
  133899. /** @hidden */
  133900. export var backgroundFragmentDeclaration: {
  133901. name: string;
  133902. shader: string;
  133903. };
  133904. }
  133905. declare module BABYLON {
  133906. /** @hidden */
  133907. export var backgroundUboDeclaration: {
  133908. name: string;
  133909. shader: string;
  133910. };
  133911. }
  133912. declare module BABYLON {
  133913. /** @hidden */
  133914. export var backgroundPixelShader: {
  133915. name: string;
  133916. shader: string;
  133917. };
  133918. }
  133919. declare module BABYLON {
  133920. /** @hidden */
  133921. export var backgroundVertexDeclaration: {
  133922. name: string;
  133923. shader: string;
  133924. };
  133925. }
  133926. declare module BABYLON {
  133927. /** @hidden */
  133928. export var backgroundVertexShader: {
  133929. name: string;
  133930. shader: string;
  133931. };
  133932. }
  133933. declare module BABYLON {
  133934. /**
  133935. * Background material used to create an efficient environement around your scene.
  133936. */
  133937. export class BackgroundMaterial extends PushMaterial {
  133938. /**
  133939. * Standard reflectance value at parallel view angle.
  133940. */
  133941. static StandardReflectance0: number;
  133942. /**
  133943. * Standard reflectance value at grazing angle.
  133944. */
  133945. static StandardReflectance90: number;
  133946. protected _primaryColor: Color3;
  133947. /**
  133948. * Key light Color (multiply against the environement texture)
  133949. */
  133950. primaryColor: Color3;
  133951. protected __perceptualColor: Nullable<Color3>;
  133952. /**
  133953. * Experimental Internal Use Only.
  133954. *
  133955. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133956. * This acts as a helper to set the primary color to a more "human friendly" value.
  133957. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133958. * output color as close as possible from the chosen value.
  133959. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133960. * part of lighting setup.)
  133961. */
  133962. get _perceptualColor(): Nullable<Color3>;
  133963. set _perceptualColor(value: Nullable<Color3>);
  133964. protected _primaryColorShadowLevel: float;
  133965. /**
  133966. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133967. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133968. */
  133969. get primaryColorShadowLevel(): float;
  133970. set primaryColorShadowLevel(value: float);
  133971. protected _primaryColorHighlightLevel: float;
  133972. /**
  133973. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133974. * The primary color is used at the level chosen to define what the white area would look.
  133975. */
  133976. get primaryColorHighlightLevel(): float;
  133977. set primaryColorHighlightLevel(value: float);
  133978. protected _reflectionTexture: Nullable<BaseTexture>;
  133979. /**
  133980. * Reflection Texture used in the material.
  133981. * Should be author in a specific way for the best result (refer to the documentation).
  133982. */
  133983. reflectionTexture: Nullable<BaseTexture>;
  133984. protected _reflectionBlur: float;
  133985. /**
  133986. * Reflection Texture level of blur.
  133987. *
  133988. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133989. * texture twice.
  133990. */
  133991. reflectionBlur: float;
  133992. protected _diffuseTexture: Nullable<BaseTexture>;
  133993. /**
  133994. * Diffuse Texture used in the material.
  133995. * Should be author in a specific way for the best result (refer to the documentation).
  133996. */
  133997. diffuseTexture: Nullable<BaseTexture>;
  133998. protected _shadowLights: Nullable<IShadowLight[]>;
  133999. /**
  134000. * Specify the list of lights casting shadow on the material.
  134001. * All scene shadow lights will be included if null.
  134002. */
  134003. shadowLights: Nullable<IShadowLight[]>;
  134004. protected _shadowLevel: float;
  134005. /**
  134006. * Helps adjusting the shadow to a softer level if required.
  134007. * 0 means black shadows and 1 means no shadows.
  134008. */
  134009. shadowLevel: float;
  134010. protected _sceneCenter: Vector3;
  134011. /**
  134012. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  134013. * It is usually zero but might be interesting to modify according to your setup.
  134014. */
  134015. sceneCenter: Vector3;
  134016. protected _opacityFresnel: boolean;
  134017. /**
  134018. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134019. * This helps ensuring a nice transition when the camera goes under the ground.
  134020. */
  134021. opacityFresnel: boolean;
  134022. protected _reflectionFresnel: boolean;
  134023. /**
  134024. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134025. * This helps adding a mirror texture on the ground.
  134026. */
  134027. reflectionFresnel: boolean;
  134028. protected _reflectionFalloffDistance: number;
  134029. /**
  134030. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134031. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134032. */
  134033. reflectionFalloffDistance: number;
  134034. protected _reflectionAmount: number;
  134035. /**
  134036. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134037. */
  134038. reflectionAmount: number;
  134039. protected _reflectionReflectance0: number;
  134040. /**
  134041. * This specifies the weight of the reflection at grazing angle.
  134042. */
  134043. reflectionReflectance0: number;
  134044. protected _reflectionReflectance90: number;
  134045. /**
  134046. * This specifies the weight of the reflection at a perpendicular point of view.
  134047. */
  134048. reflectionReflectance90: number;
  134049. /**
  134050. * Sets the reflection reflectance fresnel values according to the default standard
  134051. * empirically know to work well :-)
  134052. */
  134053. set reflectionStandardFresnelWeight(value: number);
  134054. protected _useRGBColor: boolean;
  134055. /**
  134056. * Helps to directly use the maps channels instead of their level.
  134057. */
  134058. useRGBColor: boolean;
  134059. protected _enableNoise: boolean;
  134060. /**
  134061. * This helps reducing the banding effect that could occur on the background.
  134062. */
  134063. enableNoise: boolean;
  134064. /**
  134065. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134066. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134067. * Recommended to be keep at 1.0 except for special cases.
  134068. */
  134069. get fovMultiplier(): number;
  134070. set fovMultiplier(value: number);
  134071. private _fovMultiplier;
  134072. /**
  134073. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134074. */
  134075. useEquirectangularFOV: boolean;
  134076. private _maxSimultaneousLights;
  134077. /**
  134078. * Number of Simultaneous lights allowed on the material.
  134079. */
  134080. maxSimultaneousLights: int;
  134081. private _shadowOnly;
  134082. /**
  134083. * Make the material only render shadows
  134084. */
  134085. shadowOnly: boolean;
  134086. /**
  134087. * Default configuration related to image processing available in the Background Material.
  134088. */
  134089. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134090. /**
  134091. * Keep track of the image processing observer to allow dispose and replace.
  134092. */
  134093. private _imageProcessingObserver;
  134094. /**
  134095. * Attaches a new image processing configuration to the PBR Material.
  134096. * @param configuration (if null the scene configuration will be use)
  134097. */
  134098. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134099. /**
  134100. * Gets the image processing configuration used either in this material.
  134101. */
  134102. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134103. /**
  134104. * Sets the Default image processing configuration used either in the this material.
  134105. *
  134106. * If sets to null, the scene one is in use.
  134107. */
  134108. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134109. /**
  134110. * Gets wether the color curves effect is enabled.
  134111. */
  134112. get cameraColorCurvesEnabled(): boolean;
  134113. /**
  134114. * Sets wether the color curves effect is enabled.
  134115. */
  134116. set cameraColorCurvesEnabled(value: boolean);
  134117. /**
  134118. * Gets wether the color grading effect is enabled.
  134119. */
  134120. get cameraColorGradingEnabled(): boolean;
  134121. /**
  134122. * Gets wether the color grading effect is enabled.
  134123. */
  134124. set cameraColorGradingEnabled(value: boolean);
  134125. /**
  134126. * Gets wether tonemapping is enabled or not.
  134127. */
  134128. get cameraToneMappingEnabled(): boolean;
  134129. /**
  134130. * Sets wether tonemapping is enabled or not
  134131. */
  134132. set cameraToneMappingEnabled(value: boolean);
  134133. /**
  134134. * The camera exposure used on this material.
  134135. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134136. * This corresponds to a photographic exposure.
  134137. */
  134138. get cameraExposure(): float;
  134139. /**
  134140. * The camera exposure used on this material.
  134141. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134142. * This corresponds to a photographic exposure.
  134143. */
  134144. set cameraExposure(value: float);
  134145. /**
  134146. * Gets The camera contrast used on this material.
  134147. */
  134148. get cameraContrast(): float;
  134149. /**
  134150. * Sets The camera contrast used on this material.
  134151. */
  134152. set cameraContrast(value: float);
  134153. /**
  134154. * Gets the Color Grading 2D Lookup Texture.
  134155. */
  134156. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134157. /**
  134158. * Sets the Color Grading 2D Lookup Texture.
  134159. */
  134160. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134161. /**
  134162. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134163. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134164. * 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;
  134165. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134166. */
  134167. get cameraColorCurves(): Nullable<ColorCurves>;
  134168. /**
  134169. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134170. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134171. * 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;
  134172. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134173. */
  134174. set cameraColorCurves(value: Nullable<ColorCurves>);
  134175. /**
  134176. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134177. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134178. */
  134179. switchToBGR: boolean;
  134180. private _renderTargets;
  134181. private _reflectionControls;
  134182. private _white;
  134183. private _primaryShadowColor;
  134184. private _primaryHighlightColor;
  134185. /**
  134186. * Instantiates a Background Material in the given scene
  134187. * @param name The friendly name of the material
  134188. * @param scene The scene to add the material to
  134189. */
  134190. constructor(name: string, scene: Scene);
  134191. /**
  134192. * Gets a boolean indicating that current material needs to register RTT
  134193. */
  134194. get hasRenderTargetTextures(): boolean;
  134195. /**
  134196. * The entire material has been created in order to prevent overdraw.
  134197. * @returns false
  134198. */
  134199. needAlphaTesting(): boolean;
  134200. /**
  134201. * The entire material has been created in order to prevent overdraw.
  134202. * @returns true if blending is enable
  134203. */
  134204. needAlphaBlending(): boolean;
  134205. /**
  134206. * Checks wether the material is ready to be rendered for a given mesh.
  134207. * @param mesh The mesh to render
  134208. * @param subMesh The submesh to check against
  134209. * @param useInstances Specify wether or not the material is used with instances
  134210. * @returns true if all the dependencies are ready (Textures, Effects...)
  134211. */
  134212. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134213. /**
  134214. * Compute the primary color according to the chosen perceptual color.
  134215. */
  134216. private _computePrimaryColorFromPerceptualColor;
  134217. /**
  134218. * Compute the highlights and shadow colors according to their chosen levels.
  134219. */
  134220. private _computePrimaryColors;
  134221. /**
  134222. * Build the uniform buffer used in the material.
  134223. */
  134224. buildUniformLayout(): void;
  134225. /**
  134226. * Unbind the material.
  134227. */
  134228. unbind(): void;
  134229. /**
  134230. * Bind only the world matrix to the material.
  134231. * @param world The world matrix to bind.
  134232. */
  134233. bindOnlyWorldMatrix(world: Matrix): void;
  134234. /**
  134235. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134236. * @param world The world matrix to bind.
  134237. * @param subMesh The submesh to bind for.
  134238. */
  134239. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134240. /**
  134241. * Checks to see if a texture is used in the material.
  134242. * @param texture - Base texture to use.
  134243. * @returns - Boolean specifying if a texture is used in the material.
  134244. */
  134245. hasTexture(texture: BaseTexture): boolean;
  134246. /**
  134247. * Dispose the material.
  134248. * @param forceDisposeEffect Force disposal of the associated effect.
  134249. * @param forceDisposeTextures Force disposal of the associated textures.
  134250. */
  134251. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134252. /**
  134253. * Clones the material.
  134254. * @param name The cloned name.
  134255. * @returns The cloned material.
  134256. */
  134257. clone(name: string): BackgroundMaterial;
  134258. /**
  134259. * Serializes the current material to its JSON representation.
  134260. * @returns The JSON representation.
  134261. */
  134262. serialize(): any;
  134263. /**
  134264. * Gets the class name of the material
  134265. * @returns "BackgroundMaterial"
  134266. */
  134267. getClassName(): string;
  134268. /**
  134269. * Parse a JSON input to create back a background material.
  134270. * @param source The JSON data to parse
  134271. * @param scene The scene to create the parsed material in
  134272. * @param rootUrl The root url of the assets the material depends upon
  134273. * @returns the instantiated BackgroundMaterial.
  134274. */
  134275. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134276. }
  134277. }
  134278. declare module BABYLON {
  134279. /**
  134280. * Represents the different options available during the creation of
  134281. * a Environment helper.
  134282. *
  134283. * This can control the default ground, skybox and image processing setup of your scene.
  134284. */
  134285. export interface IEnvironmentHelperOptions {
  134286. /**
  134287. * Specifies whether or not to create a ground.
  134288. * True by default.
  134289. */
  134290. createGround: boolean;
  134291. /**
  134292. * Specifies the ground size.
  134293. * 15 by default.
  134294. */
  134295. groundSize: number;
  134296. /**
  134297. * The texture used on the ground for the main color.
  134298. * Comes from the BabylonJS CDN by default.
  134299. *
  134300. * Remarks: Can be either a texture or a url.
  134301. */
  134302. groundTexture: string | BaseTexture;
  134303. /**
  134304. * The color mixed in the ground texture by default.
  134305. * BabylonJS clearColor by default.
  134306. */
  134307. groundColor: Color3;
  134308. /**
  134309. * Specifies the ground opacity.
  134310. * 1 by default.
  134311. */
  134312. groundOpacity: number;
  134313. /**
  134314. * Enables the ground to receive shadows.
  134315. * True by default.
  134316. */
  134317. enableGroundShadow: boolean;
  134318. /**
  134319. * Helps preventing the shadow to be fully black on the ground.
  134320. * 0.5 by default.
  134321. */
  134322. groundShadowLevel: number;
  134323. /**
  134324. * Creates a mirror texture attach to the ground.
  134325. * false by default.
  134326. */
  134327. enableGroundMirror: boolean;
  134328. /**
  134329. * Specifies the ground mirror size ratio.
  134330. * 0.3 by default as the default kernel is 64.
  134331. */
  134332. groundMirrorSizeRatio: number;
  134333. /**
  134334. * Specifies the ground mirror blur kernel size.
  134335. * 64 by default.
  134336. */
  134337. groundMirrorBlurKernel: number;
  134338. /**
  134339. * Specifies the ground mirror visibility amount.
  134340. * 1 by default
  134341. */
  134342. groundMirrorAmount: number;
  134343. /**
  134344. * Specifies the ground mirror reflectance weight.
  134345. * This uses the standard weight of the background material to setup the fresnel effect
  134346. * of the mirror.
  134347. * 1 by default.
  134348. */
  134349. groundMirrorFresnelWeight: number;
  134350. /**
  134351. * Specifies the ground mirror Falloff distance.
  134352. * This can helps reducing the size of the reflection.
  134353. * 0 by Default.
  134354. */
  134355. groundMirrorFallOffDistance: number;
  134356. /**
  134357. * Specifies the ground mirror texture type.
  134358. * Unsigned Int by Default.
  134359. */
  134360. groundMirrorTextureType: number;
  134361. /**
  134362. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134363. * the shown objects.
  134364. */
  134365. groundYBias: number;
  134366. /**
  134367. * Specifies whether or not to create a skybox.
  134368. * True by default.
  134369. */
  134370. createSkybox: boolean;
  134371. /**
  134372. * Specifies the skybox size.
  134373. * 20 by default.
  134374. */
  134375. skyboxSize: number;
  134376. /**
  134377. * The texture used on the skybox for the main color.
  134378. * Comes from the BabylonJS CDN by default.
  134379. *
  134380. * Remarks: Can be either a texture or a url.
  134381. */
  134382. skyboxTexture: string | BaseTexture;
  134383. /**
  134384. * The color mixed in the skybox texture by default.
  134385. * BabylonJS clearColor by default.
  134386. */
  134387. skyboxColor: Color3;
  134388. /**
  134389. * The background rotation around the Y axis of the scene.
  134390. * This helps aligning the key lights of your scene with the background.
  134391. * 0 by default.
  134392. */
  134393. backgroundYRotation: number;
  134394. /**
  134395. * Compute automatically the size of the elements to best fit with the scene.
  134396. */
  134397. sizeAuto: boolean;
  134398. /**
  134399. * Default position of the rootMesh if autoSize is not true.
  134400. */
  134401. rootPosition: Vector3;
  134402. /**
  134403. * Sets up the image processing in the scene.
  134404. * true by default.
  134405. */
  134406. setupImageProcessing: boolean;
  134407. /**
  134408. * The texture used as your environment texture in the scene.
  134409. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134410. *
  134411. * Remarks: Can be either a texture or a url.
  134412. */
  134413. environmentTexture: string | BaseTexture;
  134414. /**
  134415. * The value of the exposure to apply to the scene.
  134416. * 0.6 by default if setupImageProcessing is true.
  134417. */
  134418. cameraExposure: number;
  134419. /**
  134420. * The value of the contrast to apply to the scene.
  134421. * 1.6 by default if setupImageProcessing is true.
  134422. */
  134423. cameraContrast: number;
  134424. /**
  134425. * Specifies whether or not tonemapping should be enabled in the scene.
  134426. * true by default if setupImageProcessing is true.
  134427. */
  134428. toneMappingEnabled: boolean;
  134429. }
  134430. /**
  134431. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134432. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134433. * It also helps with the default setup of your imageProcessing configuration.
  134434. */
  134435. export class EnvironmentHelper {
  134436. /**
  134437. * Default ground texture URL.
  134438. */
  134439. private static _groundTextureCDNUrl;
  134440. /**
  134441. * Default skybox texture URL.
  134442. */
  134443. private static _skyboxTextureCDNUrl;
  134444. /**
  134445. * Default environment texture URL.
  134446. */
  134447. private static _environmentTextureCDNUrl;
  134448. /**
  134449. * Creates the default options for the helper.
  134450. */
  134451. private static _getDefaultOptions;
  134452. private _rootMesh;
  134453. /**
  134454. * Gets the root mesh created by the helper.
  134455. */
  134456. get rootMesh(): Mesh;
  134457. private _skybox;
  134458. /**
  134459. * Gets the skybox created by the helper.
  134460. */
  134461. get skybox(): Nullable<Mesh>;
  134462. private _skyboxTexture;
  134463. /**
  134464. * Gets the skybox texture created by the helper.
  134465. */
  134466. get skyboxTexture(): Nullable<BaseTexture>;
  134467. private _skyboxMaterial;
  134468. /**
  134469. * Gets the skybox material created by the helper.
  134470. */
  134471. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134472. private _ground;
  134473. /**
  134474. * Gets the ground mesh created by the helper.
  134475. */
  134476. get ground(): Nullable<Mesh>;
  134477. private _groundTexture;
  134478. /**
  134479. * Gets the ground texture created by the helper.
  134480. */
  134481. get groundTexture(): Nullable<BaseTexture>;
  134482. private _groundMirror;
  134483. /**
  134484. * Gets the ground mirror created by the helper.
  134485. */
  134486. get groundMirror(): Nullable<MirrorTexture>;
  134487. /**
  134488. * Gets the ground mirror render list to helps pushing the meshes
  134489. * you wish in the ground reflection.
  134490. */
  134491. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134492. private _groundMaterial;
  134493. /**
  134494. * Gets the ground material created by the helper.
  134495. */
  134496. get groundMaterial(): Nullable<BackgroundMaterial>;
  134497. /**
  134498. * Stores the creation options.
  134499. */
  134500. private readonly _scene;
  134501. private _options;
  134502. /**
  134503. * This observable will be notified with any error during the creation of the environment,
  134504. * mainly texture creation errors.
  134505. */
  134506. onErrorObservable: Observable<{
  134507. message?: string;
  134508. exception?: any;
  134509. }>;
  134510. /**
  134511. * constructor
  134512. * @param options Defines the options we want to customize the helper
  134513. * @param scene The scene to add the material to
  134514. */
  134515. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134516. /**
  134517. * Updates the background according to the new options
  134518. * @param options
  134519. */
  134520. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134521. /**
  134522. * Sets the primary color of all the available elements.
  134523. * @param color the main color to affect to the ground and the background
  134524. */
  134525. setMainColor(color: Color3): void;
  134526. /**
  134527. * Setup the image processing according to the specified options.
  134528. */
  134529. private _setupImageProcessing;
  134530. /**
  134531. * Setup the environment texture according to the specified options.
  134532. */
  134533. private _setupEnvironmentTexture;
  134534. /**
  134535. * Setup the background according to the specified options.
  134536. */
  134537. private _setupBackground;
  134538. /**
  134539. * Get the scene sizes according to the setup.
  134540. */
  134541. private _getSceneSize;
  134542. /**
  134543. * Setup the ground according to the specified options.
  134544. */
  134545. private _setupGround;
  134546. /**
  134547. * Setup the ground material according to the specified options.
  134548. */
  134549. private _setupGroundMaterial;
  134550. /**
  134551. * Setup the ground diffuse texture according to the specified options.
  134552. */
  134553. private _setupGroundDiffuseTexture;
  134554. /**
  134555. * Setup the ground mirror texture according to the specified options.
  134556. */
  134557. private _setupGroundMirrorTexture;
  134558. /**
  134559. * Setup the ground to receive the mirror texture.
  134560. */
  134561. private _setupMirrorInGroundMaterial;
  134562. /**
  134563. * Setup the skybox according to the specified options.
  134564. */
  134565. private _setupSkybox;
  134566. /**
  134567. * Setup the skybox material according to the specified options.
  134568. */
  134569. private _setupSkyboxMaterial;
  134570. /**
  134571. * Setup the skybox reflection texture according to the specified options.
  134572. */
  134573. private _setupSkyboxReflectionTexture;
  134574. private _errorHandler;
  134575. /**
  134576. * Dispose all the elements created by the Helper.
  134577. */
  134578. dispose(): void;
  134579. }
  134580. }
  134581. declare module BABYLON {
  134582. /**
  134583. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134584. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134585. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134586. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134587. */
  134588. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134589. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134590. /**
  134591. * Define the source as a Monoscopic panoramic 360/180.
  134592. */
  134593. static readonly MODE_MONOSCOPIC: number;
  134594. /**
  134595. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134596. */
  134597. static readonly MODE_TOPBOTTOM: number;
  134598. /**
  134599. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134600. */
  134601. static readonly MODE_SIDEBYSIDE: number;
  134602. private _halfDome;
  134603. protected _useDirectMapping: boolean;
  134604. /**
  134605. * The texture being displayed on the sphere
  134606. */
  134607. protected _texture: T;
  134608. /**
  134609. * Gets the texture being displayed on the sphere
  134610. */
  134611. get texture(): T;
  134612. /**
  134613. * Sets the texture being displayed on the sphere
  134614. */
  134615. set texture(newTexture: T);
  134616. /**
  134617. * The skybox material
  134618. */
  134619. protected _material: BackgroundMaterial;
  134620. /**
  134621. * The surface used for the dome
  134622. */
  134623. protected _mesh: Mesh;
  134624. /**
  134625. * Gets the mesh used for the dome.
  134626. */
  134627. get mesh(): Mesh;
  134628. /**
  134629. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134630. */
  134631. private _halfDomeMask;
  134632. /**
  134633. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134634. * Also see the options.resolution property.
  134635. */
  134636. get fovMultiplier(): number;
  134637. set fovMultiplier(value: number);
  134638. protected _textureMode: number;
  134639. /**
  134640. * Gets or set the current texture mode for the texture. It can be:
  134641. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134642. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134643. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134644. */
  134645. get textureMode(): number;
  134646. /**
  134647. * Sets the current texture mode for the texture. It can be:
  134648. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134649. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134650. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134651. */
  134652. set textureMode(value: number);
  134653. /**
  134654. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134655. */
  134656. get halfDome(): boolean;
  134657. /**
  134658. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134659. */
  134660. set halfDome(enabled: boolean);
  134661. /**
  134662. * Oberserver used in Stereoscopic VR Mode.
  134663. */
  134664. private _onBeforeCameraRenderObserver;
  134665. /**
  134666. * Observable raised when an error occured while loading the 360 image
  134667. */
  134668. onLoadErrorObservable: Observable<string>;
  134669. /**
  134670. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134671. * @param name Element's name, child elements will append suffixes for their own names.
  134672. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134673. * @param options An object containing optional or exposed sub element properties
  134674. */
  134675. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134676. resolution?: number;
  134677. clickToPlay?: boolean;
  134678. autoPlay?: boolean;
  134679. loop?: boolean;
  134680. size?: number;
  134681. poster?: string;
  134682. faceForward?: boolean;
  134683. useDirectMapping?: boolean;
  134684. halfDomeMode?: boolean;
  134685. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134686. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134687. protected _changeTextureMode(value: number): void;
  134688. /**
  134689. * Releases resources associated with this node.
  134690. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134691. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134692. */
  134693. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134694. }
  134695. }
  134696. declare module BABYLON {
  134697. /**
  134698. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134699. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134700. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134701. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134702. */
  134703. export class PhotoDome extends TextureDome<Texture> {
  134704. /**
  134705. * Define the image as a Monoscopic panoramic 360 image.
  134706. */
  134707. static readonly MODE_MONOSCOPIC: number;
  134708. /**
  134709. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134710. */
  134711. static readonly MODE_TOPBOTTOM: number;
  134712. /**
  134713. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134714. */
  134715. static readonly MODE_SIDEBYSIDE: number;
  134716. /**
  134717. * Gets or sets the texture being displayed on the sphere
  134718. */
  134719. get photoTexture(): Texture;
  134720. /**
  134721. * sets the texture being displayed on the sphere
  134722. */
  134723. set photoTexture(value: Texture);
  134724. /**
  134725. * Gets the current video mode for the video. It can be:
  134726. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134727. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134728. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134729. */
  134730. get imageMode(): number;
  134731. /**
  134732. * Sets the current video mode for the video. It can be:
  134733. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134734. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134735. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134736. */
  134737. set imageMode(value: number);
  134738. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134739. }
  134740. }
  134741. declare module BABYLON {
  134742. /**
  134743. * Class used to host RGBD texture specific utilities
  134744. */
  134745. export class RGBDTextureTools {
  134746. /**
  134747. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134748. * @param texture the texture to expand.
  134749. */
  134750. static ExpandRGBDTexture(texture: Texture): void;
  134751. }
  134752. }
  134753. declare module BABYLON {
  134754. /**
  134755. * Class used to host texture specific utilities
  134756. */
  134757. export class BRDFTextureTools {
  134758. /**
  134759. * Prevents texture cache collision
  134760. */
  134761. private static _instanceNumber;
  134762. /**
  134763. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134764. * @param scene defines the hosting scene
  134765. * @returns the environment BRDF texture
  134766. */
  134767. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134768. private static _environmentBRDFBase64Texture;
  134769. }
  134770. }
  134771. declare module BABYLON {
  134772. /**
  134773. * @hidden
  134774. */
  134775. export interface IMaterialClearCoatDefines {
  134776. CLEARCOAT: boolean;
  134777. CLEARCOAT_DEFAULTIOR: boolean;
  134778. CLEARCOAT_TEXTURE: boolean;
  134779. CLEARCOAT_TEXTUREDIRECTUV: number;
  134780. CLEARCOAT_BUMP: boolean;
  134781. CLEARCOAT_BUMPDIRECTUV: number;
  134782. CLEARCOAT_TINT: boolean;
  134783. CLEARCOAT_TINT_TEXTURE: boolean;
  134784. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134785. /** @hidden */
  134786. _areTexturesDirty: boolean;
  134787. }
  134788. /**
  134789. * Define the code related to the clear coat parameters of the pbr material.
  134790. */
  134791. export class PBRClearCoatConfiguration {
  134792. /**
  134793. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134794. * The default fits with a polyurethane material.
  134795. */
  134796. private static readonly _DefaultIndexOfRefraction;
  134797. private _isEnabled;
  134798. /**
  134799. * Defines if the clear coat is enabled in the material.
  134800. */
  134801. isEnabled: boolean;
  134802. /**
  134803. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134804. */
  134805. intensity: number;
  134806. /**
  134807. * Defines the clear coat layer roughness.
  134808. */
  134809. roughness: number;
  134810. private _indexOfRefraction;
  134811. /**
  134812. * Defines the index of refraction of the clear coat.
  134813. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134814. * The default fits with a polyurethane material.
  134815. * Changing the default value is more performance intensive.
  134816. */
  134817. indexOfRefraction: number;
  134818. private _texture;
  134819. /**
  134820. * Stores the clear coat values in a texture.
  134821. */
  134822. texture: Nullable<BaseTexture>;
  134823. private _bumpTexture;
  134824. /**
  134825. * Define the clear coat specific bump texture.
  134826. */
  134827. bumpTexture: Nullable<BaseTexture>;
  134828. private _isTintEnabled;
  134829. /**
  134830. * Defines if the clear coat tint is enabled in the material.
  134831. */
  134832. isTintEnabled: boolean;
  134833. /**
  134834. * Defines the clear coat tint of the material.
  134835. * This is only use if tint is enabled
  134836. */
  134837. tintColor: Color3;
  134838. /**
  134839. * Defines the distance at which the tint color should be found in the
  134840. * clear coat media.
  134841. * This is only use if tint is enabled
  134842. */
  134843. tintColorAtDistance: number;
  134844. /**
  134845. * Defines the clear coat layer thickness.
  134846. * This is only use if tint is enabled
  134847. */
  134848. tintThickness: number;
  134849. private _tintTexture;
  134850. /**
  134851. * Stores the clear tint values in a texture.
  134852. * rgb is tint
  134853. * a is a thickness factor
  134854. */
  134855. tintTexture: Nullable<BaseTexture>;
  134856. /** @hidden */
  134857. private _internalMarkAllSubMeshesAsTexturesDirty;
  134858. /** @hidden */
  134859. _markAllSubMeshesAsTexturesDirty(): void;
  134860. /**
  134861. * Instantiate a new istance of clear coat configuration.
  134862. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134863. */
  134864. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134865. /**
  134866. * Gets wehter the submesh is ready to be used or not.
  134867. * @param defines the list of "defines" to update.
  134868. * @param scene defines the scene the material belongs to.
  134869. * @param engine defines the engine the material belongs to.
  134870. * @param disableBumpMap defines wether the material disables bump or not.
  134871. * @returns - boolean indicating that the submesh is ready or not.
  134872. */
  134873. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134874. /**
  134875. * Checks to see if a texture is used in the material.
  134876. * @param defines the list of "defines" to update.
  134877. * @param scene defines the scene to the material belongs to.
  134878. */
  134879. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134880. /**
  134881. * Binds the material data.
  134882. * @param uniformBuffer defines the Uniform buffer to fill in.
  134883. * @param scene defines the scene the material belongs to.
  134884. * @param engine defines the engine the material belongs to.
  134885. * @param disableBumpMap defines wether the material disables bump or not.
  134886. * @param isFrozen defines wether the material is frozen or not.
  134887. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134888. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134889. */
  134890. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134891. /**
  134892. * Checks to see if a texture is used in the material.
  134893. * @param texture - Base texture to use.
  134894. * @returns - Boolean specifying if a texture is used in the material.
  134895. */
  134896. hasTexture(texture: BaseTexture): boolean;
  134897. /**
  134898. * Returns an array of the actively used textures.
  134899. * @param activeTextures Array of BaseTextures
  134900. */
  134901. getActiveTextures(activeTextures: BaseTexture[]): void;
  134902. /**
  134903. * Returns the animatable textures.
  134904. * @param animatables Array of animatable textures.
  134905. */
  134906. getAnimatables(animatables: IAnimatable[]): void;
  134907. /**
  134908. * Disposes the resources of the material.
  134909. * @param forceDisposeTextures - Forces the disposal of all textures.
  134910. */
  134911. dispose(forceDisposeTextures?: boolean): void;
  134912. /**
  134913. * Get the current class name of the texture useful for serialization or dynamic coding.
  134914. * @returns "PBRClearCoatConfiguration"
  134915. */
  134916. getClassName(): string;
  134917. /**
  134918. * Add fallbacks to the effect fallbacks list.
  134919. * @param defines defines the Base texture to use.
  134920. * @param fallbacks defines the current fallback list.
  134921. * @param currentRank defines the current fallback rank.
  134922. * @returns the new fallback rank.
  134923. */
  134924. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134925. /**
  134926. * Add the required uniforms to the current list.
  134927. * @param uniforms defines the current uniform list.
  134928. */
  134929. static AddUniforms(uniforms: string[]): void;
  134930. /**
  134931. * Add the required samplers to the current list.
  134932. * @param samplers defines the current sampler list.
  134933. */
  134934. static AddSamplers(samplers: string[]): void;
  134935. /**
  134936. * Add the required uniforms to the current buffer.
  134937. * @param uniformBuffer defines the current uniform buffer.
  134938. */
  134939. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134940. /**
  134941. * Makes a duplicate of the current configuration into another one.
  134942. * @param clearCoatConfiguration define the config where to copy the info
  134943. */
  134944. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134945. /**
  134946. * Serializes this clear coat configuration.
  134947. * @returns - An object with the serialized config.
  134948. */
  134949. serialize(): any;
  134950. /**
  134951. * Parses a anisotropy Configuration from a serialized object.
  134952. * @param source - Serialized object.
  134953. * @param scene Defines the scene we are parsing for
  134954. * @param rootUrl Defines the rootUrl to load from
  134955. */
  134956. parse(source: any, scene: Scene, rootUrl: string): void;
  134957. }
  134958. }
  134959. declare module BABYLON {
  134960. /**
  134961. * @hidden
  134962. */
  134963. export interface IMaterialAnisotropicDefines {
  134964. ANISOTROPIC: boolean;
  134965. ANISOTROPIC_TEXTURE: boolean;
  134966. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134967. MAINUV1: boolean;
  134968. _areTexturesDirty: boolean;
  134969. _needUVs: boolean;
  134970. }
  134971. /**
  134972. * Define the code related to the anisotropic parameters of the pbr material.
  134973. */
  134974. export class PBRAnisotropicConfiguration {
  134975. private _isEnabled;
  134976. /**
  134977. * Defines if the anisotropy is enabled in the material.
  134978. */
  134979. isEnabled: boolean;
  134980. /**
  134981. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134982. */
  134983. intensity: number;
  134984. /**
  134985. * Defines if the effect is along the tangents, bitangents or in between.
  134986. * By default, the effect is "strectching" the highlights along the tangents.
  134987. */
  134988. direction: Vector2;
  134989. private _texture;
  134990. /**
  134991. * Stores the anisotropy values in a texture.
  134992. * rg is direction (like normal from -1 to 1)
  134993. * b is a intensity
  134994. */
  134995. texture: Nullable<BaseTexture>;
  134996. /** @hidden */
  134997. private _internalMarkAllSubMeshesAsTexturesDirty;
  134998. /** @hidden */
  134999. _markAllSubMeshesAsTexturesDirty(): void;
  135000. /**
  135001. * Instantiate a new istance of anisotropy configuration.
  135002. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135003. */
  135004. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135005. /**
  135006. * Specifies that the submesh is ready to be used.
  135007. * @param defines the list of "defines" to update.
  135008. * @param scene defines the scene the material belongs to.
  135009. * @returns - boolean indicating that the submesh is ready or not.
  135010. */
  135011. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  135012. /**
  135013. * Checks to see if a texture is used in the material.
  135014. * @param defines the list of "defines" to update.
  135015. * @param mesh the mesh we are preparing the defines for.
  135016. * @param scene defines the scene the material belongs to.
  135017. */
  135018. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135019. /**
  135020. * Binds the material data.
  135021. * @param uniformBuffer defines the Uniform buffer to fill in.
  135022. * @param scene defines the scene the material belongs to.
  135023. * @param isFrozen defines wether the material is frozen or not.
  135024. */
  135025. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135026. /**
  135027. * Checks to see if a texture is used in the material.
  135028. * @param texture - Base texture to use.
  135029. * @returns - Boolean specifying if a texture is used in the material.
  135030. */
  135031. hasTexture(texture: BaseTexture): boolean;
  135032. /**
  135033. * Returns an array of the actively used textures.
  135034. * @param activeTextures Array of BaseTextures
  135035. */
  135036. getActiveTextures(activeTextures: BaseTexture[]): void;
  135037. /**
  135038. * Returns the animatable textures.
  135039. * @param animatables Array of animatable textures.
  135040. */
  135041. getAnimatables(animatables: IAnimatable[]): void;
  135042. /**
  135043. * Disposes the resources of the material.
  135044. * @param forceDisposeTextures - Forces the disposal of all textures.
  135045. */
  135046. dispose(forceDisposeTextures?: boolean): void;
  135047. /**
  135048. * Get the current class name of the texture useful for serialization or dynamic coding.
  135049. * @returns "PBRAnisotropicConfiguration"
  135050. */
  135051. getClassName(): string;
  135052. /**
  135053. * Add fallbacks to the effect fallbacks list.
  135054. * @param defines defines the Base texture to use.
  135055. * @param fallbacks defines the current fallback list.
  135056. * @param currentRank defines the current fallback rank.
  135057. * @returns the new fallback rank.
  135058. */
  135059. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135060. /**
  135061. * Add the required uniforms to the current list.
  135062. * @param uniforms defines the current uniform list.
  135063. */
  135064. static AddUniforms(uniforms: string[]): void;
  135065. /**
  135066. * Add the required uniforms to the current buffer.
  135067. * @param uniformBuffer defines the current uniform buffer.
  135068. */
  135069. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135070. /**
  135071. * Add the required samplers to the current list.
  135072. * @param samplers defines the current sampler list.
  135073. */
  135074. static AddSamplers(samplers: string[]): void;
  135075. /**
  135076. * Makes a duplicate of the current configuration into another one.
  135077. * @param anisotropicConfiguration define the config where to copy the info
  135078. */
  135079. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135080. /**
  135081. * Serializes this anisotropy configuration.
  135082. * @returns - An object with the serialized config.
  135083. */
  135084. serialize(): any;
  135085. /**
  135086. * Parses a anisotropy Configuration from a serialized object.
  135087. * @param source - Serialized object.
  135088. * @param scene Defines the scene we are parsing for
  135089. * @param rootUrl Defines the rootUrl to load from
  135090. */
  135091. parse(source: any, scene: Scene, rootUrl: string): void;
  135092. }
  135093. }
  135094. declare module BABYLON {
  135095. /**
  135096. * @hidden
  135097. */
  135098. export interface IMaterialBRDFDefines {
  135099. BRDF_V_HEIGHT_CORRELATED: boolean;
  135100. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135101. SPHERICAL_HARMONICS: boolean;
  135102. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135103. /** @hidden */
  135104. _areMiscDirty: boolean;
  135105. }
  135106. /**
  135107. * Define the code related to the BRDF parameters of the pbr material.
  135108. */
  135109. export class PBRBRDFConfiguration {
  135110. /**
  135111. * Default value used for the energy conservation.
  135112. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135113. */
  135114. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135115. /**
  135116. * Default value used for the Smith Visibility Height Correlated mode.
  135117. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135118. */
  135119. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135120. /**
  135121. * Default value used for the IBL diffuse part.
  135122. * This can help switching back to the polynomials mode globally which is a tiny bit
  135123. * less GPU intensive at the drawback of a lower quality.
  135124. */
  135125. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135126. /**
  135127. * Default value used for activating energy conservation for the specular workflow.
  135128. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135129. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135130. */
  135131. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135132. private _useEnergyConservation;
  135133. /**
  135134. * Defines if the material uses energy conservation.
  135135. */
  135136. useEnergyConservation: boolean;
  135137. private _useSmithVisibilityHeightCorrelated;
  135138. /**
  135139. * LEGACY Mode set to false
  135140. * Defines if the material uses height smith correlated visibility term.
  135141. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135142. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135143. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135144. * Not relying on height correlated will also disable energy conservation.
  135145. */
  135146. useSmithVisibilityHeightCorrelated: boolean;
  135147. private _useSphericalHarmonics;
  135148. /**
  135149. * LEGACY Mode set to false
  135150. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135151. * diffuse part of the IBL.
  135152. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135153. * to the ground truth.
  135154. */
  135155. useSphericalHarmonics: boolean;
  135156. private _useSpecularGlossinessInputEnergyConservation;
  135157. /**
  135158. * Defines if the material uses energy conservation, when the specular workflow is active.
  135159. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135160. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135161. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135162. */
  135163. useSpecularGlossinessInputEnergyConservation: boolean;
  135164. /** @hidden */
  135165. private _internalMarkAllSubMeshesAsMiscDirty;
  135166. /** @hidden */
  135167. _markAllSubMeshesAsMiscDirty(): void;
  135168. /**
  135169. * Instantiate a new istance of clear coat configuration.
  135170. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135171. */
  135172. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135173. /**
  135174. * Checks to see if a texture is used in the material.
  135175. * @param defines the list of "defines" to update.
  135176. */
  135177. prepareDefines(defines: IMaterialBRDFDefines): void;
  135178. /**
  135179. * Get the current class name of the texture useful for serialization or dynamic coding.
  135180. * @returns "PBRClearCoatConfiguration"
  135181. */
  135182. getClassName(): string;
  135183. /**
  135184. * Makes a duplicate of the current configuration into another one.
  135185. * @param brdfConfiguration define the config where to copy the info
  135186. */
  135187. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135188. /**
  135189. * Serializes this BRDF configuration.
  135190. * @returns - An object with the serialized config.
  135191. */
  135192. serialize(): any;
  135193. /**
  135194. * Parses a anisotropy Configuration from a serialized object.
  135195. * @param source - Serialized object.
  135196. * @param scene Defines the scene we are parsing for
  135197. * @param rootUrl Defines the rootUrl to load from
  135198. */
  135199. parse(source: any, scene: Scene, rootUrl: string): void;
  135200. }
  135201. }
  135202. declare module BABYLON {
  135203. /**
  135204. * @hidden
  135205. */
  135206. export interface IMaterialSheenDefines {
  135207. SHEEN: boolean;
  135208. SHEEN_TEXTURE: boolean;
  135209. SHEEN_TEXTUREDIRECTUV: number;
  135210. SHEEN_LINKWITHALBEDO: boolean;
  135211. SHEEN_ROUGHNESS: boolean;
  135212. SHEEN_ALBEDOSCALING: boolean;
  135213. /** @hidden */
  135214. _areTexturesDirty: boolean;
  135215. }
  135216. /**
  135217. * Define the code related to the Sheen parameters of the pbr material.
  135218. */
  135219. export class PBRSheenConfiguration {
  135220. private _isEnabled;
  135221. /**
  135222. * Defines if the material uses sheen.
  135223. */
  135224. isEnabled: boolean;
  135225. private _linkSheenWithAlbedo;
  135226. /**
  135227. * Defines if the sheen is linked to the sheen color.
  135228. */
  135229. linkSheenWithAlbedo: boolean;
  135230. /**
  135231. * Defines the sheen intensity.
  135232. */
  135233. intensity: number;
  135234. /**
  135235. * Defines the sheen color.
  135236. */
  135237. color: Color3;
  135238. private _texture;
  135239. /**
  135240. * Stores the sheen tint values in a texture.
  135241. * rgb is tint
  135242. * a is a intensity or roughness if roughness has been defined
  135243. */
  135244. texture: Nullable<BaseTexture>;
  135245. private _roughness;
  135246. /**
  135247. * Defines the sheen roughness.
  135248. * It is not taken into account if linkSheenWithAlbedo is true.
  135249. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135250. */
  135251. roughness: Nullable<number>;
  135252. private _albedoScaling;
  135253. /**
  135254. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135255. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135256. * making it easier to setup and tweak the effect
  135257. */
  135258. albedoScaling: boolean;
  135259. /** @hidden */
  135260. private _internalMarkAllSubMeshesAsTexturesDirty;
  135261. /** @hidden */
  135262. _markAllSubMeshesAsTexturesDirty(): void;
  135263. /**
  135264. * Instantiate a new istance of clear coat configuration.
  135265. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135266. */
  135267. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135268. /**
  135269. * Specifies that the submesh is ready to be used.
  135270. * @param defines the list of "defines" to update.
  135271. * @param scene defines the scene the material belongs to.
  135272. * @returns - boolean indicating that the submesh is ready or not.
  135273. */
  135274. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135275. /**
  135276. * Checks to see if a texture is used in the material.
  135277. * @param defines the list of "defines" to update.
  135278. * @param scene defines the scene the material belongs to.
  135279. */
  135280. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135281. /**
  135282. * Binds the material data.
  135283. * @param uniformBuffer defines the Uniform buffer to fill in.
  135284. * @param scene defines the scene the material belongs to.
  135285. * @param isFrozen defines wether the material is frozen or not.
  135286. */
  135287. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135288. /**
  135289. * Checks to see if a texture is used in the material.
  135290. * @param texture - Base texture to use.
  135291. * @returns - Boolean specifying if a texture is used in the material.
  135292. */
  135293. hasTexture(texture: BaseTexture): boolean;
  135294. /**
  135295. * Returns an array of the actively used textures.
  135296. * @param activeTextures Array of BaseTextures
  135297. */
  135298. getActiveTextures(activeTextures: BaseTexture[]): void;
  135299. /**
  135300. * Returns the animatable textures.
  135301. * @param animatables Array of animatable textures.
  135302. */
  135303. getAnimatables(animatables: IAnimatable[]): void;
  135304. /**
  135305. * Disposes the resources of the material.
  135306. * @param forceDisposeTextures - Forces the disposal of all textures.
  135307. */
  135308. dispose(forceDisposeTextures?: boolean): void;
  135309. /**
  135310. * Get the current class name of the texture useful for serialization or dynamic coding.
  135311. * @returns "PBRSheenConfiguration"
  135312. */
  135313. getClassName(): string;
  135314. /**
  135315. * Add fallbacks to the effect fallbacks list.
  135316. * @param defines defines the Base texture to use.
  135317. * @param fallbacks defines the current fallback list.
  135318. * @param currentRank defines the current fallback rank.
  135319. * @returns the new fallback rank.
  135320. */
  135321. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135322. /**
  135323. * Add the required uniforms to the current list.
  135324. * @param uniforms defines the current uniform list.
  135325. */
  135326. static AddUniforms(uniforms: string[]): void;
  135327. /**
  135328. * Add the required uniforms to the current buffer.
  135329. * @param uniformBuffer defines the current uniform buffer.
  135330. */
  135331. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135332. /**
  135333. * Add the required samplers to the current list.
  135334. * @param samplers defines the current sampler list.
  135335. */
  135336. static AddSamplers(samplers: string[]): void;
  135337. /**
  135338. * Makes a duplicate of the current configuration into another one.
  135339. * @param sheenConfiguration define the config where to copy the info
  135340. */
  135341. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135342. /**
  135343. * Serializes this BRDF configuration.
  135344. * @returns - An object with the serialized config.
  135345. */
  135346. serialize(): any;
  135347. /**
  135348. * Parses a anisotropy Configuration from a serialized object.
  135349. * @param source - Serialized object.
  135350. * @param scene Defines the scene we are parsing for
  135351. * @param rootUrl Defines the rootUrl to load from
  135352. */
  135353. parse(source: any, scene: Scene, rootUrl: string): void;
  135354. }
  135355. }
  135356. declare module BABYLON {
  135357. /**
  135358. * @hidden
  135359. */
  135360. export interface IMaterialSubSurfaceDefines {
  135361. SUBSURFACE: boolean;
  135362. SS_REFRACTION: boolean;
  135363. SS_TRANSLUCENCY: boolean;
  135364. SS_SCATTERING: boolean;
  135365. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135366. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135367. SS_REFRACTIONMAP_3D: boolean;
  135368. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135369. SS_LODINREFRACTIONALPHA: boolean;
  135370. SS_GAMMAREFRACTION: boolean;
  135371. SS_RGBDREFRACTION: boolean;
  135372. SS_LINEARSPECULARREFRACTION: boolean;
  135373. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135374. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135375. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135376. /** @hidden */
  135377. _areTexturesDirty: boolean;
  135378. }
  135379. /**
  135380. * Define the code related to the sub surface parameters of the pbr material.
  135381. */
  135382. export class PBRSubSurfaceConfiguration {
  135383. private _isRefractionEnabled;
  135384. /**
  135385. * Defines if the refraction is enabled in the material.
  135386. */
  135387. isRefractionEnabled: boolean;
  135388. private _isTranslucencyEnabled;
  135389. /**
  135390. * Defines if the translucency is enabled in the material.
  135391. */
  135392. isTranslucencyEnabled: boolean;
  135393. private _isScatteringEnabled;
  135394. /**
  135395. * Defines if the sub surface scattering is enabled in the material.
  135396. */
  135397. isScatteringEnabled: boolean;
  135398. private _scatteringDiffusionProfileIndex;
  135399. /**
  135400. * Diffusion profile for subsurface scattering.
  135401. * Useful for better scattering in the skins or foliages.
  135402. */
  135403. get scatteringDiffusionProfile(): Nullable<Color3>;
  135404. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135405. /**
  135406. * Defines the refraction intensity of the material.
  135407. * The refraction when enabled replaces the Diffuse part of the material.
  135408. * The intensity helps transitionning between diffuse and refraction.
  135409. */
  135410. refractionIntensity: number;
  135411. /**
  135412. * Defines the translucency intensity of the material.
  135413. * When translucency has been enabled, this defines how much of the "translucency"
  135414. * is addded to the diffuse part of the material.
  135415. */
  135416. translucencyIntensity: number;
  135417. /**
  135418. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135419. */
  135420. useAlbedoToTintRefraction: boolean;
  135421. private _thicknessTexture;
  135422. /**
  135423. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135424. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135425. * 0 would mean minimumThickness
  135426. * 1 would mean maximumThickness
  135427. * The other channels might be use as a mask to vary the different effects intensity.
  135428. */
  135429. thicknessTexture: Nullable<BaseTexture>;
  135430. private _refractionTexture;
  135431. /**
  135432. * Defines the texture to use for refraction.
  135433. */
  135434. refractionTexture: Nullable<BaseTexture>;
  135435. private _indexOfRefraction;
  135436. /**
  135437. * Index of refraction of the material base layer.
  135438. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135439. *
  135440. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135441. *
  135442. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135443. */
  135444. indexOfRefraction: number;
  135445. private _volumeIndexOfRefraction;
  135446. /**
  135447. * Index of refraction of the material's volume.
  135448. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135449. *
  135450. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135451. * the volume will use the same IOR as the surface.
  135452. */
  135453. get volumeIndexOfRefraction(): number;
  135454. set volumeIndexOfRefraction(value: number);
  135455. private _invertRefractionY;
  135456. /**
  135457. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135458. */
  135459. invertRefractionY: boolean;
  135460. private _linkRefractionWithTransparency;
  135461. /**
  135462. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135463. * Materials half opaque for instance using refraction could benefit from this control.
  135464. */
  135465. linkRefractionWithTransparency: boolean;
  135466. /**
  135467. * Defines the minimum thickness stored in the thickness map.
  135468. * If no thickness map is defined, this value will be used to simulate thickness.
  135469. */
  135470. minimumThickness: number;
  135471. /**
  135472. * Defines the maximum thickness stored in the thickness map.
  135473. */
  135474. maximumThickness: number;
  135475. /**
  135476. * Defines the volume tint of the material.
  135477. * This is used for both translucency and scattering.
  135478. */
  135479. tintColor: Color3;
  135480. /**
  135481. * Defines the distance at which the tint color should be found in the media.
  135482. * This is used for refraction only.
  135483. */
  135484. tintColorAtDistance: number;
  135485. /**
  135486. * Defines how far each channel transmit through the media.
  135487. * It is defined as a color to simplify it selection.
  135488. */
  135489. diffusionDistance: Color3;
  135490. private _useMaskFromThicknessTexture;
  135491. /**
  135492. * Stores the intensity of the different subsurface effects in the thickness texture.
  135493. * * the green channel is the translucency intensity.
  135494. * * the blue channel is the scattering intensity.
  135495. * * the alpha channel is the refraction intensity.
  135496. */
  135497. useMaskFromThicknessTexture: boolean;
  135498. private _scene;
  135499. /** @hidden */
  135500. private _internalMarkAllSubMeshesAsTexturesDirty;
  135501. private _internalMarkScenePrePassDirty;
  135502. /** @hidden */
  135503. _markAllSubMeshesAsTexturesDirty(): void;
  135504. /** @hidden */
  135505. _markScenePrePassDirty(): void;
  135506. /**
  135507. * Instantiate a new istance of sub surface configuration.
  135508. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135509. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135510. * @param scene The scene
  135511. */
  135512. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135513. /**
  135514. * Gets wehter the submesh is ready to be used or not.
  135515. * @param defines the list of "defines" to update.
  135516. * @param scene defines the scene the material belongs to.
  135517. * @returns - boolean indicating that the submesh is ready or not.
  135518. */
  135519. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135520. /**
  135521. * Checks to see if a texture is used in the material.
  135522. * @param defines the list of "defines" to update.
  135523. * @param scene defines the scene to the material belongs to.
  135524. */
  135525. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135526. /**
  135527. * Binds the material data.
  135528. * @param uniformBuffer defines the Uniform buffer to fill in.
  135529. * @param scene defines the scene the material belongs to.
  135530. * @param engine defines the engine the material belongs to.
  135531. * @param isFrozen defines whether the material is frozen or not.
  135532. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135533. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135534. */
  135535. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135536. /**
  135537. * Unbinds the material from the mesh.
  135538. * @param activeEffect defines the effect that should be unbound from.
  135539. * @returns true if unbound, otherwise false
  135540. */
  135541. unbind(activeEffect: Effect): boolean;
  135542. /**
  135543. * Returns the texture used for refraction or null if none is used.
  135544. * @param scene defines the scene the material belongs to.
  135545. * @returns - Refraction texture if present. If no refraction texture and refraction
  135546. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135547. */
  135548. private _getRefractionTexture;
  135549. /**
  135550. * Returns true if alpha blending should be disabled.
  135551. */
  135552. get disableAlphaBlending(): boolean;
  135553. /**
  135554. * Fills the list of render target textures.
  135555. * @param renderTargets the list of render targets to update
  135556. */
  135557. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135558. /**
  135559. * Checks to see if a texture is used in the material.
  135560. * @param texture - Base texture to use.
  135561. * @returns - Boolean specifying if a texture is used in the material.
  135562. */
  135563. hasTexture(texture: BaseTexture): boolean;
  135564. /**
  135565. * Gets a boolean indicating that current material needs to register RTT
  135566. * @returns true if this uses a render target otherwise false.
  135567. */
  135568. hasRenderTargetTextures(): boolean;
  135569. /**
  135570. * Returns an array of the actively used textures.
  135571. * @param activeTextures Array of BaseTextures
  135572. */
  135573. getActiveTextures(activeTextures: BaseTexture[]): void;
  135574. /**
  135575. * Returns the animatable textures.
  135576. * @param animatables Array of animatable textures.
  135577. */
  135578. getAnimatables(animatables: IAnimatable[]): void;
  135579. /**
  135580. * Disposes the resources of the material.
  135581. * @param forceDisposeTextures - Forces the disposal of all textures.
  135582. */
  135583. dispose(forceDisposeTextures?: boolean): void;
  135584. /**
  135585. * Get the current class name of the texture useful for serialization or dynamic coding.
  135586. * @returns "PBRSubSurfaceConfiguration"
  135587. */
  135588. getClassName(): string;
  135589. /**
  135590. * Add fallbacks to the effect fallbacks list.
  135591. * @param defines defines the Base texture to use.
  135592. * @param fallbacks defines the current fallback list.
  135593. * @param currentRank defines the current fallback rank.
  135594. * @returns the new fallback rank.
  135595. */
  135596. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135597. /**
  135598. * Add the required uniforms to the current list.
  135599. * @param uniforms defines the current uniform list.
  135600. */
  135601. static AddUniforms(uniforms: string[]): void;
  135602. /**
  135603. * Add the required samplers to the current list.
  135604. * @param samplers defines the current sampler list.
  135605. */
  135606. static AddSamplers(samplers: string[]): void;
  135607. /**
  135608. * Add the required uniforms to the current buffer.
  135609. * @param uniformBuffer defines the current uniform buffer.
  135610. */
  135611. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135612. /**
  135613. * Makes a duplicate of the current configuration into another one.
  135614. * @param configuration define the config where to copy the info
  135615. */
  135616. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135617. /**
  135618. * Serializes this Sub Surface configuration.
  135619. * @returns - An object with the serialized config.
  135620. */
  135621. serialize(): any;
  135622. /**
  135623. * Parses a anisotropy Configuration from a serialized object.
  135624. * @param source - Serialized object.
  135625. * @param scene Defines the scene we are parsing for
  135626. * @param rootUrl Defines the rootUrl to load from
  135627. */
  135628. parse(source: any, scene: Scene, rootUrl: string): void;
  135629. }
  135630. }
  135631. declare module BABYLON {
  135632. /** @hidden */
  135633. export var pbrFragmentDeclaration: {
  135634. name: string;
  135635. shader: string;
  135636. };
  135637. }
  135638. declare module BABYLON {
  135639. /** @hidden */
  135640. export var pbrUboDeclaration: {
  135641. name: string;
  135642. shader: string;
  135643. };
  135644. }
  135645. declare module BABYLON {
  135646. /** @hidden */
  135647. export var pbrFragmentExtraDeclaration: {
  135648. name: string;
  135649. shader: string;
  135650. };
  135651. }
  135652. declare module BABYLON {
  135653. /** @hidden */
  135654. export var pbrFragmentSamplersDeclaration: {
  135655. name: string;
  135656. shader: string;
  135657. };
  135658. }
  135659. declare module BABYLON {
  135660. /** @hidden */
  135661. export var importanceSampling: {
  135662. name: string;
  135663. shader: string;
  135664. };
  135665. }
  135666. declare module BABYLON {
  135667. /** @hidden */
  135668. export var pbrHelperFunctions: {
  135669. name: string;
  135670. shader: string;
  135671. };
  135672. }
  135673. declare module BABYLON {
  135674. /** @hidden */
  135675. export var harmonicsFunctions: {
  135676. name: string;
  135677. shader: string;
  135678. };
  135679. }
  135680. declare module BABYLON {
  135681. /** @hidden */
  135682. export var pbrDirectLightingSetupFunctions: {
  135683. name: string;
  135684. shader: string;
  135685. };
  135686. }
  135687. declare module BABYLON {
  135688. /** @hidden */
  135689. export var pbrDirectLightingFalloffFunctions: {
  135690. name: string;
  135691. shader: string;
  135692. };
  135693. }
  135694. declare module BABYLON {
  135695. /** @hidden */
  135696. export var pbrBRDFFunctions: {
  135697. name: string;
  135698. shader: string;
  135699. };
  135700. }
  135701. declare module BABYLON {
  135702. /** @hidden */
  135703. export var hdrFilteringFunctions: {
  135704. name: string;
  135705. shader: string;
  135706. };
  135707. }
  135708. declare module BABYLON {
  135709. /** @hidden */
  135710. export var pbrDirectLightingFunctions: {
  135711. name: string;
  135712. shader: string;
  135713. };
  135714. }
  135715. declare module BABYLON {
  135716. /** @hidden */
  135717. export var pbrIBLFunctions: {
  135718. name: string;
  135719. shader: string;
  135720. };
  135721. }
  135722. declare module BABYLON {
  135723. /** @hidden */
  135724. export var pbrBlockAlbedoOpacity: {
  135725. name: string;
  135726. shader: string;
  135727. };
  135728. }
  135729. declare module BABYLON {
  135730. /** @hidden */
  135731. export var pbrBlockReflectivity: {
  135732. name: string;
  135733. shader: string;
  135734. };
  135735. }
  135736. declare module BABYLON {
  135737. /** @hidden */
  135738. export var pbrBlockAmbientOcclusion: {
  135739. name: string;
  135740. shader: string;
  135741. };
  135742. }
  135743. declare module BABYLON {
  135744. /** @hidden */
  135745. export var pbrBlockAlphaFresnel: {
  135746. name: string;
  135747. shader: string;
  135748. };
  135749. }
  135750. declare module BABYLON {
  135751. /** @hidden */
  135752. export var pbrBlockAnisotropic: {
  135753. name: string;
  135754. shader: string;
  135755. };
  135756. }
  135757. declare module BABYLON {
  135758. /** @hidden */
  135759. export var pbrBlockReflection: {
  135760. name: string;
  135761. shader: string;
  135762. };
  135763. }
  135764. declare module BABYLON {
  135765. /** @hidden */
  135766. export var pbrBlockSheen: {
  135767. name: string;
  135768. shader: string;
  135769. };
  135770. }
  135771. declare module BABYLON {
  135772. /** @hidden */
  135773. export var pbrBlockClearcoat: {
  135774. name: string;
  135775. shader: string;
  135776. };
  135777. }
  135778. declare module BABYLON {
  135779. /** @hidden */
  135780. export var pbrBlockSubSurface: {
  135781. name: string;
  135782. shader: string;
  135783. };
  135784. }
  135785. declare module BABYLON {
  135786. /** @hidden */
  135787. export var pbrBlockNormalGeometric: {
  135788. name: string;
  135789. shader: string;
  135790. };
  135791. }
  135792. declare module BABYLON {
  135793. /** @hidden */
  135794. export var pbrBlockNormalFinal: {
  135795. name: string;
  135796. shader: string;
  135797. };
  135798. }
  135799. declare module BABYLON {
  135800. /** @hidden */
  135801. export var pbrBlockLightmapInit: {
  135802. name: string;
  135803. shader: string;
  135804. };
  135805. }
  135806. declare module BABYLON {
  135807. /** @hidden */
  135808. export var pbrBlockGeometryInfo: {
  135809. name: string;
  135810. shader: string;
  135811. };
  135812. }
  135813. declare module BABYLON {
  135814. /** @hidden */
  135815. export var pbrBlockReflectance0: {
  135816. name: string;
  135817. shader: string;
  135818. };
  135819. }
  135820. declare module BABYLON {
  135821. /** @hidden */
  135822. export var pbrBlockReflectance: {
  135823. name: string;
  135824. shader: string;
  135825. };
  135826. }
  135827. declare module BABYLON {
  135828. /** @hidden */
  135829. export var pbrBlockDirectLighting: {
  135830. name: string;
  135831. shader: string;
  135832. };
  135833. }
  135834. declare module BABYLON {
  135835. /** @hidden */
  135836. export var pbrBlockFinalLitComponents: {
  135837. name: string;
  135838. shader: string;
  135839. };
  135840. }
  135841. declare module BABYLON {
  135842. /** @hidden */
  135843. export var pbrBlockFinalUnlitComponents: {
  135844. name: string;
  135845. shader: string;
  135846. };
  135847. }
  135848. declare module BABYLON {
  135849. /** @hidden */
  135850. export var pbrBlockFinalColorComposition: {
  135851. name: string;
  135852. shader: string;
  135853. };
  135854. }
  135855. declare module BABYLON {
  135856. /** @hidden */
  135857. export var pbrBlockImageProcessing: {
  135858. name: string;
  135859. shader: string;
  135860. };
  135861. }
  135862. declare module BABYLON {
  135863. /** @hidden */
  135864. export var pbrDebug: {
  135865. name: string;
  135866. shader: string;
  135867. };
  135868. }
  135869. declare module BABYLON {
  135870. /** @hidden */
  135871. export var pbrPixelShader: {
  135872. name: string;
  135873. shader: string;
  135874. };
  135875. }
  135876. declare module BABYLON {
  135877. /** @hidden */
  135878. export var pbrVertexDeclaration: {
  135879. name: string;
  135880. shader: string;
  135881. };
  135882. }
  135883. declare module BABYLON {
  135884. /** @hidden */
  135885. export var pbrVertexShader: {
  135886. name: string;
  135887. shader: string;
  135888. };
  135889. }
  135890. declare module BABYLON {
  135891. /**
  135892. * Manages the defines for the PBR Material.
  135893. * @hidden
  135894. */
  135895. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135896. PBR: boolean;
  135897. NUM_SAMPLES: string;
  135898. REALTIME_FILTERING: boolean;
  135899. MAINUV1: boolean;
  135900. MAINUV2: boolean;
  135901. UV1: boolean;
  135902. UV2: boolean;
  135903. ALBEDO: boolean;
  135904. GAMMAALBEDO: boolean;
  135905. ALBEDODIRECTUV: number;
  135906. VERTEXCOLOR: boolean;
  135907. DETAIL: boolean;
  135908. DETAILDIRECTUV: number;
  135909. DETAIL_NORMALBLENDMETHOD: number;
  135910. AMBIENT: boolean;
  135911. AMBIENTDIRECTUV: number;
  135912. AMBIENTINGRAYSCALE: boolean;
  135913. OPACITY: boolean;
  135914. VERTEXALPHA: boolean;
  135915. OPACITYDIRECTUV: number;
  135916. OPACITYRGB: boolean;
  135917. ALPHATEST: boolean;
  135918. DEPTHPREPASS: boolean;
  135919. ALPHABLEND: boolean;
  135920. ALPHAFROMALBEDO: boolean;
  135921. ALPHATESTVALUE: string;
  135922. SPECULAROVERALPHA: boolean;
  135923. RADIANCEOVERALPHA: boolean;
  135924. ALPHAFRESNEL: boolean;
  135925. LINEARALPHAFRESNEL: boolean;
  135926. PREMULTIPLYALPHA: boolean;
  135927. EMISSIVE: boolean;
  135928. EMISSIVEDIRECTUV: number;
  135929. REFLECTIVITY: boolean;
  135930. REFLECTIVITYDIRECTUV: number;
  135931. SPECULARTERM: boolean;
  135932. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135933. MICROSURFACEAUTOMATIC: boolean;
  135934. LODBASEDMICROSFURACE: boolean;
  135935. MICROSURFACEMAP: boolean;
  135936. MICROSURFACEMAPDIRECTUV: number;
  135937. METALLICWORKFLOW: boolean;
  135938. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135939. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135940. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135941. AOSTOREINMETALMAPRED: boolean;
  135942. METALLIC_REFLECTANCE: boolean;
  135943. METALLIC_REFLECTANCEDIRECTUV: number;
  135944. ENVIRONMENTBRDF: boolean;
  135945. ENVIRONMENTBRDF_RGBD: boolean;
  135946. NORMAL: boolean;
  135947. TANGENT: boolean;
  135948. BUMP: boolean;
  135949. BUMPDIRECTUV: number;
  135950. OBJECTSPACE_NORMALMAP: boolean;
  135951. PARALLAX: boolean;
  135952. PARALLAXOCCLUSION: boolean;
  135953. NORMALXYSCALE: boolean;
  135954. LIGHTMAP: boolean;
  135955. LIGHTMAPDIRECTUV: number;
  135956. USELIGHTMAPASSHADOWMAP: boolean;
  135957. GAMMALIGHTMAP: boolean;
  135958. RGBDLIGHTMAP: boolean;
  135959. REFLECTION: boolean;
  135960. REFLECTIONMAP_3D: boolean;
  135961. REFLECTIONMAP_SPHERICAL: boolean;
  135962. REFLECTIONMAP_PLANAR: boolean;
  135963. REFLECTIONMAP_CUBIC: boolean;
  135964. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135965. REFLECTIONMAP_PROJECTION: boolean;
  135966. REFLECTIONMAP_SKYBOX: boolean;
  135967. REFLECTIONMAP_EXPLICIT: boolean;
  135968. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135969. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135970. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135971. INVERTCUBICMAP: boolean;
  135972. USESPHERICALFROMREFLECTIONMAP: boolean;
  135973. USEIRRADIANCEMAP: boolean;
  135974. SPHERICAL_HARMONICS: boolean;
  135975. USESPHERICALINVERTEX: boolean;
  135976. REFLECTIONMAP_OPPOSITEZ: boolean;
  135977. LODINREFLECTIONALPHA: boolean;
  135978. GAMMAREFLECTION: boolean;
  135979. RGBDREFLECTION: boolean;
  135980. LINEARSPECULARREFLECTION: boolean;
  135981. RADIANCEOCCLUSION: boolean;
  135982. HORIZONOCCLUSION: boolean;
  135983. INSTANCES: boolean;
  135984. THIN_INSTANCES: boolean;
  135985. PREPASS: boolean;
  135986. SCENE_MRT_COUNT: number;
  135987. NUM_BONE_INFLUENCERS: number;
  135988. BonesPerMesh: number;
  135989. BONETEXTURE: boolean;
  135990. NONUNIFORMSCALING: boolean;
  135991. MORPHTARGETS: boolean;
  135992. MORPHTARGETS_NORMAL: boolean;
  135993. MORPHTARGETS_TANGENT: boolean;
  135994. MORPHTARGETS_UV: boolean;
  135995. NUM_MORPH_INFLUENCERS: number;
  135996. IMAGEPROCESSING: boolean;
  135997. VIGNETTE: boolean;
  135998. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135999. VIGNETTEBLENDMODEOPAQUE: boolean;
  136000. TONEMAPPING: boolean;
  136001. TONEMAPPING_ACES: boolean;
  136002. CONTRAST: boolean;
  136003. COLORCURVES: boolean;
  136004. COLORGRADING: boolean;
  136005. COLORGRADING3D: boolean;
  136006. SAMPLER3DGREENDEPTH: boolean;
  136007. SAMPLER3DBGRMAP: boolean;
  136008. IMAGEPROCESSINGPOSTPROCESS: boolean;
  136009. EXPOSURE: boolean;
  136010. MULTIVIEW: boolean;
  136011. USEPHYSICALLIGHTFALLOFF: boolean;
  136012. USEGLTFLIGHTFALLOFF: boolean;
  136013. TWOSIDEDLIGHTING: boolean;
  136014. SHADOWFLOAT: boolean;
  136015. CLIPPLANE: boolean;
  136016. CLIPPLANE2: boolean;
  136017. CLIPPLANE3: boolean;
  136018. CLIPPLANE4: boolean;
  136019. CLIPPLANE5: boolean;
  136020. CLIPPLANE6: boolean;
  136021. POINTSIZE: boolean;
  136022. FOG: boolean;
  136023. LOGARITHMICDEPTH: boolean;
  136024. FORCENORMALFORWARD: boolean;
  136025. SPECULARAA: boolean;
  136026. CLEARCOAT: boolean;
  136027. CLEARCOAT_DEFAULTIOR: boolean;
  136028. CLEARCOAT_TEXTURE: boolean;
  136029. CLEARCOAT_TEXTUREDIRECTUV: number;
  136030. CLEARCOAT_BUMP: boolean;
  136031. CLEARCOAT_BUMPDIRECTUV: number;
  136032. CLEARCOAT_TINT: boolean;
  136033. CLEARCOAT_TINT_TEXTURE: boolean;
  136034. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136035. ANISOTROPIC: boolean;
  136036. ANISOTROPIC_TEXTURE: boolean;
  136037. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136038. BRDF_V_HEIGHT_CORRELATED: boolean;
  136039. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136040. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136041. SHEEN: boolean;
  136042. SHEEN_TEXTURE: boolean;
  136043. SHEEN_TEXTUREDIRECTUV: number;
  136044. SHEEN_LINKWITHALBEDO: boolean;
  136045. SHEEN_ROUGHNESS: boolean;
  136046. SHEEN_ALBEDOSCALING: boolean;
  136047. SUBSURFACE: boolean;
  136048. SS_REFRACTION: boolean;
  136049. SS_TRANSLUCENCY: boolean;
  136050. SS_SCATTERING: boolean;
  136051. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136052. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136053. SS_REFRACTIONMAP_3D: boolean;
  136054. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136055. SS_LODINREFRACTIONALPHA: boolean;
  136056. SS_GAMMAREFRACTION: boolean;
  136057. SS_RGBDREFRACTION: boolean;
  136058. SS_LINEARSPECULARREFRACTION: boolean;
  136059. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136060. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136061. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136062. UNLIT: boolean;
  136063. DEBUGMODE: number;
  136064. /**
  136065. * Initializes the PBR Material defines.
  136066. */
  136067. constructor();
  136068. /**
  136069. * Resets the PBR Material defines.
  136070. */
  136071. reset(): void;
  136072. }
  136073. /**
  136074. * The Physically based material base class of BJS.
  136075. *
  136076. * This offers the main features of a standard PBR material.
  136077. * For more information, please refer to the documentation :
  136078. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136079. */
  136080. export abstract class PBRBaseMaterial extends PushMaterial {
  136081. /**
  136082. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136083. */
  136084. static readonly PBRMATERIAL_OPAQUE: number;
  136085. /**
  136086. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136087. */
  136088. static readonly PBRMATERIAL_ALPHATEST: number;
  136089. /**
  136090. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136091. */
  136092. static readonly PBRMATERIAL_ALPHABLEND: number;
  136093. /**
  136094. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136095. * They are also discarded below the alpha cutoff threshold to improve performances.
  136096. */
  136097. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136098. /**
  136099. * Defines the default value of how much AO map is occluding the analytical lights
  136100. * (point spot...).
  136101. */
  136102. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136103. /**
  136104. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136105. */
  136106. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136107. /**
  136108. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136109. * to enhance interoperability with other engines.
  136110. */
  136111. static readonly LIGHTFALLOFF_GLTF: number;
  136112. /**
  136113. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136114. * to enhance interoperability with other materials.
  136115. */
  136116. static readonly LIGHTFALLOFF_STANDARD: number;
  136117. /**
  136118. * Intensity of the direct lights e.g. the four lights available in your scene.
  136119. * This impacts both the direct diffuse and specular highlights.
  136120. */
  136121. protected _directIntensity: number;
  136122. /**
  136123. * Intensity of the emissive part of the material.
  136124. * This helps controlling the emissive effect without modifying the emissive color.
  136125. */
  136126. protected _emissiveIntensity: number;
  136127. /**
  136128. * Intensity of the environment e.g. how much the environment will light the object
  136129. * either through harmonics for rough material or through the refelction for shiny ones.
  136130. */
  136131. protected _environmentIntensity: number;
  136132. /**
  136133. * This is a special control allowing the reduction of the specular highlights coming from the
  136134. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136135. */
  136136. protected _specularIntensity: number;
  136137. /**
  136138. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136139. */
  136140. private _lightingInfos;
  136141. /**
  136142. * Debug Control allowing disabling the bump map on this material.
  136143. */
  136144. protected _disableBumpMap: boolean;
  136145. /**
  136146. * AKA Diffuse Texture in standard nomenclature.
  136147. */
  136148. protected _albedoTexture: Nullable<BaseTexture>;
  136149. /**
  136150. * AKA Occlusion Texture in other nomenclature.
  136151. */
  136152. protected _ambientTexture: Nullable<BaseTexture>;
  136153. /**
  136154. * AKA Occlusion Texture Intensity in other nomenclature.
  136155. */
  136156. protected _ambientTextureStrength: number;
  136157. /**
  136158. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136159. * 1 means it completely occludes it
  136160. * 0 mean it has no impact
  136161. */
  136162. protected _ambientTextureImpactOnAnalyticalLights: number;
  136163. /**
  136164. * Stores the alpha values in a texture.
  136165. */
  136166. protected _opacityTexture: Nullable<BaseTexture>;
  136167. /**
  136168. * Stores the reflection values in a texture.
  136169. */
  136170. protected _reflectionTexture: Nullable<BaseTexture>;
  136171. /**
  136172. * Stores the emissive values in a texture.
  136173. */
  136174. protected _emissiveTexture: Nullable<BaseTexture>;
  136175. /**
  136176. * AKA Specular texture in other nomenclature.
  136177. */
  136178. protected _reflectivityTexture: Nullable<BaseTexture>;
  136179. /**
  136180. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136181. */
  136182. protected _metallicTexture: Nullable<BaseTexture>;
  136183. /**
  136184. * Specifies the metallic scalar of the metallic/roughness workflow.
  136185. * Can also be used to scale the metalness values of the metallic texture.
  136186. */
  136187. protected _metallic: Nullable<number>;
  136188. /**
  136189. * Specifies the roughness scalar of the metallic/roughness workflow.
  136190. * Can also be used to scale the roughness values of the metallic texture.
  136191. */
  136192. protected _roughness: Nullable<number>;
  136193. /**
  136194. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136195. * By default the indexOfrefraction is used to compute F0;
  136196. *
  136197. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136198. *
  136199. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136200. * F90 = metallicReflectanceColor;
  136201. */
  136202. protected _metallicF0Factor: number;
  136203. /**
  136204. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136205. * By default the F90 is always 1;
  136206. *
  136207. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136208. *
  136209. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136210. * F90 = metallicReflectanceColor;
  136211. */
  136212. protected _metallicReflectanceColor: Color3;
  136213. /**
  136214. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136215. * This is multiply against the scalar values defined in the material.
  136216. */
  136217. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136218. /**
  136219. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136220. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136221. */
  136222. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136223. /**
  136224. * Stores surface normal data used to displace a mesh in a texture.
  136225. */
  136226. protected _bumpTexture: Nullable<BaseTexture>;
  136227. /**
  136228. * Stores the pre-calculated light information of a mesh in a texture.
  136229. */
  136230. protected _lightmapTexture: Nullable<BaseTexture>;
  136231. /**
  136232. * The color of a material in ambient lighting.
  136233. */
  136234. protected _ambientColor: Color3;
  136235. /**
  136236. * AKA Diffuse Color in other nomenclature.
  136237. */
  136238. protected _albedoColor: Color3;
  136239. /**
  136240. * AKA Specular Color in other nomenclature.
  136241. */
  136242. protected _reflectivityColor: Color3;
  136243. /**
  136244. * The color applied when light is reflected from a material.
  136245. */
  136246. protected _reflectionColor: Color3;
  136247. /**
  136248. * The color applied when light is emitted from a material.
  136249. */
  136250. protected _emissiveColor: Color3;
  136251. /**
  136252. * AKA Glossiness in other nomenclature.
  136253. */
  136254. protected _microSurface: number;
  136255. /**
  136256. * Specifies that the material will use the light map as a show map.
  136257. */
  136258. protected _useLightmapAsShadowmap: boolean;
  136259. /**
  136260. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136261. * makes the reflect vector face the model (under horizon).
  136262. */
  136263. protected _useHorizonOcclusion: boolean;
  136264. /**
  136265. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136266. * too much the area relying on ambient texture to define their ambient occlusion.
  136267. */
  136268. protected _useRadianceOcclusion: boolean;
  136269. /**
  136270. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136271. */
  136272. protected _useAlphaFromAlbedoTexture: boolean;
  136273. /**
  136274. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136275. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136276. */
  136277. protected _useSpecularOverAlpha: boolean;
  136278. /**
  136279. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136280. */
  136281. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136282. /**
  136283. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136284. */
  136285. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136286. /**
  136287. * Specifies if the metallic texture contains the roughness information in its green channel.
  136288. */
  136289. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136290. /**
  136291. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136292. */
  136293. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136294. /**
  136295. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136296. */
  136297. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136298. /**
  136299. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136300. */
  136301. protected _useAmbientInGrayScale: boolean;
  136302. /**
  136303. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136304. * The material will try to infer what glossiness each pixel should be.
  136305. */
  136306. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136307. /**
  136308. * Defines the falloff type used in this material.
  136309. * It by default is Physical.
  136310. */
  136311. protected _lightFalloff: number;
  136312. /**
  136313. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136314. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136315. */
  136316. protected _useRadianceOverAlpha: boolean;
  136317. /**
  136318. * Allows using an object space normal map (instead of tangent space).
  136319. */
  136320. protected _useObjectSpaceNormalMap: boolean;
  136321. /**
  136322. * Allows using the bump map in parallax mode.
  136323. */
  136324. protected _useParallax: boolean;
  136325. /**
  136326. * Allows using the bump map in parallax occlusion mode.
  136327. */
  136328. protected _useParallaxOcclusion: boolean;
  136329. /**
  136330. * Controls the scale bias of the parallax mode.
  136331. */
  136332. protected _parallaxScaleBias: number;
  136333. /**
  136334. * If sets to true, disables all the lights affecting the material.
  136335. */
  136336. protected _disableLighting: boolean;
  136337. /**
  136338. * Number of Simultaneous lights allowed on the material.
  136339. */
  136340. protected _maxSimultaneousLights: number;
  136341. /**
  136342. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136343. */
  136344. protected _invertNormalMapX: boolean;
  136345. /**
  136346. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136347. */
  136348. protected _invertNormalMapY: boolean;
  136349. /**
  136350. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136351. */
  136352. protected _twoSidedLighting: boolean;
  136353. /**
  136354. * Defines the alpha limits in alpha test mode.
  136355. */
  136356. protected _alphaCutOff: number;
  136357. /**
  136358. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136359. */
  136360. protected _forceAlphaTest: boolean;
  136361. /**
  136362. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136363. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136364. */
  136365. protected _useAlphaFresnel: boolean;
  136366. /**
  136367. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136368. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136369. */
  136370. protected _useLinearAlphaFresnel: boolean;
  136371. /**
  136372. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136373. * from cos thetav and roughness:
  136374. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136375. */
  136376. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136377. /**
  136378. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136379. */
  136380. protected _forceIrradianceInFragment: boolean;
  136381. private _realTimeFiltering;
  136382. /**
  136383. * Enables realtime filtering on the texture.
  136384. */
  136385. get realTimeFiltering(): boolean;
  136386. set realTimeFiltering(b: boolean);
  136387. private _realTimeFilteringQuality;
  136388. /**
  136389. * Quality switch for realtime filtering
  136390. */
  136391. get realTimeFilteringQuality(): number;
  136392. set realTimeFilteringQuality(n: number);
  136393. /**
  136394. * Can this material render to several textures at once
  136395. */
  136396. get canRenderToMRT(): boolean;
  136397. /**
  136398. * Force normal to face away from face.
  136399. */
  136400. protected _forceNormalForward: boolean;
  136401. /**
  136402. * Enables specular anti aliasing in the PBR shader.
  136403. * It will both interacts on the Geometry for analytical and IBL lighting.
  136404. * It also prefilter the roughness map based on the bump values.
  136405. */
  136406. protected _enableSpecularAntiAliasing: boolean;
  136407. /**
  136408. * Default configuration related to image processing available in the PBR Material.
  136409. */
  136410. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136411. /**
  136412. * Keep track of the image processing observer to allow dispose and replace.
  136413. */
  136414. private _imageProcessingObserver;
  136415. /**
  136416. * Attaches a new image processing configuration to the PBR Material.
  136417. * @param configuration
  136418. */
  136419. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136420. /**
  136421. * Stores the available render targets.
  136422. */
  136423. private _renderTargets;
  136424. /**
  136425. * Sets the global ambient color for the material used in lighting calculations.
  136426. */
  136427. private _globalAmbientColor;
  136428. /**
  136429. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136430. */
  136431. private _useLogarithmicDepth;
  136432. /**
  136433. * If set to true, no lighting calculations will be applied.
  136434. */
  136435. private _unlit;
  136436. private _debugMode;
  136437. /**
  136438. * @hidden
  136439. * This is reserved for the inspector.
  136440. * Defines the material debug mode.
  136441. * It helps seeing only some components of the material while troubleshooting.
  136442. */
  136443. debugMode: number;
  136444. /**
  136445. * @hidden
  136446. * This is reserved for the inspector.
  136447. * Specify from where on screen the debug mode should start.
  136448. * The value goes from -1 (full screen) to 1 (not visible)
  136449. * It helps with side by side comparison against the final render
  136450. * This defaults to -1
  136451. */
  136452. private debugLimit;
  136453. /**
  136454. * @hidden
  136455. * This is reserved for the inspector.
  136456. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136457. * You can use the factor to better multiply the final value.
  136458. */
  136459. private debugFactor;
  136460. /**
  136461. * Defines the clear coat layer parameters for the material.
  136462. */
  136463. readonly clearCoat: PBRClearCoatConfiguration;
  136464. /**
  136465. * Defines the anisotropic parameters for the material.
  136466. */
  136467. readonly anisotropy: PBRAnisotropicConfiguration;
  136468. /**
  136469. * Defines the BRDF parameters for the material.
  136470. */
  136471. readonly brdf: PBRBRDFConfiguration;
  136472. /**
  136473. * Defines the Sheen parameters for the material.
  136474. */
  136475. readonly sheen: PBRSheenConfiguration;
  136476. /**
  136477. * Defines the SubSurface parameters for the material.
  136478. */
  136479. readonly subSurface: PBRSubSurfaceConfiguration;
  136480. /**
  136481. * Defines the detail map parameters for the material.
  136482. */
  136483. readonly detailMap: DetailMapConfiguration;
  136484. protected _rebuildInParallel: boolean;
  136485. /**
  136486. * Instantiates a new PBRMaterial instance.
  136487. *
  136488. * @param name The material name
  136489. * @param scene The scene the material will be use in.
  136490. */
  136491. constructor(name: string, scene: Scene);
  136492. /**
  136493. * Gets a boolean indicating that current material needs to register RTT
  136494. */
  136495. get hasRenderTargetTextures(): boolean;
  136496. /**
  136497. * Gets the name of the material class.
  136498. */
  136499. getClassName(): string;
  136500. /**
  136501. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136502. */
  136503. get useLogarithmicDepth(): boolean;
  136504. /**
  136505. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136506. */
  136507. set useLogarithmicDepth(value: boolean);
  136508. /**
  136509. * Returns true if alpha blending should be disabled.
  136510. */
  136511. protected get _disableAlphaBlending(): boolean;
  136512. /**
  136513. * Specifies whether or not this material should be rendered in alpha blend mode.
  136514. */
  136515. needAlphaBlending(): boolean;
  136516. /**
  136517. * Specifies whether or not this material should be rendered in alpha test mode.
  136518. */
  136519. needAlphaTesting(): boolean;
  136520. /**
  136521. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136522. */
  136523. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136524. /**
  136525. * Gets the texture used for the alpha test.
  136526. */
  136527. getAlphaTestTexture(): Nullable<BaseTexture>;
  136528. /**
  136529. * Specifies that the submesh is ready to be used.
  136530. * @param mesh - BJS mesh.
  136531. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136532. * @param useInstances - Specifies that instances should be used.
  136533. * @returns - boolean indicating that the submesh is ready or not.
  136534. */
  136535. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136536. /**
  136537. * Specifies if the material uses metallic roughness workflow.
  136538. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136539. */
  136540. isMetallicWorkflow(): boolean;
  136541. private _prepareEffect;
  136542. private _prepareDefines;
  136543. /**
  136544. * Force shader compilation
  136545. */
  136546. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136547. /**
  136548. * Initializes the uniform buffer layout for the shader.
  136549. */
  136550. buildUniformLayout(): void;
  136551. /**
  136552. * Unbinds the material from the mesh
  136553. */
  136554. unbind(): void;
  136555. /**
  136556. * Binds the submesh data.
  136557. * @param world - The world matrix.
  136558. * @param mesh - The BJS mesh.
  136559. * @param subMesh - A submesh of the BJS mesh.
  136560. */
  136561. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136562. /**
  136563. * Returns the animatable textures.
  136564. * @returns - Array of animatable textures.
  136565. */
  136566. getAnimatables(): IAnimatable[];
  136567. /**
  136568. * Returns the texture used for reflections.
  136569. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136570. */
  136571. private _getReflectionTexture;
  136572. /**
  136573. * Returns an array of the actively used textures.
  136574. * @returns - Array of BaseTextures
  136575. */
  136576. getActiveTextures(): BaseTexture[];
  136577. /**
  136578. * Checks to see if a texture is used in the material.
  136579. * @param texture - Base texture to use.
  136580. * @returns - Boolean specifying if a texture is used in the material.
  136581. */
  136582. hasTexture(texture: BaseTexture): boolean;
  136583. /**
  136584. * Sets the required values to the prepass renderer.
  136585. * @param prePassRenderer defines the prepass renderer to setup
  136586. */
  136587. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136588. /**
  136589. * Disposes the resources of the material.
  136590. * @param forceDisposeEffect - Forces the disposal of effects.
  136591. * @param forceDisposeTextures - Forces the disposal of all textures.
  136592. */
  136593. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136594. }
  136595. }
  136596. declare module BABYLON {
  136597. /**
  136598. * The Physically based material of BJS.
  136599. *
  136600. * This offers the main features of a standard PBR material.
  136601. * For more information, please refer to the documentation :
  136602. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136603. */
  136604. export class PBRMaterial extends PBRBaseMaterial {
  136605. /**
  136606. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136607. */
  136608. static readonly PBRMATERIAL_OPAQUE: number;
  136609. /**
  136610. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136611. */
  136612. static readonly PBRMATERIAL_ALPHATEST: number;
  136613. /**
  136614. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136615. */
  136616. static readonly PBRMATERIAL_ALPHABLEND: number;
  136617. /**
  136618. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136619. * They are also discarded below the alpha cutoff threshold to improve performances.
  136620. */
  136621. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136622. /**
  136623. * Defines the default value of how much AO map is occluding the analytical lights
  136624. * (point spot...).
  136625. */
  136626. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136627. /**
  136628. * Intensity of the direct lights e.g. the four lights available in your scene.
  136629. * This impacts both the direct diffuse and specular highlights.
  136630. */
  136631. directIntensity: number;
  136632. /**
  136633. * Intensity of the emissive part of the material.
  136634. * This helps controlling the emissive effect without modifying the emissive color.
  136635. */
  136636. emissiveIntensity: number;
  136637. /**
  136638. * Intensity of the environment e.g. how much the environment will light the object
  136639. * either through harmonics for rough material or through the refelction for shiny ones.
  136640. */
  136641. environmentIntensity: number;
  136642. /**
  136643. * This is a special control allowing the reduction of the specular highlights coming from the
  136644. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136645. */
  136646. specularIntensity: number;
  136647. /**
  136648. * Debug Control allowing disabling the bump map on this material.
  136649. */
  136650. disableBumpMap: boolean;
  136651. /**
  136652. * AKA Diffuse Texture in standard nomenclature.
  136653. */
  136654. albedoTexture: BaseTexture;
  136655. /**
  136656. * AKA Occlusion Texture in other nomenclature.
  136657. */
  136658. ambientTexture: BaseTexture;
  136659. /**
  136660. * AKA Occlusion Texture Intensity in other nomenclature.
  136661. */
  136662. ambientTextureStrength: number;
  136663. /**
  136664. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136665. * 1 means it completely occludes it
  136666. * 0 mean it has no impact
  136667. */
  136668. ambientTextureImpactOnAnalyticalLights: number;
  136669. /**
  136670. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136671. */
  136672. opacityTexture: BaseTexture;
  136673. /**
  136674. * Stores the reflection values in a texture.
  136675. */
  136676. reflectionTexture: Nullable<BaseTexture>;
  136677. /**
  136678. * Stores the emissive values in a texture.
  136679. */
  136680. emissiveTexture: BaseTexture;
  136681. /**
  136682. * AKA Specular texture in other nomenclature.
  136683. */
  136684. reflectivityTexture: BaseTexture;
  136685. /**
  136686. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136687. */
  136688. metallicTexture: BaseTexture;
  136689. /**
  136690. * Specifies the metallic scalar of the metallic/roughness workflow.
  136691. * Can also be used to scale the metalness values of the metallic texture.
  136692. */
  136693. metallic: Nullable<number>;
  136694. /**
  136695. * Specifies the roughness scalar of the metallic/roughness workflow.
  136696. * Can also be used to scale the roughness values of the metallic texture.
  136697. */
  136698. roughness: Nullable<number>;
  136699. /**
  136700. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136701. * By default the indexOfrefraction is used to compute F0;
  136702. *
  136703. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136704. *
  136705. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136706. * F90 = metallicReflectanceColor;
  136707. */
  136708. metallicF0Factor: number;
  136709. /**
  136710. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136711. * By default the F90 is always 1;
  136712. *
  136713. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136714. *
  136715. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136716. * F90 = metallicReflectanceColor;
  136717. */
  136718. metallicReflectanceColor: Color3;
  136719. /**
  136720. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136721. * This is multiply against the scalar values defined in the material.
  136722. */
  136723. metallicReflectanceTexture: Nullable<BaseTexture>;
  136724. /**
  136725. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136726. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136727. */
  136728. microSurfaceTexture: BaseTexture;
  136729. /**
  136730. * Stores surface normal data used to displace a mesh in a texture.
  136731. */
  136732. bumpTexture: BaseTexture;
  136733. /**
  136734. * Stores the pre-calculated light information of a mesh in a texture.
  136735. */
  136736. lightmapTexture: BaseTexture;
  136737. /**
  136738. * Stores the refracted light information in a texture.
  136739. */
  136740. get refractionTexture(): Nullable<BaseTexture>;
  136741. set refractionTexture(value: Nullable<BaseTexture>);
  136742. /**
  136743. * The color of a material in ambient lighting.
  136744. */
  136745. ambientColor: Color3;
  136746. /**
  136747. * AKA Diffuse Color in other nomenclature.
  136748. */
  136749. albedoColor: Color3;
  136750. /**
  136751. * AKA Specular Color in other nomenclature.
  136752. */
  136753. reflectivityColor: Color3;
  136754. /**
  136755. * The color reflected from the material.
  136756. */
  136757. reflectionColor: Color3;
  136758. /**
  136759. * The color emitted from the material.
  136760. */
  136761. emissiveColor: Color3;
  136762. /**
  136763. * AKA Glossiness in other nomenclature.
  136764. */
  136765. microSurface: number;
  136766. /**
  136767. * Index of refraction of the material base layer.
  136768. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136769. *
  136770. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136771. *
  136772. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136773. */
  136774. get indexOfRefraction(): number;
  136775. set indexOfRefraction(value: number);
  136776. /**
  136777. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136778. */
  136779. get invertRefractionY(): boolean;
  136780. set invertRefractionY(value: boolean);
  136781. /**
  136782. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136783. * Materials half opaque for instance using refraction could benefit from this control.
  136784. */
  136785. get linkRefractionWithTransparency(): boolean;
  136786. set linkRefractionWithTransparency(value: boolean);
  136787. /**
  136788. * If true, the light map contains occlusion information instead of lighting info.
  136789. */
  136790. useLightmapAsShadowmap: boolean;
  136791. /**
  136792. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136793. */
  136794. useAlphaFromAlbedoTexture: boolean;
  136795. /**
  136796. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136797. */
  136798. forceAlphaTest: boolean;
  136799. /**
  136800. * Defines the alpha limits in alpha test mode.
  136801. */
  136802. alphaCutOff: number;
  136803. /**
  136804. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136805. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136806. */
  136807. useSpecularOverAlpha: boolean;
  136808. /**
  136809. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136810. */
  136811. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136812. /**
  136813. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136814. */
  136815. useRoughnessFromMetallicTextureAlpha: boolean;
  136816. /**
  136817. * Specifies if the metallic texture contains the roughness information in its green channel.
  136818. */
  136819. useRoughnessFromMetallicTextureGreen: boolean;
  136820. /**
  136821. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136822. */
  136823. useMetallnessFromMetallicTextureBlue: boolean;
  136824. /**
  136825. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136826. */
  136827. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136828. /**
  136829. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136830. */
  136831. useAmbientInGrayScale: boolean;
  136832. /**
  136833. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136834. * The material will try to infer what glossiness each pixel should be.
  136835. */
  136836. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136837. /**
  136838. * BJS is using an harcoded light falloff based on a manually sets up range.
  136839. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136840. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136841. */
  136842. get usePhysicalLightFalloff(): boolean;
  136843. /**
  136844. * BJS is using an harcoded light falloff based on a manually sets up range.
  136845. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136846. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136847. */
  136848. set usePhysicalLightFalloff(value: boolean);
  136849. /**
  136850. * In order to support the falloff compatibility with gltf, a special mode has been added
  136851. * to reproduce the gltf light falloff.
  136852. */
  136853. get useGLTFLightFalloff(): boolean;
  136854. /**
  136855. * In order to support the falloff compatibility with gltf, a special mode has been added
  136856. * to reproduce the gltf light falloff.
  136857. */
  136858. set useGLTFLightFalloff(value: boolean);
  136859. /**
  136860. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136861. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136862. */
  136863. useRadianceOverAlpha: boolean;
  136864. /**
  136865. * Allows using an object space normal map (instead of tangent space).
  136866. */
  136867. useObjectSpaceNormalMap: boolean;
  136868. /**
  136869. * Allows using the bump map in parallax mode.
  136870. */
  136871. useParallax: boolean;
  136872. /**
  136873. * Allows using the bump map in parallax occlusion mode.
  136874. */
  136875. useParallaxOcclusion: boolean;
  136876. /**
  136877. * Controls the scale bias of the parallax mode.
  136878. */
  136879. parallaxScaleBias: number;
  136880. /**
  136881. * If sets to true, disables all the lights affecting the material.
  136882. */
  136883. disableLighting: boolean;
  136884. /**
  136885. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136886. */
  136887. forceIrradianceInFragment: boolean;
  136888. /**
  136889. * Number of Simultaneous lights allowed on the material.
  136890. */
  136891. maxSimultaneousLights: number;
  136892. /**
  136893. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136894. */
  136895. invertNormalMapX: boolean;
  136896. /**
  136897. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136898. */
  136899. invertNormalMapY: boolean;
  136900. /**
  136901. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136902. */
  136903. twoSidedLighting: boolean;
  136904. /**
  136905. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136906. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136907. */
  136908. useAlphaFresnel: boolean;
  136909. /**
  136910. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136911. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136912. */
  136913. useLinearAlphaFresnel: boolean;
  136914. /**
  136915. * Let user defines the brdf lookup texture used for IBL.
  136916. * A default 8bit version is embedded but you could point at :
  136917. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136918. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136919. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136920. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136921. */
  136922. environmentBRDFTexture: Nullable<BaseTexture>;
  136923. /**
  136924. * Force normal to face away from face.
  136925. */
  136926. forceNormalForward: boolean;
  136927. /**
  136928. * Enables specular anti aliasing in the PBR shader.
  136929. * It will both interacts on the Geometry for analytical and IBL lighting.
  136930. * It also prefilter the roughness map based on the bump values.
  136931. */
  136932. enableSpecularAntiAliasing: boolean;
  136933. /**
  136934. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136935. * makes the reflect vector face the model (under horizon).
  136936. */
  136937. useHorizonOcclusion: boolean;
  136938. /**
  136939. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136940. * too much the area relying on ambient texture to define their ambient occlusion.
  136941. */
  136942. useRadianceOcclusion: boolean;
  136943. /**
  136944. * If set to true, no lighting calculations will be applied.
  136945. */
  136946. unlit: boolean;
  136947. /**
  136948. * Gets the image processing configuration used either in this material.
  136949. */
  136950. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136951. /**
  136952. * Sets the Default image processing configuration used either in the this material.
  136953. *
  136954. * If sets to null, the scene one is in use.
  136955. */
  136956. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136957. /**
  136958. * Gets wether the color curves effect is enabled.
  136959. */
  136960. get cameraColorCurvesEnabled(): boolean;
  136961. /**
  136962. * Sets wether the color curves effect is enabled.
  136963. */
  136964. set cameraColorCurvesEnabled(value: boolean);
  136965. /**
  136966. * Gets wether the color grading effect is enabled.
  136967. */
  136968. get cameraColorGradingEnabled(): boolean;
  136969. /**
  136970. * Gets wether the color grading effect is enabled.
  136971. */
  136972. set cameraColorGradingEnabled(value: boolean);
  136973. /**
  136974. * Gets wether tonemapping is enabled or not.
  136975. */
  136976. get cameraToneMappingEnabled(): boolean;
  136977. /**
  136978. * Sets wether tonemapping is enabled or not
  136979. */
  136980. set cameraToneMappingEnabled(value: boolean);
  136981. /**
  136982. * The camera exposure used on this material.
  136983. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136984. * This corresponds to a photographic exposure.
  136985. */
  136986. get cameraExposure(): number;
  136987. /**
  136988. * The camera exposure used on this material.
  136989. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136990. * This corresponds to a photographic exposure.
  136991. */
  136992. set cameraExposure(value: number);
  136993. /**
  136994. * Gets The camera contrast used on this material.
  136995. */
  136996. get cameraContrast(): number;
  136997. /**
  136998. * Sets The camera contrast used on this material.
  136999. */
  137000. set cameraContrast(value: number);
  137001. /**
  137002. * Gets the Color Grading 2D Lookup Texture.
  137003. */
  137004. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  137005. /**
  137006. * Sets the Color Grading 2D Lookup Texture.
  137007. */
  137008. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  137009. /**
  137010. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137011. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137012. * 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;
  137013. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137014. */
  137015. get cameraColorCurves(): Nullable<ColorCurves>;
  137016. /**
  137017. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137018. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137019. * 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;
  137020. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137021. */
  137022. set cameraColorCurves(value: Nullable<ColorCurves>);
  137023. /**
  137024. * Instantiates a new PBRMaterial instance.
  137025. *
  137026. * @param name The material name
  137027. * @param scene The scene the material will be use in.
  137028. */
  137029. constructor(name: string, scene: Scene);
  137030. /**
  137031. * Returns the name of this material class.
  137032. */
  137033. getClassName(): string;
  137034. /**
  137035. * Makes a duplicate of the current material.
  137036. * @param name - name to use for the new material.
  137037. */
  137038. clone(name: string): PBRMaterial;
  137039. /**
  137040. * Serializes this PBR Material.
  137041. * @returns - An object with the serialized material.
  137042. */
  137043. serialize(): any;
  137044. /**
  137045. * Parses a PBR Material from a serialized object.
  137046. * @param source - Serialized object.
  137047. * @param scene - BJS scene instance.
  137048. * @param rootUrl - url for the scene object
  137049. * @returns - PBRMaterial
  137050. */
  137051. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137052. }
  137053. }
  137054. declare module BABYLON {
  137055. /**
  137056. * Direct draw surface info
  137057. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137058. */
  137059. export interface DDSInfo {
  137060. /**
  137061. * Width of the texture
  137062. */
  137063. width: number;
  137064. /**
  137065. * Width of the texture
  137066. */
  137067. height: number;
  137068. /**
  137069. * Number of Mipmaps for the texture
  137070. * @see https://en.wikipedia.org/wiki/Mipmap
  137071. */
  137072. mipmapCount: number;
  137073. /**
  137074. * If the textures format is a known fourCC format
  137075. * @see https://www.fourcc.org/
  137076. */
  137077. isFourCC: boolean;
  137078. /**
  137079. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137080. */
  137081. isRGB: boolean;
  137082. /**
  137083. * If the texture is a lumincance format
  137084. */
  137085. isLuminance: boolean;
  137086. /**
  137087. * If this is a cube texture
  137088. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137089. */
  137090. isCube: boolean;
  137091. /**
  137092. * If the texture is a compressed format eg. FOURCC_DXT1
  137093. */
  137094. isCompressed: boolean;
  137095. /**
  137096. * The dxgiFormat of the texture
  137097. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137098. */
  137099. dxgiFormat: number;
  137100. /**
  137101. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137102. */
  137103. textureType: number;
  137104. /**
  137105. * Sphericle polynomial created for the dds texture
  137106. */
  137107. sphericalPolynomial?: SphericalPolynomial;
  137108. }
  137109. /**
  137110. * Class used to provide DDS decompression tools
  137111. */
  137112. export class DDSTools {
  137113. /**
  137114. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137115. */
  137116. static StoreLODInAlphaChannel: boolean;
  137117. /**
  137118. * Gets DDS information from an array buffer
  137119. * @param data defines the array buffer view to read data from
  137120. * @returns the DDS information
  137121. */
  137122. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137123. private static _FloatView;
  137124. private static _Int32View;
  137125. private static _ToHalfFloat;
  137126. private static _FromHalfFloat;
  137127. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137128. private static _GetHalfFloatRGBAArrayBuffer;
  137129. private static _GetFloatRGBAArrayBuffer;
  137130. private static _GetFloatAsUIntRGBAArrayBuffer;
  137131. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137132. private static _GetRGBAArrayBuffer;
  137133. private static _ExtractLongWordOrder;
  137134. private static _GetRGBArrayBuffer;
  137135. private static _GetLuminanceArrayBuffer;
  137136. /**
  137137. * Uploads DDS Levels to a Babylon Texture
  137138. * @hidden
  137139. */
  137140. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137141. }
  137142. interface ThinEngine {
  137143. /**
  137144. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137145. * @param rootUrl defines the url where the file to load is located
  137146. * @param scene defines the current scene
  137147. * @param lodScale defines scale to apply to the mip map selection
  137148. * @param lodOffset defines offset to apply to the mip map selection
  137149. * @param onLoad defines an optional callback raised when the texture is loaded
  137150. * @param onError defines an optional callback raised if there is an issue to load the texture
  137151. * @param format defines the format of the data
  137152. * @param forcedExtension defines the extension to use to pick the right loader
  137153. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137154. * @returns the cube texture as an InternalTexture
  137155. */
  137156. 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;
  137157. }
  137158. }
  137159. declare module BABYLON {
  137160. /**
  137161. * Implementation of the DDS Texture Loader.
  137162. * @hidden
  137163. */
  137164. export class _DDSTextureLoader implements IInternalTextureLoader {
  137165. /**
  137166. * Defines wether the loader supports cascade loading the different faces.
  137167. */
  137168. readonly supportCascades: boolean;
  137169. /**
  137170. * This returns if the loader support the current file information.
  137171. * @param extension defines the file extension of the file being loaded
  137172. * @returns true if the loader can load the specified file
  137173. */
  137174. canLoad(extension: string): boolean;
  137175. /**
  137176. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137177. * @param data contains the texture data
  137178. * @param texture defines the BabylonJS internal texture
  137179. * @param createPolynomials will be true if polynomials have been requested
  137180. * @param onLoad defines the callback to trigger once the texture is ready
  137181. * @param onError defines the callback to trigger in case of error
  137182. */
  137183. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137184. /**
  137185. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137186. * @param data contains the texture data
  137187. * @param texture defines the BabylonJS internal texture
  137188. * @param callback defines the method to call once ready to upload
  137189. */
  137190. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137191. }
  137192. }
  137193. declare module BABYLON {
  137194. /**
  137195. * Implementation of the ENV Texture Loader.
  137196. * @hidden
  137197. */
  137198. export class _ENVTextureLoader implements IInternalTextureLoader {
  137199. /**
  137200. * Defines wether the loader supports cascade loading the different faces.
  137201. */
  137202. readonly supportCascades: boolean;
  137203. /**
  137204. * This returns if the loader support the current file information.
  137205. * @param extension defines the file extension of the file being loaded
  137206. * @returns true if the loader can load the specified file
  137207. */
  137208. canLoad(extension: string): boolean;
  137209. /**
  137210. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137211. * @param data contains the texture data
  137212. * @param texture defines the BabylonJS internal texture
  137213. * @param createPolynomials will be true if polynomials have been requested
  137214. * @param onLoad defines the callback to trigger once the texture is ready
  137215. * @param onError defines the callback to trigger in case of error
  137216. */
  137217. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137218. /**
  137219. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137220. * @param data contains the texture data
  137221. * @param texture defines the BabylonJS internal texture
  137222. * @param callback defines the method to call once ready to upload
  137223. */
  137224. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137225. }
  137226. }
  137227. declare module BABYLON {
  137228. /**
  137229. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137230. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137231. */
  137232. export class KhronosTextureContainer {
  137233. /** contents of the KTX container file */
  137234. data: ArrayBufferView;
  137235. private static HEADER_LEN;
  137236. private static COMPRESSED_2D;
  137237. private static COMPRESSED_3D;
  137238. private static TEX_2D;
  137239. private static TEX_3D;
  137240. /**
  137241. * Gets the openGL type
  137242. */
  137243. glType: number;
  137244. /**
  137245. * Gets the openGL type size
  137246. */
  137247. glTypeSize: number;
  137248. /**
  137249. * Gets the openGL format
  137250. */
  137251. glFormat: number;
  137252. /**
  137253. * Gets the openGL internal format
  137254. */
  137255. glInternalFormat: number;
  137256. /**
  137257. * Gets the base internal format
  137258. */
  137259. glBaseInternalFormat: number;
  137260. /**
  137261. * Gets image width in pixel
  137262. */
  137263. pixelWidth: number;
  137264. /**
  137265. * Gets image height in pixel
  137266. */
  137267. pixelHeight: number;
  137268. /**
  137269. * Gets image depth in pixels
  137270. */
  137271. pixelDepth: number;
  137272. /**
  137273. * Gets the number of array elements
  137274. */
  137275. numberOfArrayElements: number;
  137276. /**
  137277. * Gets the number of faces
  137278. */
  137279. numberOfFaces: number;
  137280. /**
  137281. * Gets the number of mipmap levels
  137282. */
  137283. numberOfMipmapLevels: number;
  137284. /**
  137285. * Gets the bytes of key value data
  137286. */
  137287. bytesOfKeyValueData: number;
  137288. /**
  137289. * Gets the load type
  137290. */
  137291. loadType: number;
  137292. /**
  137293. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137294. */
  137295. isInvalid: boolean;
  137296. /**
  137297. * Creates a new KhronosTextureContainer
  137298. * @param data contents of the KTX container file
  137299. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137300. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137301. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137302. */
  137303. constructor(
  137304. /** contents of the KTX container file */
  137305. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137306. /**
  137307. * Uploads KTX content to a Babylon Texture.
  137308. * It is assumed that the texture has already been created & is currently bound
  137309. * @hidden
  137310. */
  137311. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137312. private _upload2DCompressedLevels;
  137313. /**
  137314. * Checks if the given data starts with a KTX file identifier.
  137315. * @param data the data to check
  137316. * @returns true if the data is a KTX file or false otherwise
  137317. */
  137318. static IsValid(data: ArrayBufferView): boolean;
  137319. }
  137320. }
  137321. declare module BABYLON {
  137322. /**
  137323. * Class for loading KTX2 files
  137324. * !!! Experimental Extension Subject to Changes !!!
  137325. * @hidden
  137326. */
  137327. export class KhronosTextureContainer2 {
  137328. private static _ModulePromise;
  137329. private static _TranscodeFormat;
  137330. constructor(engine: ThinEngine);
  137331. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137332. private _determineTranscodeFormat;
  137333. /**
  137334. * Checks if the given data starts with a KTX2 file identifier.
  137335. * @param data the data to check
  137336. * @returns true if the data is a KTX2 file or false otherwise
  137337. */
  137338. static IsValid(data: ArrayBufferView): boolean;
  137339. }
  137340. }
  137341. declare module BABYLON {
  137342. /**
  137343. * Implementation of the KTX Texture Loader.
  137344. * @hidden
  137345. */
  137346. export class _KTXTextureLoader implements IInternalTextureLoader {
  137347. /**
  137348. * Defines wether the loader supports cascade loading the different faces.
  137349. */
  137350. readonly supportCascades: boolean;
  137351. /**
  137352. * This returns if the loader support the current file information.
  137353. * @param extension defines the file extension of the file being loaded
  137354. * @param mimeType defines the optional mime type of the file being loaded
  137355. * @returns true if the loader can load the specified file
  137356. */
  137357. canLoad(extension: string, mimeType?: string): boolean;
  137358. /**
  137359. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137360. * @param data contains the texture data
  137361. * @param texture defines the BabylonJS internal texture
  137362. * @param createPolynomials will be true if polynomials have been requested
  137363. * @param onLoad defines the callback to trigger once the texture is ready
  137364. * @param onError defines the callback to trigger in case of error
  137365. */
  137366. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137367. /**
  137368. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137369. * @param data contains the texture data
  137370. * @param texture defines the BabylonJS internal texture
  137371. * @param callback defines the method to call once ready to upload
  137372. */
  137373. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137374. }
  137375. }
  137376. declare module BABYLON {
  137377. /** @hidden */
  137378. export var _forceSceneHelpersToBundle: boolean;
  137379. interface Scene {
  137380. /**
  137381. * Creates a default light for the scene.
  137382. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137383. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137384. */
  137385. createDefaultLight(replace?: boolean): void;
  137386. /**
  137387. * Creates a default camera for the scene.
  137388. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137389. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137390. * @param replace has default false, when true replaces the active camera in the scene
  137391. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137392. */
  137393. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137394. /**
  137395. * Creates a default camera and a default light.
  137396. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137397. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137398. * @param replace has the default false, when true replaces the active camera/light in the scene
  137399. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137400. */
  137401. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137402. /**
  137403. * Creates a new sky box
  137404. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137405. * @param environmentTexture defines the texture to use as environment texture
  137406. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137407. * @param scale defines the overall scale of the skybox
  137408. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137409. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137410. * @returns a new mesh holding the sky box
  137411. */
  137412. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137413. /**
  137414. * Creates a new environment
  137415. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137416. * @param options defines the options you can use to configure the environment
  137417. * @returns the new EnvironmentHelper
  137418. */
  137419. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137420. /**
  137421. * Creates a new VREXperienceHelper
  137422. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137423. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137424. * @returns a new VREXperienceHelper
  137425. */
  137426. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137427. /**
  137428. * Creates a new WebXRDefaultExperience
  137429. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137430. * @param options experience options
  137431. * @returns a promise for a new WebXRDefaultExperience
  137432. */
  137433. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137434. }
  137435. }
  137436. declare module BABYLON {
  137437. /**
  137438. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137439. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137440. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137441. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137442. */
  137443. export class VideoDome extends TextureDome<VideoTexture> {
  137444. /**
  137445. * Define the video source as a Monoscopic panoramic 360 video.
  137446. */
  137447. static readonly MODE_MONOSCOPIC: number;
  137448. /**
  137449. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137450. */
  137451. static readonly MODE_TOPBOTTOM: number;
  137452. /**
  137453. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137454. */
  137455. static readonly MODE_SIDEBYSIDE: number;
  137456. /**
  137457. * Get the video texture associated with this video dome
  137458. */
  137459. get videoTexture(): VideoTexture;
  137460. /**
  137461. * Get the video mode of this dome
  137462. */
  137463. get videoMode(): number;
  137464. /**
  137465. * Set the video mode of this dome.
  137466. * @see textureMode
  137467. */
  137468. set videoMode(value: number);
  137469. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137470. }
  137471. }
  137472. declare module BABYLON {
  137473. /**
  137474. * This class can be used to get instrumentation data from a Babylon engine
  137475. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137476. */
  137477. export class EngineInstrumentation implements IDisposable {
  137478. /**
  137479. * Define the instrumented engine.
  137480. */
  137481. engine: Engine;
  137482. private _captureGPUFrameTime;
  137483. private _gpuFrameTimeToken;
  137484. private _gpuFrameTime;
  137485. private _captureShaderCompilationTime;
  137486. private _shaderCompilationTime;
  137487. private _onBeginFrameObserver;
  137488. private _onEndFrameObserver;
  137489. private _onBeforeShaderCompilationObserver;
  137490. private _onAfterShaderCompilationObserver;
  137491. /**
  137492. * Gets the perf counter used for GPU frame time
  137493. */
  137494. get gpuFrameTimeCounter(): PerfCounter;
  137495. /**
  137496. * Gets the GPU frame time capture status
  137497. */
  137498. get captureGPUFrameTime(): boolean;
  137499. /**
  137500. * Enable or disable the GPU frame time capture
  137501. */
  137502. set captureGPUFrameTime(value: boolean);
  137503. /**
  137504. * Gets the perf counter used for shader compilation time
  137505. */
  137506. get shaderCompilationTimeCounter(): PerfCounter;
  137507. /**
  137508. * Gets the shader compilation time capture status
  137509. */
  137510. get captureShaderCompilationTime(): boolean;
  137511. /**
  137512. * Enable or disable the shader compilation time capture
  137513. */
  137514. set captureShaderCompilationTime(value: boolean);
  137515. /**
  137516. * Instantiates a new engine instrumentation.
  137517. * This class can be used to get instrumentation data from a Babylon engine
  137518. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137519. * @param engine Defines the engine to instrument
  137520. */
  137521. constructor(
  137522. /**
  137523. * Define the instrumented engine.
  137524. */
  137525. engine: Engine);
  137526. /**
  137527. * Dispose and release associated resources.
  137528. */
  137529. dispose(): void;
  137530. }
  137531. }
  137532. declare module BABYLON {
  137533. /**
  137534. * This class can be used to get instrumentation data from a Babylon engine
  137535. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137536. */
  137537. export class SceneInstrumentation implements IDisposable {
  137538. /**
  137539. * Defines the scene to instrument
  137540. */
  137541. scene: Scene;
  137542. private _captureActiveMeshesEvaluationTime;
  137543. private _activeMeshesEvaluationTime;
  137544. private _captureRenderTargetsRenderTime;
  137545. private _renderTargetsRenderTime;
  137546. private _captureFrameTime;
  137547. private _frameTime;
  137548. private _captureRenderTime;
  137549. private _renderTime;
  137550. private _captureInterFrameTime;
  137551. private _interFrameTime;
  137552. private _captureParticlesRenderTime;
  137553. private _particlesRenderTime;
  137554. private _captureSpritesRenderTime;
  137555. private _spritesRenderTime;
  137556. private _capturePhysicsTime;
  137557. private _physicsTime;
  137558. private _captureAnimationsTime;
  137559. private _animationsTime;
  137560. private _captureCameraRenderTime;
  137561. private _cameraRenderTime;
  137562. private _onBeforeActiveMeshesEvaluationObserver;
  137563. private _onAfterActiveMeshesEvaluationObserver;
  137564. private _onBeforeRenderTargetsRenderObserver;
  137565. private _onAfterRenderTargetsRenderObserver;
  137566. private _onAfterRenderObserver;
  137567. private _onBeforeDrawPhaseObserver;
  137568. private _onAfterDrawPhaseObserver;
  137569. private _onBeforeAnimationsObserver;
  137570. private _onBeforeParticlesRenderingObserver;
  137571. private _onAfterParticlesRenderingObserver;
  137572. private _onBeforeSpritesRenderingObserver;
  137573. private _onAfterSpritesRenderingObserver;
  137574. private _onBeforePhysicsObserver;
  137575. private _onAfterPhysicsObserver;
  137576. private _onAfterAnimationsObserver;
  137577. private _onBeforeCameraRenderObserver;
  137578. private _onAfterCameraRenderObserver;
  137579. /**
  137580. * Gets the perf counter used for active meshes evaluation time
  137581. */
  137582. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137583. /**
  137584. * Gets the active meshes evaluation time capture status
  137585. */
  137586. get captureActiveMeshesEvaluationTime(): boolean;
  137587. /**
  137588. * Enable or disable the active meshes evaluation time capture
  137589. */
  137590. set captureActiveMeshesEvaluationTime(value: boolean);
  137591. /**
  137592. * Gets the perf counter used for render targets render time
  137593. */
  137594. get renderTargetsRenderTimeCounter(): PerfCounter;
  137595. /**
  137596. * Gets the render targets render time capture status
  137597. */
  137598. get captureRenderTargetsRenderTime(): boolean;
  137599. /**
  137600. * Enable or disable the render targets render time capture
  137601. */
  137602. set captureRenderTargetsRenderTime(value: boolean);
  137603. /**
  137604. * Gets the perf counter used for particles render time
  137605. */
  137606. get particlesRenderTimeCounter(): PerfCounter;
  137607. /**
  137608. * Gets the particles render time capture status
  137609. */
  137610. get captureParticlesRenderTime(): boolean;
  137611. /**
  137612. * Enable or disable the particles render time capture
  137613. */
  137614. set captureParticlesRenderTime(value: boolean);
  137615. /**
  137616. * Gets the perf counter used for sprites render time
  137617. */
  137618. get spritesRenderTimeCounter(): PerfCounter;
  137619. /**
  137620. * Gets the sprites render time capture status
  137621. */
  137622. get captureSpritesRenderTime(): boolean;
  137623. /**
  137624. * Enable or disable the sprites render time capture
  137625. */
  137626. set captureSpritesRenderTime(value: boolean);
  137627. /**
  137628. * Gets the perf counter used for physics time
  137629. */
  137630. get physicsTimeCounter(): PerfCounter;
  137631. /**
  137632. * Gets the physics time capture status
  137633. */
  137634. get capturePhysicsTime(): boolean;
  137635. /**
  137636. * Enable or disable the physics time capture
  137637. */
  137638. set capturePhysicsTime(value: boolean);
  137639. /**
  137640. * Gets the perf counter used for animations time
  137641. */
  137642. get animationsTimeCounter(): PerfCounter;
  137643. /**
  137644. * Gets the animations time capture status
  137645. */
  137646. get captureAnimationsTime(): boolean;
  137647. /**
  137648. * Enable or disable the animations time capture
  137649. */
  137650. set captureAnimationsTime(value: boolean);
  137651. /**
  137652. * Gets the perf counter used for frame time capture
  137653. */
  137654. get frameTimeCounter(): PerfCounter;
  137655. /**
  137656. * Gets the frame time capture status
  137657. */
  137658. get captureFrameTime(): boolean;
  137659. /**
  137660. * Enable or disable the frame time capture
  137661. */
  137662. set captureFrameTime(value: boolean);
  137663. /**
  137664. * Gets the perf counter used for inter-frames time capture
  137665. */
  137666. get interFrameTimeCounter(): PerfCounter;
  137667. /**
  137668. * Gets the inter-frames time capture status
  137669. */
  137670. get captureInterFrameTime(): boolean;
  137671. /**
  137672. * Enable or disable the inter-frames time capture
  137673. */
  137674. set captureInterFrameTime(value: boolean);
  137675. /**
  137676. * Gets the perf counter used for render time capture
  137677. */
  137678. get renderTimeCounter(): PerfCounter;
  137679. /**
  137680. * Gets the render time capture status
  137681. */
  137682. get captureRenderTime(): boolean;
  137683. /**
  137684. * Enable or disable the render time capture
  137685. */
  137686. set captureRenderTime(value: boolean);
  137687. /**
  137688. * Gets the perf counter used for camera render time capture
  137689. */
  137690. get cameraRenderTimeCounter(): PerfCounter;
  137691. /**
  137692. * Gets the camera render time capture status
  137693. */
  137694. get captureCameraRenderTime(): boolean;
  137695. /**
  137696. * Enable or disable the camera render time capture
  137697. */
  137698. set captureCameraRenderTime(value: boolean);
  137699. /**
  137700. * Gets the perf counter used for draw calls
  137701. */
  137702. get drawCallsCounter(): PerfCounter;
  137703. /**
  137704. * Instantiates a new scene instrumentation.
  137705. * This class can be used to get instrumentation data from a Babylon engine
  137706. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137707. * @param scene Defines the scene to instrument
  137708. */
  137709. constructor(
  137710. /**
  137711. * Defines the scene to instrument
  137712. */
  137713. scene: Scene);
  137714. /**
  137715. * Dispose and release associated resources.
  137716. */
  137717. dispose(): void;
  137718. }
  137719. }
  137720. declare module BABYLON {
  137721. /** @hidden */
  137722. export var glowMapGenerationPixelShader: {
  137723. name: string;
  137724. shader: string;
  137725. };
  137726. }
  137727. declare module BABYLON {
  137728. /** @hidden */
  137729. export var glowMapGenerationVertexShader: {
  137730. name: string;
  137731. shader: string;
  137732. };
  137733. }
  137734. declare module BABYLON {
  137735. /**
  137736. * Effect layer options. This helps customizing the behaviour
  137737. * of the effect layer.
  137738. */
  137739. export interface IEffectLayerOptions {
  137740. /**
  137741. * Multiplication factor apply to the canvas size to compute the render target size
  137742. * used to generated the objects (the smaller the faster).
  137743. */
  137744. mainTextureRatio: number;
  137745. /**
  137746. * Enforces a fixed size texture to ensure effect stability across devices.
  137747. */
  137748. mainTextureFixedSize?: number;
  137749. /**
  137750. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137751. */
  137752. alphaBlendingMode: number;
  137753. /**
  137754. * The camera attached to the layer.
  137755. */
  137756. camera: Nullable<Camera>;
  137757. /**
  137758. * The rendering group to draw the layer in.
  137759. */
  137760. renderingGroupId: number;
  137761. }
  137762. /**
  137763. * The effect layer Helps adding post process effect blended with the main pass.
  137764. *
  137765. * This can be for instance use to generate glow or higlight effects on the scene.
  137766. *
  137767. * The effect layer class can not be used directly and is intented to inherited from to be
  137768. * customized per effects.
  137769. */
  137770. export abstract class EffectLayer {
  137771. private _vertexBuffers;
  137772. private _indexBuffer;
  137773. private _cachedDefines;
  137774. private _effectLayerMapGenerationEffect;
  137775. private _effectLayerOptions;
  137776. private _mergeEffect;
  137777. protected _scene: Scene;
  137778. protected _engine: Engine;
  137779. protected _maxSize: number;
  137780. protected _mainTextureDesiredSize: ISize;
  137781. protected _mainTexture: RenderTargetTexture;
  137782. protected _shouldRender: boolean;
  137783. protected _postProcesses: PostProcess[];
  137784. protected _textures: BaseTexture[];
  137785. protected _emissiveTextureAndColor: {
  137786. texture: Nullable<BaseTexture>;
  137787. color: Color4;
  137788. };
  137789. /**
  137790. * The name of the layer
  137791. */
  137792. name: string;
  137793. /**
  137794. * The clear color of the texture used to generate the glow map.
  137795. */
  137796. neutralColor: Color4;
  137797. /**
  137798. * Specifies whether the highlight layer is enabled or not.
  137799. */
  137800. isEnabled: boolean;
  137801. /**
  137802. * Gets the camera attached to the layer.
  137803. */
  137804. get camera(): Nullable<Camera>;
  137805. /**
  137806. * Gets the rendering group id the layer should render in.
  137807. */
  137808. get renderingGroupId(): number;
  137809. set renderingGroupId(renderingGroupId: number);
  137810. /**
  137811. * An event triggered when the effect layer has been disposed.
  137812. */
  137813. onDisposeObservable: Observable<EffectLayer>;
  137814. /**
  137815. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137816. */
  137817. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137818. /**
  137819. * An event triggered when the generated texture is being merged in the scene.
  137820. */
  137821. onBeforeComposeObservable: Observable<EffectLayer>;
  137822. /**
  137823. * An event triggered when the mesh is rendered into the effect render target.
  137824. */
  137825. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137826. /**
  137827. * An event triggered after the mesh has been rendered into the effect render target.
  137828. */
  137829. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137830. /**
  137831. * An event triggered when the generated texture has been merged in the scene.
  137832. */
  137833. onAfterComposeObservable: Observable<EffectLayer>;
  137834. /**
  137835. * An event triggered when the efffect layer changes its size.
  137836. */
  137837. onSizeChangedObservable: Observable<EffectLayer>;
  137838. /** @hidden */
  137839. static _SceneComponentInitialization: (scene: Scene) => void;
  137840. /**
  137841. * Instantiates a new effect Layer and references it in the scene.
  137842. * @param name The name of the layer
  137843. * @param scene The scene to use the layer in
  137844. */
  137845. constructor(
  137846. /** The Friendly of the effect in the scene */
  137847. name: string, scene: Scene);
  137848. /**
  137849. * Get the effect name of the layer.
  137850. * @return The effect name
  137851. */
  137852. abstract getEffectName(): string;
  137853. /**
  137854. * Checks for the readiness of the element composing the layer.
  137855. * @param subMesh the mesh to check for
  137856. * @param useInstances specify whether or not to use instances to render the mesh
  137857. * @return true if ready otherwise, false
  137858. */
  137859. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137860. /**
  137861. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137862. * @returns true if the effect requires stencil during the main canvas render pass.
  137863. */
  137864. abstract needStencil(): boolean;
  137865. /**
  137866. * Create the merge effect. This is the shader use to blit the information back
  137867. * to the main canvas at the end of the scene rendering.
  137868. * @returns The effect containing the shader used to merge the effect on the main canvas
  137869. */
  137870. protected abstract _createMergeEffect(): Effect;
  137871. /**
  137872. * Creates the render target textures and post processes used in the effect layer.
  137873. */
  137874. protected abstract _createTextureAndPostProcesses(): void;
  137875. /**
  137876. * Implementation specific of rendering the generating effect on the main canvas.
  137877. * @param effect The effect used to render through
  137878. */
  137879. protected abstract _internalRender(effect: Effect): void;
  137880. /**
  137881. * Sets the required values for both the emissive texture and and the main color.
  137882. */
  137883. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137884. /**
  137885. * Free any resources and references associated to a mesh.
  137886. * Internal use
  137887. * @param mesh The mesh to free.
  137888. */
  137889. abstract _disposeMesh(mesh: Mesh): void;
  137890. /**
  137891. * Serializes this layer (Glow or Highlight for example)
  137892. * @returns a serialized layer object
  137893. */
  137894. abstract serialize?(): any;
  137895. /**
  137896. * Initializes the effect layer with the required options.
  137897. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137898. */
  137899. protected _init(options: Partial<IEffectLayerOptions>): void;
  137900. /**
  137901. * Generates the index buffer of the full screen quad blending to the main canvas.
  137902. */
  137903. private _generateIndexBuffer;
  137904. /**
  137905. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137906. */
  137907. private _generateVertexBuffer;
  137908. /**
  137909. * Sets the main texture desired size which is the closest power of two
  137910. * of the engine canvas size.
  137911. */
  137912. private _setMainTextureSize;
  137913. /**
  137914. * Creates the main texture for the effect layer.
  137915. */
  137916. protected _createMainTexture(): void;
  137917. /**
  137918. * Adds specific effects defines.
  137919. * @param defines The defines to add specifics to.
  137920. */
  137921. protected _addCustomEffectDefines(defines: string[]): void;
  137922. /**
  137923. * Checks for the readiness of the element composing the layer.
  137924. * @param subMesh the mesh to check for
  137925. * @param useInstances specify whether or not to use instances to render the mesh
  137926. * @param emissiveTexture the associated emissive texture used to generate the glow
  137927. * @return true if ready otherwise, false
  137928. */
  137929. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137930. /**
  137931. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137932. */
  137933. render(): void;
  137934. /**
  137935. * Determine if a given mesh will be used in the current effect.
  137936. * @param mesh mesh to test
  137937. * @returns true if the mesh will be used
  137938. */
  137939. hasMesh(mesh: AbstractMesh): boolean;
  137940. /**
  137941. * Returns true if the layer contains information to display, otherwise false.
  137942. * @returns true if the glow layer should be rendered
  137943. */
  137944. shouldRender(): boolean;
  137945. /**
  137946. * Returns true if the mesh should render, otherwise false.
  137947. * @param mesh The mesh to render
  137948. * @returns true if it should render otherwise false
  137949. */
  137950. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137951. /**
  137952. * Returns true if the mesh can be rendered, otherwise false.
  137953. * @param mesh The mesh to render
  137954. * @param material The material used on the mesh
  137955. * @returns true if it can be rendered otherwise false
  137956. */
  137957. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137958. /**
  137959. * Returns true if the mesh should render, otherwise false.
  137960. * @param mesh The mesh to render
  137961. * @returns true if it should render otherwise false
  137962. */
  137963. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137964. /**
  137965. * Renders the submesh passed in parameter to the generation map.
  137966. */
  137967. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137968. /**
  137969. * Defines whether the current material of the mesh should be use to render the effect.
  137970. * @param mesh defines the current mesh to render
  137971. */
  137972. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137973. /**
  137974. * Rebuild the required buffers.
  137975. * @hidden Internal use only.
  137976. */
  137977. _rebuild(): void;
  137978. /**
  137979. * Dispose only the render target textures and post process.
  137980. */
  137981. private _disposeTextureAndPostProcesses;
  137982. /**
  137983. * Dispose the highlight layer and free resources.
  137984. */
  137985. dispose(): void;
  137986. /**
  137987. * Gets the class name of the effect layer
  137988. * @returns the string with the class name of the effect layer
  137989. */
  137990. getClassName(): string;
  137991. /**
  137992. * Creates an effect layer from parsed effect layer data
  137993. * @param parsedEffectLayer defines effect layer data
  137994. * @param scene defines the current scene
  137995. * @param rootUrl defines the root URL containing the effect layer information
  137996. * @returns a parsed effect Layer
  137997. */
  137998. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137999. }
  138000. }
  138001. declare module BABYLON {
  138002. interface AbstractScene {
  138003. /**
  138004. * The list of effect layers (highlights/glow) added to the scene
  138005. * @see https://doc.babylonjs.com/how_to/highlight_layer
  138006. * @see https://doc.babylonjs.com/how_to/glow_layer
  138007. */
  138008. effectLayers: Array<EffectLayer>;
  138009. /**
  138010. * Removes the given effect layer from this scene.
  138011. * @param toRemove defines the effect layer to remove
  138012. * @returns the index of the removed effect layer
  138013. */
  138014. removeEffectLayer(toRemove: EffectLayer): number;
  138015. /**
  138016. * Adds the given effect layer to this scene
  138017. * @param newEffectLayer defines the effect layer to add
  138018. */
  138019. addEffectLayer(newEffectLayer: EffectLayer): void;
  138020. }
  138021. /**
  138022. * Defines the layer scene component responsible to manage any effect layers
  138023. * in a given scene.
  138024. */
  138025. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138026. /**
  138027. * The component name helpfull to identify the component in the list of scene components.
  138028. */
  138029. readonly name: string;
  138030. /**
  138031. * The scene the component belongs to.
  138032. */
  138033. scene: Scene;
  138034. private _engine;
  138035. private _renderEffects;
  138036. private _needStencil;
  138037. private _previousStencilState;
  138038. /**
  138039. * Creates a new instance of the component for the given scene
  138040. * @param scene Defines the scene to register the component in
  138041. */
  138042. constructor(scene: Scene);
  138043. /**
  138044. * Registers the component in a given scene
  138045. */
  138046. register(): void;
  138047. /**
  138048. * Rebuilds the elements related to this component in case of
  138049. * context lost for instance.
  138050. */
  138051. rebuild(): void;
  138052. /**
  138053. * Serializes the component data to the specified json object
  138054. * @param serializationObject The object to serialize to
  138055. */
  138056. serialize(serializationObject: any): void;
  138057. /**
  138058. * Adds all the elements from the container to the scene
  138059. * @param container the container holding the elements
  138060. */
  138061. addFromContainer(container: AbstractScene): void;
  138062. /**
  138063. * Removes all the elements in the container from the scene
  138064. * @param container contains the elements to remove
  138065. * @param dispose if the removed element should be disposed (default: false)
  138066. */
  138067. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138068. /**
  138069. * Disposes the component and the associated ressources.
  138070. */
  138071. dispose(): void;
  138072. private _isReadyForMesh;
  138073. private _renderMainTexture;
  138074. private _setStencil;
  138075. private _setStencilBack;
  138076. private _draw;
  138077. private _drawCamera;
  138078. private _drawRenderingGroup;
  138079. }
  138080. }
  138081. declare module BABYLON {
  138082. /** @hidden */
  138083. export var glowMapMergePixelShader: {
  138084. name: string;
  138085. shader: string;
  138086. };
  138087. }
  138088. declare module BABYLON {
  138089. /** @hidden */
  138090. export var glowMapMergeVertexShader: {
  138091. name: string;
  138092. shader: string;
  138093. };
  138094. }
  138095. declare module BABYLON {
  138096. interface AbstractScene {
  138097. /**
  138098. * Return a the first highlight layer of the scene with a given name.
  138099. * @param name The name of the highlight layer to look for.
  138100. * @return The highlight layer if found otherwise null.
  138101. */
  138102. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138103. }
  138104. /**
  138105. * Glow layer options. This helps customizing the behaviour
  138106. * of the glow layer.
  138107. */
  138108. export interface IGlowLayerOptions {
  138109. /**
  138110. * Multiplication factor apply to the canvas size to compute the render target size
  138111. * used to generated the glowing objects (the smaller the faster).
  138112. */
  138113. mainTextureRatio: number;
  138114. /**
  138115. * Enforces a fixed size texture to ensure resize independant blur.
  138116. */
  138117. mainTextureFixedSize?: number;
  138118. /**
  138119. * How big is the kernel of the blur texture.
  138120. */
  138121. blurKernelSize: number;
  138122. /**
  138123. * The camera attached to the layer.
  138124. */
  138125. camera: Nullable<Camera>;
  138126. /**
  138127. * Enable MSAA by chosing the number of samples.
  138128. */
  138129. mainTextureSamples?: number;
  138130. /**
  138131. * The rendering group to draw the layer in.
  138132. */
  138133. renderingGroupId: number;
  138134. }
  138135. /**
  138136. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138137. *
  138138. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138139. *
  138140. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138141. */
  138142. export class GlowLayer extends EffectLayer {
  138143. /**
  138144. * Effect Name of the layer.
  138145. */
  138146. static readonly EffectName: string;
  138147. /**
  138148. * The default blur kernel size used for the glow.
  138149. */
  138150. static DefaultBlurKernelSize: number;
  138151. /**
  138152. * The default texture size ratio used for the glow.
  138153. */
  138154. static DefaultTextureRatio: number;
  138155. /**
  138156. * Sets the kernel size of the blur.
  138157. */
  138158. set blurKernelSize(value: number);
  138159. /**
  138160. * Gets the kernel size of the blur.
  138161. */
  138162. get blurKernelSize(): number;
  138163. /**
  138164. * Sets the glow intensity.
  138165. */
  138166. set intensity(value: number);
  138167. /**
  138168. * Gets the glow intensity.
  138169. */
  138170. get intensity(): number;
  138171. private _options;
  138172. private _intensity;
  138173. private _horizontalBlurPostprocess1;
  138174. private _verticalBlurPostprocess1;
  138175. private _horizontalBlurPostprocess2;
  138176. private _verticalBlurPostprocess2;
  138177. private _blurTexture1;
  138178. private _blurTexture2;
  138179. private _postProcesses1;
  138180. private _postProcesses2;
  138181. private _includedOnlyMeshes;
  138182. private _excludedMeshes;
  138183. private _meshesUsingTheirOwnMaterials;
  138184. /**
  138185. * Callback used to let the user override the color selection on a per mesh basis
  138186. */
  138187. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138188. /**
  138189. * Callback used to let the user override the texture selection on a per mesh basis
  138190. */
  138191. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138192. /**
  138193. * Instantiates a new glow Layer and references it to the scene.
  138194. * @param name The name of the layer
  138195. * @param scene The scene to use the layer in
  138196. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138197. */
  138198. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138199. /**
  138200. * Get the effect name of the layer.
  138201. * @return The effect name
  138202. */
  138203. getEffectName(): string;
  138204. /**
  138205. * Create the merge effect. This is the shader use to blit the information back
  138206. * to the main canvas at the end of the scene rendering.
  138207. */
  138208. protected _createMergeEffect(): Effect;
  138209. /**
  138210. * Creates the render target textures and post processes used in the glow layer.
  138211. */
  138212. protected _createTextureAndPostProcesses(): void;
  138213. /**
  138214. * Checks for the readiness of the element composing the layer.
  138215. * @param subMesh the mesh to check for
  138216. * @param useInstances specify wether or not to use instances to render the mesh
  138217. * @param emissiveTexture the associated emissive texture used to generate the glow
  138218. * @return true if ready otherwise, false
  138219. */
  138220. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138221. /**
  138222. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138223. */
  138224. needStencil(): boolean;
  138225. /**
  138226. * Returns true if the mesh can be rendered, otherwise false.
  138227. * @param mesh The mesh to render
  138228. * @param material The material used on the mesh
  138229. * @returns true if it can be rendered otherwise false
  138230. */
  138231. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138232. /**
  138233. * Implementation specific of rendering the generating effect on the main canvas.
  138234. * @param effect The effect used to render through
  138235. */
  138236. protected _internalRender(effect: Effect): void;
  138237. /**
  138238. * Sets the required values for both the emissive texture and and the main color.
  138239. */
  138240. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138241. /**
  138242. * Returns true if the mesh should render, otherwise false.
  138243. * @param mesh The mesh to render
  138244. * @returns true if it should render otherwise false
  138245. */
  138246. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138247. /**
  138248. * Adds specific effects defines.
  138249. * @param defines The defines to add specifics to.
  138250. */
  138251. protected _addCustomEffectDefines(defines: string[]): void;
  138252. /**
  138253. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138254. * @param mesh The mesh to exclude from the glow layer
  138255. */
  138256. addExcludedMesh(mesh: Mesh): void;
  138257. /**
  138258. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138259. * @param mesh The mesh to remove
  138260. */
  138261. removeExcludedMesh(mesh: Mesh): void;
  138262. /**
  138263. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138264. * @param mesh The mesh to include in the glow layer
  138265. */
  138266. addIncludedOnlyMesh(mesh: Mesh): void;
  138267. /**
  138268. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138269. * @param mesh The mesh to remove
  138270. */
  138271. removeIncludedOnlyMesh(mesh: Mesh): void;
  138272. /**
  138273. * Determine if a given mesh will be used in the glow layer
  138274. * @param mesh The mesh to test
  138275. * @returns true if the mesh will be highlighted by the current glow layer
  138276. */
  138277. hasMesh(mesh: AbstractMesh): boolean;
  138278. /**
  138279. * Defines whether the current material of the mesh should be use to render the effect.
  138280. * @param mesh defines the current mesh to render
  138281. */
  138282. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138283. /**
  138284. * Add a mesh to be rendered through its own material and not with emissive only.
  138285. * @param mesh The mesh for which we need to use its material
  138286. */
  138287. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138288. /**
  138289. * Remove a mesh from being rendered through its own material and not with emissive only.
  138290. * @param mesh The mesh for which we need to not use its material
  138291. */
  138292. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138293. /**
  138294. * Free any resources and references associated to a mesh.
  138295. * Internal use
  138296. * @param mesh The mesh to free.
  138297. * @hidden
  138298. */
  138299. _disposeMesh(mesh: Mesh): void;
  138300. /**
  138301. * Gets the class name of the effect layer
  138302. * @returns the string with the class name of the effect layer
  138303. */
  138304. getClassName(): string;
  138305. /**
  138306. * Serializes this glow layer
  138307. * @returns a serialized glow layer object
  138308. */
  138309. serialize(): any;
  138310. /**
  138311. * Creates a Glow Layer from parsed glow layer data
  138312. * @param parsedGlowLayer defines glow layer data
  138313. * @param scene defines the current scene
  138314. * @param rootUrl defines the root URL containing the glow layer information
  138315. * @returns a parsed Glow Layer
  138316. */
  138317. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138318. }
  138319. }
  138320. declare module BABYLON {
  138321. /** @hidden */
  138322. export var glowBlurPostProcessPixelShader: {
  138323. name: string;
  138324. shader: string;
  138325. };
  138326. }
  138327. declare module BABYLON {
  138328. interface AbstractScene {
  138329. /**
  138330. * Return a the first highlight layer of the scene with a given name.
  138331. * @param name The name of the highlight layer to look for.
  138332. * @return The highlight layer if found otherwise null.
  138333. */
  138334. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138335. }
  138336. /**
  138337. * Highlight layer options. This helps customizing the behaviour
  138338. * of the highlight layer.
  138339. */
  138340. export interface IHighlightLayerOptions {
  138341. /**
  138342. * Multiplication factor apply to the canvas size to compute the render target size
  138343. * used to generated the glowing objects (the smaller the faster).
  138344. */
  138345. mainTextureRatio: number;
  138346. /**
  138347. * Enforces a fixed size texture to ensure resize independant blur.
  138348. */
  138349. mainTextureFixedSize?: number;
  138350. /**
  138351. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138352. * of the picture to blur (the smaller the faster).
  138353. */
  138354. blurTextureSizeRatio: number;
  138355. /**
  138356. * How big in texel of the blur texture is the vertical blur.
  138357. */
  138358. blurVerticalSize: number;
  138359. /**
  138360. * How big in texel of the blur texture is the horizontal blur.
  138361. */
  138362. blurHorizontalSize: number;
  138363. /**
  138364. * Alpha blending mode used to apply the blur. Default is combine.
  138365. */
  138366. alphaBlendingMode: number;
  138367. /**
  138368. * The camera attached to the layer.
  138369. */
  138370. camera: Nullable<Camera>;
  138371. /**
  138372. * Should we display highlight as a solid stroke?
  138373. */
  138374. isStroke?: boolean;
  138375. /**
  138376. * The rendering group to draw the layer in.
  138377. */
  138378. renderingGroupId: number;
  138379. }
  138380. /**
  138381. * The highlight layer Helps adding a glow effect around a mesh.
  138382. *
  138383. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138384. * glowy meshes to your scene.
  138385. *
  138386. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138387. */
  138388. export class HighlightLayer extends EffectLayer {
  138389. name: string;
  138390. /**
  138391. * Effect Name of the highlight layer.
  138392. */
  138393. static readonly EffectName: string;
  138394. /**
  138395. * The neutral color used during the preparation of the glow effect.
  138396. * This is black by default as the blend operation is a blend operation.
  138397. */
  138398. static NeutralColor: Color4;
  138399. /**
  138400. * Stencil value used for glowing meshes.
  138401. */
  138402. static GlowingMeshStencilReference: number;
  138403. /**
  138404. * Stencil value used for the other meshes in the scene.
  138405. */
  138406. static NormalMeshStencilReference: number;
  138407. /**
  138408. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138409. */
  138410. innerGlow: boolean;
  138411. /**
  138412. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138413. */
  138414. outerGlow: boolean;
  138415. /**
  138416. * Specifies the horizontal size of the blur.
  138417. */
  138418. set blurHorizontalSize(value: number);
  138419. /**
  138420. * Specifies the vertical size of the blur.
  138421. */
  138422. set blurVerticalSize(value: number);
  138423. /**
  138424. * Gets the horizontal size of the blur.
  138425. */
  138426. get blurHorizontalSize(): number;
  138427. /**
  138428. * Gets the vertical size of the blur.
  138429. */
  138430. get blurVerticalSize(): number;
  138431. /**
  138432. * An event triggered when the highlight layer is being blurred.
  138433. */
  138434. onBeforeBlurObservable: Observable<HighlightLayer>;
  138435. /**
  138436. * An event triggered when the highlight layer has been blurred.
  138437. */
  138438. onAfterBlurObservable: Observable<HighlightLayer>;
  138439. private _instanceGlowingMeshStencilReference;
  138440. private _options;
  138441. private _downSamplePostprocess;
  138442. private _horizontalBlurPostprocess;
  138443. private _verticalBlurPostprocess;
  138444. private _blurTexture;
  138445. private _meshes;
  138446. private _excludedMeshes;
  138447. /**
  138448. * Instantiates a new highlight Layer and references it to the scene..
  138449. * @param name The name of the layer
  138450. * @param scene The scene to use the layer in
  138451. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138452. */
  138453. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138454. /**
  138455. * Get the effect name of the layer.
  138456. * @return The effect name
  138457. */
  138458. getEffectName(): string;
  138459. /**
  138460. * Create the merge effect. This is the shader use to blit the information back
  138461. * to the main canvas at the end of the scene rendering.
  138462. */
  138463. protected _createMergeEffect(): Effect;
  138464. /**
  138465. * Creates the render target textures and post processes used in the highlight layer.
  138466. */
  138467. protected _createTextureAndPostProcesses(): void;
  138468. /**
  138469. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138470. */
  138471. needStencil(): boolean;
  138472. /**
  138473. * Checks for the readiness of the element composing the layer.
  138474. * @param subMesh the mesh to check for
  138475. * @param useInstances specify wether or not to use instances to render the mesh
  138476. * @param emissiveTexture the associated emissive texture used to generate the glow
  138477. * @return true if ready otherwise, false
  138478. */
  138479. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138480. /**
  138481. * Implementation specific of rendering the generating effect on the main canvas.
  138482. * @param effect The effect used to render through
  138483. */
  138484. protected _internalRender(effect: Effect): void;
  138485. /**
  138486. * Returns true if the layer contains information to display, otherwise false.
  138487. */
  138488. shouldRender(): boolean;
  138489. /**
  138490. * Returns true if the mesh should render, otherwise false.
  138491. * @param mesh The mesh to render
  138492. * @returns true if it should render otherwise false
  138493. */
  138494. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138495. /**
  138496. * Returns true if the mesh can be rendered, otherwise false.
  138497. * @param mesh The mesh to render
  138498. * @param material The material used on the mesh
  138499. * @returns true if it can be rendered otherwise false
  138500. */
  138501. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138502. /**
  138503. * Adds specific effects defines.
  138504. * @param defines The defines to add specifics to.
  138505. */
  138506. protected _addCustomEffectDefines(defines: string[]): void;
  138507. /**
  138508. * Sets the required values for both the emissive texture and and the main color.
  138509. */
  138510. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138511. /**
  138512. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138513. * @param mesh The mesh to exclude from the highlight layer
  138514. */
  138515. addExcludedMesh(mesh: Mesh): void;
  138516. /**
  138517. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138518. * @param mesh The mesh to highlight
  138519. */
  138520. removeExcludedMesh(mesh: Mesh): void;
  138521. /**
  138522. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138523. * @param mesh mesh to test
  138524. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138525. */
  138526. hasMesh(mesh: AbstractMesh): boolean;
  138527. /**
  138528. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138529. * @param mesh The mesh to highlight
  138530. * @param color The color of the highlight
  138531. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138532. */
  138533. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138534. /**
  138535. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138536. * @param mesh The mesh to highlight
  138537. */
  138538. removeMesh(mesh: Mesh): void;
  138539. /**
  138540. * Remove all the meshes currently referenced in the highlight layer
  138541. */
  138542. removeAllMeshes(): void;
  138543. /**
  138544. * Force the stencil to the normal expected value for none glowing parts
  138545. */
  138546. private _defaultStencilReference;
  138547. /**
  138548. * Free any resources and references associated to a mesh.
  138549. * Internal use
  138550. * @param mesh The mesh to free.
  138551. * @hidden
  138552. */
  138553. _disposeMesh(mesh: Mesh): void;
  138554. /**
  138555. * Dispose the highlight layer and free resources.
  138556. */
  138557. dispose(): void;
  138558. /**
  138559. * Gets the class name of the effect layer
  138560. * @returns the string with the class name of the effect layer
  138561. */
  138562. getClassName(): string;
  138563. /**
  138564. * Serializes this Highlight layer
  138565. * @returns a serialized Highlight layer object
  138566. */
  138567. serialize(): any;
  138568. /**
  138569. * Creates a Highlight layer from parsed Highlight layer data
  138570. * @param parsedHightlightLayer defines the Highlight layer data
  138571. * @param scene defines the current scene
  138572. * @param rootUrl defines the root URL containing the Highlight layer information
  138573. * @returns a parsed Highlight layer
  138574. */
  138575. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138576. }
  138577. }
  138578. declare module BABYLON {
  138579. interface AbstractScene {
  138580. /**
  138581. * The list of layers (background and foreground) of the scene
  138582. */
  138583. layers: Array<Layer>;
  138584. }
  138585. /**
  138586. * Defines the layer scene component responsible to manage any layers
  138587. * in a given scene.
  138588. */
  138589. export class LayerSceneComponent implements ISceneComponent {
  138590. /**
  138591. * The component name helpfull to identify the component in the list of scene components.
  138592. */
  138593. readonly name: string;
  138594. /**
  138595. * The scene the component belongs to.
  138596. */
  138597. scene: Scene;
  138598. private _engine;
  138599. /**
  138600. * Creates a new instance of the component for the given scene
  138601. * @param scene Defines the scene to register the component in
  138602. */
  138603. constructor(scene: Scene);
  138604. /**
  138605. * Registers the component in a given scene
  138606. */
  138607. register(): void;
  138608. /**
  138609. * Rebuilds the elements related to this component in case of
  138610. * context lost for instance.
  138611. */
  138612. rebuild(): void;
  138613. /**
  138614. * Disposes the component and the associated ressources.
  138615. */
  138616. dispose(): void;
  138617. private _draw;
  138618. private _drawCameraPredicate;
  138619. private _drawCameraBackground;
  138620. private _drawCameraForeground;
  138621. private _drawRenderTargetPredicate;
  138622. private _drawRenderTargetBackground;
  138623. private _drawRenderTargetForeground;
  138624. /**
  138625. * Adds all the elements from the container to the scene
  138626. * @param container the container holding the elements
  138627. */
  138628. addFromContainer(container: AbstractScene): void;
  138629. /**
  138630. * Removes all the elements in the container from the scene
  138631. * @param container contains the elements to remove
  138632. * @param dispose if the removed element should be disposed (default: false)
  138633. */
  138634. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138635. }
  138636. }
  138637. declare module BABYLON {
  138638. /** @hidden */
  138639. export var layerPixelShader: {
  138640. name: string;
  138641. shader: string;
  138642. };
  138643. }
  138644. declare module BABYLON {
  138645. /** @hidden */
  138646. export var layerVertexShader: {
  138647. name: string;
  138648. shader: string;
  138649. };
  138650. }
  138651. declare module BABYLON {
  138652. /**
  138653. * This represents a full screen 2d layer.
  138654. * This can be useful to display a picture in the background of your scene for instance.
  138655. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138656. */
  138657. export class Layer {
  138658. /**
  138659. * Define the name of the layer.
  138660. */
  138661. name: string;
  138662. /**
  138663. * Define the texture the layer should display.
  138664. */
  138665. texture: Nullable<Texture>;
  138666. /**
  138667. * Is the layer in background or foreground.
  138668. */
  138669. isBackground: boolean;
  138670. /**
  138671. * Define the color of the layer (instead of texture).
  138672. */
  138673. color: Color4;
  138674. /**
  138675. * Define the scale of the layer in order to zoom in out of the texture.
  138676. */
  138677. scale: Vector2;
  138678. /**
  138679. * Define an offset for the layer in order to shift the texture.
  138680. */
  138681. offset: Vector2;
  138682. /**
  138683. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138684. */
  138685. alphaBlendingMode: number;
  138686. /**
  138687. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138688. * Alpha test will not mix with the background color in case of transparency.
  138689. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138690. */
  138691. alphaTest: boolean;
  138692. /**
  138693. * Define a mask to restrict the layer to only some of the scene cameras.
  138694. */
  138695. layerMask: number;
  138696. /**
  138697. * Define the list of render target the layer is visible into.
  138698. */
  138699. renderTargetTextures: RenderTargetTexture[];
  138700. /**
  138701. * Define if the layer is only used in renderTarget or if it also
  138702. * renders in the main frame buffer of the canvas.
  138703. */
  138704. renderOnlyInRenderTargetTextures: boolean;
  138705. private _scene;
  138706. private _vertexBuffers;
  138707. private _indexBuffer;
  138708. private _effect;
  138709. private _previousDefines;
  138710. /**
  138711. * An event triggered when the layer is disposed.
  138712. */
  138713. onDisposeObservable: Observable<Layer>;
  138714. private _onDisposeObserver;
  138715. /**
  138716. * Back compatibility with callback before the onDisposeObservable existed.
  138717. * The set callback will be triggered when the layer has been disposed.
  138718. */
  138719. set onDispose(callback: () => void);
  138720. /**
  138721. * An event triggered before rendering the scene
  138722. */
  138723. onBeforeRenderObservable: Observable<Layer>;
  138724. private _onBeforeRenderObserver;
  138725. /**
  138726. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138727. * The set callback will be triggered just before rendering the layer.
  138728. */
  138729. set onBeforeRender(callback: () => void);
  138730. /**
  138731. * An event triggered after rendering the scene
  138732. */
  138733. onAfterRenderObservable: Observable<Layer>;
  138734. private _onAfterRenderObserver;
  138735. /**
  138736. * Back compatibility with callback before the onAfterRenderObservable existed.
  138737. * The set callback will be triggered just after rendering the layer.
  138738. */
  138739. set onAfterRender(callback: () => void);
  138740. /**
  138741. * Instantiates a new layer.
  138742. * This represents a full screen 2d layer.
  138743. * This can be useful to display a picture in the background of your scene for instance.
  138744. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138745. * @param name Define the name of the layer in the scene
  138746. * @param imgUrl Define the url of the texture to display in the layer
  138747. * @param scene Define the scene the layer belongs to
  138748. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138749. * @param color Defines a color for the layer
  138750. */
  138751. constructor(
  138752. /**
  138753. * Define the name of the layer.
  138754. */
  138755. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138756. private _createIndexBuffer;
  138757. /** @hidden */
  138758. _rebuild(): void;
  138759. /**
  138760. * Renders the layer in the scene.
  138761. */
  138762. render(): void;
  138763. /**
  138764. * Disposes and releases the associated ressources.
  138765. */
  138766. dispose(): void;
  138767. }
  138768. }
  138769. declare module BABYLON {
  138770. /** @hidden */
  138771. export var lensFlarePixelShader: {
  138772. name: string;
  138773. shader: string;
  138774. };
  138775. }
  138776. declare module BABYLON {
  138777. /** @hidden */
  138778. export var lensFlareVertexShader: {
  138779. name: string;
  138780. shader: string;
  138781. };
  138782. }
  138783. declare module BABYLON {
  138784. /**
  138785. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138786. * It is usually composed of several `lensFlare`.
  138787. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138788. */
  138789. export class LensFlareSystem {
  138790. /**
  138791. * Define the name of the lens flare system
  138792. */
  138793. name: string;
  138794. /**
  138795. * List of lens flares used in this system.
  138796. */
  138797. lensFlares: LensFlare[];
  138798. /**
  138799. * Define a limit from the border the lens flare can be visible.
  138800. */
  138801. borderLimit: number;
  138802. /**
  138803. * Define a viewport border we do not want to see the lens flare in.
  138804. */
  138805. viewportBorder: number;
  138806. /**
  138807. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138808. */
  138809. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138810. /**
  138811. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138812. */
  138813. layerMask: number;
  138814. /**
  138815. * Define the id of the lens flare system in the scene.
  138816. * (equal to name by default)
  138817. */
  138818. id: string;
  138819. private _scene;
  138820. private _emitter;
  138821. private _vertexBuffers;
  138822. private _indexBuffer;
  138823. private _effect;
  138824. private _positionX;
  138825. private _positionY;
  138826. private _isEnabled;
  138827. /** @hidden */
  138828. static _SceneComponentInitialization: (scene: Scene) => void;
  138829. /**
  138830. * Instantiates a lens flare system.
  138831. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138832. * It is usually composed of several `lensFlare`.
  138833. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138834. * @param name Define the name of the lens flare system in the scene
  138835. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138836. * @param scene Define the scene the lens flare system belongs to
  138837. */
  138838. constructor(
  138839. /**
  138840. * Define the name of the lens flare system
  138841. */
  138842. name: string, emitter: any, scene: Scene);
  138843. /**
  138844. * Define if the lens flare system is enabled.
  138845. */
  138846. get isEnabled(): boolean;
  138847. set isEnabled(value: boolean);
  138848. /**
  138849. * Get the scene the effects belongs to.
  138850. * @returns the scene holding the lens flare system
  138851. */
  138852. getScene(): Scene;
  138853. /**
  138854. * Get the emitter of the lens flare system.
  138855. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138856. * @returns the emitter of the lens flare system
  138857. */
  138858. getEmitter(): any;
  138859. /**
  138860. * Set the emitter of the lens flare system.
  138861. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138862. * @param newEmitter Define the new emitter of the system
  138863. */
  138864. setEmitter(newEmitter: any): void;
  138865. /**
  138866. * Get the lens flare system emitter position.
  138867. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138868. * @returns the position
  138869. */
  138870. getEmitterPosition(): Vector3;
  138871. /**
  138872. * @hidden
  138873. */
  138874. computeEffectivePosition(globalViewport: Viewport): boolean;
  138875. /** @hidden */
  138876. _isVisible(): boolean;
  138877. /**
  138878. * @hidden
  138879. */
  138880. render(): boolean;
  138881. /**
  138882. * Dispose and release the lens flare with its associated resources.
  138883. */
  138884. dispose(): void;
  138885. /**
  138886. * Parse a lens flare system from a JSON repressentation
  138887. * @param parsedLensFlareSystem Define the JSON to parse
  138888. * @param scene Define the scene the parsed system should be instantiated in
  138889. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138890. * @returns the parsed system
  138891. */
  138892. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138893. /**
  138894. * Serialize the current Lens Flare System into a JSON representation.
  138895. * @returns the serialized JSON
  138896. */
  138897. serialize(): any;
  138898. }
  138899. }
  138900. declare module BABYLON {
  138901. /**
  138902. * This represents one of the lens effect in a `lensFlareSystem`.
  138903. * It controls one of the indiviual texture used in the effect.
  138904. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138905. */
  138906. export class LensFlare {
  138907. /**
  138908. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138909. */
  138910. size: number;
  138911. /**
  138912. * 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.
  138913. */
  138914. position: number;
  138915. /**
  138916. * Define the lens color.
  138917. */
  138918. color: Color3;
  138919. /**
  138920. * Define the lens texture.
  138921. */
  138922. texture: Nullable<Texture>;
  138923. /**
  138924. * Define the alpha mode to render this particular lens.
  138925. */
  138926. alphaMode: number;
  138927. private _system;
  138928. /**
  138929. * Creates a new Lens Flare.
  138930. * This represents one of the lens effect in a `lensFlareSystem`.
  138931. * It controls one of the indiviual texture used in the effect.
  138932. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138933. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138934. * @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.
  138935. * @param color Define the lens color
  138936. * @param imgUrl Define the lens texture url
  138937. * @param system Define the `lensFlareSystem` this flare is part of
  138938. * @returns The newly created Lens Flare
  138939. */
  138940. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138941. /**
  138942. * Instantiates a new Lens Flare.
  138943. * This represents one of the lens effect in a `lensFlareSystem`.
  138944. * It controls one of the indiviual texture used in the effect.
  138945. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138946. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138947. * @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.
  138948. * @param color Define the lens color
  138949. * @param imgUrl Define the lens texture url
  138950. * @param system Define the `lensFlareSystem` this flare is part of
  138951. */
  138952. constructor(
  138953. /**
  138954. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138955. */
  138956. size: number,
  138957. /**
  138958. * 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.
  138959. */
  138960. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138961. /**
  138962. * Dispose and release the lens flare with its associated resources.
  138963. */
  138964. dispose(): void;
  138965. }
  138966. }
  138967. declare module BABYLON {
  138968. interface AbstractScene {
  138969. /**
  138970. * The list of lens flare system added to the scene
  138971. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138972. */
  138973. lensFlareSystems: Array<LensFlareSystem>;
  138974. /**
  138975. * Removes the given lens flare system from this scene.
  138976. * @param toRemove The lens flare system to remove
  138977. * @returns The index of the removed lens flare system
  138978. */
  138979. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138980. /**
  138981. * Adds the given lens flare system to this scene
  138982. * @param newLensFlareSystem The lens flare system to add
  138983. */
  138984. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138985. /**
  138986. * Gets a lens flare system using its name
  138987. * @param name defines the name to look for
  138988. * @returns the lens flare system or null if not found
  138989. */
  138990. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138991. /**
  138992. * Gets a lens flare system using its id
  138993. * @param id defines the id to look for
  138994. * @returns the lens flare system or null if not found
  138995. */
  138996. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138997. }
  138998. /**
  138999. * Defines the lens flare scene component responsible to manage any lens flares
  139000. * in a given scene.
  139001. */
  139002. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  139003. /**
  139004. * The component name helpfull to identify the component in the list of scene components.
  139005. */
  139006. readonly name: string;
  139007. /**
  139008. * The scene the component belongs to.
  139009. */
  139010. scene: Scene;
  139011. /**
  139012. * Creates a new instance of the component for the given scene
  139013. * @param scene Defines the scene to register the component in
  139014. */
  139015. constructor(scene: Scene);
  139016. /**
  139017. * Registers the component in a given scene
  139018. */
  139019. register(): void;
  139020. /**
  139021. * Rebuilds the elements related to this component in case of
  139022. * context lost for instance.
  139023. */
  139024. rebuild(): void;
  139025. /**
  139026. * Adds all the elements from the container to the scene
  139027. * @param container the container holding the elements
  139028. */
  139029. addFromContainer(container: AbstractScene): void;
  139030. /**
  139031. * Removes all the elements in the container from the scene
  139032. * @param container contains the elements to remove
  139033. * @param dispose if the removed element should be disposed (default: false)
  139034. */
  139035. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139036. /**
  139037. * Serializes the component data to the specified json object
  139038. * @param serializationObject The object to serialize to
  139039. */
  139040. serialize(serializationObject: any): void;
  139041. /**
  139042. * Disposes the component and the associated ressources.
  139043. */
  139044. dispose(): void;
  139045. private _draw;
  139046. }
  139047. }
  139048. declare module BABYLON {
  139049. /** @hidden */
  139050. export var depthPixelShader: {
  139051. name: string;
  139052. shader: string;
  139053. };
  139054. }
  139055. declare module BABYLON {
  139056. /** @hidden */
  139057. export var depthVertexShader: {
  139058. name: string;
  139059. shader: string;
  139060. };
  139061. }
  139062. declare module BABYLON {
  139063. /**
  139064. * This represents a depth renderer in Babylon.
  139065. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139066. */
  139067. export class DepthRenderer {
  139068. private _scene;
  139069. private _depthMap;
  139070. private _effect;
  139071. private readonly _storeNonLinearDepth;
  139072. private readonly _clearColor;
  139073. /** Get if the depth renderer is using packed depth or not */
  139074. readonly isPacked: boolean;
  139075. private _cachedDefines;
  139076. private _camera;
  139077. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139078. enabled: boolean;
  139079. /**
  139080. * Specifiess that the depth renderer will only be used within
  139081. * the camera it is created for.
  139082. * This can help forcing its rendering during the camera processing.
  139083. */
  139084. useOnlyInActiveCamera: boolean;
  139085. /** @hidden */
  139086. static _SceneComponentInitialization: (scene: Scene) => void;
  139087. /**
  139088. * Instantiates a depth renderer
  139089. * @param scene The scene the renderer belongs to
  139090. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139091. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139092. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139093. */
  139094. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139095. /**
  139096. * Creates the depth rendering effect and checks if the effect is ready.
  139097. * @param subMesh The submesh to be used to render the depth map of
  139098. * @param useInstances If multiple world instances should be used
  139099. * @returns if the depth renderer is ready to render the depth map
  139100. */
  139101. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139102. /**
  139103. * Gets the texture which the depth map will be written to.
  139104. * @returns The depth map texture
  139105. */
  139106. getDepthMap(): RenderTargetTexture;
  139107. /**
  139108. * Disposes of the depth renderer.
  139109. */
  139110. dispose(): void;
  139111. }
  139112. }
  139113. declare module BABYLON {
  139114. /** @hidden */
  139115. export var minmaxReduxPixelShader: {
  139116. name: string;
  139117. shader: string;
  139118. };
  139119. }
  139120. declare module BABYLON {
  139121. /**
  139122. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139123. * and maximum values from all values of the texture.
  139124. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139125. * The source values are read from the red channel of the texture.
  139126. */
  139127. export class MinMaxReducer {
  139128. /**
  139129. * Observable triggered when the computation has been performed
  139130. */
  139131. onAfterReductionPerformed: Observable<{
  139132. min: number;
  139133. max: number;
  139134. }>;
  139135. protected _camera: Camera;
  139136. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139137. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139138. protected _postProcessManager: PostProcessManager;
  139139. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139140. protected _forceFullscreenViewport: boolean;
  139141. /**
  139142. * Creates a min/max reducer
  139143. * @param camera The camera to use for the post processes
  139144. */
  139145. constructor(camera: Camera);
  139146. /**
  139147. * Gets the texture used to read the values from.
  139148. */
  139149. get sourceTexture(): Nullable<RenderTargetTexture>;
  139150. /**
  139151. * Sets the source texture to read the values from.
  139152. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139153. * because in such textures '1' value must not be taken into account to compute the maximum
  139154. * as this value is used to clear the texture.
  139155. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139156. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139157. * @param depthRedux Indicates if the texture is a depth texture or not
  139158. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139159. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139160. */
  139161. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139162. /**
  139163. * Defines the refresh rate of the computation.
  139164. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139165. */
  139166. get refreshRate(): number;
  139167. set refreshRate(value: number);
  139168. protected _activated: boolean;
  139169. /**
  139170. * Gets the activation status of the reducer
  139171. */
  139172. get activated(): boolean;
  139173. /**
  139174. * Activates the reduction computation.
  139175. * When activated, the observers registered in onAfterReductionPerformed are
  139176. * called after the compuation is performed
  139177. */
  139178. activate(): void;
  139179. /**
  139180. * Deactivates the reduction computation.
  139181. */
  139182. deactivate(): void;
  139183. /**
  139184. * Disposes the min/max reducer
  139185. * @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.
  139186. */
  139187. dispose(disposeAll?: boolean): void;
  139188. }
  139189. }
  139190. declare module BABYLON {
  139191. /**
  139192. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139193. */
  139194. export class DepthReducer extends MinMaxReducer {
  139195. private _depthRenderer;
  139196. private _depthRendererId;
  139197. /**
  139198. * Gets the depth renderer used for the computation.
  139199. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139200. */
  139201. get depthRenderer(): Nullable<DepthRenderer>;
  139202. /**
  139203. * Creates a depth reducer
  139204. * @param camera The camera used to render the depth texture
  139205. */
  139206. constructor(camera: Camera);
  139207. /**
  139208. * Sets the depth renderer to use to generate the depth map
  139209. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139210. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139211. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139212. */
  139213. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139214. /** @hidden */
  139215. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139216. /**
  139217. * Activates the reduction computation.
  139218. * When activated, the observers registered in onAfterReductionPerformed are
  139219. * called after the compuation is performed
  139220. */
  139221. activate(): void;
  139222. /**
  139223. * Deactivates the reduction computation.
  139224. */
  139225. deactivate(): void;
  139226. /**
  139227. * Disposes the depth reducer
  139228. * @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.
  139229. */
  139230. dispose(disposeAll?: boolean): void;
  139231. }
  139232. }
  139233. declare module BABYLON {
  139234. /**
  139235. * A CSM implementation allowing casting shadows on large scenes.
  139236. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139237. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139238. */
  139239. export class CascadedShadowGenerator extends ShadowGenerator {
  139240. private static readonly frustumCornersNDCSpace;
  139241. /**
  139242. * Name of the CSM class
  139243. */
  139244. static CLASSNAME: string;
  139245. /**
  139246. * Defines the default number of cascades used by the CSM.
  139247. */
  139248. static readonly DEFAULT_CASCADES_COUNT: number;
  139249. /**
  139250. * Defines the minimum number of cascades used by the CSM.
  139251. */
  139252. static readonly MIN_CASCADES_COUNT: number;
  139253. /**
  139254. * Defines the maximum number of cascades used by the CSM.
  139255. */
  139256. static readonly MAX_CASCADES_COUNT: number;
  139257. protected _validateFilter(filter: number): number;
  139258. /**
  139259. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139260. */
  139261. penumbraDarkness: number;
  139262. private _numCascades;
  139263. /**
  139264. * Gets or set the number of cascades used by the CSM.
  139265. */
  139266. get numCascades(): number;
  139267. set numCascades(value: number);
  139268. /**
  139269. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139270. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139271. */
  139272. stabilizeCascades: boolean;
  139273. private _freezeShadowCastersBoundingInfo;
  139274. private _freezeShadowCastersBoundingInfoObservable;
  139275. /**
  139276. * Enables or disables the shadow casters bounding info computation.
  139277. * If your shadow casters don't move, you can disable this feature.
  139278. * If it is enabled, the bounding box computation is done every frame.
  139279. */
  139280. get freezeShadowCastersBoundingInfo(): boolean;
  139281. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139282. private _scbiMin;
  139283. private _scbiMax;
  139284. protected _computeShadowCastersBoundingInfo(): void;
  139285. protected _shadowCastersBoundingInfo: BoundingInfo;
  139286. /**
  139287. * Gets or sets the shadow casters bounding info.
  139288. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139289. * so that the system won't overwrite the bounds you provide
  139290. */
  139291. get shadowCastersBoundingInfo(): BoundingInfo;
  139292. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139293. protected _breaksAreDirty: boolean;
  139294. protected _minDistance: number;
  139295. protected _maxDistance: number;
  139296. /**
  139297. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139298. *
  139299. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139300. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139301. * @param min minimal distance for the breaks (default to 0.)
  139302. * @param max maximal distance for the breaks (default to 1.)
  139303. */
  139304. setMinMaxDistance(min: number, max: number): void;
  139305. /** Gets the minimal distance used in the cascade break computation */
  139306. get minDistance(): number;
  139307. /** Gets the maximal distance used in the cascade break computation */
  139308. get maxDistance(): number;
  139309. /**
  139310. * Gets the class name of that object
  139311. * @returns "CascadedShadowGenerator"
  139312. */
  139313. getClassName(): string;
  139314. private _cascadeMinExtents;
  139315. private _cascadeMaxExtents;
  139316. /**
  139317. * Gets a cascade minimum extents
  139318. * @param cascadeIndex index of the cascade
  139319. * @returns the minimum cascade extents
  139320. */
  139321. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139322. /**
  139323. * Gets a cascade maximum extents
  139324. * @param cascadeIndex index of the cascade
  139325. * @returns the maximum cascade extents
  139326. */
  139327. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139328. private _cascades;
  139329. private _currentLayer;
  139330. private _viewSpaceFrustumsZ;
  139331. private _viewMatrices;
  139332. private _projectionMatrices;
  139333. private _transformMatrices;
  139334. private _transformMatricesAsArray;
  139335. private _frustumLengths;
  139336. private _lightSizeUVCorrection;
  139337. private _depthCorrection;
  139338. private _frustumCornersWorldSpace;
  139339. private _frustumCenter;
  139340. private _shadowCameraPos;
  139341. private _shadowMaxZ;
  139342. /**
  139343. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139344. * It defaults to camera.maxZ
  139345. */
  139346. get shadowMaxZ(): number;
  139347. /**
  139348. * Sets the shadow max z distance.
  139349. */
  139350. set shadowMaxZ(value: number);
  139351. protected _debug: boolean;
  139352. /**
  139353. * Gets or sets the debug flag.
  139354. * When enabled, the cascades are materialized by different colors on the screen.
  139355. */
  139356. get debug(): boolean;
  139357. set debug(dbg: boolean);
  139358. private _depthClamp;
  139359. /**
  139360. * Gets or sets the depth clamping value.
  139361. *
  139362. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139363. * to account for the shadow casters far away.
  139364. *
  139365. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139366. */
  139367. get depthClamp(): boolean;
  139368. set depthClamp(value: boolean);
  139369. private _cascadeBlendPercentage;
  139370. /**
  139371. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139372. * It defaults to 0.1 (10% blending).
  139373. */
  139374. get cascadeBlendPercentage(): number;
  139375. set cascadeBlendPercentage(value: number);
  139376. private _lambda;
  139377. /**
  139378. * Gets or set the lambda parameter.
  139379. * This parameter is used to split the camera frustum and create the cascades.
  139380. * 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.
  139381. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139382. */
  139383. get lambda(): number;
  139384. set lambda(value: number);
  139385. /**
  139386. * Gets the view matrix corresponding to a given cascade
  139387. * @param cascadeNum cascade to retrieve the view matrix from
  139388. * @returns the cascade view matrix
  139389. */
  139390. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139391. /**
  139392. * Gets the projection matrix corresponding to a given cascade
  139393. * @param cascadeNum cascade to retrieve the projection matrix from
  139394. * @returns the cascade projection matrix
  139395. */
  139396. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139397. /**
  139398. * Gets the transformation matrix corresponding to a given cascade
  139399. * @param cascadeNum cascade to retrieve the transformation matrix from
  139400. * @returns the cascade transformation matrix
  139401. */
  139402. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139403. private _depthRenderer;
  139404. /**
  139405. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139406. *
  139407. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139408. *
  139409. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139410. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139411. * @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
  139412. */
  139413. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139414. private _depthReducer;
  139415. private _autoCalcDepthBounds;
  139416. /**
  139417. * Gets or sets the autoCalcDepthBounds property.
  139418. *
  139419. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139420. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139421. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139422. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139423. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139424. */
  139425. get autoCalcDepthBounds(): boolean;
  139426. set autoCalcDepthBounds(value: boolean);
  139427. /**
  139428. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139429. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139430. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139431. * for setting the refresh rate on the renderer yourself!
  139432. */
  139433. get autoCalcDepthBoundsRefreshRate(): number;
  139434. set autoCalcDepthBoundsRefreshRate(value: number);
  139435. /**
  139436. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139437. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139438. * you change the camera near/far planes!
  139439. */
  139440. splitFrustum(): void;
  139441. private _splitFrustum;
  139442. private _computeMatrices;
  139443. private _computeFrustumInWorldSpace;
  139444. private _computeCascadeFrustum;
  139445. /**
  139446. * Support test.
  139447. */
  139448. static get IsSupported(): boolean;
  139449. /** @hidden */
  139450. static _SceneComponentInitialization: (scene: Scene) => void;
  139451. /**
  139452. * Creates a Cascaded Shadow Generator object.
  139453. * A ShadowGenerator is the required tool to use the shadows.
  139454. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139455. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139456. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139457. * @param light The directional light object generating the shadows.
  139458. * @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.
  139459. */
  139460. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139461. protected _initializeGenerator(): void;
  139462. protected _createTargetRenderTexture(): void;
  139463. protected _initializeShadowMap(): void;
  139464. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139465. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139466. /**
  139467. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139468. * @param defines Defines of the material we want to update
  139469. * @param lightIndex Index of the light in the enabled light list of the material
  139470. */
  139471. prepareDefines(defines: any, lightIndex: number): void;
  139472. /**
  139473. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139474. * defined in the generator but impacting the effect).
  139475. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139476. * @param effect The effect we are binfing the information for
  139477. */
  139478. bindShadowLight(lightIndex: string, effect: Effect): void;
  139479. /**
  139480. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139481. * (eq to view projection * shadow projection matrices)
  139482. * @returns The transform matrix used to create the shadow map
  139483. */
  139484. getTransformMatrix(): Matrix;
  139485. /**
  139486. * Disposes the ShadowGenerator.
  139487. * Returns nothing.
  139488. */
  139489. dispose(): void;
  139490. /**
  139491. * Serializes the shadow generator setup to a json object.
  139492. * @returns The serialized JSON object
  139493. */
  139494. serialize(): any;
  139495. /**
  139496. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139497. * @param parsedShadowGenerator The JSON object to parse
  139498. * @param scene The scene to create the shadow map for
  139499. * @returns The parsed shadow generator
  139500. */
  139501. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139502. }
  139503. }
  139504. declare module BABYLON {
  139505. /**
  139506. * Defines the shadow generator component responsible to manage any shadow generators
  139507. * in a given scene.
  139508. */
  139509. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139510. /**
  139511. * The component name helpfull to identify the component in the list of scene components.
  139512. */
  139513. readonly name: string;
  139514. /**
  139515. * The scene the component belongs to.
  139516. */
  139517. scene: Scene;
  139518. /**
  139519. * Creates a new instance of the component for the given scene
  139520. * @param scene Defines the scene to register the component in
  139521. */
  139522. constructor(scene: Scene);
  139523. /**
  139524. * Registers the component in a given scene
  139525. */
  139526. register(): void;
  139527. /**
  139528. * Rebuilds the elements related to this component in case of
  139529. * context lost for instance.
  139530. */
  139531. rebuild(): void;
  139532. /**
  139533. * Serializes the component data to the specified json object
  139534. * @param serializationObject The object to serialize to
  139535. */
  139536. serialize(serializationObject: any): void;
  139537. /**
  139538. * Adds all the elements from the container to the scene
  139539. * @param container the container holding the elements
  139540. */
  139541. addFromContainer(container: AbstractScene): void;
  139542. /**
  139543. * Removes all the elements in the container from the scene
  139544. * @param container contains the elements to remove
  139545. * @param dispose if the removed element should be disposed (default: false)
  139546. */
  139547. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139548. /**
  139549. * Rebuilds the elements related to this component in case of
  139550. * context lost for instance.
  139551. */
  139552. dispose(): void;
  139553. private _gatherRenderTargets;
  139554. }
  139555. }
  139556. declare module BABYLON {
  139557. /**
  139558. * A point light is a light defined by an unique point in world space.
  139559. * The light is emitted in every direction from this point.
  139560. * A good example of a point light is a standard light bulb.
  139561. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139562. */
  139563. export class PointLight extends ShadowLight {
  139564. private _shadowAngle;
  139565. /**
  139566. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139567. * This specifies what angle the shadow will use to be created.
  139568. *
  139569. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139570. */
  139571. get shadowAngle(): number;
  139572. /**
  139573. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139574. * This specifies what angle the shadow will use to be created.
  139575. *
  139576. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139577. */
  139578. set shadowAngle(value: number);
  139579. /**
  139580. * Gets the direction if it has been set.
  139581. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139582. */
  139583. get direction(): Vector3;
  139584. /**
  139585. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139586. */
  139587. set direction(value: Vector3);
  139588. /**
  139589. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139590. * A PointLight emits the light in every direction.
  139591. * It can cast shadows.
  139592. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139593. * ```javascript
  139594. * var pointLight = new PointLight("pl", camera.position, scene);
  139595. * ```
  139596. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139597. * @param name The light friendly name
  139598. * @param position The position of the point light in the scene
  139599. * @param scene The scene the lights belongs to
  139600. */
  139601. constructor(name: string, position: Vector3, scene: Scene);
  139602. /**
  139603. * Returns the string "PointLight"
  139604. * @returns the class name
  139605. */
  139606. getClassName(): string;
  139607. /**
  139608. * Returns the integer 0.
  139609. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139610. */
  139611. getTypeID(): number;
  139612. /**
  139613. * Specifies wether or not the shadowmap should be a cube texture.
  139614. * @returns true if the shadowmap needs to be a cube texture.
  139615. */
  139616. needCube(): boolean;
  139617. /**
  139618. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139619. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139620. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139621. */
  139622. getShadowDirection(faceIndex?: number): Vector3;
  139623. /**
  139624. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139625. * - fov = PI / 2
  139626. * - aspect ratio : 1.0
  139627. * - z-near and far equal to the active camera minZ and maxZ.
  139628. * Returns the PointLight.
  139629. */
  139630. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139631. protected _buildUniformLayout(): void;
  139632. /**
  139633. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139634. * @param effect The effect to update
  139635. * @param lightIndex The index of the light in the effect to update
  139636. * @returns The point light
  139637. */
  139638. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139639. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139640. /**
  139641. * Prepares the list of defines specific to the light type.
  139642. * @param defines the list of defines
  139643. * @param lightIndex defines the index of the light for the effect
  139644. */
  139645. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139646. }
  139647. }
  139648. declare module BABYLON {
  139649. /**
  139650. * Header information of HDR texture files.
  139651. */
  139652. export interface HDRInfo {
  139653. /**
  139654. * The height of the texture in pixels.
  139655. */
  139656. height: number;
  139657. /**
  139658. * The width of the texture in pixels.
  139659. */
  139660. width: number;
  139661. /**
  139662. * The index of the beginning of the data in the binary file.
  139663. */
  139664. dataPosition: number;
  139665. }
  139666. /**
  139667. * This groups tools to convert HDR texture to native colors array.
  139668. */
  139669. export class HDRTools {
  139670. private static Ldexp;
  139671. private static Rgbe2float;
  139672. private static readStringLine;
  139673. /**
  139674. * Reads header information from an RGBE texture stored in a native array.
  139675. * More information on this format are available here:
  139676. * https://en.wikipedia.org/wiki/RGBE_image_format
  139677. *
  139678. * @param uint8array The binary file stored in native array.
  139679. * @return The header information.
  139680. */
  139681. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139682. /**
  139683. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139684. * This RGBE texture needs to store the information as a panorama.
  139685. *
  139686. * More information on this format are available here:
  139687. * https://en.wikipedia.org/wiki/RGBE_image_format
  139688. *
  139689. * @param buffer The binary file stored in an array buffer.
  139690. * @param size The expected size of the extracted cubemap.
  139691. * @return The Cube Map information.
  139692. */
  139693. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139694. /**
  139695. * Returns the pixels data extracted from an RGBE texture.
  139696. * This pixels will be stored left to right up to down in the R G B order in one array.
  139697. *
  139698. * More information on this format are available here:
  139699. * https://en.wikipedia.org/wiki/RGBE_image_format
  139700. *
  139701. * @param uint8array The binary file stored in an array buffer.
  139702. * @param hdrInfo The header information of the file.
  139703. * @return The pixels data in RGB right to left up to down order.
  139704. */
  139705. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139706. private static RGBE_ReadPixels_RLE;
  139707. private static RGBE_ReadPixels_NOT_RLE;
  139708. }
  139709. }
  139710. declare module BABYLON {
  139711. /**
  139712. * Effect Render Options
  139713. */
  139714. export interface IEffectRendererOptions {
  139715. /**
  139716. * Defines the vertices positions.
  139717. */
  139718. positions?: number[];
  139719. /**
  139720. * Defines the indices.
  139721. */
  139722. indices?: number[];
  139723. }
  139724. /**
  139725. * Helper class to render one or more effects.
  139726. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139727. */
  139728. export class EffectRenderer {
  139729. private engine;
  139730. private static _DefaultOptions;
  139731. private _vertexBuffers;
  139732. private _indexBuffer;
  139733. private _fullscreenViewport;
  139734. /**
  139735. * Creates an effect renderer
  139736. * @param engine the engine to use for rendering
  139737. * @param options defines the options of the effect renderer
  139738. */
  139739. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139740. /**
  139741. * Sets the current viewport in normalized coordinates 0-1
  139742. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139743. */
  139744. setViewport(viewport?: Viewport): void;
  139745. /**
  139746. * Binds the embedded attributes buffer to the effect.
  139747. * @param effect Defines the effect to bind the attributes for
  139748. */
  139749. bindBuffers(effect: Effect): void;
  139750. /**
  139751. * Sets the current effect wrapper to use during draw.
  139752. * The effect needs to be ready before calling this api.
  139753. * This also sets the default full screen position attribute.
  139754. * @param effectWrapper Defines the effect to draw with
  139755. */
  139756. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139757. /**
  139758. * Restores engine states
  139759. */
  139760. restoreStates(): void;
  139761. /**
  139762. * Draws a full screen quad.
  139763. */
  139764. draw(): void;
  139765. private isRenderTargetTexture;
  139766. /**
  139767. * renders one or more effects to a specified texture
  139768. * @param effectWrapper the effect to renderer
  139769. * @param outputTexture texture to draw to, if null it will render to the screen.
  139770. */
  139771. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139772. /**
  139773. * Disposes of the effect renderer
  139774. */
  139775. dispose(): void;
  139776. }
  139777. /**
  139778. * Options to create an EffectWrapper
  139779. */
  139780. interface EffectWrapperCreationOptions {
  139781. /**
  139782. * Engine to use to create the effect
  139783. */
  139784. engine: ThinEngine;
  139785. /**
  139786. * Fragment shader for the effect
  139787. */
  139788. fragmentShader: string;
  139789. /**
  139790. * Use the shader store instead of direct source code
  139791. */
  139792. useShaderStore?: boolean;
  139793. /**
  139794. * Vertex shader for the effect
  139795. */
  139796. vertexShader?: string;
  139797. /**
  139798. * Attributes to use in the shader
  139799. */
  139800. attributeNames?: Array<string>;
  139801. /**
  139802. * Uniforms to use in the shader
  139803. */
  139804. uniformNames?: Array<string>;
  139805. /**
  139806. * Texture sampler names to use in the shader
  139807. */
  139808. samplerNames?: Array<string>;
  139809. /**
  139810. * Defines to use in the shader
  139811. */
  139812. defines?: Array<string>;
  139813. /**
  139814. * Callback when effect is compiled
  139815. */
  139816. onCompiled?: Nullable<(effect: Effect) => void>;
  139817. /**
  139818. * The friendly name of the effect displayed in Spector.
  139819. */
  139820. name?: string;
  139821. }
  139822. /**
  139823. * Wraps an effect to be used for rendering
  139824. */
  139825. export class EffectWrapper {
  139826. /**
  139827. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139828. */
  139829. onApplyObservable: Observable<{}>;
  139830. /**
  139831. * The underlying effect
  139832. */
  139833. effect: Effect;
  139834. /**
  139835. * Creates an effect to be renderer
  139836. * @param creationOptions options to create the effect
  139837. */
  139838. constructor(creationOptions: EffectWrapperCreationOptions);
  139839. /**
  139840. * Disposes of the effect wrapper
  139841. */
  139842. dispose(): void;
  139843. }
  139844. }
  139845. declare module BABYLON {
  139846. /** @hidden */
  139847. export var hdrFilteringVertexShader: {
  139848. name: string;
  139849. shader: string;
  139850. };
  139851. }
  139852. declare module BABYLON {
  139853. /** @hidden */
  139854. export var hdrFilteringPixelShader: {
  139855. name: string;
  139856. shader: string;
  139857. };
  139858. }
  139859. declare module BABYLON {
  139860. /**
  139861. * Options for texture filtering
  139862. */
  139863. interface IHDRFilteringOptions {
  139864. /**
  139865. * Scales pixel intensity for the input HDR map.
  139866. */
  139867. hdrScale?: number;
  139868. /**
  139869. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139870. */
  139871. quality?: number;
  139872. }
  139873. /**
  139874. * Filters HDR maps to get correct renderings of PBR reflections
  139875. */
  139876. export class HDRFiltering {
  139877. private _engine;
  139878. private _effectRenderer;
  139879. private _effectWrapper;
  139880. private _lodGenerationOffset;
  139881. private _lodGenerationScale;
  139882. /**
  139883. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139884. * you care about baking speed.
  139885. */
  139886. quality: number;
  139887. /**
  139888. * Scales pixel intensity for the input HDR map.
  139889. */
  139890. hdrScale: number;
  139891. /**
  139892. * Instantiates HDR filter for reflection maps
  139893. *
  139894. * @param engine Thin engine
  139895. * @param options Options
  139896. */
  139897. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139898. private _createRenderTarget;
  139899. private _prefilterInternal;
  139900. private _createEffect;
  139901. /**
  139902. * Get a value indicating if the filter is ready to be used
  139903. * @param texture Texture to filter
  139904. * @returns true if the filter is ready
  139905. */
  139906. isReady(texture: BaseTexture): boolean;
  139907. /**
  139908. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139909. * Prefiltering will be invoked at the end of next rendering pass.
  139910. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139911. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139912. * @param texture Texture to filter
  139913. * @param onFinished Callback when filtering is done
  139914. * @return Promise called when prefiltering is done
  139915. */
  139916. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139917. }
  139918. }
  139919. declare module BABYLON {
  139920. /**
  139921. * This represents a texture coming from an HDR input.
  139922. *
  139923. * The only supported format is currently panorama picture stored in RGBE format.
  139924. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139925. */
  139926. export class HDRCubeTexture extends BaseTexture {
  139927. private static _facesMapping;
  139928. private _generateHarmonics;
  139929. private _noMipmap;
  139930. private _prefilterOnLoad;
  139931. private _textureMatrix;
  139932. private _size;
  139933. private _onLoad;
  139934. private _onError;
  139935. /**
  139936. * The texture URL.
  139937. */
  139938. url: string;
  139939. protected _isBlocking: boolean;
  139940. /**
  139941. * Sets wether or not the texture is blocking during loading.
  139942. */
  139943. set isBlocking(value: boolean);
  139944. /**
  139945. * Gets wether or not the texture is blocking during loading.
  139946. */
  139947. get isBlocking(): boolean;
  139948. protected _rotationY: number;
  139949. /**
  139950. * Sets texture matrix rotation angle around Y axis in radians.
  139951. */
  139952. set rotationY(value: number);
  139953. /**
  139954. * Gets texture matrix rotation angle around Y axis radians.
  139955. */
  139956. get rotationY(): number;
  139957. /**
  139958. * Gets or sets the center of the bounding box associated with the cube texture
  139959. * It must define where the camera used to render the texture was set
  139960. */
  139961. boundingBoxPosition: Vector3;
  139962. private _boundingBoxSize;
  139963. /**
  139964. * Gets or sets the size of the bounding box associated with the cube texture
  139965. * When defined, the cubemap will switch to local mode
  139966. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139967. * @example https://www.babylonjs-playground.com/#RNASML
  139968. */
  139969. set boundingBoxSize(value: Vector3);
  139970. get boundingBoxSize(): Vector3;
  139971. /**
  139972. * Instantiates an HDRTexture from the following parameters.
  139973. *
  139974. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139975. * @param sceneOrEngine The scene or engine the texture will be used in
  139976. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139977. * @param noMipmap Forces to not generate the mipmap if true
  139978. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139979. * @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)
  139980. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139981. */
  139982. 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>);
  139983. /**
  139984. * Get the current class name of the texture useful for serialization or dynamic coding.
  139985. * @returns "HDRCubeTexture"
  139986. */
  139987. getClassName(): string;
  139988. /**
  139989. * Occurs when the file is raw .hdr file.
  139990. */
  139991. private loadTexture;
  139992. clone(): HDRCubeTexture;
  139993. delayLoad(): void;
  139994. /**
  139995. * Get the texture reflection matrix used to rotate/transform the reflection.
  139996. * @returns the reflection matrix
  139997. */
  139998. getReflectionTextureMatrix(): Matrix;
  139999. /**
  140000. * Set the texture reflection matrix used to rotate/transform the reflection.
  140001. * @param value Define the reflection matrix to set
  140002. */
  140003. setReflectionTextureMatrix(value: Matrix): void;
  140004. /**
  140005. * Parses a JSON representation of an HDR Texture in order to create the texture
  140006. * @param parsedTexture Define the JSON representation
  140007. * @param scene Define the scene the texture should be created in
  140008. * @param rootUrl Define the root url in case we need to load relative dependencies
  140009. * @returns the newly created texture after parsing
  140010. */
  140011. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  140012. serialize(): any;
  140013. }
  140014. }
  140015. declare module BABYLON {
  140016. /**
  140017. * Class used to control physics engine
  140018. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140019. */
  140020. export class PhysicsEngine implements IPhysicsEngine {
  140021. private _physicsPlugin;
  140022. /**
  140023. * Global value used to control the smallest number supported by the simulation
  140024. */
  140025. static Epsilon: number;
  140026. private _impostors;
  140027. private _joints;
  140028. private _subTimeStep;
  140029. /**
  140030. * Gets the gravity vector used by the simulation
  140031. */
  140032. gravity: Vector3;
  140033. /**
  140034. * Factory used to create the default physics plugin.
  140035. * @returns The default physics plugin
  140036. */
  140037. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140038. /**
  140039. * Creates a new Physics Engine
  140040. * @param gravity defines the gravity vector used by the simulation
  140041. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140042. */
  140043. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140044. /**
  140045. * Sets the gravity vector used by the simulation
  140046. * @param gravity defines the gravity vector to use
  140047. */
  140048. setGravity(gravity: Vector3): void;
  140049. /**
  140050. * Set the time step of the physics engine.
  140051. * Default is 1/60.
  140052. * To slow it down, enter 1/600 for example.
  140053. * To speed it up, 1/30
  140054. * @param newTimeStep defines the new timestep to apply to this world.
  140055. */
  140056. setTimeStep(newTimeStep?: number): void;
  140057. /**
  140058. * Get the time step of the physics engine.
  140059. * @returns the current time step
  140060. */
  140061. getTimeStep(): number;
  140062. /**
  140063. * Set the sub time step of the physics engine.
  140064. * Default is 0 meaning there is no sub steps
  140065. * To increase physics resolution precision, set a small value (like 1 ms)
  140066. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140067. */
  140068. setSubTimeStep(subTimeStep?: number): void;
  140069. /**
  140070. * Get the sub time step of the physics engine.
  140071. * @returns the current sub time step
  140072. */
  140073. getSubTimeStep(): number;
  140074. /**
  140075. * Release all resources
  140076. */
  140077. dispose(): void;
  140078. /**
  140079. * Gets the name of the current physics plugin
  140080. * @returns the name of the plugin
  140081. */
  140082. getPhysicsPluginName(): string;
  140083. /**
  140084. * Adding a new impostor for the impostor tracking.
  140085. * This will be done by the impostor itself.
  140086. * @param impostor the impostor to add
  140087. */
  140088. addImpostor(impostor: PhysicsImpostor): void;
  140089. /**
  140090. * Remove an impostor from the engine.
  140091. * This impostor and its mesh will not longer be updated by the physics engine.
  140092. * @param impostor the impostor to remove
  140093. */
  140094. removeImpostor(impostor: PhysicsImpostor): void;
  140095. /**
  140096. * Add a joint to the physics engine
  140097. * @param mainImpostor defines the main impostor to which the joint is added.
  140098. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140099. * @param joint defines the joint that will connect both impostors.
  140100. */
  140101. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140102. /**
  140103. * Removes a joint from the simulation
  140104. * @param mainImpostor defines the impostor used with the joint
  140105. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140106. * @param joint defines the joint to remove
  140107. */
  140108. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140109. /**
  140110. * Called by the scene. No need to call it.
  140111. * @param delta defines the timespam between frames
  140112. */
  140113. _step(delta: number): void;
  140114. /**
  140115. * Gets the current plugin used to run the simulation
  140116. * @returns current plugin
  140117. */
  140118. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140119. /**
  140120. * Gets the list of physic impostors
  140121. * @returns an array of PhysicsImpostor
  140122. */
  140123. getImpostors(): Array<PhysicsImpostor>;
  140124. /**
  140125. * Gets the impostor for a physics enabled object
  140126. * @param object defines the object impersonated by the impostor
  140127. * @returns the PhysicsImpostor or null if not found
  140128. */
  140129. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140130. /**
  140131. * Gets the impostor for a physics body object
  140132. * @param body defines physics body used by the impostor
  140133. * @returns the PhysicsImpostor or null if not found
  140134. */
  140135. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140136. /**
  140137. * Does a raycast in the physics world
  140138. * @param from when should the ray start?
  140139. * @param to when should the ray end?
  140140. * @returns PhysicsRaycastResult
  140141. */
  140142. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140143. }
  140144. }
  140145. declare module BABYLON {
  140146. /** @hidden */
  140147. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140148. private _useDeltaForWorldStep;
  140149. world: any;
  140150. name: string;
  140151. private _physicsMaterials;
  140152. private _fixedTimeStep;
  140153. private _cannonRaycastResult;
  140154. private _raycastResult;
  140155. private _physicsBodysToRemoveAfterStep;
  140156. private _firstFrame;
  140157. BJSCANNON: any;
  140158. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140159. setGravity(gravity: Vector3): void;
  140160. setTimeStep(timeStep: number): void;
  140161. getTimeStep(): number;
  140162. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140163. private _removeMarkedPhysicsBodiesFromWorld;
  140164. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140165. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140166. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140167. private _processChildMeshes;
  140168. removePhysicsBody(impostor: PhysicsImpostor): void;
  140169. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140170. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140171. private _addMaterial;
  140172. private _checkWithEpsilon;
  140173. private _createShape;
  140174. private _createHeightmap;
  140175. private _minus90X;
  140176. private _plus90X;
  140177. private _tmpPosition;
  140178. private _tmpDeltaPosition;
  140179. private _tmpUnityRotation;
  140180. private _updatePhysicsBodyTransformation;
  140181. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140182. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140183. isSupported(): boolean;
  140184. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140185. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140186. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140187. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140188. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140189. getBodyMass(impostor: PhysicsImpostor): number;
  140190. getBodyFriction(impostor: PhysicsImpostor): number;
  140191. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140192. getBodyRestitution(impostor: PhysicsImpostor): number;
  140193. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140194. sleepBody(impostor: PhysicsImpostor): void;
  140195. wakeUpBody(impostor: PhysicsImpostor): void;
  140196. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140197. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140198. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140199. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140200. getRadius(impostor: PhysicsImpostor): number;
  140201. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140202. dispose(): void;
  140203. private _extendNamespace;
  140204. /**
  140205. * Does a raycast in the physics world
  140206. * @param from when should the ray start?
  140207. * @param to when should the ray end?
  140208. * @returns PhysicsRaycastResult
  140209. */
  140210. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140211. }
  140212. }
  140213. declare module BABYLON {
  140214. /** @hidden */
  140215. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140216. private _useDeltaForWorldStep;
  140217. world: any;
  140218. name: string;
  140219. BJSOIMO: any;
  140220. private _raycastResult;
  140221. private _fixedTimeStep;
  140222. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140223. setGravity(gravity: Vector3): void;
  140224. setTimeStep(timeStep: number): void;
  140225. getTimeStep(): number;
  140226. private _tmpImpostorsArray;
  140227. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140228. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140229. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140230. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140231. private _tmpPositionVector;
  140232. removePhysicsBody(impostor: PhysicsImpostor): void;
  140233. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140234. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140235. isSupported(): boolean;
  140236. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140237. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140238. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140239. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140240. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140241. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140242. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140243. getBodyMass(impostor: PhysicsImpostor): number;
  140244. getBodyFriction(impostor: PhysicsImpostor): number;
  140245. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140246. getBodyRestitution(impostor: PhysicsImpostor): number;
  140247. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140248. sleepBody(impostor: PhysicsImpostor): void;
  140249. wakeUpBody(impostor: PhysicsImpostor): void;
  140250. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140251. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140252. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140253. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140254. getRadius(impostor: PhysicsImpostor): number;
  140255. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140256. dispose(): void;
  140257. /**
  140258. * Does a raycast in the physics world
  140259. * @param from when should the ray start?
  140260. * @param to when should the ray end?
  140261. * @returns PhysicsRaycastResult
  140262. */
  140263. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140264. }
  140265. }
  140266. declare module BABYLON {
  140267. /**
  140268. * AmmoJS Physics plugin
  140269. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140270. * @see https://github.com/kripken/ammo.js/
  140271. */
  140272. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140273. private _useDeltaForWorldStep;
  140274. /**
  140275. * Reference to the Ammo library
  140276. */
  140277. bjsAMMO: any;
  140278. /**
  140279. * Created ammoJS world which physics bodies are added to
  140280. */
  140281. world: any;
  140282. /**
  140283. * Name of the plugin
  140284. */
  140285. name: string;
  140286. private _timeStep;
  140287. private _fixedTimeStep;
  140288. private _maxSteps;
  140289. private _tmpQuaternion;
  140290. private _tmpAmmoTransform;
  140291. private _tmpAmmoQuaternion;
  140292. private _tmpAmmoConcreteContactResultCallback;
  140293. private _collisionConfiguration;
  140294. private _dispatcher;
  140295. private _overlappingPairCache;
  140296. private _solver;
  140297. private _softBodySolver;
  140298. private _tmpAmmoVectorA;
  140299. private _tmpAmmoVectorB;
  140300. private _tmpAmmoVectorC;
  140301. private _tmpAmmoVectorD;
  140302. private _tmpContactCallbackResult;
  140303. private _tmpAmmoVectorRCA;
  140304. private _tmpAmmoVectorRCB;
  140305. private _raycastResult;
  140306. private static readonly DISABLE_COLLISION_FLAG;
  140307. private static readonly KINEMATIC_FLAG;
  140308. private static readonly DISABLE_DEACTIVATION_FLAG;
  140309. /**
  140310. * Initializes the ammoJS plugin
  140311. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140312. * @param ammoInjection can be used to inject your own ammo reference
  140313. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140314. */
  140315. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140316. /**
  140317. * Sets the gravity of the physics world (m/(s^2))
  140318. * @param gravity Gravity to set
  140319. */
  140320. setGravity(gravity: Vector3): void;
  140321. /**
  140322. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140323. * @param timeStep timestep to use in seconds
  140324. */
  140325. setTimeStep(timeStep: number): void;
  140326. /**
  140327. * 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)
  140328. * @param fixedTimeStep fixedTimeStep to use in seconds
  140329. */
  140330. setFixedTimeStep(fixedTimeStep: number): void;
  140331. /**
  140332. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140333. * @param maxSteps the maximum number of steps by the physics engine per frame
  140334. */
  140335. setMaxSteps(maxSteps: number): void;
  140336. /**
  140337. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140338. * @returns the current timestep in seconds
  140339. */
  140340. getTimeStep(): number;
  140341. /**
  140342. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140343. */
  140344. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140345. private _isImpostorInContact;
  140346. private _isImpostorPairInContact;
  140347. private _stepSimulation;
  140348. /**
  140349. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140350. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140351. * After the step the babylon meshes are set to the position of the physics imposters
  140352. * @param delta amount of time to step forward
  140353. * @param impostors array of imposters to update before/after the step
  140354. */
  140355. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140356. /**
  140357. * Update babylon mesh to match physics world object
  140358. * @param impostor imposter to match
  140359. */
  140360. private _afterSoftStep;
  140361. /**
  140362. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140363. * @param impostor imposter to match
  140364. */
  140365. private _ropeStep;
  140366. /**
  140367. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140368. * @param impostor imposter to match
  140369. */
  140370. private _softbodyOrClothStep;
  140371. private _tmpMatrix;
  140372. /**
  140373. * Applies an impulse on the imposter
  140374. * @param impostor imposter to apply impulse to
  140375. * @param force amount of force to be applied to the imposter
  140376. * @param contactPoint the location to apply the impulse on the imposter
  140377. */
  140378. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140379. /**
  140380. * Applies a force on the imposter
  140381. * @param impostor imposter to apply force
  140382. * @param force amount of force to be applied to the imposter
  140383. * @param contactPoint the location to apply the force on the imposter
  140384. */
  140385. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140386. /**
  140387. * Creates a physics body using the plugin
  140388. * @param impostor the imposter to create the physics body on
  140389. */
  140390. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140391. /**
  140392. * Removes the physics body from the imposter and disposes of the body's memory
  140393. * @param impostor imposter to remove the physics body from
  140394. */
  140395. removePhysicsBody(impostor: PhysicsImpostor): void;
  140396. /**
  140397. * Generates a joint
  140398. * @param impostorJoint the imposter joint to create the joint with
  140399. */
  140400. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140401. /**
  140402. * Removes a joint
  140403. * @param impostorJoint the imposter joint to remove the joint from
  140404. */
  140405. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140406. private _addMeshVerts;
  140407. /**
  140408. * Initialise the soft body vertices to match its object's (mesh) vertices
  140409. * Softbody vertices (nodes) are in world space and to match this
  140410. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140411. * @param impostor to create the softbody for
  140412. */
  140413. private _softVertexData;
  140414. /**
  140415. * Create an impostor's soft body
  140416. * @param impostor to create the softbody for
  140417. */
  140418. private _createSoftbody;
  140419. /**
  140420. * Create cloth for an impostor
  140421. * @param impostor to create the softbody for
  140422. */
  140423. private _createCloth;
  140424. /**
  140425. * Create rope for an impostor
  140426. * @param impostor to create the softbody for
  140427. */
  140428. private _createRope;
  140429. /**
  140430. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140431. * @param impostor to create the custom physics shape for
  140432. */
  140433. private _createCustom;
  140434. private _addHullVerts;
  140435. private _createShape;
  140436. /**
  140437. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140438. * @param impostor imposter containing the physics body and babylon object
  140439. */
  140440. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140441. /**
  140442. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140443. * @param impostor imposter containing the physics body and babylon object
  140444. * @param newPosition new position
  140445. * @param newRotation new rotation
  140446. */
  140447. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140448. /**
  140449. * If this plugin is supported
  140450. * @returns true if its supported
  140451. */
  140452. isSupported(): boolean;
  140453. /**
  140454. * Sets the linear velocity of the physics body
  140455. * @param impostor imposter to set the velocity on
  140456. * @param velocity velocity to set
  140457. */
  140458. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140459. /**
  140460. * Sets the angular velocity of the physics body
  140461. * @param impostor imposter to set the velocity on
  140462. * @param velocity velocity to set
  140463. */
  140464. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140465. /**
  140466. * gets the linear velocity
  140467. * @param impostor imposter to get linear velocity from
  140468. * @returns linear velocity
  140469. */
  140470. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140471. /**
  140472. * gets the angular velocity
  140473. * @param impostor imposter to get angular velocity from
  140474. * @returns angular velocity
  140475. */
  140476. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140477. /**
  140478. * Sets the mass of physics body
  140479. * @param impostor imposter to set the mass on
  140480. * @param mass mass to set
  140481. */
  140482. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140483. /**
  140484. * Gets the mass of the physics body
  140485. * @param impostor imposter to get the mass from
  140486. * @returns mass
  140487. */
  140488. getBodyMass(impostor: PhysicsImpostor): number;
  140489. /**
  140490. * Gets friction of the impostor
  140491. * @param impostor impostor to get friction from
  140492. * @returns friction value
  140493. */
  140494. getBodyFriction(impostor: PhysicsImpostor): number;
  140495. /**
  140496. * Sets friction of the impostor
  140497. * @param impostor impostor to set friction on
  140498. * @param friction friction value
  140499. */
  140500. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140501. /**
  140502. * Gets restitution of the impostor
  140503. * @param impostor impostor to get restitution from
  140504. * @returns restitution value
  140505. */
  140506. getBodyRestitution(impostor: PhysicsImpostor): number;
  140507. /**
  140508. * Sets resitution of the impostor
  140509. * @param impostor impostor to set resitution on
  140510. * @param restitution resitution value
  140511. */
  140512. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140513. /**
  140514. * Gets pressure inside the impostor
  140515. * @param impostor impostor to get pressure from
  140516. * @returns pressure value
  140517. */
  140518. getBodyPressure(impostor: PhysicsImpostor): number;
  140519. /**
  140520. * Sets pressure inside a soft body impostor
  140521. * Cloth and rope must remain 0 pressure
  140522. * @param impostor impostor to set pressure on
  140523. * @param pressure pressure value
  140524. */
  140525. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140526. /**
  140527. * Gets stiffness of the impostor
  140528. * @param impostor impostor to get stiffness from
  140529. * @returns pressure value
  140530. */
  140531. getBodyStiffness(impostor: PhysicsImpostor): number;
  140532. /**
  140533. * Sets stiffness of the impostor
  140534. * @param impostor impostor to set stiffness on
  140535. * @param stiffness stiffness value from 0 to 1
  140536. */
  140537. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140538. /**
  140539. * Gets velocityIterations of the impostor
  140540. * @param impostor impostor to get velocity iterations from
  140541. * @returns velocityIterations value
  140542. */
  140543. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140544. /**
  140545. * Sets velocityIterations of the impostor
  140546. * @param impostor impostor to set velocity iterations on
  140547. * @param velocityIterations velocityIterations value
  140548. */
  140549. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140550. /**
  140551. * Gets positionIterations of the impostor
  140552. * @param impostor impostor to get position iterations from
  140553. * @returns positionIterations value
  140554. */
  140555. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140556. /**
  140557. * Sets positionIterations of the impostor
  140558. * @param impostor impostor to set position on
  140559. * @param positionIterations positionIterations value
  140560. */
  140561. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140562. /**
  140563. * Append an anchor to a cloth object
  140564. * @param impostor is the cloth impostor to add anchor to
  140565. * @param otherImpostor is the rigid impostor to anchor to
  140566. * @param width ratio across width from 0 to 1
  140567. * @param height ratio up height from 0 to 1
  140568. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140569. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140570. */
  140571. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140572. /**
  140573. * Append an hook to a rope object
  140574. * @param impostor is the rope impostor to add hook to
  140575. * @param otherImpostor is the rigid impostor to hook to
  140576. * @param length ratio along the rope from 0 to 1
  140577. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140578. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140579. */
  140580. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140581. /**
  140582. * Sleeps the physics body and stops it from being active
  140583. * @param impostor impostor to sleep
  140584. */
  140585. sleepBody(impostor: PhysicsImpostor): void;
  140586. /**
  140587. * Activates the physics body
  140588. * @param impostor impostor to activate
  140589. */
  140590. wakeUpBody(impostor: PhysicsImpostor): void;
  140591. /**
  140592. * Updates the distance parameters of the joint
  140593. * @param joint joint to update
  140594. * @param maxDistance maximum distance of the joint
  140595. * @param minDistance minimum distance of the joint
  140596. */
  140597. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140598. /**
  140599. * Sets a motor on the joint
  140600. * @param joint joint to set motor on
  140601. * @param speed speed of the motor
  140602. * @param maxForce maximum force of the motor
  140603. * @param motorIndex index of the motor
  140604. */
  140605. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140606. /**
  140607. * Sets the motors limit
  140608. * @param joint joint to set limit on
  140609. * @param upperLimit upper limit
  140610. * @param lowerLimit lower limit
  140611. */
  140612. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140613. /**
  140614. * Syncs the position and rotation of a mesh with the impostor
  140615. * @param mesh mesh to sync
  140616. * @param impostor impostor to update the mesh with
  140617. */
  140618. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140619. /**
  140620. * Gets the radius of the impostor
  140621. * @param impostor impostor to get radius from
  140622. * @returns the radius
  140623. */
  140624. getRadius(impostor: PhysicsImpostor): number;
  140625. /**
  140626. * Gets the box size of the impostor
  140627. * @param impostor impostor to get box size from
  140628. * @param result the resulting box size
  140629. */
  140630. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140631. /**
  140632. * Disposes of the impostor
  140633. */
  140634. dispose(): void;
  140635. /**
  140636. * Does a raycast in the physics world
  140637. * @param from when should the ray start?
  140638. * @param to when should the ray end?
  140639. * @returns PhysicsRaycastResult
  140640. */
  140641. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140642. }
  140643. }
  140644. declare module BABYLON {
  140645. interface AbstractScene {
  140646. /**
  140647. * The list of reflection probes added to the scene
  140648. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140649. */
  140650. reflectionProbes: Array<ReflectionProbe>;
  140651. /**
  140652. * Removes the given reflection probe from this scene.
  140653. * @param toRemove The reflection probe to remove
  140654. * @returns The index of the removed reflection probe
  140655. */
  140656. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140657. /**
  140658. * Adds the given reflection probe to this scene.
  140659. * @param newReflectionProbe The reflection probe to add
  140660. */
  140661. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140662. }
  140663. /**
  140664. * Class used to generate realtime reflection / refraction cube textures
  140665. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140666. */
  140667. export class ReflectionProbe {
  140668. /** defines the name of the probe */
  140669. name: string;
  140670. private _scene;
  140671. private _renderTargetTexture;
  140672. private _projectionMatrix;
  140673. private _viewMatrix;
  140674. private _target;
  140675. private _add;
  140676. private _attachedMesh;
  140677. private _invertYAxis;
  140678. /** Gets or sets probe position (center of the cube map) */
  140679. position: Vector3;
  140680. /**
  140681. * Creates a new reflection probe
  140682. * @param name defines the name of the probe
  140683. * @param size defines the texture resolution (for each face)
  140684. * @param scene defines the hosting scene
  140685. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140686. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140687. */
  140688. constructor(
  140689. /** defines the name of the probe */
  140690. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140691. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140692. get samples(): number;
  140693. set samples(value: number);
  140694. /** Gets or sets the refresh rate to use (on every frame by default) */
  140695. get refreshRate(): number;
  140696. set refreshRate(value: number);
  140697. /**
  140698. * Gets the hosting scene
  140699. * @returns a Scene
  140700. */
  140701. getScene(): Scene;
  140702. /** Gets the internal CubeTexture used to render to */
  140703. get cubeTexture(): RenderTargetTexture;
  140704. /** Gets the list of meshes to render */
  140705. get renderList(): Nullable<AbstractMesh[]>;
  140706. /**
  140707. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140708. * @param mesh defines the mesh to attach to
  140709. */
  140710. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140711. /**
  140712. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140713. * @param renderingGroupId The rendering group id corresponding to its index
  140714. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140715. */
  140716. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140717. /**
  140718. * Clean all associated resources
  140719. */
  140720. dispose(): void;
  140721. /**
  140722. * Converts the reflection probe information to a readable string for debug purpose.
  140723. * @param fullDetails Supports for multiple levels of logging within scene loading
  140724. * @returns the human readable reflection probe info
  140725. */
  140726. toString(fullDetails?: boolean): string;
  140727. /**
  140728. * Get the class name of the relfection probe.
  140729. * @returns "ReflectionProbe"
  140730. */
  140731. getClassName(): string;
  140732. /**
  140733. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140734. * @returns The JSON representation of the texture
  140735. */
  140736. serialize(): any;
  140737. /**
  140738. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140739. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140740. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140741. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140742. * @returns The parsed reflection probe if successful
  140743. */
  140744. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140745. }
  140746. }
  140747. declare module BABYLON {
  140748. /** @hidden */
  140749. export var _BabylonLoaderRegistered: boolean;
  140750. /**
  140751. * Helps setting up some configuration for the babylon file loader.
  140752. */
  140753. export class BabylonFileLoaderConfiguration {
  140754. /**
  140755. * The loader does not allow injecting custom physix engine into the plugins.
  140756. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140757. * So you could set this variable to your engine import to make it work.
  140758. */
  140759. static LoaderInjectedPhysicsEngine: any;
  140760. }
  140761. }
  140762. declare module BABYLON {
  140763. /**
  140764. * The Physically based simple base material of BJS.
  140765. *
  140766. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140767. * It is used as the base class for both the specGloss and metalRough conventions.
  140768. */
  140769. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140770. /**
  140771. * Number of Simultaneous lights allowed on the material.
  140772. */
  140773. maxSimultaneousLights: number;
  140774. /**
  140775. * If sets to true, disables all the lights affecting the material.
  140776. */
  140777. disableLighting: boolean;
  140778. /**
  140779. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140780. */
  140781. environmentTexture: BaseTexture;
  140782. /**
  140783. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140784. */
  140785. invertNormalMapX: boolean;
  140786. /**
  140787. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140788. */
  140789. invertNormalMapY: boolean;
  140790. /**
  140791. * Normal map used in the model.
  140792. */
  140793. normalTexture: BaseTexture;
  140794. /**
  140795. * Emissivie color used to self-illuminate the model.
  140796. */
  140797. emissiveColor: Color3;
  140798. /**
  140799. * Emissivie texture used to self-illuminate the model.
  140800. */
  140801. emissiveTexture: BaseTexture;
  140802. /**
  140803. * Occlusion Channel Strenght.
  140804. */
  140805. occlusionStrength: number;
  140806. /**
  140807. * Occlusion Texture of the material (adding extra occlusion effects).
  140808. */
  140809. occlusionTexture: BaseTexture;
  140810. /**
  140811. * Defines the alpha limits in alpha test mode.
  140812. */
  140813. alphaCutOff: number;
  140814. /**
  140815. * Gets the current double sided mode.
  140816. */
  140817. get doubleSided(): boolean;
  140818. /**
  140819. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140820. */
  140821. set doubleSided(value: boolean);
  140822. /**
  140823. * Stores the pre-calculated light information of a mesh in a texture.
  140824. */
  140825. lightmapTexture: BaseTexture;
  140826. /**
  140827. * If true, the light map contains occlusion information instead of lighting info.
  140828. */
  140829. useLightmapAsShadowmap: boolean;
  140830. /**
  140831. * Instantiates a new PBRMaterial instance.
  140832. *
  140833. * @param name The material name
  140834. * @param scene The scene the material will be use in.
  140835. */
  140836. constructor(name: string, scene: Scene);
  140837. getClassName(): string;
  140838. }
  140839. }
  140840. declare module BABYLON {
  140841. /**
  140842. * The PBR material of BJS following the metal roughness convention.
  140843. *
  140844. * This fits to the PBR convention in the GLTF definition:
  140845. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140846. */
  140847. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140848. /**
  140849. * The base color has two different interpretations depending on the value of metalness.
  140850. * When the material is a metal, the base color is the specific measured reflectance value
  140851. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140852. * of the material.
  140853. */
  140854. baseColor: Color3;
  140855. /**
  140856. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140857. * well as opacity information in the alpha channel.
  140858. */
  140859. baseTexture: BaseTexture;
  140860. /**
  140861. * Specifies the metallic scalar value of the material.
  140862. * Can also be used to scale the metalness values of the metallic texture.
  140863. */
  140864. metallic: number;
  140865. /**
  140866. * Specifies the roughness scalar value of the material.
  140867. * Can also be used to scale the roughness values of the metallic texture.
  140868. */
  140869. roughness: number;
  140870. /**
  140871. * Texture containing both the metallic value in the B channel and the
  140872. * roughness value in the G channel to keep better precision.
  140873. */
  140874. metallicRoughnessTexture: BaseTexture;
  140875. /**
  140876. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140877. *
  140878. * @param name The material name
  140879. * @param scene The scene the material will be use in.
  140880. */
  140881. constructor(name: string, scene: Scene);
  140882. /**
  140883. * Return the currrent class name of the material.
  140884. */
  140885. getClassName(): string;
  140886. /**
  140887. * Makes a duplicate of the current material.
  140888. * @param name - name to use for the new material.
  140889. */
  140890. clone(name: string): PBRMetallicRoughnessMaterial;
  140891. /**
  140892. * Serialize the material to a parsable JSON object.
  140893. */
  140894. serialize(): any;
  140895. /**
  140896. * Parses a JSON object correponding to the serialize function.
  140897. */
  140898. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140899. }
  140900. }
  140901. declare module BABYLON {
  140902. /**
  140903. * The PBR material of BJS following the specular glossiness convention.
  140904. *
  140905. * This fits to the PBR convention in the GLTF definition:
  140906. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140907. */
  140908. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140909. /**
  140910. * Specifies the diffuse color of the material.
  140911. */
  140912. diffuseColor: Color3;
  140913. /**
  140914. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140915. * channel.
  140916. */
  140917. diffuseTexture: BaseTexture;
  140918. /**
  140919. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140920. */
  140921. specularColor: Color3;
  140922. /**
  140923. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140924. */
  140925. glossiness: number;
  140926. /**
  140927. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140928. */
  140929. specularGlossinessTexture: BaseTexture;
  140930. /**
  140931. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140932. *
  140933. * @param name The material name
  140934. * @param scene The scene the material will be use in.
  140935. */
  140936. constructor(name: string, scene: Scene);
  140937. /**
  140938. * Return the currrent class name of the material.
  140939. */
  140940. getClassName(): string;
  140941. /**
  140942. * Makes a duplicate of the current material.
  140943. * @param name - name to use for the new material.
  140944. */
  140945. clone(name: string): PBRSpecularGlossinessMaterial;
  140946. /**
  140947. * Serialize the material to a parsable JSON object.
  140948. */
  140949. serialize(): any;
  140950. /**
  140951. * Parses a JSON object correponding to the serialize function.
  140952. */
  140953. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140954. }
  140955. }
  140956. declare module BABYLON {
  140957. /**
  140958. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140959. * It can help converting any input color in a desired output one. This can then be used to create effects
  140960. * from sepia, black and white to sixties or futuristic rendering...
  140961. *
  140962. * The only supported format is currently 3dl.
  140963. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140964. */
  140965. export class ColorGradingTexture extends BaseTexture {
  140966. /**
  140967. * The texture URL.
  140968. */
  140969. url: string;
  140970. /**
  140971. * Empty line regex stored for GC.
  140972. */
  140973. private static _noneEmptyLineRegex;
  140974. private _textureMatrix;
  140975. private _onLoad;
  140976. /**
  140977. * Instantiates a ColorGradingTexture from the following parameters.
  140978. *
  140979. * @param url The location of the color gradind data (currently only supporting 3dl)
  140980. * @param sceneOrEngine The scene or engine the texture will be used in
  140981. * @param onLoad defines a callback triggered when the texture has been loaded
  140982. */
  140983. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140984. /**
  140985. * Fires the onload event from the constructor if requested.
  140986. */
  140987. private _triggerOnLoad;
  140988. /**
  140989. * Returns the texture matrix used in most of the material.
  140990. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140991. */
  140992. getTextureMatrix(): Matrix;
  140993. /**
  140994. * Occurs when the file being loaded is a .3dl LUT file.
  140995. */
  140996. private load3dlTexture;
  140997. /**
  140998. * Starts the loading process of the texture.
  140999. */
  141000. private loadTexture;
  141001. /**
  141002. * Clones the color gradind texture.
  141003. */
  141004. clone(): ColorGradingTexture;
  141005. /**
  141006. * Called during delayed load for textures.
  141007. */
  141008. delayLoad(): void;
  141009. /**
  141010. * Parses a color grading texture serialized by Babylon.
  141011. * @param parsedTexture The texture information being parsedTexture
  141012. * @param scene The scene to load the texture in
  141013. * @param rootUrl The root url of the data assets to load
  141014. * @return A color gradind texture
  141015. */
  141016. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  141017. /**
  141018. * Serializes the LUT texture to json format.
  141019. */
  141020. serialize(): any;
  141021. }
  141022. }
  141023. declare module BABYLON {
  141024. /**
  141025. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141026. */
  141027. export class EquiRectangularCubeTexture extends BaseTexture {
  141028. /** The six faces of the cube. */
  141029. private static _FacesMapping;
  141030. private _noMipmap;
  141031. private _onLoad;
  141032. private _onError;
  141033. /** The size of the cubemap. */
  141034. private _size;
  141035. /** The buffer of the image. */
  141036. private _buffer;
  141037. /** The width of the input image. */
  141038. private _width;
  141039. /** The height of the input image. */
  141040. private _height;
  141041. /** The URL to the image. */
  141042. url: string;
  141043. /**
  141044. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141045. * @param url The location of the image
  141046. * @param scene The scene the texture will be used in
  141047. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141048. * @param noMipmap Forces to not generate the mipmap if true
  141049. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141050. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141051. * @param onLoad — defines a callback called when texture is loaded
  141052. * @param onError — defines a callback called if there is an error
  141053. */
  141054. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141055. /**
  141056. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141057. */
  141058. private loadImage;
  141059. /**
  141060. * Convert the image buffer into a cubemap and create a CubeTexture.
  141061. */
  141062. private loadTexture;
  141063. /**
  141064. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141065. * @param buffer The ArrayBuffer that should be converted.
  141066. * @returns The buffer as Float32Array.
  141067. */
  141068. private getFloat32ArrayFromArrayBuffer;
  141069. /**
  141070. * Get the current class name of the texture useful for serialization or dynamic coding.
  141071. * @returns "EquiRectangularCubeTexture"
  141072. */
  141073. getClassName(): string;
  141074. /**
  141075. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141076. * @returns A clone of the current EquiRectangularCubeTexture.
  141077. */
  141078. clone(): EquiRectangularCubeTexture;
  141079. }
  141080. }
  141081. declare module BABYLON {
  141082. /**
  141083. * Defines the options related to the creation of an HtmlElementTexture
  141084. */
  141085. export interface IHtmlElementTextureOptions {
  141086. /**
  141087. * Defines wether mip maps should be created or not.
  141088. */
  141089. generateMipMaps?: boolean;
  141090. /**
  141091. * Defines the sampling mode of the texture.
  141092. */
  141093. samplingMode?: number;
  141094. /**
  141095. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141096. */
  141097. engine: Nullable<ThinEngine>;
  141098. /**
  141099. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141100. */
  141101. scene: Nullable<Scene>;
  141102. }
  141103. /**
  141104. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141105. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141106. * is automatically managed.
  141107. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141108. * in your application.
  141109. *
  141110. * As the update is not automatic, you need to call them manually.
  141111. */
  141112. export class HtmlElementTexture extends BaseTexture {
  141113. /**
  141114. * The texture URL.
  141115. */
  141116. element: HTMLVideoElement | HTMLCanvasElement;
  141117. private static readonly DefaultOptions;
  141118. private _textureMatrix;
  141119. private _isVideo;
  141120. private _generateMipMaps;
  141121. private _samplingMode;
  141122. /**
  141123. * Instantiates a HtmlElementTexture from the following parameters.
  141124. *
  141125. * @param name Defines the name of the texture
  141126. * @param element Defines the video or canvas the texture is filled with
  141127. * @param options Defines the other none mandatory texture creation options
  141128. */
  141129. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141130. private _createInternalTexture;
  141131. /**
  141132. * Returns the texture matrix used in most of the material.
  141133. */
  141134. getTextureMatrix(): Matrix;
  141135. /**
  141136. * Updates the content of the texture.
  141137. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141138. */
  141139. update(invertY?: Nullable<boolean>): void;
  141140. }
  141141. }
  141142. declare module BABYLON {
  141143. /**
  141144. * Based on jsTGALoader - Javascript loader for TGA file
  141145. * By Vincent Thibault
  141146. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141147. */
  141148. export class TGATools {
  141149. private static _TYPE_INDEXED;
  141150. private static _TYPE_RGB;
  141151. private static _TYPE_GREY;
  141152. private static _TYPE_RLE_INDEXED;
  141153. private static _TYPE_RLE_RGB;
  141154. private static _TYPE_RLE_GREY;
  141155. private static _ORIGIN_MASK;
  141156. private static _ORIGIN_SHIFT;
  141157. private static _ORIGIN_BL;
  141158. private static _ORIGIN_BR;
  141159. private static _ORIGIN_UL;
  141160. private static _ORIGIN_UR;
  141161. /**
  141162. * Gets the header of a TGA file
  141163. * @param data defines the TGA data
  141164. * @returns the header
  141165. */
  141166. static GetTGAHeader(data: Uint8Array): any;
  141167. /**
  141168. * Uploads TGA content to a Babylon Texture
  141169. * @hidden
  141170. */
  141171. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141172. /** @hidden */
  141173. 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;
  141174. /** @hidden */
  141175. 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;
  141176. /** @hidden */
  141177. 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;
  141178. /** @hidden */
  141179. 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;
  141180. /** @hidden */
  141181. 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;
  141182. /** @hidden */
  141183. 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;
  141184. }
  141185. }
  141186. declare module BABYLON {
  141187. /**
  141188. * Implementation of the TGA Texture Loader.
  141189. * @hidden
  141190. */
  141191. export class _TGATextureLoader implements IInternalTextureLoader {
  141192. /**
  141193. * Defines wether the loader supports cascade loading the different faces.
  141194. */
  141195. readonly supportCascades: boolean;
  141196. /**
  141197. * This returns if the loader support the current file information.
  141198. * @param extension defines the file extension of the file being loaded
  141199. * @returns true if the loader can load the specified file
  141200. */
  141201. canLoad(extension: string): boolean;
  141202. /**
  141203. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141204. * @param data contains the texture data
  141205. * @param texture defines the BabylonJS internal texture
  141206. * @param createPolynomials will be true if polynomials have been requested
  141207. * @param onLoad defines the callback to trigger once the texture is ready
  141208. * @param onError defines the callback to trigger in case of error
  141209. */
  141210. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141211. /**
  141212. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141213. * @param data contains the texture data
  141214. * @param texture defines the BabylonJS internal texture
  141215. * @param callback defines the method to call once ready to upload
  141216. */
  141217. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141218. }
  141219. }
  141220. declare module BABYLON {
  141221. /**
  141222. * Info about the .basis files
  141223. */
  141224. class BasisFileInfo {
  141225. /**
  141226. * If the file has alpha
  141227. */
  141228. hasAlpha: boolean;
  141229. /**
  141230. * Info about each image of the basis file
  141231. */
  141232. images: Array<{
  141233. levels: Array<{
  141234. width: number;
  141235. height: number;
  141236. transcodedPixels: ArrayBufferView;
  141237. }>;
  141238. }>;
  141239. }
  141240. /**
  141241. * Result of transcoding a basis file
  141242. */
  141243. class TranscodeResult {
  141244. /**
  141245. * Info about the .basis file
  141246. */
  141247. fileInfo: BasisFileInfo;
  141248. /**
  141249. * Format to use when loading the file
  141250. */
  141251. format: number;
  141252. }
  141253. /**
  141254. * Configuration options for the Basis transcoder
  141255. */
  141256. export class BasisTranscodeConfiguration {
  141257. /**
  141258. * Supported compression formats used to determine the supported output format of the transcoder
  141259. */
  141260. supportedCompressionFormats?: {
  141261. /**
  141262. * etc1 compression format
  141263. */
  141264. etc1?: boolean;
  141265. /**
  141266. * s3tc compression format
  141267. */
  141268. s3tc?: boolean;
  141269. /**
  141270. * pvrtc compression format
  141271. */
  141272. pvrtc?: boolean;
  141273. /**
  141274. * etc2 compression format
  141275. */
  141276. etc2?: boolean;
  141277. };
  141278. /**
  141279. * If mipmap levels should be loaded for transcoded images (Default: true)
  141280. */
  141281. loadMipmapLevels?: boolean;
  141282. /**
  141283. * Index of a single image to load (Default: all images)
  141284. */
  141285. loadSingleImage?: number;
  141286. }
  141287. /**
  141288. * Used to load .Basis files
  141289. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141290. */
  141291. export class BasisTools {
  141292. private static _IgnoreSupportedFormats;
  141293. /**
  141294. * URL to use when loading the basis transcoder
  141295. */
  141296. static JSModuleURL: string;
  141297. /**
  141298. * URL to use when loading the wasm module for the transcoder
  141299. */
  141300. static WasmModuleURL: string;
  141301. /**
  141302. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141303. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141304. * @returns internal format corresponding to the Basis format
  141305. */
  141306. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141307. private static _WorkerPromise;
  141308. private static _Worker;
  141309. private static _actionId;
  141310. private static _CreateWorkerAsync;
  141311. /**
  141312. * Transcodes a loaded image file to compressed pixel data
  141313. * @param data image data to transcode
  141314. * @param config configuration options for the transcoding
  141315. * @returns a promise resulting in the transcoded image
  141316. */
  141317. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141318. /**
  141319. * Loads a texture from the transcode result
  141320. * @param texture texture load to
  141321. * @param transcodeResult the result of transcoding the basis file to load from
  141322. */
  141323. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141324. }
  141325. }
  141326. declare module BABYLON {
  141327. /**
  141328. * Loader for .basis file format
  141329. */
  141330. export class _BasisTextureLoader implements IInternalTextureLoader {
  141331. /**
  141332. * Defines whether the loader supports cascade loading the different faces.
  141333. */
  141334. readonly supportCascades: boolean;
  141335. /**
  141336. * This returns if the loader support the current file information.
  141337. * @param extension defines the file extension of the file being loaded
  141338. * @returns true if the loader can load the specified file
  141339. */
  141340. canLoad(extension: string): boolean;
  141341. /**
  141342. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141343. * @param data contains the texture data
  141344. * @param texture defines the BabylonJS internal texture
  141345. * @param createPolynomials will be true if polynomials have been requested
  141346. * @param onLoad defines the callback to trigger once the texture is ready
  141347. * @param onError defines the callback to trigger in case of error
  141348. */
  141349. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141350. /**
  141351. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141352. * @param data contains the texture data
  141353. * @param texture defines the BabylonJS internal texture
  141354. * @param callback defines the method to call once ready to upload
  141355. */
  141356. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141357. }
  141358. }
  141359. declare module BABYLON {
  141360. /**
  141361. * Defines the basic options interface of a TexturePacker Frame
  141362. */
  141363. export interface ITexturePackerFrame {
  141364. /**
  141365. * The frame ID
  141366. */
  141367. id: number;
  141368. /**
  141369. * The frames Scale
  141370. */
  141371. scale: Vector2;
  141372. /**
  141373. * The Frames offset
  141374. */
  141375. offset: Vector2;
  141376. }
  141377. /**
  141378. * This is a support class for frame Data on texture packer sets.
  141379. */
  141380. export class TexturePackerFrame implements ITexturePackerFrame {
  141381. /**
  141382. * The frame ID
  141383. */
  141384. id: number;
  141385. /**
  141386. * The frames Scale
  141387. */
  141388. scale: Vector2;
  141389. /**
  141390. * The Frames offset
  141391. */
  141392. offset: Vector2;
  141393. /**
  141394. * Initializes a texture package frame.
  141395. * @param id The numerical frame identifier
  141396. * @param scale Scalar Vector2 for UV frame
  141397. * @param offset Vector2 for the frame position in UV units.
  141398. * @returns TexturePackerFrame
  141399. */
  141400. constructor(id: number, scale: Vector2, offset: Vector2);
  141401. }
  141402. }
  141403. declare module BABYLON {
  141404. /**
  141405. * Defines the basic options interface of a TexturePacker
  141406. */
  141407. export interface ITexturePackerOptions {
  141408. /**
  141409. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141410. */
  141411. map?: string[];
  141412. /**
  141413. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141414. */
  141415. uvsIn?: string;
  141416. /**
  141417. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141418. */
  141419. uvsOut?: string;
  141420. /**
  141421. * number representing the layout style. Defaults to LAYOUT_STRIP
  141422. */
  141423. layout?: number;
  141424. /**
  141425. * number of columns if using custom column count layout(2). This defaults to 4.
  141426. */
  141427. colnum?: number;
  141428. /**
  141429. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141430. */
  141431. updateInputMeshes?: boolean;
  141432. /**
  141433. * boolean flag to dispose all the source textures. Defaults to true.
  141434. */
  141435. disposeSources?: boolean;
  141436. /**
  141437. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141438. */
  141439. fillBlanks?: boolean;
  141440. /**
  141441. * string value representing the context fill style color. Defaults to 'black'.
  141442. */
  141443. customFillColor?: string;
  141444. /**
  141445. * Width and Height Value of each Frame in the TexturePacker Sets
  141446. */
  141447. frameSize?: number;
  141448. /**
  141449. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141450. */
  141451. paddingRatio?: number;
  141452. /**
  141453. * Number that declares the fill method for the padding gutter.
  141454. */
  141455. paddingMode?: number;
  141456. /**
  141457. * If in SUBUV_COLOR padding mode what color to use.
  141458. */
  141459. paddingColor?: Color3 | Color4;
  141460. }
  141461. /**
  141462. * Defines the basic interface of a TexturePacker JSON File
  141463. */
  141464. export interface ITexturePackerJSON {
  141465. /**
  141466. * The frame ID
  141467. */
  141468. name: string;
  141469. /**
  141470. * The base64 channel data
  141471. */
  141472. sets: any;
  141473. /**
  141474. * The options of the Packer
  141475. */
  141476. options: ITexturePackerOptions;
  141477. /**
  141478. * The frame data of the Packer
  141479. */
  141480. frames: Array<number>;
  141481. }
  141482. /**
  141483. * This is a support class that generates a series of packed texture sets.
  141484. * @see https://doc.babylonjs.com/babylon101/materials
  141485. */
  141486. export class TexturePacker {
  141487. /** Packer Layout Constant 0 */
  141488. static readonly LAYOUT_STRIP: number;
  141489. /** Packer Layout Constant 1 */
  141490. static readonly LAYOUT_POWER2: number;
  141491. /** Packer Layout Constant 2 */
  141492. static readonly LAYOUT_COLNUM: number;
  141493. /** Packer Layout Constant 0 */
  141494. static readonly SUBUV_WRAP: number;
  141495. /** Packer Layout Constant 1 */
  141496. static readonly SUBUV_EXTEND: number;
  141497. /** Packer Layout Constant 2 */
  141498. static readonly SUBUV_COLOR: number;
  141499. /** The Name of the Texture Package */
  141500. name: string;
  141501. /** The scene scope of the TexturePacker */
  141502. scene: Scene;
  141503. /** The Meshes to target */
  141504. meshes: AbstractMesh[];
  141505. /** Arguments passed with the Constructor */
  141506. options: ITexturePackerOptions;
  141507. /** The promise that is started upon initialization */
  141508. promise: Nullable<Promise<TexturePacker | string>>;
  141509. /** The Container object for the channel sets that are generated */
  141510. sets: object;
  141511. /** The Container array for the frames that are generated */
  141512. frames: TexturePackerFrame[];
  141513. /** The expected number of textures the system is parsing. */
  141514. private _expecting;
  141515. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141516. private _paddingValue;
  141517. /**
  141518. * Initializes a texture package series from an array of meshes or a single mesh.
  141519. * @param name The name of the package
  141520. * @param meshes The target meshes to compose the package from
  141521. * @param options The arguments that texture packer should follow while building.
  141522. * @param scene The scene which the textures are scoped to.
  141523. * @returns TexturePacker
  141524. */
  141525. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141526. /**
  141527. * Starts the package process
  141528. * @param resolve The promises resolution function
  141529. * @returns TexturePacker
  141530. */
  141531. private _createFrames;
  141532. /**
  141533. * Calculates the Size of the Channel Sets
  141534. * @returns Vector2
  141535. */
  141536. private _calculateSize;
  141537. /**
  141538. * Calculates the UV data for the frames.
  141539. * @param baseSize the base frameSize
  141540. * @param padding the base frame padding
  141541. * @param dtSize size of the Dynamic Texture for that channel
  141542. * @param dtUnits is 1/dtSize
  141543. * @param update flag to update the input meshes
  141544. */
  141545. private _calculateMeshUVFrames;
  141546. /**
  141547. * Calculates the frames Offset.
  141548. * @param index of the frame
  141549. * @returns Vector2
  141550. */
  141551. private _getFrameOffset;
  141552. /**
  141553. * Updates a Mesh to the frame data
  141554. * @param mesh that is the target
  141555. * @param frameID or the frame index
  141556. */
  141557. private _updateMeshUV;
  141558. /**
  141559. * Updates a Meshes materials to use the texture packer channels
  141560. * @param m is the mesh to target
  141561. * @param force all channels on the packer to be set.
  141562. */
  141563. private _updateTextureReferences;
  141564. /**
  141565. * Public method to set a Mesh to a frame
  141566. * @param m that is the target
  141567. * @param frameID or the frame index
  141568. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141569. */
  141570. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141571. /**
  141572. * Starts the async promise to compile the texture packer.
  141573. * @returns Promise<void>
  141574. */
  141575. processAsync(): Promise<void>;
  141576. /**
  141577. * Disposes all textures associated with this packer
  141578. */
  141579. dispose(): void;
  141580. /**
  141581. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141582. * @param imageType is the image type to use.
  141583. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141584. */
  141585. download(imageType?: string, quality?: number): void;
  141586. /**
  141587. * Public method to load a texturePacker JSON file.
  141588. * @param data of the JSON file in string format.
  141589. */
  141590. updateFromJSON(data: string): void;
  141591. }
  141592. }
  141593. declare module BABYLON {
  141594. /**
  141595. * 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.
  141596. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141597. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141598. */
  141599. export class CustomProceduralTexture extends ProceduralTexture {
  141600. private _animate;
  141601. private _time;
  141602. private _config;
  141603. private _texturePath;
  141604. /**
  141605. * Instantiates a new Custom Procedural Texture.
  141606. * 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.
  141607. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141608. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141609. * @param name Define the name of the texture
  141610. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141611. * @param size Define the size of the texture to create
  141612. * @param scene Define the scene the texture belongs to
  141613. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141614. * @param generateMipMaps Define if the texture should creates mip maps or not
  141615. */
  141616. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141617. private _loadJson;
  141618. /**
  141619. * Is the texture ready to be used ? (rendered at least once)
  141620. * @returns true if ready, otherwise, false.
  141621. */
  141622. isReady(): boolean;
  141623. /**
  141624. * Render the texture to its associated render target.
  141625. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141626. */
  141627. render(useCameraPostProcess?: boolean): void;
  141628. /**
  141629. * Update the list of dependant textures samplers in the shader.
  141630. */
  141631. updateTextures(): void;
  141632. /**
  141633. * Update the uniform values of the procedural texture in the shader.
  141634. */
  141635. updateShaderUniforms(): void;
  141636. /**
  141637. * Define if the texture animates or not.
  141638. */
  141639. get animate(): boolean;
  141640. set animate(value: boolean);
  141641. }
  141642. }
  141643. declare module BABYLON {
  141644. /** @hidden */
  141645. export var noisePixelShader: {
  141646. name: string;
  141647. shader: string;
  141648. };
  141649. }
  141650. declare module BABYLON {
  141651. /**
  141652. * Class used to generate noise procedural textures
  141653. */
  141654. export class NoiseProceduralTexture extends ProceduralTexture {
  141655. /** Gets or sets the start time (default is 0) */
  141656. time: number;
  141657. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141658. brightness: number;
  141659. /** Defines the number of octaves to process */
  141660. octaves: number;
  141661. /** Defines the level of persistence (0.8 by default) */
  141662. persistence: number;
  141663. /** Gets or sets animation speed factor (default is 1) */
  141664. animationSpeedFactor: number;
  141665. /**
  141666. * Creates a new NoiseProceduralTexture
  141667. * @param name defines the name fo the texture
  141668. * @param size defines the size of the texture (default is 256)
  141669. * @param scene defines the hosting scene
  141670. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141671. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141672. */
  141673. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141674. private _updateShaderUniforms;
  141675. protected _getDefines(): string;
  141676. /** Generate the current state of the procedural texture */
  141677. render(useCameraPostProcess?: boolean): void;
  141678. /**
  141679. * Serializes this noise procedural texture
  141680. * @returns a serialized noise procedural texture object
  141681. */
  141682. serialize(): any;
  141683. /**
  141684. * Clone the texture.
  141685. * @returns the cloned texture
  141686. */
  141687. clone(): NoiseProceduralTexture;
  141688. /**
  141689. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141690. * @param parsedTexture defines parsed texture data
  141691. * @param scene defines the current scene
  141692. * @param rootUrl defines the root URL containing noise procedural texture information
  141693. * @returns a parsed NoiseProceduralTexture
  141694. */
  141695. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141696. }
  141697. }
  141698. declare module BABYLON {
  141699. /**
  141700. * Raw cube texture where the raw buffers are passed in
  141701. */
  141702. export class RawCubeTexture extends CubeTexture {
  141703. /**
  141704. * Creates a cube texture where the raw buffers are passed in.
  141705. * @param scene defines the scene the texture is attached to
  141706. * @param data defines the array of data to use to create each face
  141707. * @param size defines the size of the textures
  141708. * @param format defines the format of the data
  141709. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141710. * @param generateMipMaps defines if the engine should generate the mip levels
  141711. * @param invertY defines if data must be stored with Y axis inverted
  141712. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141713. * @param compression defines the compression used (null by default)
  141714. */
  141715. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141716. /**
  141717. * Updates the raw cube texture.
  141718. * @param data defines the data to store
  141719. * @param format defines the data format
  141720. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141721. * @param invertY defines if data must be stored with Y axis inverted
  141722. * @param compression defines the compression used (null by default)
  141723. * @param level defines which level of the texture to update
  141724. */
  141725. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141726. /**
  141727. * Updates a raw cube texture with RGBD encoded data.
  141728. * @param data defines the array of data [mipmap][face] to use to create each face
  141729. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141730. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141731. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141732. * @returns a promsie that resolves when the operation is complete
  141733. */
  141734. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141735. /**
  141736. * Clones the raw cube texture.
  141737. * @return a new cube texture
  141738. */
  141739. clone(): CubeTexture;
  141740. /** @hidden */
  141741. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141742. }
  141743. }
  141744. declare module BABYLON {
  141745. /**
  141746. * Class used to store 2D array textures containing user data
  141747. */
  141748. export class RawTexture2DArray extends Texture {
  141749. /** Gets or sets the texture format to use */
  141750. format: number;
  141751. /**
  141752. * Create a new RawTexture2DArray
  141753. * @param data defines the data of the texture
  141754. * @param width defines the width of the texture
  141755. * @param height defines the height of the texture
  141756. * @param depth defines the number of layers of the texture
  141757. * @param format defines the texture format to use
  141758. * @param scene defines the hosting scene
  141759. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141760. * @param invertY defines if texture must be stored with Y axis inverted
  141761. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141762. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141763. */
  141764. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141765. /** Gets or sets the texture format to use */
  141766. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141767. /**
  141768. * Update the texture with new data
  141769. * @param data defines the data to store in the texture
  141770. */
  141771. update(data: ArrayBufferView): void;
  141772. }
  141773. }
  141774. declare module BABYLON {
  141775. /**
  141776. * Class used to store 3D textures containing user data
  141777. */
  141778. export class RawTexture3D extends Texture {
  141779. /** Gets or sets the texture format to use */
  141780. format: number;
  141781. /**
  141782. * Create a new RawTexture3D
  141783. * @param data defines the data of the texture
  141784. * @param width defines the width of the texture
  141785. * @param height defines the height of the texture
  141786. * @param depth defines the depth of the texture
  141787. * @param format defines the texture format to use
  141788. * @param scene defines the hosting scene
  141789. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141790. * @param invertY defines if texture must be stored with Y axis inverted
  141791. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141792. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141793. */
  141794. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141795. /** Gets or sets the texture format to use */
  141796. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141797. /**
  141798. * Update the texture with new data
  141799. * @param data defines the data to store in the texture
  141800. */
  141801. update(data: ArrayBufferView): void;
  141802. }
  141803. }
  141804. declare module BABYLON {
  141805. /**
  141806. * Creates a refraction texture used by refraction channel of the standard material.
  141807. * It is like a mirror but to see through a material.
  141808. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141809. */
  141810. export class RefractionTexture extends RenderTargetTexture {
  141811. /**
  141812. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141813. * 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.
  141814. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141815. */
  141816. refractionPlane: Plane;
  141817. /**
  141818. * Define how deep under the surface we should see.
  141819. */
  141820. depth: number;
  141821. /**
  141822. * Creates a refraction texture used by refraction channel of the standard material.
  141823. * It is like a mirror but to see through a material.
  141824. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141825. * @param name Define the texture name
  141826. * @param size Define the size of the underlying texture
  141827. * @param scene Define the scene the refraction belongs to
  141828. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141829. */
  141830. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141831. /**
  141832. * Clone the refraction texture.
  141833. * @returns the cloned texture
  141834. */
  141835. clone(): RefractionTexture;
  141836. /**
  141837. * Serialize the texture to a JSON representation you could use in Parse later on
  141838. * @returns the serialized JSON representation
  141839. */
  141840. serialize(): any;
  141841. }
  141842. }
  141843. declare module BABYLON {
  141844. /**
  141845. * Block used to add support for vertex skinning (bones)
  141846. */
  141847. export class BonesBlock extends NodeMaterialBlock {
  141848. /**
  141849. * Creates a new BonesBlock
  141850. * @param name defines the block name
  141851. */
  141852. constructor(name: string);
  141853. /**
  141854. * Initialize the block and prepare the context for build
  141855. * @param state defines the state that will be used for the build
  141856. */
  141857. initialize(state: NodeMaterialBuildState): void;
  141858. /**
  141859. * Gets the current class name
  141860. * @returns the class name
  141861. */
  141862. getClassName(): string;
  141863. /**
  141864. * Gets the matrix indices input component
  141865. */
  141866. get matricesIndices(): NodeMaterialConnectionPoint;
  141867. /**
  141868. * Gets the matrix weights input component
  141869. */
  141870. get matricesWeights(): NodeMaterialConnectionPoint;
  141871. /**
  141872. * Gets the extra matrix indices input component
  141873. */
  141874. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141875. /**
  141876. * Gets the extra matrix weights input component
  141877. */
  141878. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141879. /**
  141880. * Gets the world input component
  141881. */
  141882. get world(): NodeMaterialConnectionPoint;
  141883. /**
  141884. * Gets the output component
  141885. */
  141886. get output(): NodeMaterialConnectionPoint;
  141887. autoConfigure(material: NodeMaterial): void;
  141888. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141889. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141890. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141891. protected _buildBlock(state: NodeMaterialBuildState): this;
  141892. }
  141893. }
  141894. declare module BABYLON {
  141895. /**
  141896. * Block used to add support for instances
  141897. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141898. */
  141899. export class InstancesBlock extends NodeMaterialBlock {
  141900. /**
  141901. * Creates a new InstancesBlock
  141902. * @param name defines the block name
  141903. */
  141904. constructor(name: string);
  141905. /**
  141906. * Gets the current class name
  141907. * @returns the class name
  141908. */
  141909. getClassName(): string;
  141910. /**
  141911. * Gets the first world row input component
  141912. */
  141913. get world0(): NodeMaterialConnectionPoint;
  141914. /**
  141915. * Gets the second world row input component
  141916. */
  141917. get world1(): NodeMaterialConnectionPoint;
  141918. /**
  141919. * Gets the third world row input component
  141920. */
  141921. get world2(): NodeMaterialConnectionPoint;
  141922. /**
  141923. * Gets the forth world row input component
  141924. */
  141925. get world3(): NodeMaterialConnectionPoint;
  141926. /**
  141927. * Gets the world input component
  141928. */
  141929. get world(): NodeMaterialConnectionPoint;
  141930. /**
  141931. * Gets the output component
  141932. */
  141933. get output(): NodeMaterialConnectionPoint;
  141934. /**
  141935. * Gets the isntanceID component
  141936. */
  141937. get instanceID(): NodeMaterialConnectionPoint;
  141938. autoConfigure(material: NodeMaterial): void;
  141939. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141940. protected _buildBlock(state: NodeMaterialBuildState): this;
  141941. }
  141942. }
  141943. declare module BABYLON {
  141944. /**
  141945. * Block used to add morph targets support to vertex shader
  141946. */
  141947. export class MorphTargetsBlock extends NodeMaterialBlock {
  141948. private _repeatableContentAnchor;
  141949. /**
  141950. * Create a new MorphTargetsBlock
  141951. * @param name defines the block name
  141952. */
  141953. constructor(name: string);
  141954. /**
  141955. * Gets the current class name
  141956. * @returns the class name
  141957. */
  141958. getClassName(): string;
  141959. /**
  141960. * Gets the position input component
  141961. */
  141962. get position(): NodeMaterialConnectionPoint;
  141963. /**
  141964. * Gets the normal input component
  141965. */
  141966. get normal(): NodeMaterialConnectionPoint;
  141967. /**
  141968. * Gets the tangent input component
  141969. */
  141970. get tangent(): NodeMaterialConnectionPoint;
  141971. /**
  141972. * Gets the tangent input component
  141973. */
  141974. get uv(): NodeMaterialConnectionPoint;
  141975. /**
  141976. * Gets the position output component
  141977. */
  141978. get positionOutput(): NodeMaterialConnectionPoint;
  141979. /**
  141980. * Gets the normal output component
  141981. */
  141982. get normalOutput(): NodeMaterialConnectionPoint;
  141983. /**
  141984. * Gets the tangent output component
  141985. */
  141986. get tangentOutput(): NodeMaterialConnectionPoint;
  141987. /**
  141988. * Gets the tangent output component
  141989. */
  141990. get uvOutput(): NodeMaterialConnectionPoint;
  141991. initialize(state: NodeMaterialBuildState): void;
  141992. autoConfigure(material: NodeMaterial): void;
  141993. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141994. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141995. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141996. protected _buildBlock(state: NodeMaterialBuildState): this;
  141997. }
  141998. }
  141999. declare module BABYLON {
  142000. /**
  142001. * Block used to get data information from a light
  142002. */
  142003. export class LightInformationBlock extends NodeMaterialBlock {
  142004. private _lightDataUniformName;
  142005. private _lightColorUniformName;
  142006. private _lightTypeDefineName;
  142007. /**
  142008. * Gets or sets the light associated with this block
  142009. */
  142010. light: Nullable<Light>;
  142011. /**
  142012. * Creates a new LightInformationBlock
  142013. * @param name defines the block name
  142014. */
  142015. constructor(name: string);
  142016. /**
  142017. * Gets the current class name
  142018. * @returns the class name
  142019. */
  142020. getClassName(): string;
  142021. /**
  142022. * Gets the world position input component
  142023. */
  142024. get worldPosition(): NodeMaterialConnectionPoint;
  142025. /**
  142026. * Gets the direction output component
  142027. */
  142028. get direction(): NodeMaterialConnectionPoint;
  142029. /**
  142030. * Gets the direction output component
  142031. */
  142032. get color(): NodeMaterialConnectionPoint;
  142033. /**
  142034. * Gets the direction output component
  142035. */
  142036. get intensity(): NodeMaterialConnectionPoint;
  142037. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142038. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142039. protected _buildBlock(state: NodeMaterialBuildState): this;
  142040. serialize(): any;
  142041. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142042. }
  142043. }
  142044. declare module BABYLON {
  142045. /**
  142046. * Block used to add image processing support to fragment shader
  142047. */
  142048. export class ImageProcessingBlock extends NodeMaterialBlock {
  142049. /**
  142050. * Create a new ImageProcessingBlock
  142051. * @param name defines the block name
  142052. */
  142053. constructor(name: string);
  142054. /**
  142055. * Gets the current class name
  142056. * @returns the class name
  142057. */
  142058. getClassName(): string;
  142059. /**
  142060. * Gets the color input component
  142061. */
  142062. get color(): NodeMaterialConnectionPoint;
  142063. /**
  142064. * Gets the output component
  142065. */
  142066. get output(): NodeMaterialConnectionPoint;
  142067. /**
  142068. * Initialize the block and prepare the context for build
  142069. * @param state defines the state that will be used for the build
  142070. */
  142071. initialize(state: NodeMaterialBuildState): void;
  142072. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142073. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142074. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142075. protected _buildBlock(state: NodeMaterialBuildState): this;
  142076. }
  142077. }
  142078. declare module BABYLON {
  142079. /**
  142080. * Block used to pertub normals based on a normal map
  142081. */
  142082. export class PerturbNormalBlock extends NodeMaterialBlock {
  142083. private _tangentSpaceParameterName;
  142084. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142085. invertX: boolean;
  142086. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142087. invertY: boolean;
  142088. /**
  142089. * Create a new PerturbNormalBlock
  142090. * @param name defines the block name
  142091. */
  142092. constructor(name: string);
  142093. /**
  142094. * Gets the current class name
  142095. * @returns the class name
  142096. */
  142097. getClassName(): string;
  142098. /**
  142099. * Gets the world position input component
  142100. */
  142101. get worldPosition(): NodeMaterialConnectionPoint;
  142102. /**
  142103. * Gets the world normal input component
  142104. */
  142105. get worldNormal(): NodeMaterialConnectionPoint;
  142106. /**
  142107. * Gets the world tangent input component
  142108. */
  142109. get worldTangent(): NodeMaterialConnectionPoint;
  142110. /**
  142111. * Gets the uv input component
  142112. */
  142113. get uv(): NodeMaterialConnectionPoint;
  142114. /**
  142115. * Gets the normal map color input component
  142116. */
  142117. get normalMapColor(): NodeMaterialConnectionPoint;
  142118. /**
  142119. * Gets the strength input component
  142120. */
  142121. get strength(): NodeMaterialConnectionPoint;
  142122. /**
  142123. * Gets the output component
  142124. */
  142125. get output(): NodeMaterialConnectionPoint;
  142126. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142127. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142128. autoConfigure(material: NodeMaterial): void;
  142129. protected _buildBlock(state: NodeMaterialBuildState): this;
  142130. protected _dumpPropertiesCode(): string;
  142131. serialize(): any;
  142132. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142133. }
  142134. }
  142135. declare module BABYLON {
  142136. /**
  142137. * Block used to discard a pixel if a value is smaller than a cutoff
  142138. */
  142139. export class DiscardBlock extends NodeMaterialBlock {
  142140. /**
  142141. * Create a new DiscardBlock
  142142. * @param name defines the block name
  142143. */
  142144. constructor(name: string);
  142145. /**
  142146. * Gets the current class name
  142147. * @returns the class name
  142148. */
  142149. getClassName(): string;
  142150. /**
  142151. * Gets the color input component
  142152. */
  142153. get value(): NodeMaterialConnectionPoint;
  142154. /**
  142155. * Gets the cutoff input component
  142156. */
  142157. get cutoff(): NodeMaterialConnectionPoint;
  142158. protected _buildBlock(state: NodeMaterialBuildState): this;
  142159. }
  142160. }
  142161. declare module BABYLON {
  142162. /**
  142163. * Block used to test if the fragment shader is front facing
  142164. */
  142165. export class FrontFacingBlock extends NodeMaterialBlock {
  142166. /**
  142167. * Creates a new FrontFacingBlock
  142168. * @param name defines the block name
  142169. */
  142170. constructor(name: string);
  142171. /**
  142172. * Gets the current class name
  142173. * @returns the class name
  142174. */
  142175. getClassName(): string;
  142176. /**
  142177. * Gets the output component
  142178. */
  142179. get output(): NodeMaterialConnectionPoint;
  142180. protected _buildBlock(state: NodeMaterialBuildState): this;
  142181. }
  142182. }
  142183. declare module BABYLON {
  142184. /**
  142185. * Block used to get the derivative value on x and y of a given input
  142186. */
  142187. export class DerivativeBlock extends NodeMaterialBlock {
  142188. /**
  142189. * Create a new DerivativeBlock
  142190. * @param name defines the block name
  142191. */
  142192. constructor(name: string);
  142193. /**
  142194. * Gets the current class name
  142195. * @returns the class name
  142196. */
  142197. getClassName(): string;
  142198. /**
  142199. * Gets the input component
  142200. */
  142201. get input(): NodeMaterialConnectionPoint;
  142202. /**
  142203. * Gets the derivative output on x
  142204. */
  142205. get dx(): NodeMaterialConnectionPoint;
  142206. /**
  142207. * Gets the derivative output on y
  142208. */
  142209. get dy(): NodeMaterialConnectionPoint;
  142210. protected _buildBlock(state: NodeMaterialBuildState): this;
  142211. }
  142212. }
  142213. declare module BABYLON {
  142214. /**
  142215. * Block used to make gl_FragCoord available
  142216. */
  142217. export class FragCoordBlock extends NodeMaterialBlock {
  142218. /**
  142219. * Creates a new FragCoordBlock
  142220. * @param name defines the block name
  142221. */
  142222. constructor(name: string);
  142223. /**
  142224. * Gets the current class name
  142225. * @returns the class name
  142226. */
  142227. getClassName(): string;
  142228. /**
  142229. * Gets the xy component
  142230. */
  142231. get xy(): NodeMaterialConnectionPoint;
  142232. /**
  142233. * Gets the xyz component
  142234. */
  142235. get xyz(): NodeMaterialConnectionPoint;
  142236. /**
  142237. * Gets the xyzw component
  142238. */
  142239. get xyzw(): NodeMaterialConnectionPoint;
  142240. /**
  142241. * Gets the x component
  142242. */
  142243. get x(): NodeMaterialConnectionPoint;
  142244. /**
  142245. * Gets the y component
  142246. */
  142247. get y(): NodeMaterialConnectionPoint;
  142248. /**
  142249. * Gets the z component
  142250. */
  142251. get z(): NodeMaterialConnectionPoint;
  142252. /**
  142253. * Gets the w component
  142254. */
  142255. get output(): NodeMaterialConnectionPoint;
  142256. protected writeOutputs(state: NodeMaterialBuildState): string;
  142257. protected _buildBlock(state: NodeMaterialBuildState): this;
  142258. }
  142259. }
  142260. declare module BABYLON {
  142261. /**
  142262. * Block used to get the screen sizes
  142263. */
  142264. export class ScreenSizeBlock extends NodeMaterialBlock {
  142265. private _varName;
  142266. private _scene;
  142267. /**
  142268. * Creates a new ScreenSizeBlock
  142269. * @param name defines the block name
  142270. */
  142271. constructor(name: string);
  142272. /**
  142273. * Gets the current class name
  142274. * @returns the class name
  142275. */
  142276. getClassName(): string;
  142277. /**
  142278. * Gets the xy component
  142279. */
  142280. get xy(): NodeMaterialConnectionPoint;
  142281. /**
  142282. * Gets the x component
  142283. */
  142284. get x(): NodeMaterialConnectionPoint;
  142285. /**
  142286. * Gets the y component
  142287. */
  142288. get y(): NodeMaterialConnectionPoint;
  142289. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142290. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142291. protected _buildBlock(state: NodeMaterialBuildState): this;
  142292. }
  142293. }
  142294. declare module BABYLON {
  142295. /**
  142296. * Block used to add support for scene fog
  142297. */
  142298. export class FogBlock extends NodeMaterialBlock {
  142299. private _fogDistanceName;
  142300. private _fogParameters;
  142301. /**
  142302. * Create a new FogBlock
  142303. * @param name defines the block name
  142304. */
  142305. constructor(name: string);
  142306. /**
  142307. * Gets the current class name
  142308. * @returns the class name
  142309. */
  142310. getClassName(): string;
  142311. /**
  142312. * Gets the world position input component
  142313. */
  142314. get worldPosition(): NodeMaterialConnectionPoint;
  142315. /**
  142316. * Gets the view input component
  142317. */
  142318. get view(): NodeMaterialConnectionPoint;
  142319. /**
  142320. * Gets the color input component
  142321. */
  142322. get input(): NodeMaterialConnectionPoint;
  142323. /**
  142324. * Gets the fog color input component
  142325. */
  142326. get fogColor(): NodeMaterialConnectionPoint;
  142327. /**
  142328. * Gets the output component
  142329. */
  142330. get output(): NodeMaterialConnectionPoint;
  142331. autoConfigure(material: NodeMaterial): void;
  142332. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142333. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142334. protected _buildBlock(state: NodeMaterialBuildState): this;
  142335. }
  142336. }
  142337. declare module BABYLON {
  142338. /**
  142339. * Block used to add light in the fragment shader
  142340. */
  142341. export class LightBlock extends NodeMaterialBlock {
  142342. private _lightId;
  142343. /**
  142344. * Gets or sets the light associated with this block
  142345. */
  142346. light: Nullable<Light>;
  142347. /**
  142348. * Create a new LightBlock
  142349. * @param name defines the block name
  142350. */
  142351. constructor(name: string);
  142352. /**
  142353. * Gets the current class name
  142354. * @returns the class name
  142355. */
  142356. getClassName(): string;
  142357. /**
  142358. * Gets the world position input component
  142359. */
  142360. get worldPosition(): NodeMaterialConnectionPoint;
  142361. /**
  142362. * Gets the world normal input component
  142363. */
  142364. get worldNormal(): NodeMaterialConnectionPoint;
  142365. /**
  142366. * Gets the camera (or eye) position component
  142367. */
  142368. get cameraPosition(): NodeMaterialConnectionPoint;
  142369. /**
  142370. * Gets the glossiness component
  142371. */
  142372. get glossiness(): NodeMaterialConnectionPoint;
  142373. /**
  142374. * Gets the glossinness power component
  142375. */
  142376. get glossPower(): NodeMaterialConnectionPoint;
  142377. /**
  142378. * Gets the diffuse color component
  142379. */
  142380. get diffuseColor(): NodeMaterialConnectionPoint;
  142381. /**
  142382. * Gets the specular color component
  142383. */
  142384. get specularColor(): NodeMaterialConnectionPoint;
  142385. /**
  142386. * Gets the diffuse output component
  142387. */
  142388. get diffuseOutput(): NodeMaterialConnectionPoint;
  142389. /**
  142390. * Gets the specular output component
  142391. */
  142392. get specularOutput(): NodeMaterialConnectionPoint;
  142393. /**
  142394. * Gets the shadow output component
  142395. */
  142396. get shadow(): NodeMaterialConnectionPoint;
  142397. autoConfigure(material: NodeMaterial): void;
  142398. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142399. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142400. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142401. private _injectVertexCode;
  142402. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142403. serialize(): any;
  142404. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142405. }
  142406. }
  142407. declare module BABYLON {
  142408. /**
  142409. * Block used to read a reflection texture from a sampler
  142410. */
  142411. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142412. /**
  142413. * Create a new ReflectionTextureBlock
  142414. * @param name defines the block name
  142415. */
  142416. constructor(name: string);
  142417. /**
  142418. * Gets the current class name
  142419. * @returns the class name
  142420. */
  142421. getClassName(): string;
  142422. /**
  142423. * Gets the world position input component
  142424. */
  142425. get position(): NodeMaterialConnectionPoint;
  142426. /**
  142427. * Gets the world position input component
  142428. */
  142429. get worldPosition(): NodeMaterialConnectionPoint;
  142430. /**
  142431. * Gets the world normal input component
  142432. */
  142433. get worldNormal(): NodeMaterialConnectionPoint;
  142434. /**
  142435. * Gets the world input component
  142436. */
  142437. get world(): NodeMaterialConnectionPoint;
  142438. /**
  142439. * Gets the camera (or eye) position component
  142440. */
  142441. get cameraPosition(): NodeMaterialConnectionPoint;
  142442. /**
  142443. * Gets the view input component
  142444. */
  142445. get view(): NodeMaterialConnectionPoint;
  142446. /**
  142447. * Gets the rgb output component
  142448. */
  142449. get rgb(): NodeMaterialConnectionPoint;
  142450. /**
  142451. * Gets the rgba output component
  142452. */
  142453. get rgba(): NodeMaterialConnectionPoint;
  142454. /**
  142455. * Gets the r output component
  142456. */
  142457. get r(): NodeMaterialConnectionPoint;
  142458. /**
  142459. * Gets the g output component
  142460. */
  142461. get g(): NodeMaterialConnectionPoint;
  142462. /**
  142463. * Gets the b output component
  142464. */
  142465. get b(): NodeMaterialConnectionPoint;
  142466. /**
  142467. * Gets the a output component
  142468. */
  142469. get a(): NodeMaterialConnectionPoint;
  142470. autoConfigure(material: NodeMaterial): void;
  142471. protected _buildBlock(state: NodeMaterialBuildState): this;
  142472. }
  142473. }
  142474. declare module BABYLON {
  142475. /**
  142476. * Block used to add 2 vectors
  142477. */
  142478. export class AddBlock extends NodeMaterialBlock {
  142479. /**
  142480. * Creates a new AddBlock
  142481. * @param name defines the block name
  142482. */
  142483. constructor(name: string);
  142484. /**
  142485. * Gets the current class name
  142486. * @returns the class name
  142487. */
  142488. getClassName(): string;
  142489. /**
  142490. * Gets the left operand input component
  142491. */
  142492. get left(): NodeMaterialConnectionPoint;
  142493. /**
  142494. * Gets the right operand input component
  142495. */
  142496. get right(): NodeMaterialConnectionPoint;
  142497. /**
  142498. * Gets the output component
  142499. */
  142500. get output(): NodeMaterialConnectionPoint;
  142501. protected _buildBlock(state: NodeMaterialBuildState): this;
  142502. }
  142503. }
  142504. declare module BABYLON {
  142505. /**
  142506. * Block used to scale a vector by a float
  142507. */
  142508. export class ScaleBlock extends NodeMaterialBlock {
  142509. /**
  142510. * Creates a new ScaleBlock
  142511. * @param name defines the block name
  142512. */
  142513. constructor(name: string);
  142514. /**
  142515. * Gets the current class name
  142516. * @returns the class name
  142517. */
  142518. getClassName(): string;
  142519. /**
  142520. * Gets the input component
  142521. */
  142522. get input(): NodeMaterialConnectionPoint;
  142523. /**
  142524. * Gets the factor input component
  142525. */
  142526. get factor(): NodeMaterialConnectionPoint;
  142527. /**
  142528. * Gets the output component
  142529. */
  142530. get output(): NodeMaterialConnectionPoint;
  142531. protected _buildBlock(state: NodeMaterialBuildState): this;
  142532. }
  142533. }
  142534. declare module BABYLON {
  142535. /**
  142536. * Block used to clamp a float
  142537. */
  142538. export class ClampBlock extends NodeMaterialBlock {
  142539. /** Gets or sets the minimum range */
  142540. minimum: number;
  142541. /** Gets or sets the maximum range */
  142542. maximum: number;
  142543. /**
  142544. * Creates a new ClampBlock
  142545. * @param name defines the block name
  142546. */
  142547. constructor(name: string);
  142548. /**
  142549. * Gets the current class name
  142550. * @returns the class name
  142551. */
  142552. getClassName(): string;
  142553. /**
  142554. * Gets the value input component
  142555. */
  142556. get value(): NodeMaterialConnectionPoint;
  142557. /**
  142558. * Gets the output component
  142559. */
  142560. get output(): NodeMaterialConnectionPoint;
  142561. protected _buildBlock(state: NodeMaterialBuildState): this;
  142562. protected _dumpPropertiesCode(): string;
  142563. serialize(): any;
  142564. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142565. }
  142566. }
  142567. declare module BABYLON {
  142568. /**
  142569. * Block used to apply a cross product between 2 vectors
  142570. */
  142571. export class CrossBlock extends NodeMaterialBlock {
  142572. /**
  142573. * Creates a new CrossBlock
  142574. * @param name defines the block name
  142575. */
  142576. constructor(name: string);
  142577. /**
  142578. * Gets the current class name
  142579. * @returns the class name
  142580. */
  142581. getClassName(): string;
  142582. /**
  142583. * Gets the left operand input component
  142584. */
  142585. get left(): NodeMaterialConnectionPoint;
  142586. /**
  142587. * Gets the right operand input component
  142588. */
  142589. get right(): NodeMaterialConnectionPoint;
  142590. /**
  142591. * Gets the output component
  142592. */
  142593. get output(): NodeMaterialConnectionPoint;
  142594. protected _buildBlock(state: NodeMaterialBuildState): this;
  142595. }
  142596. }
  142597. declare module BABYLON {
  142598. /**
  142599. * Block used to apply a dot product between 2 vectors
  142600. */
  142601. export class DotBlock extends NodeMaterialBlock {
  142602. /**
  142603. * Creates a new DotBlock
  142604. * @param name defines the block name
  142605. */
  142606. constructor(name: string);
  142607. /**
  142608. * Gets the current class name
  142609. * @returns the class name
  142610. */
  142611. getClassName(): string;
  142612. /**
  142613. * Gets the left operand input component
  142614. */
  142615. get left(): NodeMaterialConnectionPoint;
  142616. /**
  142617. * Gets the right operand input component
  142618. */
  142619. get right(): NodeMaterialConnectionPoint;
  142620. /**
  142621. * Gets the output component
  142622. */
  142623. get output(): NodeMaterialConnectionPoint;
  142624. protected _buildBlock(state: NodeMaterialBuildState): this;
  142625. }
  142626. }
  142627. declare module BABYLON {
  142628. /**
  142629. * Block used to normalize a vector
  142630. */
  142631. export class NormalizeBlock extends NodeMaterialBlock {
  142632. /**
  142633. * Creates a new NormalizeBlock
  142634. * @param name defines the block name
  142635. */
  142636. constructor(name: string);
  142637. /**
  142638. * Gets the current class name
  142639. * @returns the class name
  142640. */
  142641. getClassName(): string;
  142642. /**
  142643. * Gets the input component
  142644. */
  142645. get input(): NodeMaterialConnectionPoint;
  142646. /**
  142647. * Gets the output component
  142648. */
  142649. get output(): NodeMaterialConnectionPoint;
  142650. protected _buildBlock(state: NodeMaterialBuildState): this;
  142651. }
  142652. }
  142653. declare module BABYLON {
  142654. /**
  142655. * Operations supported by the Trigonometry block
  142656. */
  142657. export enum TrigonometryBlockOperations {
  142658. /** Cos */
  142659. Cos = 0,
  142660. /** Sin */
  142661. Sin = 1,
  142662. /** Abs */
  142663. Abs = 2,
  142664. /** Exp */
  142665. Exp = 3,
  142666. /** Exp2 */
  142667. Exp2 = 4,
  142668. /** Round */
  142669. Round = 5,
  142670. /** Floor */
  142671. Floor = 6,
  142672. /** Ceiling */
  142673. Ceiling = 7,
  142674. /** Square root */
  142675. Sqrt = 8,
  142676. /** Log */
  142677. Log = 9,
  142678. /** Tangent */
  142679. Tan = 10,
  142680. /** Arc tangent */
  142681. ArcTan = 11,
  142682. /** Arc cosinus */
  142683. ArcCos = 12,
  142684. /** Arc sinus */
  142685. ArcSin = 13,
  142686. /** Fraction */
  142687. Fract = 14,
  142688. /** Sign */
  142689. Sign = 15,
  142690. /** To radians (from degrees) */
  142691. Radians = 16,
  142692. /** To degrees (from radians) */
  142693. Degrees = 17
  142694. }
  142695. /**
  142696. * Block used to apply trigonometry operation to floats
  142697. */
  142698. export class TrigonometryBlock extends NodeMaterialBlock {
  142699. /**
  142700. * Gets or sets the operation applied by the block
  142701. */
  142702. operation: TrigonometryBlockOperations;
  142703. /**
  142704. * Creates a new TrigonometryBlock
  142705. * @param name defines the block name
  142706. */
  142707. constructor(name: string);
  142708. /**
  142709. * Gets the current class name
  142710. * @returns the class name
  142711. */
  142712. getClassName(): string;
  142713. /**
  142714. * Gets the input component
  142715. */
  142716. get input(): NodeMaterialConnectionPoint;
  142717. /**
  142718. * Gets the output component
  142719. */
  142720. get output(): NodeMaterialConnectionPoint;
  142721. protected _buildBlock(state: NodeMaterialBuildState): this;
  142722. serialize(): any;
  142723. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142724. protected _dumpPropertiesCode(): string;
  142725. }
  142726. }
  142727. declare module BABYLON {
  142728. /**
  142729. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142730. */
  142731. export class ColorMergerBlock extends NodeMaterialBlock {
  142732. /**
  142733. * Create a new ColorMergerBlock
  142734. * @param name defines the block name
  142735. */
  142736. constructor(name: string);
  142737. /**
  142738. * Gets the current class name
  142739. * @returns the class name
  142740. */
  142741. getClassName(): string;
  142742. /**
  142743. * Gets the rgb component (input)
  142744. */
  142745. get rgbIn(): NodeMaterialConnectionPoint;
  142746. /**
  142747. * Gets the r component (input)
  142748. */
  142749. get r(): NodeMaterialConnectionPoint;
  142750. /**
  142751. * Gets the g component (input)
  142752. */
  142753. get g(): NodeMaterialConnectionPoint;
  142754. /**
  142755. * Gets the b component (input)
  142756. */
  142757. get b(): NodeMaterialConnectionPoint;
  142758. /**
  142759. * Gets the a component (input)
  142760. */
  142761. get a(): NodeMaterialConnectionPoint;
  142762. /**
  142763. * Gets the rgba component (output)
  142764. */
  142765. get rgba(): NodeMaterialConnectionPoint;
  142766. /**
  142767. * Gets the rgb component (output)
  142768. */
  142769. get rgbOut(): NodeMaterialConnectionPoint;
  142770. /**
  142771. * Gets the rgb component (output)
  142772. * @deprecated Please use rgbOut instead.
  142773. */
  142774. get rgb(): NodeMaterialConnectionPoint;
  142775. protected _buildBlock(state: NodeMaterialBuildState): this;
  142776. }
  142777. }
  142778. declare module BABYLON {
  142779. /**
  142780. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142781. */
  142782. export class VectorSplitterBlock extends NodeMaterialBlock {
  142783. /**
  142784. * Create a new VectorSplitterBlock
  142785. * @param name defines the block name
  142786. */
  142787. constructor(name: string);
  142788. /**
  142789. * Gets the current class name
  142790. * @returns the class name
  142791. */
  142792. getClassName(): string;
  142793. /**
  142794. * Gets the xyzw component (input)
  142795. */
  142796. get xyzw(): NodeMaterialConnectionPoint;
  142797. /**
  142798. * Gets the xyz component (input)
  142799. */
  142800. get xyzIn(): NodeMaterialConnectionPoint;
  142801. /**
  142802. * Gets the xy component (input)
  142803. */
  142804. get xyIn(): NodeMaterialConnectionPoint;
  142805. /**
  142806. * Gets the xyz component (output)
  142807. */
  142808. get xyzOut(): NodeMaterialConnectionPoint;
  142809. /**
  142810. * Gets the xy component (output)
  142811. */
  142812. get xyOut(): NodeMaterialConnectionPoint;
  142813. /**
  142814. * Gets the x component (output)
  142815. */
  142816. get x(): NodeMaterialConnectionPoint;
  142817. /**
  142818. * Gets the y component (output)
  142819. */
  142820. get y(): NodeMaterialConnectionPoint;
  142821. /**
  142822. * Gets the z component (output)
  142823. */
  142824. get z(): NodeMaterialConnectionPoint;
  142825. /**
  142826. * Gets the w component (output)
  142827. */
  142828. get w(): NodeMaterialConnectionPoint;
  142829. protected _inputRename(name: string): string;
  142830. protected _outputRename(name: string): string;
  142831. protected _buildBlock(state: NodeMaterialBuildState): this;
  142832. }
  142833. }
  142834. declare module BABYLON {
  142835. /**
  142836. * Block used to lerp between 2 values
  142837. */
  142838. export class LerpBlock extends NodeMaterialBlock {
  142839. /**
  142840. * Creates a new LerpBlock
  142841. * @param name defines the block name
  142842. */
  142843. constructor(name: string);
  142844. /**
  142845. * Gets the current class name
  142846. * @returns the class name
  142847. */
  142848. getClassName(): string;
  142849. /**
  142850. * Gets the left operand input component
  142851. */
  142852. get left(): NodeMaterialConnectionPoint;
  142853. /**
  142854. * Gets the right operand input component
  142855. */
  142856. get right(): NodeMaterialConnectionPoint;
  142857. /**
  142858. * Gets the gradient operand input component
  142859. */
  142860. get gradient(): NodeMaterialConnectionPoint;
  142861. /**
  142862. * Gets the output component
  142863. */
  142864. get output(): NodeMaterialConnectionPoint;
  142865. protected _buildBlock(state: NodeMaterialBuildState): this;
  142866. }
  142867. }
  142868. declare module BABYLON {
  142869. /**
  142870. * Block used to divide 2 vectors
  142871. */
  142872. export class DivideBlock extends NodeMaterialBlock {
  142873. /**
  142874. * Creates a new DivideBlock
  142875. * @param name defines the block name
  142876. */
  142877. constructor(name: string);
  142878. /**
  142879. * Gets the current class name
  142880. * @returns the class name
  142881. */
  142882. getClassName(): string;
  142883. /**
  142884. * Gets the left operand input component
  142885. */
  142886. get left(): NodeMaterialConnectionPoint;
  142887. /**
  142888. * Gets the right operand input component
  142889. */
  142890. get right(): NodeMaterialConnectionPoint;
  142891. /**
  142892. * Gets the output component
  142893. */
  142894. get output(): NodeMaterialConnectionPoint;
  142895. protected _buildBlock(state: NodeMaterialBuildState): this;
  142896. }
  142897. }
  142898. declare module BABYLON {
  142899. /**
  142900. * Block used to subtract 2 vectors
  142901. */
  142902. export class SubtractBlock extends NodeMaterialBlock {
  142903. /**
  142904. * Creates a new SubtractBlock
  142905. * @param name defines the block name
  142906. */
  142907. constructor(name: string);
  142908. /**
  142909. * Gets the current class name
  142910. * @returns the class name
  142911. */
  142912. getClassName(): string;
  142913. /**
  142914. * Gets the left operand input component
  142915. */
  142916. get left(): NodeMaterialConnectionPoint;
  142917. /**
  142918. * Gets the right operand input component
  142919. */
  142920. get right(): NodeMaterialConnectionPoint;
  142921. /**
  142922. * Gets the output component
  142923. */
  142924. get output(): NodeMaterialConnectionPoint;
  142925. protected _buildBlock(state: NodeMaterialBuildState): this;
  142926. }
  142927. }
  142928. declare module BABYLON {
  142929. /**
  142930. * Block used to step a value
  142931. */
  142932. export class StepBlock extends NodeMaterialBlock {
  142933. /**
  142934. * Creates a new StepBlock
  142935. * @param name defines the block name
  142936. */
  142937. constructor(name: string);
  142938. /**
  142939. * Gets the current class name
  142940. * @returns the class name
  142941. */
  142942. getClassName(): string;
  142943. /**
  142944. * Gets the value operand input component
  142945. */
  142946. get value(): NodeMaterialConnectionPoint;
  142947. /**
  142948. * Gets the edge operand input component
  142949. */
  142950. get edge(): NodeMaterialConnectionPoint;
  142951. /**
  142952. * Gets the output component
  142953. */
  142954. get output(): NodeMaterialConnectionPoint;
  142955. protected _buildBlock(state: NodeMaterialBuildState): this;
  142956. }
  142957. }
  142958. declare module BABYLON {
  142959. /**
  142960. * Block used to get the opposite (1 - x) of a value
  142961. */
  142962. export class OneMinusBlock extends NodeMaterialBlock {
  142963. /**
  142964. * Creates a new OneMinusBlock
  142965. * @param name defines the block name
  142966. */
  142967. constructor(name: string);
  142968. /**
  142969. * Gets the current class name
  142970. * @returns the class name
  142971. */
  142972. getClassName(): string;
  142973. /**
  142974. * Gets the input component
  142975. */
  142976. get input(): NodeMaterialConnectionPoint;
  142977. /**
  142978. * Gets the output component
  142979. */
  142980. get output(): NodeMaterialConnectionPoint;
  142981. protected _buildBlock(state: NodeMaterialBuildState): this;
  142982. }
  142983. }
  142984. declare module BABYLON {
  142985. /**
  142986. * Block used to get the view direction
  142987. */
  142988. export class ViewDirectionBlock extends NodeMaterialBlock {
  142989. /**
  142990. * Creates a new ViewDirectionBlock
  142991. * @param name defines the block name
  142992. */
  142993. constructor(name: string);
  142994. /**
  142995. * Gets the current class name
  142996. * @returns the class name
  142997. */
  142998. getClassName(): string;
  142999. /**
  143000. * Gets the world position component
  143001. */
  143002. get worldPosition(): NodeMaterialConnectionPoint;
  143003. /**
  143004. * Gets the camera position component
  143005. */
  143006. get cameraPosition(): NodeMaterialConnectionPoint;
  143007. /**
  143008. * Gets the output component
  143009. */
  143010. get output(): NodeMaterialConnectionPoint;
  143011. autoConfigure(material: NodeMaterial): void;
  143012. protected _buildBlock(state: NodeMaterialBuildState): this;
  143013. }
  143014. }
  143015. declare module BABYLON {
  143016. /**
  143017. * Block used to compute fresnel value
  143018. */
  143019. export class FresnelBlock extends NodeMaterialBlock {
  143020. /**
  143021. * Create a new FresnelBlock
  143022. * @param name defines the block name
  143023. */
  143024. constructor(name: string);
  143025. /**
  143026. * Gets the current class name
  143027. * @returns the class name
  143028. */
  143029. getClassName(): string;
  143030. /**
  143031. * Gets the world normal input component
  143032. */
  143033. get worldNormal(): NodeMaterialConnectionPoint;
  143034. /**
  143035. * Gets the view direction input component
  143036. */
  143037. get viewDirection(): NodeMaterialConnectionPoint;
  143038. /**
  143039. * Gets the bias input component
  143040. */
  143041. get bias(): NodeMaterialConnectionPoint;
  143042. /**
  143043. * Gets the camera (or eye) position component
  143044. */
  143045. get power(): NodeMaterialConnectionPoint;
  143046. /**
  143047. * Gets the fresnel output component
  143048. */
  143049. get fresnel(): NodeMaterialConnectionPoint;
  143050. autoConfigure(material: NodeMaterial): void;
  143051. protected _buildBlock(state: NodeMaterialBuildState): this;
  143052. }
  143053. }
  143054. declare module BABYLON {
  143055. /**
  143056. * Block used to get the max of 2 values
  143057. */
  143058. export class MaxBlock extends NodeMaterialBlock {
  143059. /**
  143060. * Creates a new MaxBlock
  143061. * @param name defines the block name
  143062. */
  143063. constructor(name: string);
  143064. /**
  143065. * Gets the current class name
  143066. * @returns the class name
  143067. */
  143068. getClassName(): string;
  143069. /**
  143070. * Gets the left operand input component
  143071. */
  143072. get left(): NodeMaterialConnectionPoint;
  143073. /**
  143074. * Gets the right operand input component
  143075. */
  143076. get right(): NodeMaterialConnectionPoint;
  143077. /**
  143078. * Gets the output component
  143079. */
  143080. get output(): NodeMaterialConnectionPoint;
  143081. protected _buildBlock(state: NodeMaterialBuildState): this;
  143082. }
  143083. }
  143084. declare module BABYLON {
  143085. /**
  143086. * Block used to get the min of 2 values
  143087. */
  143088. export class MinBlock extends NodeMaterialBlock {
  143089. /**
  143090. * Creates a new MinBlock
  143091. * @param name defines the block name
  143092. */
  143093. constructor(name: string);
  143094. /**
  143095. * Gets the current class name
  143096. * @returns the class name
  143097. */
  143098. getClassName(): string;
  143099. /**
  143100. * Gets the left operand input component
  143101. */
  143102. get left(): NodeMaterialConnectionPoint;
  143103. /**
  143104. * Gets the right operand input component
  143105. */
  143106. get right(): NodeMaterialConnectionPoint;
  143107. /**
  143108. * Gets the output component
  143109. */
  143110. get output(): NodeMaterialConnectionPoint;
  143111. protected _buildBlock(state: NodeMaterialBuildState): this;
  143112. }
  143113. }
  143114. declare module BABYLON {
  143115. /**
  143116. * Block used to get the distance between 2 values
  143117. */
  143118. export class DistanceBlock extends NodeMaterialBlock {
  143119. /**
  143120. * Creates a new DistanceBlock
  143121. * @param name defines the block name
  143122. */
  143123. constructor(name: string);
  143124. /**
  143125. * Gets the current class name
  143126. * @returns the class name
  143127. */
  143128. getClassName(): string;
  143129. /**
  143130. * Gets the left operand input component
  143131. */
  143132. get left(): NodeMaterialConnectionPoint;
  143133. /**
  143134. * Gets the right operand input component
  143135. */
  143136. get right(): NodeMaterialConnectionPoint;
  143137. /**
  143138. * Gets the output component
  143139. */
  143140. get output(): NodeMaterialConnectionPoint;
  143141. protected _buildBlock(state: NodeMaterialBuildState): this;
  143142. }
  143143. }
  143144. declare module BABYLON {
  143145. /**
  143146. * Block used to get the length of a vector
  143147. */
  143148. export class LengthBlock extends NodeMaterialBlock {
  143149. /**
  143150. * Creates a new LengthBlock
  143151. * @param name defines the block name
  143152. */
  143153. constructor(name: string);
  143154. /**
  143155. * Gets the current class name
  143156. * @returns the class name
  143157. */
  143158. getClassName(): string;
  143159. /**
  143160. * Gets the value input component
  143161. */
  143162. get value(): NodeMaterialConnectionPoint;
  143163. /**
  143164. * Gets the output component
  143165. */
  143166. get output(): NodeMaterialConnectionPoint;
  143167. protected _buildBlock(state: NodeMaterialBuildState): this;
  143168. }
  143169. }
  143170. declare module BABYLON {
  143171. /**
  143172. * Block used to get negative version of a value (i.e. x * -1)
  143173. */
  143174. export class NegateBlock extends NodeMaterialBlock {
  143175. /**
  143176. * Creates a new NegateBlock
  143177. * @param name defines the block name
  143178. */
  143179. constructor(name: string);
  143180. /**
  143181. * Gets the current class name
  143182. * @returns the class name
  143183. */
  143184. getClassName(): string;
  143185. /**
  143186. * Gets the value input component
  143187. */
  143188. get value(): NodeMaterialConnectionPoint;
  143189. /**
  143190. * Gets the output component
  143191. */
  143192. get output(): NodeMaterialConnectionPoint;
  143193. protected _buildBlock(state: NodeMaterialBuildState): this;
  143194. }
  143195. }
  143196. declare module BABYLON {
  143197. /**
  143198. * Block used to get the value of the first parameter raised to the power of the second
  143199. */
  143200. export class PowBlock extends NodeMaterialBlock {
  143201. /**
  143202. * Creates a new PowBlock
  143203. * @param name defines the block name
  143204. */
  143205. constructor(name: string);
  143206. /**
  143207. * Gets the current class name
  143208. * @returns the class name
  143209. */
  143210. getClassName(): string;
  143211. /**
  143212. * Gets the value operand input component
  143213. */
  143214. get value(): NodeMaterialConnectionPoint;
  143215. /**
  143216. * Gets the power operand input component
  143217. */
  143218. get power(): NodeMaterialConnectionPoint;
  143219. /**
  143220. * Gets the output component
  143221. */
  143222. get output(): NodeMaterialConnectionPoint;
  143223. protected _buildBlock(state: NodeMaterialBuildState): this;
  143224. }
  143225. }
  143226. declare module BABYLON {
  143227. /**
  143228. * Block used to get a random number
  143229. */
  143230. export class RandomNumberBlock extends NodeMaterialBlock {
  143231. /**
  143232. * Creates a new RandomNumberBlock
  143233. * @param name defines the block name
  143234. */
  143235. constructor(name: string);
  143236. /**
  143237. * Gets the current class name
  143238. * @returns the class name
  143239. */
  143240. getClassName(): string;
  143241. /**
  143242. * Gets the seed input component
  143243. */
  143244. get seed(): NodeMaterialConnectionPoint;
  143245. /**
  143246. * Gets the output component
  143247. */
  143248. get output(): NodeMaterialConnectionPoint;
  143249. protected _buildBlock(state: NodeMaterialBuildState): this;
  143250. }
  143251. }
  143252. declare module BABYLON {
  143253. /**
  143254. * Block used to compute arc tangent of 2 values
  143255. */
  143256. export class ArcTan2Block extends NodeMaterialBlock {
  143257. /**
  143258. * Creates a new ArcTan2Block
  143259. * @param name defines the block name
  143260. */
  143261. constructor(name: string);
  143262. /**
  143263. * Gets the current class name
  143264. * @returns the class name
  143265. */
  143266. getClassName(): string;
  143267. /**
  143268. * Gets the x operand input component
  143269. */
  143270. get x(): NodeMaterialConnectionPoint;
  143271. /**
  143272. * Gets the y operand input component
  143273. */
  143274. get y(): NodeMaterialConnectionPoint;
  143275. /**
  143276. * Gets the output component
  143277. */
  143278. get output(): NodeMaterialConnectionPoint;
  143279. protected _buildBlock(state: NodeMaterialBuildState): this;
  143280. }
  143281. }
  143282. declare module BABYLON {
  143283. /**
  143284. * Block used to smooth step a value
  143285. */
  143286. export class SmoothStepBlock extends NodeMaterialBlock {
  143287. /**
  143288. * Creates a new SmoothStepBlock
  143289. * @param name defines the block name
  143290. */
  143291. constructor(name: string);
  143292. /**
  143293. * Gets the current class name
  143294. * @returns the class name
  143295. */
  143296. getClassName(): string;
  143297. /**
  143298. * Gets the value operand input component
  143299. */
  143300. get value(): NodeMaterialConnectionPoint;
  143301. /**
  143302. * Gets the first edge operand input component
  143303. */
  143304. get edge0(): NodeMaterialConnectionPoint;
  143305. /**
  143306. * Gets the second edge operand input component
  143307. */
  143308. get edge1(): NodeMaterialConnectionPoint;
  143309. /**
  143310. * Gets the output component
  143311. */
  143312. get output(): NodeMaterialConnectionPoint;
  143313. protected _buildBlock(state: NodeMaterialBuildState): this;
  143314. }
  143315. }
  143316. declare module BABYLON {
  143317. /**
  143318. * Block used to get the reciprocal (1 / x) of a value
  143319. */
  143320. export class ReciprocalBlock extends NodeMaterialBlock {
  143321. /**
  143322. * Creates a new ReciprocalBlock
  143323. * @param name defines the block name
  143324. */
  143325. constructor(name: string);
  143326. /**
  143327. * Gets the current class name
  143328. * @returns the class name
  143329. */
  143330. getClassName(): string;
  143331. /**
  143332. * Gets the input component
  143333. */
  143334. get input(): NodeMaterialConnectionPoint;
  143335. /**
  143336. * Gets the output component
  143337. */
  143338. get output(): NodeMaterialConnectionPoint;
  143339. protected _buildBlock(state: NodeMaterialBuildState): this;
  143340. }
  143341. }
  143342. declare module BABYLON {
  143343. /**
  143344. * Block used to replace a color by another one
  143345. */
  143346. export class ReplaceColorBlock extends NodeMaterialBlock {
  143347. /**
  143348. * Creates a new ReplaceColorBlock
  143349. * @param name defines the block name
  143350. */
  143351. constructor(name: string);
  143352. /**
  143353. * Gets the current class name
  143354. * @returns the class name
  143355. */
  143356. getClassName(): string;
  143357. /**
  143358. * Gets the value input component
  143359. */
  143360. get value(): NodeMaterialConnectionPoint;
  143361. /**
  143362. * Gets the reference input component
  143363. */
  143364. get reference(): NodeMaterialConnectionPoint;
  143365. /**
  143366. * Gets the distance input component
  143367. */
  143368. get distance(): NodeMaterialConnectionPoint;
  143369. /**
  143370. * Gets the replacement input component
  143371. */
  143372. get replacement(): NodeMaterialConnectionPoint;
  143373. /**
  143374. * Gets the output component
  143375. */
  143376. get output(): NodeMaterialConnectionPoint;
  143377. protected _buildBlock(state: NodeMaterialBuildState): this;
  143378. }
  143379. }
  143380. declare module BABYLON {
  143381. /**
  143382. * Block used to posterize a value
  143383. * @see https://en.wikipedia.org/wiki/Posterization
  143384. */
  143385. export class PosterizeBlock extends NodeMaterialBlock {
  143386. /**
  143387. * Creates a new PosterizeBlock
  143388. * @param name defines the block name
  143389. */
  143390. constructor(name: string);
  143391. /**
  143392. * Gets the current class name
  143393. * @returns the class name
  143394. */
  143395. getClassName(): string;
  143396. /**
  143397. * Gets the value input component
  143398. */
  143399. get value(): NodeMaterialConnectionPoint;
  143400. /**
  143401. * Gets the steps input component
  143402. */
  143403. get steps(): NodeMaterialConnectionPoint;
  143404. /**
  143405. * Gets the output component
  143406. */
  143407. get output(): NodeMaterialConnectionPoint;
  143408. protected _buildBlock(state: NodeMaterialBuildState): this;
  143409. }
  143410. }
  143411. declare module BABYLON {
  143412. /**
  143413. * Operations supported by the Wave block
  143414. */
  143415. export enum WaveBlockKind {
  143416. /** SawTooth */
  143417. SawTooth = 0,
  143418. /** Square */
  143419. Square = 1,
  143420. /** Triangle */
  143421. Triangle = 2
  143422. }
  143423. /**
  143424. * Block used to apply wave operation to floats
  143425. */
  143426. export class WaveBlock extends NodeMaterialBlock {
  143427. /**
  143428. * Gets or sets the kibnd of wave to be applied by the block
  143429. */
  143430. kind: WaveBlockKind;
  143431. /**
  143432. * Creates a new WaveBlock
  143433. * @param name defines the block name
  143434. */
  143435. constructor(name: string);
  143436. /**
  143437. * Gets the current class name
  143438. * @returns the class name
  143439. */
  143440. getClassName(): string;
  143441. /**
  143442. * Gets the input component
  143443. */
  143444. get input(): NodeMaterialConnectionPoint;
  143445. /**
  143446. * Gets the output component
  143447. */
  143448. get output(): NodeMaterialConnectionPoint;
  143449. protected _buildBlock(state: NodeMaterialBuildState): this;
  143450. serialize(): any;
  143451. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143452. }
  143453. }
  143454. declare module BABYLON {
  143455. /**
  143456. * Class used to store a color step for the GradientBlock
  143457. */
  143458. export class GradientBlockColorStep {
  143459. /**
  143460. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143461. */
  143462. step: number;
  143463. /**
  143464. * Gets or sets the color associated with this step
  143465. */
  143466. color: Color3;
  143467. /**
  143468. * Creates a new GradientBlockColorStep
  143469. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143470. * @param color defines the color associated with this step
  143471. */
  143472. constructor(
  143473. /**
  143474. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143475. */
  143476. step: number,
  143477. /**
  143478. * Gets or sets the color associated with this step
  143479. */
  143480. color: Color3);
  143481. }
  143482. /**
  143483. * Block used to return a color from a gradient based on an input value between 0 and 1
  143484. */
  143485. export class GradientBlock extends NodeMaterialBlock {
  143486. /**
  143487. * Gets or sets the list of color steps
  143488. */
  143489. colorSteps: GradientBlockColorStep[];
  143490. /**
  143491. * Creates a new GradientBlock
  143492. * @param name defines the block name
  143493. */
  143494. constructor(name: string);
  143495. /**
  143496. * Gets the current class name
  143497. * @returns the class name
  143498. */
  143499. getClassName(): string;
  143500. /**
  143501. * Gets the gradient input component
  143502. */
  143503. get gradient(): NodeMaterialConnectionPoint;
  143504. /**
  143505. * Gets the output component
  143506. */
  143507. get output(): NodeMaterialConnectionPoint;
  143508. private _writeColorConstant;
  143509. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143510. serialize(): any;
  143511. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143512. protected _dumpPropertiesCode(): string;
  143513. }
  143514. }
  143515. declare module BABYLON {
  143516. /**
  143517. * Block used to normalize lerp between 2 values
  143518. */
  143519. export class NLerpBlock extends NodeMaterialBlock {
  143520. /**
  143521. * Creates a new NLerpBlock
  143522. * @param name defines the block name
  143523. */
  143524. constructor(name: string);
  143525. /**
  143526. * Gets the current class name
  143527. * @returns the class name
  143528. */
  143529. getClassName(): string;
  143530. /**
  143531. * Gets the left operand input component
  143532. */
  143533. get left(): NodeMaterialConnectionPoint;
  143534. /**
  143535. * Gets the right operand input component
  143536. */
  143537. get right(): NodeMaterialConnectionPoint;
  143538. /**
  143539. * Gets the gradient operand input component
  143540. */
  143541. get gradient(): NodeMaterialConnectionPoint;
  143542. /**
  143543. * Gets the output component
  143544. */
  143545. get output(): NodeMaterialConnectionPoint;
  143546. protected _buildBlock(state: NodeMaterialBuildState): this;
  143547. }
  143548. }
  143549. declare module BABYLON {
  143550. /**
  143551. * block used to Generate a Worley Noise 3D Noise Pattern
  143552. */
  143553. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143554. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143555. manhattanDistance: boolean;
  143556. /**
  143557. * Creates a new WorleyNoise3DBlock
  143558. * @param name defines the block name
  143559. */
  143560. constructor(name: string);
  143561. /**
  143562. * Gets the current class name
  143563. * @returns the class name
  143564. */
  143565. getClassName(): string;
  143566. /**
  143567. * Gets the seed input component
  143568. */
  143569. get seed(): NodeMaterialConnectionPoint;
  143570. /**
  143571. * Gets the jitter input component
  143572. */
  143573. get jitter(): NodeMaterialConnectionPoint;
  143574. /**
  143575. * Gets the output component
  143576. */
  143577. get output(): NodeMaterialConnectionPoint;
  143578. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143579. /**
  143580. * Exposes the properties to the UI?
  143581. */
  143582. protected _dumpPropertiesCode(): string;
  143583. /**
  143584. * Exposes the properties to the Seralize?
  143585. */
  143586. serialize(): any;
  143587. /**
  143588. * Exposes the properties to the deseralize?
  143589. */
  143590. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143591. }
  143592. }
  143593. declare module BABYLON {
  143594. /**
  143595. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143596. */
  143597. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143598. /**
  143599. * Creates a new SimplexPerlin3DBlock
  143600. * @param name defines the block name
  143601. */
  143602. constructor(name: string);
  143603. /**
  143604. * Gets the current class name
  143605. * @returns the class name
  143606. */
  143607. getClassName(): string;
  143608. /**
  143609. * Gets the seed operand input component
  143610. */
  143611. get seed(): NodeMaterialConnectionPoint;
  143612. /**
  143613. * Gets the output component
  143614. */
  143615. get output(): NodeMaterialConnectionPoint;
  143616. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143617. }
  143618. }
  143619. declare module BABYLON {
  143620. /**
  143621. * Block used to blend normals
  143622. */
  143623. export class NormalBlendBlock extends NodeMaterialBlock {
  143624. /**
  143625. * Creates a new NormalBlendBlock
  143626. * @param name defines the block name
  143627. */
  143628. constructor(name: string);
  143629. /**
  143630. * Gets the current class name
  143631. * @returns the class name
  143632. */
  143633. getClassName(): string;
  143634. /**
  143635. * Gets the first input component
  143636. */
  143637. get normalMap0(): NodeMaterialConnectionPoint;
  143638. /**
  143639. * Gets the second input component
  143640. */
  143641. get normalMap1(): NodeMaterialConnectionPoint;
  143642. /**
  143643. * Gets the output component
  143644. */
  143645. get output(): NodeMaterialConnectionPoint;
  143646. protected _buildBlock(state: NodeMaterialBuildState): this;
  143647. }
  143648. }
  143649. declare module BABYLON {
  143650. /**
  143651. * Block used to rotate a 2d vector by a given angle
  143652. */
  143653. export class Rotate2dBlock extends NodeMaterialBlock {
  143654. /**
  143655. * Creates a new Rotate2dBlock
  143656. * @param name defines the block name
  143657. */
  143658. constructor(name: string);
  143659. /**
  143660. * Gets the current class name
  143661. * @returns the class name
  143662. */
  143663. getClassName(): string;
  143664. /**
  143665. * Gets the input vector
  143666. */
  143667. get input(): NodeMaterialConnectionPoint;
  143668. /**
  143669. * Gets the input angle
  143670. */
  143671. get angle(): NodeMaterialConnectionPoint;
  143672. /**
  143673. * Gets the output component
  143674. */
  143675. get output(): NodeMaterialConnectionPoint;
  143676. autoConfigure(material: NodeMaterial): void;
  143677. protected _buildBlock(state: NodeMaterialBuildState): this;
  143678. }
  143679. }
  143680. declare module BABYLON {
  143681. /**
  143682. * Block used to get the reflected vector from a direction and a normal
  143683. */
  143684. export class ReflectBlock extends NodeMaterialBlock {
  143685. /**
  143686. * Creates a new ReflectBlock
  143687. * @param name defines the block name
  143688. */
  143689. constructor(name: string);
  143690. /**
  143691. * Gets the current class name
  143692. * @returns the class name
  143693. */
  143694. getClassName(): string;
  143695. /**
  143696. * Gets the incident component
  143697. */
  143698. get incident(): NodeMaterialConnectionPoint;
  143699. /**
  143700. * Gets the normal component
  143701. */
  143702. get normal(): NodeMaterialConnectionPoint;
  143703. /**
  143704. * Gets the output component
  143705. */
  143706. get output(): NodeMaterialConnectionPoint;
  143707. protected _buildBlock(state: NodeMaterialBuildState): this;
  143708. }
  143709. }
  143710. declare module BABYLON {
  143711. /**
  143712. * Block used to get the refracted vector from a direction and a normal
  143713. */
  143714. export class RefractBlock extends NodeMaterialBlock {
  143715. /**
  143716. * Creates a new RefractBlock
  143717. * @param name defines the block name
  143718. */
  143719. constructor(name: string);
  143720. /**
  143721. * Gets the current class name
  143722. * @returns the class name
  143723. */
  143724. getClassName(): string;
  143725. /**
  143726. * Gets the incident component
  143727. */
  143728. get incident(): NodeMaterialConnectionPoint;
  143729. /**
  143730. * Gets the normal component
  143731. */
  143732. get normal(): NodeMaterialConnectionPoint;
  143733. /**
  143734. * Gets the index of refraction component
  143735. */
  143736. get ior(): NodeMaterialConnectionPoint;
  143737. /**
  143738. * Gets the output component
  143739. */
  143740. get output(): NodeMaterialConnectionPoint;
  143741. protected _buildBlock(state: NodeMaterialBuildState): this;
  143742. }
  143743. }
  143744. declare module BABYLON {
  143745. /**
  143746. * Block used to desaturate a color
  143747. */
  143748. export class DesaturateBlock extends NodeMaterialBlock {
  143749. /**
  143750. * Creates a new DesaturateBlock
  143751. * @param name defines the block name
  143752. */
  143753. constructor(name: string);
  143754. /**
  143755. * Gets the current class name
  143756. * @returns the class name
  143757. */
  143758. getClassName(): string;
  143759. /**
  143760. * Gets the color operand input component
  143761. */
  143762. get color(): NodeMaterialConnectionPoint;
  143763. /**
  143764. * Gets the level operand input component
  143765. */
  143766. get level(): NodeMaterialConnectionPoint;
  143767. /**
  143768. * Gets the output component
  143769. */
  143770. get output(): NodeMaterialConnectionPoint;
  143771. protected _buildBlock(state: NodeMaterialBuildState): this;
  143772. }
  143773. }
  143774. declare module BABYLON {
  143775. /**
  143776. * Block used to implement the ambient occlusion module of the PBR material
  143777. */
  143778. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143779. /**
  143780. * Create a new AmbientOcclusionBlock
  143781. * @param name defines the block name
  143782. */
  143783. constructor(name: string);
  143784. /**
  143785. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143786. */
  143787. useAmbientInGrayScale: boolean;
  143788. /**
  143789. * Initialize the block and prepare the context for build
  143790. * @param state defines the state that will be used for the build
  143791. */
  143792. initialize(state: NodeMaterialBuildState): void;
  143793. /**
  143794. * Gets the current class name
  143795. * @returns the class name
  143796. */
  143797. getClassName(): string;
  143798. /**
  143799. * Gets the texture input component
  143800. */
  143801. get texture(): NodeMaterialConnectionPoint;
  143802. /**
  143803. * Gets the texture intensity component
  143804. */
  143805. get intensity(): NodeMaterialConnectionPoint;
  143806. /**
  143807. * Gets the direct light intensity input component
  143808. */
  143809. get directLightIntensity(): NodeMaterialConnectionPoint;
  143810. /**
  143811. * Gets the ambient occlusion object output component
  143812. */
  143813. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143814. /**
  143815. * Gets the main code of the block (fragment side)
  143816. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143817. * @returns the shader code
  143818. */
  143819. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143820. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143821. protected _buildBlock(state: NodeMaterialBuildState): this;
  143822. protected _dumpPropertiesCode(): string;
  143823. serialize(): any;
  143824. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143825. }
  143826. }
  143827. declare module BABYLON {
  143828. /**
  143829. * Block used to implement the reflection module of the PBR material
  143830. */
  143831. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143832. /** @hidden */
  143833. _defineLODReflectionAlpha: string;
  143834. /** @hidden */
  143835. _defineLinearSpecularReflection: string;
  143836. private _vEnvironmentIrradianceName;
  143837. /** @hidden */
  143838. _vReflectionMicrosurfaceInfosName: string;
  143839. /** @hidden */
  143840. _vReflectionInfosName: string;
  143841. /** @hidden */
  143842. _vReflectionFilteringInfoName: string;
  143843. private _scene;
  143844. /**
  143845. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143846. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143847. * It's less burden on the user side in the editor part.
  143848. */
  143849. /** @hidden */
  143850. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143851. /** @hidden */
  143852. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143853. /** @hidden */
  143854. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143855. /**
  143856. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143857. * diffuse part of the IBL.
  143858. */
  143859. useSphericalHarmonics: boolean;
  143860. /**
  143861. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143862. */
  143863. forceIrradianceInFragment: boolean;
  143864. /**
  143865. * Create a new ReflectionBlock
  143866. * @param name defines the block name
  143867. */
  143868. constructor(name: string);
  143869. /**
  143870. * Gets the current class name
  143871. * @returns the class name
  143872. */
  143873. getClassName(): string;
  143874. /**
  143875. * Gets the position input component
  143876. */
  143877. get position(): NodeMaterialConnectionPoint;
  143878. /**
  143879. * Gets the world position input component
  143880. */
  143881. get worldPosition(): NodeMaterialConnectionPoint;
  143882. /**
  143883. * Gets the world normal input component
  143884. */
  143885. get worldNormal(): NodeMaterialConnectionPoint;
  143886. /**
  143887. * Gets the world input component
  143888. */
  143889. get world(): NodeMaterialConnectionPoint;
  143890. /**
  143891. * Gets the camera (or eye) position component
  143892. */
  143893. get cameraPosition(): NodeMaterialConnectionPoint;
  143894. /**
  143895. * Gets the view input component
  143896. */
  143897. get view(): NodeMaterialConnectionPoint;
  143898. /**
  143899. * Gets the color input component
  143900. */
  143901. get color(): NodeMaterialConnectionPoint;
  143902. /**
  143903. * Gets the reflection object output component
  143904. */
  143905. get reflection(): NodeMaterialConnectionPoint;
  143906. /**
  143907. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143908. */
  143909. get hasTexture(): boolean;
  143910. /**
  143911. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143912. */
  143913. get reflectionColor(): string;
  143914. protected _getTexture(): Nullable<BaseTexture>;
  143915. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143916. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143917. /**
  143918. * Gets the code to inject in the vertex shader
  143919. * @param state current state of the node material building
  143920. * @returns the shader code
  143921. */
  143922. handleVertexSide(state: NodeMaterialBuildState): string;
  143923. /**
  143924. * Gets the main code of the block (fragment side)
  143925. * @param state current state of the node material building
  143926. * @param normalVarName name of the existing variable corresponding to the normal
  143927. * @returns the shader code
  143928. */
  143929. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143930. protected _buildBlock(state: NodeMaterialBuildState): this;
  143931. protected _dumpPropertiesCode(): string;
  143932. serialize(): any;
  143933. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143934. }
  143935. }
  143936. declare module BABYLON {
  143937. /**
  143938. * Block used to implement the sheen module of the PBR material
  143939. */
  143940. export class SheenBlock extends NodeMaterialBlock {
  143941. /**
  143942. * Create a new SheenBlock
  143943. * @param name defines the block name
  143944. */
  143945. constructor(name: string);
  143946. /**
  143947. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143948. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143949. * making it easier to setup and tweak the effect
  143950. */
  143951. albedoScaling: boolean;
  143952. /**
  143953. * Defines if the sheen is linked to the sheen color.
  143954. */
  143955. linkSheenWithAlbedo: boolean;
  143956. /**
  143957. * Initialize the block and prepare the context for build
  143958. * @param state defines the state that will be used for the build
  143959. */
  143960. initialize(state: NodeMaterialBuildState): void;
  143961. /**
  143962. * Gets the current class name
  143963. * @returns the class name
  143964. */
  143965. getClassName(): string;
  143966. /**
  143967. * Gets the intensity input component
  143968. */
  143969. get intensity(): NodeMaterialConnectionPoint;
  143970. /**
  143971. * Gets the color input component
  143972. */
  143973. get color(): NodeMaterialConnectionPoint;
  143974. /**
  143975. * Gets the roughness input component
  143976. */
  143977. get roughness(): NodeMaterialConnectionPoint;
  143978. /**
  143979. * Gets the sheen object output component
  143980. */
  143981. get sheen(): NodeMaterialConnectionPoint;
  143982. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143983. /**
  143984. * Gets the main code of the block (fragment side)
  143985. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143986. * @returns the shader code
  143987. */
  143988. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143989. protected _buildBlock(state: NodeMaterialBuildState): this;
  143990. protected _dumpPropertiesCode(): string;
  143991. serialize(): any;
  143992. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143993. }
  143994. }
  143995. declare module BABYLON {
  143996. /**
  143997. * Block used to implement the reflectivity module of the PBR material
  143998. */
  143999. export class ReflectivityBlock extends NodeMaterialBlock {
  144000. private _metallicReflectanceColor;
  144001. private _metallicF0Factor;
  144002. /** @hidden */
  144003. _vMetallicReflectanceFactorsName: string;
  144004. /**
  144005. * The property below is set by the main PBR block prior to calling methods of this class.
  144006. */
  144007. /** @hidden */
  144008. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  144009. /**
  144010. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  144011. */
  144012. useAmbientOcclusionFromMetallicTextureRed: boolean;
  144013. /**
  144014. * Specifies if the metallic texture contains the metallness information in its blue channel.
  144015. */
  144016. useMetallnessFromMetallicTextureBlue: boolean;
  144017. /**
  144018. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  144019. */
  144020. useRoughnessFromMetallicTextureAlpha: boolean;
  144021. /**
  144022. * Specifies if the metallic texture contains the roughness information in its green channel.
  144023. */
  144024. useRoughnessFromMetallicTextureGreen: boolean;
  144025. /**
  144026. * Create a new ReflectivityBlock
  144027. * @param name defines the block name
  144028. */
  144029. constructor(name: string);
  144030. /**
  144031. * Initialize the block and prepare the context for build
  144032. * @param state defines the state that will be used for the build
  144033. */
  144034. initialize(state: NodeMaterialBuildState): void;
  144035. /**
  144036. * Gets the current class name
  144037. * @returns the class name
  144038. */
  144039. getClassName(): string;
  144040. /**
  144041. * Gets the metallic input component
  144042. */
  144043. get metallic(): NodeMaterialConnectionPoint;
  144044. /**
  144045. * Gets the roughness input component
  144046. */
  144047. get roughness(): NodeMaterialConnectionPoint;
  144048. /**
  144049. * Gets the texture input component
  144050. */
  144051. get texture(): NodeMaterialConnectionPoint;
  144052. /**
  144053. * Gets the reflectivity object output component
  144054. */
  144055. get reflectivity(): NodeMaterialConnectionPoint;
  144056. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144057. /**
  144058. * Gets the main code of the block (fragment side)
  144059. * @param state current state of the node material building
  144060. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144061. * @returns the shader code
  144062. */
  144063. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144064. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144065. protected _buildBlock(state: NodeMaterialBuildState): this;
  144066. protected _dumpPropertiesCode(): string;
  144067. serialize(): any;
  144068. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144069. }
  144070. }
  144071. declare module BABYLON {
  144072. /**
  144073. * Block used to implement the anisotropy module of the PBR material
  144074. */
  144075. export class AnisotropyBlock extends NodeMaterialBlock {
  144076. /**
  144077. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144078. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144079. * It's less burden on the user side in the editor part.
  144080. */
  144081. /** @hidden */
  144082. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144083. /** @hidden */
  144084. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144085. /**
  144086. * Create a new AnisotropyBlock
  144087. * @param name defines the block name
  144088. */
  144089. constructor(name: string);
  144090. /**
  144091. * Initialize the block and prepare the context for build
  144092. * @param state defines the state that will be used for the build
  144093. */
  144094. initialize(state: NodeMaterialBuildState): void;
  144095. /**
  144096. * Gets the current class name
  144097. * @returns the class name
  144098. */
  144099. getClassName(): string;
  144100. /**
  144101. * Gets the intensity input component
  144102. */
  144103. get intensity(): NodeMaterialConnectionPoint;
  144104. /**
  144105. * Gets the direction input component
  144106. */
  144107. get direction(): NodeMaterialConnectionPoint;
  144108. /**
  144109. * Gets the texture input component
  144110. */
  144111. get texture(): NodeMaterialConnectionPoint;
  144112. /**
  144113. * Gets the uv input component
  144114. */
  144115. get uv(): NodeMaterialConnectionPoint;
  144116. /**
  144117. * Gets the worldTangent input component
  144118. */
  144119. get worldTangent(): NodeMaterialConnectionPoint;
  144120. /**
  144121. * Gets the anisotropy object output component
  144122. */
  144123. get anisotropy(): NodeMaterialConnectionPoint;
  144124. private _generateTBNSpace;
  144125. /**
  144126. * Gets the main code of the block (fragment side)
  144127. * @param state current state of the node material building
  144128. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144129. * @returns the shader code
  144130. */
  144131. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144132. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144133. protected _buildBlock(state: NodeMaterialBuildState): this;
  144134. }
  144135. }
  144136. declare module BABYLON {
  144137. /**
  144138. * Block used to implement the clear coat module of the PBR material
  144139. */
  144140. export class ClearCoatBlock extends NodeMaterialBlock {
  144141. private _scene;
  144142. /**
  144143. * Create a new ClearCoatBlock
  144144. * @param name defines the block name
  144145. */
  144146. constructor(name: string);
  144147. /**
  144148. * Initialize the block and prepare the context for build
  144149. * @param state defines the state that will be used for the build
  144150. */
  144151. initialize(state: NodeMaterialBuildState): void;
  144152. /**
  144153. * Gets the current class name
  144154. * @returns the class name
  144155. */
  144156. getClassName(): string;
  144157. /**
  144158. * Gets the intensity input component
  144159. */
  144160. get intensity(): NodeMaterialConnectionPoint;
  144161. /**
  144162. * Gets the roughness input component
  144163. */
  144164. get roughness(): NodeMaterialConnectionPoint;
  144165. /**
  144166. * Gets the ior input component
  144167. */
  144168. get ior(): NodeMaterialConnectionPoint;
  144169. /**
  144170. * Gets the texture input component
  144171. */
  144172. get texture(): NodeMaterialConnectionPoint;
  144173. /**
  144174. * Gets the bump texture input component
  144175. */
  144176. get bumpTexture(): NodeMaterialConnectionPoint;
  144177. /**
  144178. * Gets the uv input component
  144179. */
  144180. get uv(): NodeMaterialConnectionPoint;
  144181. /**
  144182. * Gets the tint color input component
  144183. */
  144184. get tintColor(): NodeMaterialConnectionPoint;
  144185. /**
  144186. * Gets the tint "at distance" input component
  144187. */
  144188. get tintAtDistance(): NodeMaterialConnectionPoint;
  144189. /**
  144190. * Gets the tint thickness input component
  144191. */
  144192. get tintThickness(): NodeMaterialConnectionPoint;
  144193. /**
  144194. * Gets the world tangent input component
  144195. */
  144196. get worldTangent(): NodeMaterialConnectionPoint;
  144197. /**
  144198. * Gets the clear coat object output component
  144199. */
  144200. get clearcoat(): NodeMaterialConnectionPoint;
  144201. autoConfigure(material: NodeMaterial): void;
  144202. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144203. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144204. private _generateTBNSpace;
  144205. /**
  144206. * Gets the main code of the block (fragment side)
  144207. * @param state current state of the node material building
  144208. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144209. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144210. * @param worldPosVarName name of the variable holding the world position
  144211. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144212. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144213. * @param worldNormalVarName name of the variable holding the world normal
  144214. * @returns the shader code
  144215. */
  144216. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144217. protected _buildBlock(state: NodeMaterialBuildState): this;
  144218. }
  144219. }
  144220. declare module BABYLON {
  144221. /**
  144222. * Block used to implement the sub surface module of the PBR material
  144223. */
  144224. export class SubSurfaceBlock extends NodeMaterialBlock {
  144225. /**
  144226. * Create a new SubSurfaceBlock
  144227. * @param name defines the block name
  144228. */
  144229. constructor(name: string);
  144230. /**
  144231. * Stores the intensity of the different subsurface effects in the thickness texture.
  144232. * * the green channel is the translucency intensity.
  144233. * * the blue channel is the scattering intensity.
  144234. * * the alpha channel is the refraction intensity.
  144235. */
  144236. useMaskFromThicknessTexture: boolean;
  144237. /**
  144238. * Initialize the block and prepare the context for build
  144239. * @param state defines the state that will be used for the build
  144240. */
  144241. initialize(state: NodeMaterialBuildState): void;
  144242. /**
  144243. * Gets the current class name
  144244. * @returns the class name
  144245. */
  144246. getClassName(): string;
  144247. /**
  144248. * Gets the min thickness input component
  144249. */
  144250. get minThickness(): NodeMaterialConnectionPoint;
  144251. /**
  144252. * Gets the max thickness input component
  144253. */
  144254. get maxThickness(): NodeMaterialConnectionPoint;
  144255. /**
  144256. * Gets the thickness texture component
  144257. */
  144258. get thicknessTexture(): NodeMaterialConnectionPoint;
  144259. /**
  144260. * Gets the tint color input component
  144261. */
  144262. get tintColor(): NodeMaterialConnectionPoint;
  144263. /**
  144264. * Gets the translucency intensity input component
  144265. */
  144266. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144267. /**
  144268. * Gets the translucency diffusion distance input component
  144269. */
  144270. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144271. /**
  144272. * Gets the refraction object parameters
  144273. */
  144274. get refraction(): NodeMaterialConnectionPoint;
  144275. /**
  144276. * Gets the sub surface object output component
  144277. */
  144278. get subsurface(): NodeMaterialConnectionPoint;
  144279. autoConfigure(material: NodeMaterial): void;
  144280. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144281. /**
  144282. * Gets the main code of the block (fragment side)
  144283. * @param state current state of the node material building
  144284. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144285. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144286. * @param worldPosVarName name of the variable holding the world position
  144287. * @returns the shader code
  144288. */
  144289. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144290. protected _buildBlock(state: NodeMaterialBuildState): this;
  144291. }
  144292. }
  144293. declare module BABYLON {
  144294. /**
  144295. * Block used to implement the PBR metallic/roughness model
  144296. */
  144297. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144298. /**
  144299. * Gets or sets the light associated with this block
  144300. */
  144301. light: Nullable<Light>;
  144302. private _lightId;
  144303. private _scene;
  144304. private _environmentBRDFTexture;
  144305. private _environmentBrdfSamplerName;
  144306. private _vNormalWName;
  144307. private _invertNormalName;
  144308. /**
  144309. * Create a new ReflectionBlock
  144310. * @param name defines the block name
  144311. */
  144312. constructor(name: string);
  144313. /**
  144314. * Intensity of the direct lights e.g. the four lights available in your scene.
  144315. * This impacts both the direct diffuse and specular highlights.
  144316. */
  144317. directIntensity: number;
  144318. /**
  144319. * Intensity of the environment e.g. how much the environment will light the object
  144320. * either through harmonics for rough material or through the refelction for shiny ones.
  144321. */
  144322. environmentIntensity: number;
  144323. /**
  144324. * This is a special control allowing the reduction of the specular highlights coming from the
  144325. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144326. */
  144327. specularIntensity: number;
  144328. /**
  144329. * Defines the falloff type used in this material.
  144330. * It by default is Physical.
  144331. */
  144332. lightFalloff: number;
  144333. /**
  144334. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144335. */
  144336. useAlphaFromAlbedoTexture: boolean;
  144337. /**
  144338. * Specifies that alpha test should be used
  144339. */
  144340. useAlphaTest: boolean;
  144341. /**
  144342. * Defines the alpha limits in alpha test mode.
  144343. */
  144344. alphaTestCutoff: number;
  144345. /**
  144346. * Specifies that alpha blending should be used
  144347. */
  144348. useAlphaBlending: boolean;
  144349. /**
  144350. * Defines if the alpha value should be determined via the rgb values.
  144351. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144352. */
  144353. opacityRGB: boolean;
  144354. /**
  144355. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144356. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144357. */
  144358. useRadianceOverAlpha: boolean;
  144359. /**
  144360. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144361. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144362. */
  144363. useSpecularOverAlpha: boolean;
  144364. /**
  144365. * Enables specular anti aliasing in the PBR shader.
  144366. * It will both interacts on the Geometry for analytical and IBL lighting.
  144367. * It also prefilter the roughness map based on the bump values.
  144368. */
  144369. enableSpecularAntiAliasing: boolean;
  144370. /**
  144371. * Enables realtime filtering on the texture.
  144372. */
  144373. realTimeFiltering: boolean;
  144374. /**
  144375. * Quality switch for realtime filtering
  144376. */
  144377. realTimeFilteringQuality: number;
  144378. /**
  144379. * Defines if the material uses energy conservation.
  144380. */
  144381. useEnergyConservation: boolean;
  144382. /**
  144383. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144384. * too much the area relying on ambient texture to define their ambient occlusion.
  144385. */
  144386. useRadianceOcclusion: boolean;
  144387. /**
  144388. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144389. * makes the reflect vector face the model (under horizon).
  144390. */
  144391. useHorizonOcclusion: boolean;
  144392. /**
  144393. * If set to true, no lighting calculations will be applied.
  144394. */
  144395. unlit: boolean;
  144396. /**
  144397. * Force normal to face away from face.
  144398. */
  144399. forceNormalForward: boolean;
  144400. /**
  144401. * Defines the material debug mode.
  144402. * It helps seeing only some components of the material while troubleshooting.
  144403. */
  144404. debugMode: number;
  144405. /**
  144406. * Specify from where on screen the debug mode should start.
  144407. * The value goes from -1 (full screen) to 1 (not visible)
  144408. * It helps with side by side comparison against the final render
  144409. * This defaults to 0
  144410. */
  144411. debugLimit: number;
  144412. /**
  144413. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144414. * You can use the factor to better multiply the final value.
  144415. */
  144416. debugFactor: number;
  144417. /**
  144418. * Initialize the block and prepare the context for build
  144419. * @param state defines the state that will be used for the build
  144420. */
  144421. initialize(state: NodeMaterialBuildState): void;
  144422. /**
  144423. * Gets the current class name
  144424. * @returns the class name
  144425. */
  144426. getClassName(): string;
  144427. /**
  144428. * Gets the world position input component
  144429. */
  144430. get worldPosition(): NodeMaterialConnectionPoint;
  144431. /**
  144432. * Gets the world normal input component
  144433. */
  144434. get worldNormal(): NodeMaterialConnectionPoint;
  144435. /**
  144436. * Gets the perturbed normal input component
  144437. */
  144438. get perturbedNormal(): NodeMaterialConnectionPoint;
  144439. /**
  144440. * Gets the camera position input component
  144441. */
  144442. get cameraPosition(): NodeMaterialConnectionPoint;
  144443. /**
  144444. * Gets the base color input component
  144445. */
  144446. get baseColor(): NodeMaterialConnectionPoint;
  144447. /**
  144448. * Gets the opacity texture input component
  144449. */
  144450. get opacityTexture(): NodeMaterialConnectionPoint;
  144451. /**
  144452. * Gets the ambient color input component
  144453. */
  144454. get ambientColor(): NodeMaterialConnectionPoint;
  144455. /**
  144456. * Gets the reflectivity object parameters
  144457. */
  144458. get reflectivity(): NodeMaterialConnectionPoint;
  144459. /**
  144460. * Gets the ambient occlusion object parameters
  144461. */
  144462. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144463. /**
  144464. * Gets the reflection object parameters
  144465. */
  144466. get reflection(): NodeMaterialConnectionPoint;
  144467. /**
  144468. * Gets the sheen object parameters
  144469. */
  144470. get sheen(): NodeMaterialConnectionPoint;
  144471. /**
  144472. * Gets the clear coat object parameters
  144473. */
  144474. get clearcoat(): NodeMaterialConnectionPoint;
  144475. /**
  144476. * Gets the sub surface object parameters
  144477. */
  144478. get subsurface(): NodeMaterialConnectionPoint;
  144479. /**
  144480. * Gets the anisotropy object parameters
  144481. */
  144482. get anisotropy(): NodeMaterialConnectionPoint;
  144483. /**
  144484. * Gets the ambient output component
  144485. */
  144486. get ambient(): NodeMaterialConnectionPoint;
  144487. /**
  144488. * Gets the diffuse output component
  144489. */
  144490. get diffuse(): NodeMaterialConnectionPoint;
  144491. /**
  144492. * Gets the specular output component
  144493. */
  144494. get specular(): NodeMaterialConnectionPoint;
  144495. /**
  144496. * Gets the sheen output component
  144497. */
  144498. get sheenDir(): NodeMaterialConnectionPoint;
  144499. /**
  144500. * Gets the clear coat output component
  144501. */
  144502. get clearcoatDir(): NodeMaterialConnectionPoint;
  144503. /**
  144504. * Gets the indirect diffuse output component
  144505. */
  144506. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144507. /**
  144508. * Gets the indirect specular output component
  144509. */
  144510. get specularIndirect(): NodeMaterialConnectionPoint;
  144511. /**
  144512. * Gets the indirect sheen output component
  144513. */
  144514. get sheenIndirect(): NodeMaterialConnectionPoint;
  144515. /**
  144516. * Gets the indirect clear coat output component
  144517. */
  144518. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144519. /**
  144520. * Gets the refraction output component
  144521. */
  144522. get refraction(): NodeMaterialConnectionPoint;
  144523. /**
  144524. * Gets the global lighting output component
  144525. */
  144526. get lighting(): NodeMaterialConnectionPoint;
  144527. /**
  144528. * Gets the shadow output component
  144529. */
  144530. get shadow(): NodeMaterialConnectionPoint;
  144531. /**
  144532. * Gets the alpha output component
  144533. */
  144534. get alpha(): NodeMaterialConnectionPoint;
  144535. autoConfigure(material: NodeMaterial): void;
  144536. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144537. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144538. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144539. private _injectVertexCode;
  144540. /**
  144541. * Gets the code corresponding to the albedo/opacity module
  144542. * @returns the shader code
  144543. */
  144544. getAlbedoOpacityCode(): string;
  144545. protected _buildBlock(state: NodeMaterialBuildState): this;
  144546. protected _dumpPropertiesCode(): string;
  144547. serialize(): any;
  144548. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144549. }
  144550. }
  144551. declare module BABYLON {
  144552. /**
  144553. * Block used to compute value of one parameter modulo another
  144554. */
  144555. export class ModBlock extends NodeMaterialBlock {
  144556. /**
  144557. * Creates a new ModBlock
  144558. * @param name defines the block name
  144559. */
  144560. constructor(name: string);
  144561. /**
  144562. * Gets the current class name
  144563. * @returns the class name
  144564. */
  144565. getClassName(): string;
  144566. /**
  144567. * Gets the left operand input component
  144568. */
  144569. get left(): NodeMaterialConnectionPoint;
  144570. /**
  144571. * Gets the right operand input component
  144572. */
  144573. get right(): NodeMaterialConnectionPoint;
  144574. /**
  144575. * Gets the output component
  144576. */
  144577. get output(): NodeMaterialConnectionPoint;
  144578. protected _buildBlock(state: NodeMaterialBuildState): this;
  144579. }
  144580. }
  144581. declare module BABYLON {
  144582. /**
  144583. * Helper class to push actions to a pool of workers.
  144584. */
  144585. export class WorkerPool implements IDisposable {
  144586. private _workerInfos;
  144587. private _pendingActions;
  144588. /**
  144589. * Constructor
  144590. * @param workers Array of workers to use for actions
  144591. */
  144592. constructor(workers: Array<Worker>);
  144593. /**
  144594. * Terminates all workers and clears any pending actions.
  144595. */
  144596. dispose(): void;
  144597. /**
  144598. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144599. * pended until a worker has completed its action.
  144600. * @param action The action to perform. Call onComplete when the action is complete.
  144601. */
  144602. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144603. private _execute;
  144604. }
  144605. }
  144606. declare module BABYLON {
  144607. /**
  144608. * Configuration for Draco compression
  144609. */
  144610. export interface IDracoCompressionConfiguration {
  144611. /**
  144612. * Configuration for the decoder.
  144613. */
  144614. decoder: {
  144615. /**
  144616. * The url to the WebAssembly module.
  144617. */
  144618. wasmUrl?: string;
  144619. /**
  144620. * The url to the WebAssembly binary.
  144621. */
  144622. wasmBinaryUrl?: string;
  144623. /**
  144624. * The url to the fallback JavaScript module.
  144625. */
  144626. fallbackUrl?: string;
  144627. };
  144628. }
  144629. /**
  144630. * Draco compression (https://google.github.io/draco/)
  144631. *
  144632. * This class wraps the Draco module.
  144633. *
  144634. * **Encoder**
  144635. *
  144636. * The encoder is not currently implemented.
  144637. *
  144638. * **Decoder**
  144639. *
  144640. * 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.
  144641. *
  144642. * To update the configuration, use the following code:
  144643. * ```javascript
  144644. * DracoCompression.Configuration = {
  144645. * decoder: {
  144646. * wasmUrl: "<url to the WebAssembly library>",
  144647. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144648. * fallbackUrl: "<url to the fallback JavaScript library>",
  144649. * }
  144650. * };
  144651. * ```
  144652. *
  144653. * 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.
  144654. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144655. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144656. *
  144657. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144658. * ```javascript
  144659. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144660. * ```
  144661. *
  144662. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144663. */
  144664. export class DracoCompression implements IDisposable {
  144665. private _workerPoolPromise?;
  144666. private _decoderModulePromise?;
  144667. /**
  144668. * The configuration. Defaults to the following urls:
  144669. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144670. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144671. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144672. */
  144673. static Configuration: IDracoCompressionConfiguration;
  144674. /**
  144675. * Returns true if the decoder configuration is available.
  144676. */
  144677. static get DecoderAvailable(): boolean;
  144678. /**
  144679. * Default number of workers to create when creating the draco compression object.
  144680. */
  144681. static DefaultNumWorkers: number;
  144682. private static GetDefaultNumWorkers;
  144683. private static _Default;
  144684. /**
  144685. * Default instance for the draco compression object.
  144686. */
  144687. static get Default(): DracoCompression;
  144688. /**
  144689. * Constructor
  144690. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144691. */
  144692. constructor(numWorkers?: number);
  144693. /**
  144694. * Stop all async operations and release resources.
  144695. */
  144696. dispose(): void;
  144697. /**
  144698. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144699. * @returns a promise that resolves when ready
  144700. */
  144701. whenReadyAsync(): Promise<void>;
  144702. /**
  144703. * Decode Draco compressed mesh data to vertex data.
  144704. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144705. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144706. * @returns A promise that resolves with the decoded vertex data
  144707. */
  144708. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144709. [kind: string]: number;
  144710. }): Promise<VertexData>;
  144711. }
  144712. }
  144713. declare module BABYLON {
  144714. /**
  144715. * Class for building Constructive Solid Geometry
  144716. */
  144717. export class CSG {
  144718. private polygons;
  144719. /**
  144720. * The world matrix
  144721. */
  144722. matrix: Matrix;
  144723. /**
  144724. * Stores the position
  144725. */
  144726. position: Vector3;
  144727. /**
  144728. * Stores the rotation
  144729. */
  144730. rotation: Vector3;
  144731. /**
  144732. * Stores the rotation quaternion
  144733. */
  144734. rotationQuaternion: Nullable<Quaternion>;
  144735. /**
  144736. * Stores the scaling vector
  144737. */
  144738. scaling: Vector3;
  144739. /**
  144740. * Convert the Mesh to CSG
  144741. * @param mesh The Mesh to convert to CSG
  144742. * @returns A new CSG from the Mesh
  144743. */
  144744. static FromMesh(mesh: Mesh): CSG;
  144745. /**
  144746. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144747. * @param polygons Polygons used to construct a CSG solid
  144748. */
  144749. private static FromPolygons;
  144750. /**
  144751. * Clones, or makes a deep copy, of the CSG
  144752. * @returns A new CSG
  144753. */
  144754. clone(): CSG;
  144755. /**
  144756. * Unions this CSG with another CSG
  144757. * @param csg The CSG to union against this CSG
  144758. * @returns The unioned CSG
  144759. */
  144760. union(csg: CSG): CSG;
  144761. /**
  144762. * Unions this CSG with another CSG in place
  144763. * @param csg The CSG to union against this CSG
  144764. */
  144765. unionInPlace(csg: CSG): void;
  144766. /**
  144767. * Subtracts this CSG with another CSG
  144768. * @param csg The CSG to subtract against this CSG
  144769. * @returns A new CSG
  144770. */
  144771. subtract(csg: CSG): CSG;
  144772. /**
  144773. * Subtracts this CSG with another CSG in place
  144774. * @param csg The CSG to subtact against this CSG
  144775. */
  144776. subtractInPlace(csg: CSG): void;
  144777. /**
  144778. * Intersect this CSG with another CSG
  144779. * @param csg The CSG to intersect against this CSG
  144780. * @returns A new CSG
  144781. */
  144782. intersect(csg: CSG): CSG;
  144783. /**
  144784. * Intersects this CSG with another CSG in place
  144785. * @param csg The CSG to intersect against this CSG
  144786. */
  144787. intersectInPlace(csg: CSG): void;
  144788. /**
  144789. * Return a new CSG solid with solid and empty space switched. This solid is
  144790. * not modified.
  144791. * @returns A new CSG solid with solid and empty space switched
  144792. */
  144793. inverse(): CSG;
  144794. /**
  144795. * Inverses the CSG in place
  144796. */
  144797. inverseInPlace(): void;
  144798. /**
  144799. * This is used to keep meshes transformations so they can be restored
  144800. * when we build back a Babylon Mesh
  144801. * NB : All CSG operations are performed in world coordinates
  144802. * @param csg The CSG to copy the transform attributes from
  144803. * @returns This CSG
  144804. */
  144805. copyTransformAttributes(csg: CSG): CSG;
  144806. /**
  144807. * Build Raw mesh from CSG
  144808. * Coordinates here are in world space
  144809. * @param name The name of the mesh geometry
  144810. * @param scene The Scene
  144811. * @param keepSubMeshes Specifies if the submeshes should be kept
  144812. * @returns A new Mesh
  144813. */
  144814. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144815. /**
  144816. * Build Mesh from CSG taking material and transforms into account
  144817. * @param name The name of the Mesh
  144818. * @param material The material of the Mesh
  144819. * @param scene The Scene
  144820. * @param keepSubMeshes Specifies if submeshes should be kept
  144821. * @returns The new Mesh
  144822. */
  144823. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144824. }
  144825. }
  144826. declare module BABYLON {
  144827. /**
  144828. * Class used to create a trail following a mesh
  144829. */
  144830. export class TrailMesh extends Mesh {
  144831. private _generator;
  144832. private _autoStart;
  144833. private _running;
  144834. private _diameter;
  144835. private _length;
  144836. private _sectionPolygonPointsCount;
  144837. private _sectionVectors;
  144838. private _sectionNormalVectors;
  144839. private _beforeRenderObserver;
  144840. /**
  144841. * @constructor
  144842. * @param name The value used by scene.getMeshByName() to do a lookup.
  144843. * @param generator The mesh or transform node to generate a trail.
  144844. * @param scene The scene to add this mesh to.
  144845. * @param diameter Diameter of trailing mesh. Default is 1.
  144846. * @param length Length of trailing mesh. Default is 60.
  144847. * @param autoStart Automatically start trailing mesh. Default true.
  144848. */
  144849. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144850. /**
  144851. * "TrailMesh"
  144852. * @returns "TrailMesh"
  144853. */
  144854. getClassName(): string;
  144855. private _createMesh;
  144856. /**
  144857. * Start trailing mesh.
  144858. */
  144859. start(): void;
  144860. /**
  144861. * Stop trailing mesh.
  144862. */
  144863. stop(): void;
  144864. /**
  144865. * Update trailing mesh geometry.
  144866. */
  144867. update(): void;
  144868. /**
  144869. * Returns a new TrailMesh object.
  144870. * @param name is a string, the name given to the new mesh
  144871. * @param newGenerator use new generator object for cloned trail mesh
  144872. * @returns a new mesh
  144873. */
  144874. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144875. /**
  144876. * Serializes this trail mesh
  144877. * @param serializationObject object to write serialization to
  144878. */
  144879. serialize(serializationObject: any): void;
  144880. /**
  144881. * Parses a serialized trail mesh
  144882. * @param parsedMesh the serialized mesh
  144883. * @param scene the scene to create the trail mesh in
  144884. * @returns the created trail mesh
  144885. */
  144886. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144887. }
  144888. }
  144889. declare module BABYLON {
  144890. /**
  144891. * Class containing static functions to help procedurally build meshes
  144892. */
  144893. export class TiledBoxBuilder {
  144894. /**
  144895. * Creates a box mesh
  144896. * 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)
  144897. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144898. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144899. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144901. * @param name defines the name of the mesh
  144902. * @param options defines the options used to create the mesh
  144903. * @param scene defines the hosting scene
  144904. * @returns the box mesh
  144905. */
  144906. static CreateTiledBox(name: string, options: {
  144907. pattern?: number;
  144908. width?: number;
  144909. height?: number;
  144910. depth?: number;
  144911. tileSize?: number;
  144912. tileWidth?: number;
  144913. tileHeight?: number;
  144914. alignHorizontal?: number;
  144915. alignVertical?: number;
  144916. faceUV?: Vector4[];
  144917. faceColors?: Color4[];
  144918. sideOrientation?: number;
  144919. updatable?: boolean;
  144920. }, scene?: Nullable<Scene>): Mesh;
  144921. }
  144922. }
  144923. declare module BABYLON {
  144924. /**
  144925. * Class containing static functions to help procedurally build meshes
  144926. */
  144927. export class TorusKnotBuilder {
  144928. /**
  144929. * Creates a torus knot mesh
  144930. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144931. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144932. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144933. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144934. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144935. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144936. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144937. * @param name defines the name of the mesh
  144938. * @param options defines the options used to create the mesh
  144939. * @param scene defines the hosting scene
  144940. * @returns the torus knot mesh
  144941. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144942. */
  144943. static CreateTorusKnot(name: string, options: {
  144944. radius?: number;
  144945. tube?: number;
  144946. radialSegments?: number;
  144947. tubularSegments?: number;
  144948. p?: number;
  144949. q?: number;
  144950. updatable?: boolean;
  144951. sideOrientation?: number;
  144952. frontUVs?: Vector4;
  144953. backUVs?: Vector4;
  144954. }, scene: any): Mesh;
  144955. }
  144956. }
  144957. declare module BABYLON {
  144958. /**
  144959. * Polygon
  144960. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144961. */
  144962. export class Polygon {
  144963. /**
  144964. * Creates a rectangle
  144965. * @param xmin bottom X coord
  144966. * @param ymin bottom Y coord
  144967. * @param xmax top X coord
  144968. * @param ymax top Y coord
  144969. * @returns points that make the resulting rectation
  144970. */
  144971. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144972. /**
  144973. * Creates a circle
  144974. * @param radius radius of circle
  144975. * @param cx scale in x
  144976. * @param cy scale in y
  144977. * @param numberOfSides number of sides that make up the circle
  144978. * @returns points that make the resulting circle
  144979. */
  144980. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144981. /**
  144982. * Creates a polygon from input string
  144983. * @param input Input polygon data
  144984. * @returns the parsed points
  144985. */
  144986. static Parse(input: string): Vector2[];
  144987. /**
  144988. * Starts building a polygon from x and y coordinates
  144989. * @param x x coordinate
  144990. * @param y y coordinate
  144991. * @returns the started path2
  144992. */
  144993. static StartingAt(x: number, y: number): Path2;
  144994. }
  144995. /**
  144996. * Builds a polygon
  144997. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144998. */
  144999. export class PolygonMeshBuilder {
  145000. private _points;
  145001. private _outlinepoints;
  145002. private _holes;
  145003. private _name;
  145004. private _scene;
  145005. private _epoints;
  145006. private _eholes;
  145007. private _addToepoint;
  145008. /**
  145009. * Babylon reference to the earcut plugin.
  145010. */
  145011. bjsEarcut: any;
  145012. /**
  145013. * Creates a PolygonMeshBuilder
  145014. * @param name name of the builder
  145015. * @param contours Path of the polygon
  145016. * @param scene scene to add to when creating the mesh
  145017. * @param earcutInjection can be used to inject your own earcut reference
  145018. */
  145019. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145020. /**
  145021. * Adds a whole within the polygon
  145022. * @param hole Array of points defining the hole
  145023. * @returns this
  145024. */
  145025. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145026. /**
  145027. * Creates the polygon
  145028. * @param updatable If the mesh should be updatable
  145029. * @param depth The depth of the mesh created
  145030. * @returns the created mesh
  145031. */
  145032. build(updatable?: boolean, depth?: number): Mesh;
  145033. /**
  145034. * Creates the polygon
  145035. * @param depth The depth of the mesh created
  145036. * @returns the created VertexData
  145037. */
  145038. buildVertexData(depth?: number): VertexData;
  145039. /**
  145040. * Adds a side to the polygon
  145041. * @param positions points that make the polygon
  145042. * @param normals normals of the polygon
  145043. * @param uvs uvs of the polygon
  145044. * @param indices indices of the polygon
  145045. * @param bounds bounds of the polygon
  145046. * @param points points of the polygon
  145047. * @param depth depth of the polygon
  145048. * @param flip flip of the polygon
  145049. */
  145050. private addSide;
  145051. }
  145052. }
  145053. declare module BABYLON {
  145054. /**
  145055. * Class containing static functions to help procedurally build meshes
  145056. */
  145057. export class PolygonBuilder {
  145058. /**
  145059. * Creates a polygon mesh
  145060. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145061. * * 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
  145062. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145063. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145064. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145065. * * Remember you can only change the shape positions, not their number when updating a polygon
  145066. * @param name defines the name of the mesh
  145067. * @param options defines the options used to create the mesh
  145068. * @param scene defines the hosting scene
  145069. * @param earcutInjection can be used to inject your own earcut reference
  145070. * @returns the polygon mesh
  145071. */
  145072. static CreatePolygon(name: string, options: {
  145073. shape: Vector3[];
  145074. holes?: Vector3[][];
  145075. depth?: number;
  145076. faceUV?: Vector4[];
  145077. faceColors?: Color4[];
  145078. updatable?: boolean;
  145079. sideOrientation?: number;
  145080. frontUVs?: Vector4;
  145081. backUVs?: Vector4;
  145082. wrap?: boolean;
  145083. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145084. /**
  145085. * Creates an extruded polygon mesh, with depth in the Y direction.
  145086. * * 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)
  145087. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145088. * @param name defines the name of the mesh
  145089. * @param options defines the options used to create the mesh
  145090. * @param scene defines the hosting scene
  145091. * @param earcutInjection can be used to inject your own earcut reference
  145092. * @returns the polygon mesh
  145093. */
  145094. static ExtrudePolygon(name: string, options: {
  145095. shape: Vector3[];
  145096. holes?: Vector3[][];
  145097. depth?: number;
  145098. faceUV?: Vector4[];
  145099. faceColors?: Color4[];
  145100. updatable?: boolean;
  145101. sideOrientation?: number;
  145102. frontUVs?: Vector4;
  145103. backUVs?: Vector4;
  145104. wrap?: boolean;
  145105. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145106. }
  145107. }
  145108. declare module BABYLON {
  145109. /**
  145110. * Class containing static functions to help procedurally build meshes
  145111. */
  145112. export class LatheBuilder {
  145113. /**
  145114. * Creates lathe mesh.
  145115. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145116. * * 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
  145117. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145118. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145119. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145120. * * 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
  145121. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145122. * * 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
  145123. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145124. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145125. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145126. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145127. * @param name defines the name of the mesh
  145128. * @param options defines the options used to create the mesh
  145129. * @param scene defines the hosting scene
  145130. * @returns the lathe mesh
  145131. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145132. */
  145133. static CreateLathe(name: string, options: {
  145134. shape: Vector3[];
  145135. radius?: number;
  145136. tessellation?: number;
  145137. clip?: number;
  145138. arc?: number;
  145139. closed?: boolean;
  145140. updatable?: boolean;
  145141. sideOrientation?: number;
  145142. frontUVs?: Vector4;
  145143. backUVs?: Vector4;
  145144. cap?: number;
  145145. invertUV?: boolean;
  145146. }, scene?: Nullable<Scene>): Mesh;
  145147. }
  145148. }
  145149. declare module BABYLON {
  145150. /**
  145151. * Class containing static functions to help procedurally build meshes
  145152. */
  145153. export class TiledPlaneBuilder {
  145154. /**
  145155. * Creates a tiled plane mesh
  145156. * * The parameter `pattern` will, depending on value, do nothing or
  145157. * * * flip (reflect about central vertical) alternate tiles across and up
  145158. * * * flip every tile on alternate rows
  145159. * * * rotate (180 degs) alternate tiles across and up
  145160. * * * rotate every tile on alternate rows
  145161. * * * flip and rotate alternate tiles across and up
  145162. * * * flip and rotate every tile on alternate rows
  145163. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145164. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145165. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145166. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145167. * * 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)
  145168. * * 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)
  145169. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145170. * @param name defines the name of the mesh
  145171. * @param options defines the options used to create the mesh
  145172. * @param scene defines the hosting scene
  145173. * @returns the box mesh
  145174. */
  145175. static CreateTiledPlane(name: string, options: {
  145176. pattern?: number;
  145177. tileSize?: number;
  145178. tileWidth?: number;
  145179. tileHeight?: number;
  145180. size?: number;
  145181. width?: number;
  145182. height?: number;
  145183. alignHorizontal?: number;
  145184. alignVertical?: number;
  145185. sideOrientation?: number;
  145186. frontUVs?: Vector4;
  145187. backUVs?: Vector4;
  145188. updatable?: boolean;
  145189. }, scene?: Nullable<Scene>): Mesh;
  145190. }
  145191. }
  145192. declare module BABYLON {
  145193. /**
  145194. * Class containing static functions to help procedurally build meshes
  145195. */
  145196. export class TubeBuilder {
  145197. /**
  145198. * Creates a tube mesh.
  145199. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145200. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145201. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145202. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145203. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145204. * * 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)
  145205. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145206. * * 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
  145207. * * 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
  145208. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145209. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145210. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145211. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145212. * @param name defines the name of the mesh
  145213. * @param options defines the options used to create the mesh
  145214. * @param scene defines the hosting scene
  145215. * @returns the tube mesh
  145216. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145217. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145218. */
  145219. static CreateTube(name: string, options: {
  145220. path: Vector3[];
  145221. radius?: number;
  145222. tessellation?: number;
  145223. radiusFunction?: {
  145224. (i: number, distance: number): number;
  145225. };
  145226. cap?: number;
  145227. arc?: number;
  145228. updatable?: boolean;
  145229. sideOrientation?: number;
  145230. frontUVs?: Vector4;
  145231. backUVs?: Vector4;
  145232. instance?: Mesh;
  145233. invertUV?: boolean;
  145234. }, scene?: Nullable<Scene>): Mesh;
  145235. }
  145236. }
  145237. declare module BABYLON {
  145238. /**
  145239. * Class containing static functions to help procedurally build meshes
  145240. */
  145241. export class IcoSphereBuilder {
  145242. /**
  145243. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145244. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145245. * * 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`)
  145246. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145247. * * 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
  145248. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145249. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145250. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145251. * @param name defines the name of the mesh
  145252. * @param options defines the options used to create the mesh
  145253. * @param scene defines the hosting scene
  145254. * @returns the icosahedron mesh
  145255. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145256. */
  145257. static CreateIcoSphere(name: string, options: {
  145258. radius?: number;
  145259. radiusX?: number;
  145260. radiusY?: number;
  145261. radiusZ?: number;
  145262. flat?: boolean;
  145263. subdivisions?: number;
  145264. sideOrientation?: number;
  145265. frontUVs?: Vector4;
  145266. backUVs?: Vector4;
  145267. updatable?: boolean;
  145268. }, scene?: Nullable<Scene>): Mesh;
  145269. }
  145270. }
  145271. declare module BABYLON {
  145272. /**
  145273. * Class containing static functions to help procedurally build meshes
  145274. */
  145275. export class DecalBuilder {
  145276. /**
  145277. * Creates a decal mesh.
  145278. * 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
  145279. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145280. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145281. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145282. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145283. * @param name defines the name of the mesh
  145284. * @param sourceMesh defines the mesh where the decal must be applied
  145285. * @param options defines the options used to create the mesh
  145286. * @param scene defines the hosting scene
  145287. * @returns the decal mesh
  145288. * @see https://doc.babylonjs.com/how_to/decals
  145289. */
  145290. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145291. position?: Vector3;
  145292. normal?: Vector3;
  145293. size?: Vector3;
  145294. angle?: number;
  145295. }): Mesh;
  145296. }
  145297. }
  145298. declare module BABYLON {
  145299. /**
  145300. * Class containing static functions to help procedurally build meshes
  145301. */
  145302. export class MeshBuilder {
  145303. /**
  145304. * Creates a box mesh
  145305. * * The parameter `size` sets the size (float) of each box side (default 1)
  145306. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145307. * * 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)
  145308. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145309. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145310. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145311. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145312. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145313. * @param name defines the name of the mesh
  145314. * @param options defines the options used to create the mesh
  145315. * @param scene defines the hosting scene
  145316. * @returns the box mesh
  145317. */
  145318. static CreateBox(name: string, options: {
  145319. size?: number;
  145320. width?: number;
  145321. height?: number;
  145322. depth?: number;
  145323. faceUV?: Vector4[];
  145324. faceColors?: Color4[];
  145325. sideOrientation?: number;
  145326. frontUVs?: Vector4;
  145327. backUVs?: Vector4;
  145328. wrap?: boolean;
  145329. topBaseAt?: number;
  145330. bottomBaseAt?: number;
  145331. updatable?: boolean;
  145332. }, scene?: Nullable<Scene>): Mesh;
  145333. /**
  145334. * Creates a tiled box mesh
  145335. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145336. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145337. * @param name defines the name of the mesh
  145338. * @param options defines the options used to create the mesh
  145339. * @param scene defines the hosting scene
  145340. * @returns the tiled box mesh
  145341. */
  145342. static CreateTiledBox(name: string, options: {
  145343. pattern?: number;
  145344. size?: number;
  145345. width?: number;
  145346. height?: number;
  145347. depth: number;
  145348. tileSize?: number;
  145349. tileWidth?: number;
  145350. tileHeight?: number;
  145351. faceUV?: Vector4[];
  145352. faceColors?: Color4[];
  145353. alignHorizontal?: number;
  145354. alignVertical?: number;
  145355. sideOrientation?: number;
  145356. updatable?: boolean;
  145357. }, scene?: Nullable<Scene>): Mesh;
  145358. /**
  145359. * Creates a sphere mesh
  145360. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145361. * * 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`)
  145362. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145363. * * 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
  145364. * * 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)
  145365. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145366. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145367. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145368. * @param name defines the name of the mesh
  145369. * @param options defines the options used to create the mesh
  145370. * @param scene defines the hosting scene
  145371. * @returns the sphere mesh
  145372. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145373. */
  145374. static CreateSphere(name: string, options: {
  145375. segments?: number;
  145376. diameter?: number;
  145377. diameterX?: number;
  145378. diameterY?: number;
  145379. diameterZ?: number;
  145380. arc?: number;
  145381. slice?: number;
  145382. sideOrientation?: number;
  145383. frontUVs?: Vector4;
  145384. backUVs?: Vector4;
  145385. updatable?: boolean;
  145386. }, scene?: Nullable<Scene>): Mesh;
  145387. /**
  145388. * Creates a plane polygonal mesh. By default, this is a disc
  145389. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145390. * * 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
  145391. * * 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
  145392. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145393. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145394. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145395. * @param name defines the name of the mesh
  145396. * @param options defines the options used to create the mesh
  145397. * @param scene defines the hosting scene
  145398. * @returns the plane polygonal mesh
  145399. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145400. */
  145401. static CreateDisc(name: string, options: {
  145402. radius?: number;
  145403. tessellation?: number;
  145404. arc?: number;
  145405. updatable?: boolean;
  145406. sideOrientation?: number;
  145407. frontUVs?: Vector4;
  145408. backUVs?: Vector4;
  145409. }, scene?: Nullable<Scene>): Mesh;
  145410. /**
  145411. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145412. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145413. * * 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`)
  145414. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145415. * * 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
  145416. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145417. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145418. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145419. * @param name defines the name of the mesh
  145420. * @param options defines the options used to create the mesh
  145421. * @param scene defines the hosting scene
  145422. * @returns the icosahedron mesh
  145423. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145424. */
  145425. static CreateIcoSphere(name: string, options: {
  145426. radius?: number;
  145427. radiusX?: number;
  145428. radiusY?: number;
  145429. radiusZ?: number;
  145430. flat?: boolean;
  145431. subdivisions?: number;
  145432. sideOrientation?: number;
  145433. frontUVs?: Vector4;
  145434. backUVs?: Vector4;
  145435. updatable?: boolean;
  145436. }, scene?: Nullable<Scene>): Mesh;
  145437. /**
  145438. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145439. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145440. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145441. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145442. * * 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
  145443. * * 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
  145444. * * 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
  145445. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145446. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145447. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145448. * * 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
  145449. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145450. * * 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
  145451. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145452. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145453. * @param name defines the name of the mesh
  145454. * @param options defines the options used to create the mesh
  145455. * @param scene defines the hosting scene
  145456. * @returns the ribbon mesh
  145457. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145458. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145459. */
  145460. static CreateRibbon(name: string, options: {
  145461. pathArray: Vector3[][];
  145462. closeArray?: boolean;
  145463. closePath?: boolean;
  145464. offset?: number;
  145465. updatable?: boolean;
  145466. sideOrientation?: number;
  145467. frontUVs?: Vector4;
  145468. backUVs?: Vector4;
  145469. instance?: Mesh;
  145470. invertUV?: boolean;
  145471. uvs?: Vector2[];
  145472. colors?: Color4[];
  145473. }, scene?: Nullable<Scene>): Mesh;
  145474. /**
  145475. * Creates a cylinder or a cone mesh
  145476. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145477. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145478. * * 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.
  145479. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145480. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145481. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145482. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145483. * * 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).
  145484. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145485. * * 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).
  145486. * * 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
  145487. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145488. * * 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
  145489. * * 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.
  145490. * * If `enclose` is false, a ring surface is one element.
  145491. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145492. * * 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
  145493. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145494. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145495. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145496. * @param name defines the name of the mesh
  145497. * @param options defines the options used to create the mesh
  145498. * @param scene defines the hosting scene
  145499. * @returns the cylinder mesh
  145500. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145501. */
  145502. static CreateCylinder(name: string, options: {
  145503. height?: number;
  145504. diameterTop?: number;
  145505. diameterBottom?: number;
  145506. diameter?: number;
  145507. tessellation?: number;
  145508. subdivisions?: number;
  145509. arc?: number;
  145510. faceColors?: Color4[];
  145511. faceUV?: Vector4[];
  145512. updatable?: boolean;
  145513. hasRings?: boolean;
  145514. enclose?: boolean;
  145515. cap?: number;
  145516. sideOrientation?: number;
  145517. frontUVs?: Vector4;
  145518. backUVs?: Vector4;
  145519. }, scene?: Nullable<Scene>): Mesh;
  145520. /**
  145521. * Creates a torus mesh
  145522. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145523. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145524. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145525. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145526. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145527. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145528. * @param name defines the name of the mesh
  145529. * @param options defines the options used to create the mesh
  145530. * @param scene defines the hosting scene
  145531. * @returns the torus mesh
  145532. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145533. */
  145534. static CreateTorus(name: string, options: {
  145535. diameter?: number;
  145536. thickness?: number;
  145537. tessellation?: number;
  145538. updatable?: boolean;
  145539. sideOrientation?: number;
  145540. frontUVs?: Vector4;
  145541. backUVs?: Vector4;
  145542. }, scene?: Nullable<Scene>): Mesh;
  145543. /**
  145544. * Creates a torus knot mesh
  145545. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145546. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145547. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145548. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145549. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145550. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145551. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145552. * @param name defines the name of the mesh
  145553. * @param options defines the options used to create the mesh
  145554. * @param scene defines the hosting scene
  145555. * @returns the torus knot mesh
  145556. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145557. */
  145558. static CreateTorusKnot(name: string, options: {
  145559. radius?: number;
  145560. tube?: number;
  145561. radialSegments?: number;
  145562. tubularSegments?: number;
  145563. p?: number;
  145564. q?: number;
  145565. updatable?: boolean;
  145566. sideOrientation?: number;
  145567. frontUVs?: Vector4;
  145568. backUVs?: Vector4;
  145569. }, scene?: Nullable<Scene>): Mesh;
  145570. /**
  145571. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145572. * * 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
  145573. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145574. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145575. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145576. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145577. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145578. * * 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
  145579. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145580. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145581. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145582. * @param name defines the name of the new line system
  145583. * @param options defines the options used to create the line system
  145584. * @param scene defines the hosting scene
  145585. * @returns a new line system mesh
  145586. */
  145587. static CreateLineSystem(name: string, options: {
  145588. lines: Vector3[][];
  145589. updatable?: boolean;
  145590. instance?: Nullable<LinesMesh>;
  145591. colors?: Nullable<Color4[][]>;
  145592. useVertexAlpha?: boolean;
  145593. }, scene: Nullable<Scene>): LinesMesh;
  145594. /**
  145595. * Creates a line mesh
  145596. * 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
  145597. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145598. * * The parameter `points` is an array successive Vector3
  145599. * * 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
  145600. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145601. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145602. * * When updating an instance, remember that only point positions can change, not the number of points
  145603. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145604. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145605. * @param name defines the name of the new line system
  145606. * @param options defines the options used to create the line system
  145607. * @param scene defines the hosting scene
  145608. * @returns a new line mesh
  145609. */
  145610. static CreateLines(name: string, options: {
  145611. points: Vector3[];
  145612. updatable?: boolean;
  145613. instance?: Nullable<LinesMesh>;
  145614. colors?: Color4[];
  145615. useVertexAlpha?: boolean;
  145616. }, scene?: Nullable<Scene>): LinesMesh;
  145617. /**
  145618. * Creates a dashed line mesh
  145619. * * 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
  145620. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145621. * * The parameter `points` is an array successive Vector3
  145622. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145623. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145624. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145625. * * 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
  145626. * * When updating an instance, remember that only point positions can change, not the number of points
  145627. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145628. * @param name defines the name of the mesh
  145629. * @param options defines the options used to create the mesh
  145630. * @param scene defines the hosting scene
  145631. * @returns the dashed line mesh
  145632. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145633. */
  145634. static CreateDashedLines(name: string, options: {
  145635. points: Vector3[];
  145636. dashSize?: number;
  145637. gapSize?: number;
  145638. dashNb?: number;
  145639. updatable?: boolean;
  145640. instance?: LinesMesh;
  145641. }, scene?: Nullable<Scene>): LinesMesh;
  145642. /**
  145643. * 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.
  145644. * * 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.
  145645. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145646. * * 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.
  145647. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145648. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  145649. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  145650. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145651. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145652. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145653. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145654. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145655. * @param name defines the name of the mesh
  145656. * @param options defines the options used to create the mesh
  145657. * @param scene defines the hosting scene
  145658. * @returns the extruded shape mesh
  145659. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145660. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145661. */
  145662. static ExtrudeShape(name: string, options: {
  145663. shape: Vector3[];
  145664. path: Vector3[];
  145665. scale?: number;
  145666. rotation?: number;
  145667. cap?: number;
  145668. updatable?: boolean;
  145669. sideOrientation?: number;
  145670. frontUVs?: Vector4;
  145671. backUVs?: Vector4;
  145672. instance?: Mesh;
  145673. invertUV?: boolean;
  145674. }, scene?: Nullable<Scene>): Mesh;
  145675. /**
  145676. * Creates an custom extruded shape mesh.
  145677. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145678. * * 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.
  145679. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145680. * * 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
  145681. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145682. * * 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
  145683. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145684. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145685. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145686. * * 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
  145687. * * 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
  145688. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145689. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145690. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145691. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145692. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145693. * @param name defines the name of the mesh
  145694. * @param options defines the options used to create the mesh
  145695. * @param scene defines the hosting scene
  145696. * @returns the custom extruded shape mesh
  145697. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145698. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145699. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145700. */
  145701. static ExtrudeShapeCustom(name: string, options: {
  145702. shape: Vector3[];
  145703. path: Vector3[];
  145704. scaleFunction?: any;
  145705. rotationFunction?: any;
  145706. ribbonCloseArray?: boolean;
  145707. ribbonClosePath?: boolean;
  145708. cap?: number;
  145709. updatable?: boolean;
  145710. sideOrientation?: number;
  145711. frontUVs?: Vector4;
  145712. backUVs?: Vector4;
  145713. instance?: Mesh;
  145714. invertUV?: boolean;
  145715. }, scene?: Nullable<Scene>): Mesh;
  145716. /**
  145717. * Creates lathe mesh.
  145718. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145719. * * 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
  145720. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145721. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145722. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145723. * * 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
  145724. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145725. * * 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
  145726. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145727. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145728. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145729. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145730. * @param name defines the name of the mesh
  145731. * @param options defines the options used to create the mesh
  145732. * @param scene defines the hosting scene
  145733. * @returns the lathe mesh
  145734. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145735. */
  145736. static CreateLathe(name: string, options: {
  145737. shape: Vector3[];
  145738. radius?: number;
  145739. tessellation?: number;
  145740. clip?: number;
  145741. arc?: number;
  145742. closed?: boolean;
  145743. updatable?: boolean;
  145744. sideOrientation?: number;
  145745. frontUVs?: Vector4;
  145746. backUVs?: Vector4;
  145747. cap?: number;
  145748. invertUV?: boolean;
  145749. }, scene?: Nullable<Scene>): Mesh;
  145750. /**
  145751. * Creates a tiled plane mesh
  145752. * * You can set a limited pattern arrangement with the tiles
  145753. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145754. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145755. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145756. * @param name defines the name of the mesh
  145757. * @param options defines the options used to create the mesh
  145758. * @param scene defines the hosting scene
  145759. * @returns the plane mesh
  145760. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145761. */
  145762. static CreateTiledPlane(name: string, options: {
  145763. pattern?: number;
  145764. tileSize?: number;
  145765. tileWidth?: number;
  145766. tileHeight?: number;
  145767. size?: number;
  145768. width?: number;
  145769. height?: number;
  145770. alignHorizontal?: number;
  145771. alignVertical?: number;
  145772. sideOrientation?: number;
  145773. frontUVs?: Vector4;
  145774. backUVs?: Vector4;
  145775. updatable?: boolean;
  145776. }, scene?: Nullable<Scene>): Mesh;
  145777. /**
  145778. * Creates a plane mesh
  145779. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145780. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145781. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145782. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145783. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145784. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145785. * @param name defines the name of the mesh
  145786. * @param options defines the options used to create the mesh
  145787. * @param scene defines the hosting scene
  145788. * @returns the plane mesh
  145789. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145790. */
  145791. static CreatePlane(name: string, options: {
  145792. size?: number;
  145793. width?: number;
  145794. height?: number;
  145795. sideOrientation?: number;
  145796. frontUVs?: Vector4;
  145797. backUVs?: Vector4;
  145798. updatable?: boolean;
  145799. sourcePlane?: Plane;
  145800. }, scene?: Nullable<Scene>): Mesh;
  145801. /**
  145802. * Creates a ground mesh
  145803. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145804. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145805. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145806. * @param name defines the name of the mesh
  145807. * @param options defines the options used to create the mesh
  145808. * @param scene defines the hosting scene
  145809. * @returns the ground mesh
  145810. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145811. */
  145812. static CreateGround(name: string, options: {
  145813. width?: number;
  145814. height?: number;
  145815. subdivisions?: number;
  145816. subdivisionsX?: number;
  145817. subdivisionsY?: number;
  145818. updatable?: boolean;
  145819. }, scene?: Nullable<Scene>): Mesh;
  145820. /**
  145821. * Creates a tiled ground mesh
  145822. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145823. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145824. * * 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
  145825. * * 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
  145826. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145827. * @param name defines the name of the mesh
  145828. * @param options defines the options used to create the mesh
  145829. * @param scene defines the hosting scene
  145830. * @returns the tiled ground mesh
  145831. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145832. */
  145833. static CreateTiledGround(name: string, options: {
  145834. xmin: number;
  145835. zmin: number;
  145836. xmax: number;
  145837. zmax: number;
  145838. subdivisions?: {
  145839. w: number;
  145840. h: number;
  145841. };
  145842. precision?: {
  145843. w: number;
  145844. h: number;
  145845. };
  145846. updatable?: boolean;
  145847. }, scene?: Nullable<Scene>): Mesh;
  145848. /**
  145849. * Creates a ground mesh from a height map
  145850. * * The parameter `url` sets the URL of the height map image resource.
  145851. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145852. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145853. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145854. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145855. * * 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.
  145856. * * 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).
  145857. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145858. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145859. * @param name defines the name of the mesh
  145860. * @param url defines the url to the height map
  145861. * @param options defines the options used to create the mesh
  145862. * @param scene defines the hosting scene
  145863. * @returns the ground mesh
  145864. * @see https://doc.babylonjs.com/babylon101/height_map
  145865. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145866. */
  145867. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145868. width?: number;
  145869. height?: number;
  145870. subdivisions?: number;
  145871. minHeight?: number;
  145872. maxHeight?: number;
  145873. colorFilter?: Color3;
  145874. alphaFilter?: number;
  145875. updatable?: boolean;
  145876. onReady?: (mesh: GroundMesh) => void;
  145877. }, scene?: Nullable<Scene>): GroundMesh;
  145878. /**
  145879. * Creates a polygon mesh
  145880. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145881. * * 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
  145882. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145883. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145884. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145885. * * Remember you can only change the shape positions, not their number when updating a polygon
  145886. * @param name defines the name of the mesh
  145887. * @param options defines the options used to create the mesh
  145888. * @param scene defines the hosting scene
  145889. * @param earcutInjection can be used to inject your own earcut reference
  145890. * @returns the polygon mesh
  145891. */
  145892. static CreatePolygon(name: string, options: {
  145893. shape: Vector3[];
  145894. holes?: Vector3[][];
  145895. depth?: number;
  145896. faceUV?: Vector4[];
  145897. faceColors?: Color4[];
  145898. updatable?: boolean;
  145899. sideOrientation?: number;
  145900. frontUVs?: Vector4;
  145901. backUVs?: Vector4;
  145902. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145903. /**
  145904. * Creates an extruded polygon mesh, with depth in the Y direction.
  145905. * * 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)
  145906. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145907. * @param name defines the name of the mesh
  145908. * @param options defines the options used to create the mesh
  145909. * @param scene defines the hosting scene
  145910. * @param earcutInjection can be used to inject your own earcut reference
  145911. * @returns the polygon mesh
  145912. */
  145913. static ExtrudePolygon(name: string, options: {
  145914. shape: Vector3[];
  145915. holes?: Vector3[][];
  145916. depth?: number;
  145917. faceUV?: Vector4[];
  145918. faceColors?: Color4[];
  145919. updatable?: boolean;
  145920. sideOrientation?: number;
  145921. frontUVs?: Vector4;
  145922. backUVs?: Vector4;
  145923. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145924. /**
  145925. * Creates a tube mesh.
  145926. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145927. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145928. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145929. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145930. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145931. * * 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)
  145932. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145933. * * 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
  145934. * * 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
  145935. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145936. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145937. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145938. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145939. * @param name defines the name of the mesh
  145940. * @param options defines the options used to create the mesh
  145941. * @param scene defines the hosting scene
  145942. * @returns the tube mesh
  145943. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145944. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145945. */
  145946. static CreateTube(name: string, options: {
  145947. path: Vector3[];
  145948. radius?: number;
  145949. tessellation?: number;
  145950. radiusFunction?: {
  145951. (i: number, distance: number): number;
  145952. };
  145953. cap?: number;
  145954. arc?: number;
  145955. updatable?: boolean;
  145956. sideOrientation?: number;
  145957. frontUVs?: Vector4;
  145958. backUVs?: Vector4;
  145959. instance?: Mesh;
  145960. invertUV?: boolean;
  145961. }, scene?: Nullable<Scene>): Mesh;
  145962. /**
  145963. * Creates a polyhedron mesh
  145964. * * 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
  145965. * * The parameter `size` (positive float, default 1) sets the polygon size
  145966. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145967. * * 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`
  145968. * * 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
  145969. * * 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)`)
  145970. * * 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
  145971. * * 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
  145972. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145973. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145974. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145975. * @param name defines the name of the mesh
  145976. * @param options defines the options used to create the mesh
  145977. * @param scene defines the hosting scene
  145978. * @returns the polyhedron mesh
  145979. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145980. */
  145981. static CreatePolyhedron(name: string, options: {
  145982. type?: number;
  145983. size?: number;
  145984. sizeX?: number;
  145985. sizeY?: number;
  145986. sizeZ?: number;
  145987. custom?: any;
  145988. faceUV?: Vector4[];
  145989. faceColors?: Color4[];
  145990. flat?: boolean;
  145991. updatable?: boolean;
  145992. sideOrientation?: number;
  145993. frontUVs?: Vector4;
  145994. backUVs?: Vector4;
  145995. }, scene?: Nullable<Scene>): Mesh;
  145996. /**
  145997. * Creates a decal mesh.
  145998. * 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
  145999. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146000. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146001. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146002. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146003. * @param name defines the name of the mesh
  146004. * @param sourceMesh defines the mesh where the decal must be applied
  146005. * @param options defines the options used to create the mesh
  146006. * @param scene defines the hosting scene
  146007. * @returns the decal mesh
  146008. * @see https://doc.babylonjs.com/how_to/decals
  146009. */
  146010. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146011. position?: Vector3;
  146012. normal?: Vector3;
  146013. size?: Vector3;
  146014. angle?: number;
  146015. }): Mesh;
  146016. }
  146017. }
  146018. declare module BABYLON {
  146019. /**
  146020. * A simplifier interface for future simplification implementations
  146021. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146022. */
  146023. export interface ISimplifier {
  146024. /**
  146025. * Simplification of a given mesh according to the given settings.
  146026. * Since this requires computation, it is assumed that the function runs async.
  146027. * @param settings The settings of the simplification, including quality and distance
  146028. * @param successCallback A callback that will be called after the mesh was simplified.
  146029. * @param errorCallback in case of an error, this callback will be called. optional.
  146030. */
  146031. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146032. }
  146033. /**
  146034. * Expected simplification settings.
  146035. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146036. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146037. */
  146038. export interface ISimplificationSettings {
  146039. /**
  146040. * Gets or sets the expected quality
  146041. */
  146042. quality: number;
  146043. /**
  146044. * Gets or sets the distance when this optimized version should be used
  146045. */
  146046. distance: number;
  146047. /**
  146048. * Gets an already optimized mesh
  146049. */
  146050. optimizeMesh?: boolean;
  146051. }
  146052. /**
  146053. * Class used to specify simplification options
  146054. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146055. */
  146056. export class SimplificationSettings implements ISimplificationSettings {
  146057. /** expected quality */
  146058. quality: number;
  146059. /** distance when this optimized version should be used */
  146060. distance: number;
  146061. /** already optimized mesh */
  146062. optimizeMesh?: boolean | undefined;
  146063. /**
  146064. * Creates a SimplificationSettings
  146065. * @param quality expected quality
  146066. * @param distance distance when this optimized version should be used
  146067. * @param optimizeMesh already optimized mesh
  146068. */
  146069. constructor(
  146070. /** expected quality */
  146071. quality: number,
  146072. /** distance when this optimized version should be used */
  146073. distance: number,
  146074. /** already optimized mesh */
  146075. optimizeMesh?: boolean | undefined);
  146076. }
  146077. /**
  146078. * Interface used to define a simplification task
  146079. */
  146080. export interface ISimplificationTask {
  146081. /**
  146082. * Array of settings
  146083. */
  146084. settings: Array<ISimplificationSettings>;
  146085. /**
  146086. * Simplification type
  146087. */
  146088. simplificationType: SimplificationType;
  146089. /**
  146090. * Mesh to simplify
  146091. */
  146092. mesh: Mesh;
  146093. /**
  146094. * Callback called on success
  146095. */
  146096. successCallback?: () => void;
  146097. /**
  146098. * Defines if parallel processing can be used
  146099. */
  146100. parallelProcessing: boolean;
  146101. }
  146102. /**
  146103. * Queue used to order the simplification tasks
  146104. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146105. */
  146106. export class SimplificationQueue {
  146107. private _simplificationArray;
  146108. /**
  146109. * Gets a boolean indicating that the process is still running
  146110. */
  146111. running: boolean;
  146112. /**
  146113. * Creates a new queue
  146114. */
  146115. constructor();
  146116. /**
  146117. * Adds a new simplification task
  146118. * @param task defines a task to add
  146119. */
  146120. addTask(task: ISimplificationTask): void;
  146121. /**
  146122. * Execute next task
  146123. */
  146124. executeNext(): void;
  146125. /**
  146126. * Execute a simplification task
  146127. * @param task defines the task to run
  146128. */
  146129. runSimplification(task: ISimplificationTask): void;
  146130. private getSimplifier;
  146131. }
  146132. /**
  146133. * The implemented types of simplification
  146134. * At the moment only Quadratic Error Decimation is implemented
  146135. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146136. */
  146137. export enum SimplificationType {
  146138. /** Quadratic error decimation */
  146139. QUADRATIC = 0
  146140. }
  146141. /**
  146142. * An implementation of the Quadratic Error simplification algorithm.
  146143. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146144. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146145. * @author RaananW
  146146. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146147. */
  146148. export class QuadraticErrorSimplification implements ISimplifier {
  146149. private _mesh;
  146150. private triangles;
  146151. private vertices;
  146152. private references;
  146153. private _reconstructedMesh;
  146154. /** Gets or sets the number pf sync interations */
  146155. syncIterations: number;
  146156. /** Gets or sets the aggressiveness of the simplifier */
  146157. aggressiveness: number;
  146158. /** Gets or sets the number of allowed iterations for decimation */
  146159. decimationIterations: number;
  146160. /** Gets or sets the espilon to use for bounding box computation */
  146161. boundingBoxEpsilon: number;
  146162. /**
  146163. * Creates a new QuadraticErrorSimplification
  146164. * @param _mesh defines the target mesh
  146165. */
  146166. constructor(_mesh: Mesh);
  146167. /**
  146168. * Simplification of a given mesh according to the given settings.
  146169. * Since this requires computation, it is assumed that the function runs async.
  146170. * @param settings The settings of the simplification, including quality and distance
  146171. * @param successCallback A callback that will be called after the mesh was simplified.
  146172. */
  146173. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146174. private runDecimation;
  146175. private initWithMesh;
  146176. private init;
  146177. private reconstructMesh;
  146178. private initDecimatedMesh;
  146179. private isFlipped;
  146180. private updateTriangles;
  146181. private identifyBorder;
  146182. private updateMesh;
  146183. private vertexError;
  146184. private calculateError;
  146185. }
  146186. }
  146187. declare module BABYLON {
  146188. interface Scene {
  146189. /** @hidden (Backing field) */
  146190. _simplificationQueue: SimplificationQueue;
  146191. /**
  146192. * Gets or sets the simplification queue attached to the scene
  146193. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146194. */
  146195. simplificationQueue: SimplificationQueue;
  146196. }
  146197. interface Mesh {
  146198. /**
  146199. * Simplify the mesh according to the given array of settings.
  146200. * Function will return immediately and will simplify async
  146201. * @param settings a collection of simplification settings
  146202. * @param parallelProcessing should all levels calculate parallel or one after the other
  146203. * @param simplificationType the type of simplification to run
  146204. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146205. * @returns the current mesh
  146206. */
  146207. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146208. }
  146209. /**
  146210. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146211. * created in a scene
  146212. */
  146213. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146214. /**
  146215. * The component name helpfull to identify the component in the list of scene components.
  146216. */
  146217. readonly name: string;
  146218. /**
  146219. * The scene the component belongs to.
  146220. */
  146221. scene: Scene;
  146222. /**
  146223. * Creates a new instance of the component for the given scene
  146224. * @param scene Defines the scene to register the component in
  146225. */
  146226. constructor(scene: Scene);
  146227. /**
  146228. * Registers the component in a given scene
  146229. */
  146230. register(): void;
  146231. /**
  146232. * Rebuilds the elements related to this component in case of
  146233. * context lost for instance.
  146234. */
  146235. rebuild(): void;
  146236. /**
  146237. * Disposes the component and the associated ressources
  146238. */
  146239. dispose(): void;
  146240. private _beforeCameraUpdate;
  146241. }
  146242. }
  146243. declare module BABYLON {
  146244. interface Mesh {
  146245. /**
  146246. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146247. */
  146248. thinInstanceEnablePicking: boolean;
  146249. /**
  146250. * Creates a new thin instance
  146251. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146252. * @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
  146253. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146254. */
  146255. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146256. /**
  146257. * Adds the transformation (matrix) of the current mesh as a thin instance
  146258. * @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
  146259. * @returns the thin instance index number
  146260. */
  146261. thinInstanceAddSelf(refresh: boolean): number;
  146262. /**
  146263. * Registers a custom attribute to be used with thin instances
  146264. * @param kind name of the attribute
  146265. * @param stride size in floats of the attribute
  146266. */
  146267. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146268. /**
  146269. * Sets the matrix of a thin instance
  146270. * @param index index of the thin instance
  146271. * @param matrix matrix to set
  146272. * @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
  146273. */
  146274. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146275. /**
  146276. * Sets the value of a custom attribute for a thin instance
  146277. * @param kind name of the attribute
  146278. * @param index index of the thin instance
  146279. * @param value value to set
  146280. * @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
  146281. */
  146282. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146283. /**
  146284. * 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.
  146285. */
  146286. thinInstanceCount: number;
  146287. /**
  146288. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146289. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146290. * @param buffer buffer to set
  146291. * @param stride size in floats of each value of the buffer
  146292. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146293. */
  146294. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146295. /**
  146296. * Gets the list of world matrices
  146297. * @return an array containing all the world matrices from the thin instances
  146298. */
  146299. thinInstanceGetWorldMatrices(): Matrix[];
  146300. /**
  146301. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146302. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146303. */
  146304. thinInstanceBufferUpdated(kind: string): void;
  146305. /**
  146306. * Applies a partial update to a buffer directly on the GPU
  146307. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  146308. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146309. * @param data the data to set in the GPU buffer
  146310. * @param offset the offset in the GPU buffer where to update the data
  146311. */
  146312. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  146313. /**
  146314. * Refreshes the bounding info, taking into account all the thin instances defined
  146315. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146316. */
  146317. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146318. /** @hidden */
  146319. _thinInstanceInitializeUserStorage(): void;
  146320. /** @hidden */
  146321. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146322. /** @hidden */
  146323. _userThinInstanceBuffersStorage: {
  146324. data: {
  146325. [key: string]: Float32Array;
  146326. };
  146327. sizes: {
  146328. [key: string]: number;
  146329. };
  146330. vertexBuffers: {
  146331. [key: string]: Nullable<VertexBuffer>;
  146332. };
  146333. strides: {
  146334. [key: string]: number;
  146335. };
  146336. };
  146337. }
  146338. }
  146339. declare module BABYLON {
  146340. /**
  146341. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146342. */
  146343. export interface INavigationEnginePlugin {
  146344. /**
  146345. * plugin name
  146346. */
  146347. name: string;
  146348. /**
  146349. * Creates a navigation mesh
  146350. * @param meshes array of all the geometry used to compute the navigatio mesh
  146351. * @param parameters bunch of parameters used to filter geometry
  146352. */
  146353. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146354. /**
  146355. * Create a navigation mesh debug mesh
  146356. * @param scene is where the mesh will be added
  146357. * @returns debug display mesh
  146358. */
  146359. createDebugNavMesh(scene: Scene): Mesh;
  146360. /**
  146361. * Get a navigation mesh constrained position, closest to the parameter position
  146362. * @param position world position
  146363. * @returns the closest point to position constrained by the navigation mesh
  146364. */
  146365. getClosestPoint(position: Vector3): Vector3;
  146366. /**
  146367. * Get a navigation mesh constrained position, closest to the parameter position
  146368. * @param position world position
  146369. * @param result output the closest point to position constrained by the navigation mesh
  146370. */
  146371. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146372. /**
  146373. * Get a navigation mesh constrained position, within a particular radius
  146374. * @param position world position
  146375. * @param maxRadius the maximum distance to the constrained world position
  146376. * @returns the closest point to position constrained by the navigation mesh
  146377. */
  146378. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146379. /**
  146380. * Get a navigation mesh constrained position, within a particular radius
  146381. * @param position world position
  146382. * @param maxRadius the maximum distance to the constrained world position
  146383. * @param result output the closest point to position constrained by the navigation mesh
  146384. */
  146385. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146386. /**
  146387. * Compute the final position from a segment made of destination-position
  146388. * @param position world position
  146389. * @param destination world position
  146390. * @returns the resulting point along the navmesh
  146391. */
  146392. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146393. /**
  146394. * Compute the final position from a segment made of destination-position
  146395. * @param position world position
  146396. * @param destination world position
  146397. * @param result output the resulting point along the navmesh
  146398. */
  146399. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146400. /**
  146401. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146402. * @param start world position
  146403. * @param end world position
  146404. * @returns array containing world position composing the path
  146405. */
  146406. computePath(start: Vector3, end: Vector3): Vector3[];
  146407. /**
  146408. * If this plugin is supported
  146409. * @returns true if plugin is supported
  146410. */
  146411. isSupported(): boolean;
  146412. /**
  146413. * Create a new Crowd so you can add agents
  146414. * @param maxAgents the maximum agent count in the crowd
  146415. * @param maxAgentRadius the maximum radius an agent can have
  146416. * @param scene to attach the crowd to
  146417. * @returns the crowd you can add agents to
  146418. */
  146419. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146420. /**
  146421. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146422. * The queries will try to find a solution within those bounds
  146423. * default is (1,1,1)
  146424. * @param extent x,y,z value that define the extent around the queries point of reference
  146425. */
  146426. setDefaultQueryExtent(extent: Vector3): void;
  146427. /**
  146428. * Get the Bounding box extent specified by setDefaultQueryExtent
  146429. * @returns the box extent values
  146430. */
  146431. getDefaultQueryExtent(): Vector3;
  146432. /**
  146433. * build the navmesh from a previously saved state using getNavmeshData
  146434. * @param data the Uint8Array returned by getNavmeshData
  146435. */
  146436. buildFromNavmeshData(data: Uint8Array): void;
  146437. /**
  146438. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146439. * @returns data the Uint8Array that can be saved and reused
  146440. */
  146441. getNavmeshData(): Uint8Array;
  146442. /**
  146443. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146444. * @param result output the box extent values
  146445. */
  146446. getDefaultQueryExtentToRef(result: Vector3): void;
  146447. /**
  146448. * Release all resources
  146449. */
  146450. dispose(): void;
  146451. }
  146452. /**
  146453. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146454. */
  146455. export interface ICrowd {
  146456. /**
  146457. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146458. * You can attach anything to that node. The node position is updated in the scene update tick.
  146459. * @param pos world position that will be constrained by the navigation mesh
  146460. * @param parameters agent parameters
  146461. * @param transform hooked to the agent that will be update by the scene
  146462. * @returns agent index
  146463. */
  146464. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146465. /**
  146466. * Returns the agent position in world space
  146467. * @param index agent index returned by addAgent
  146468. * @returns world space position
  146469. */
  146470. getAgentPosition(index: number): Vector3;
  146471. /**
  146472. * Gets the agent position result in world space
  146473. * @param index agent index returned by addAgent
  146474. * @param result output world space position
  146475. */
  146476. getAgentPositionToRef(index: number, result: Vector3): void;
  146477. /**
  146478. * Gets the agent velocity in world space
  146479. * @param index agent index returned by addAgent
  146480. * @returns world space velocity
  146481. */
  146482. getAgentVelocity(index: number): Vector3;
  146483. /**
  146484. * Gets the agent velocity result in world space
  146485. * @param index agent index returned by addAgent
  146486. * @param result output world space velocity
  146487. */
  146488. getAgentVelocityToRef(index: number, result: Vector3): void;
  146489. /**
  146490. * remove a particular agent previously created
  146491. * @param index agent index returned by addAgent
  146492. */
  146493. removeAgent(index: number): void;
  146494. /**
  146495. * get the list of all agents attached to this crowd
  146496. * @returns list of agent indices
  146497. */
  146498. getAgents(): number[];
  146499. /**
  146500. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146501. * @param deltaTime in seconds
  146502. */
  146503. update(deltaTime: number): void;
  146504. /**
  146505. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146506. * @param index agent index returned by addAgent
  146507. * @param destination targeted world position
  146508. */
  146509. agentGoto(index: number, destination: Vector3): void;
  146510. /**
  146511. * Teleport the agent to a new position
  146512. * @param index agent index returned by addAgent
  146513. * @param destination targeted world position
  146514. */
  146515. agentTeleport(index: number, destination: Vector3): void;
  146516. /**
  146517. * Update agent parameters
  146518. * @param index agent index returned by addAgent
  146519. * @param parameters agent parameters
  146520. */
  146521. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146522. /**
  146523. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146524. * The queries will try to find a solution within those bounds
  146525. * default is (1,1,1)
  146526. * @param extent x,y,z value that define the extent around the queries point of reference
  146527. */
  146528. setDefaultQueryExtent(extent: Vector3): void;
  146529. /**
  146530. * Get the Bounding box extent specified by setDefaultQueryExtent
  146531. * @returns the box extent values
  146532. */
  146533. getDefaultQueryExtent(): Vector3;
  146534. /**
  146535. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146536. * @param result output the box extent values
  146537. */
  146538. getDefaultQueryExtentToRef(result: Vector3): void;
  146539. /**
  146540. * Release all resources
  146541. */
  146542. dispose(): void;
  146543. }
  146544. /**
  146545. * Configures an agent
  146546. */
  146547. export interface IAgentParameters {
  146548. /**
  146549. * Agent radius. [Limit: >= 0]
  146550. */
  146551. radius: number;
  146552. /**
  146553. * Agent height. [Limit: > 0]
  146554. */
  146555. height: number;
  146556. /**
  146557. * Maximum allowed acceleration. [Limit: >= 0]
  146558. */
  146559. maxAcceleration: number;
  146560. /**
  146561. * Maximum allowed speed. [Limit: >= 0]
  146562. */
  146563. maxSpeed: number;
  146564. /**
  146565. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146566. */
  146567. collisionQueryRange: number;
  146568. /**
  146569. * The path visibility optimization range. [Limit: > 0]
  146570. */
  146571. pathOptimizationRange: number;
  146572. /**
  146573. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146574. */
  146575. separationWeight: number;
  146576. }
  146577. /**
  146578. * Configures the navigation mesh creation
  146579. */
  146580. export interface INavMeshParameters {
  146581. /**
  146582. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146583. */
  146584. cs: number;
  146585. /**
  146586. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146587. */
  146588. ch: number;
  146589. /**
  146590. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146591. */
  146592. walkableSlopeAngle: number;
  146593. /**
  146594. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146595. * be considered walkable. [Limit: >= 3] [Units: vx]
  146596. */
  146597. walkableHeight: number;
  146598. /**
  146599. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146600. */
  146601. walkableClimb: number;
  146602. /**
  146603. * The distance to erode/shrink the walkable area of the heightfield away from
  146604. * obstructions. [Limit: >=0] [Units: vx]
  146605. */
  146606. walkableRadius: number;
  146607. /**
  146608. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146609. */
  146610. maxEdgeLen: number;
  146611. /**
  146612. * The maximum distance a simplfied contour's border edges should deviate
  146613. * the original raw contour. [Limit: >=0] [Units: vx]
  146614. */
  146615. maxSimplificationError: number;
  146616. /**
  146617. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146618. */
  146619. minRegionArea: number;
  146620. /**
  146621. * Any regions with a span count smaller than this value will, if possible,
  146622. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146623. */
  146624. mergeRegionArea: number;
  146625. /**
  146626. * The maximum number of vertices allowed for polygons generated during the
  146627. * contour to polygon conversion process. [Limit: >= 3]
  146628. */
  146629. maxVertsPerPoly: number;
  146630. /**
  146631. * Sets the sampling distance to use when generating the detail mesh.
  146632. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146633. */
  146634. detailSampleDist: number;
  146635. /**
  146636. * The maximum distance the detail mesh surface should deviate from heightfield
  146637. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146638. */
  146639. detailSampleMaxError: number;
  146640. }
  146641. }
  146642. declare module BABYLON {
  146643. /**
  146644. * RecastJS navigation plugin
  146645. */
  146646. export class RecastJSPlugin implements INavigationEnginePlugin {
  146647. /**
  146648. * Reference to the Recast library
  146649. */
  146650. bjsRECAST: any;
  146651. /**
  146652. * plugin name
  146653. */
  146654. name: string;
  146655. /**
  146656. * the first navmesh created. We might extend this to support multiple navmeshes
  146657. */
  146658. navMesh: any;
  146659. /**
  146660. * Initializes the recastJS plugin
  146661. * @param recastInjection can be used to inject your own recast reference
  146662. */
  146663. constructor(recastInjection?: any);
  146664. /**
  146665. * Creates a navigation mesh
  146666. * @param meshes array of all the geometry used to compute the navigatio mesh
  146667. * @param parameters bunch of parameters used to filter geometry
  146668. */
  146669. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146670. /**
  146671. * Create a navigation mesh debug mesh
  146672. * @param scene is where the mesh will be added
  146673. * @returns debug display mesh
  146674. */
  146675. createDebugNavMesh(scene: Scene): Mesh;
  146676. /**
  146677. * Get a navigation mesh constrained position, closest to the parameter position
  146678. * @param position world position
  146679. * @returns the closest point to position constrained by the navigation mesh
  146680. */
  146681. getClosestPoint(position: Vector3): Vector3;
  146682. /**
  146683. * Get a navigation mesh constrained position, closest to the parameter position
  146684. * @param position world position
  146685. * @param result output the closest point to position constrained by the navigation mesh
  146686. */
  146687. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146688. /**
  146689. * Get a navigation mesh constrained position, within a particular radius
  146690. * @param position world position
  146691. * @param maxRadius the maximum distance to the constrained world position
  146692. * @returns the closest point to position constrained by the navigation mesh
  146693. */
  146694. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146695. /**
  146696. * Get a navigation mesh constrained position, within a particular radius
  146697. * @param position world position
  146698. * @param maxRadius the maximum distance to the constrained world position
  146699. * @param result output the closest point to position constrained by the navigation mesh
  146700. */
  146701. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146702. /**
  146703. * Compute the final position from a segment made of destination-position
  146704. * @param position world position
  146705. * @param destination world position
  146706. * @returns the resulting point along the navmesh
  146707. */
  146708. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146709. /**
  146710. * Compute the final position from a segment made of destination-position
  146711. * @param position world position
  146712. * @param destination world position
  146713. * @param result output the resulting point along the navmesh
  146714. */
  146715. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146716. /**
  146717. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146718. * @param start world position
  146719. * @param end world position
  146720. * @returns array containing world position composing the path
  146721. */
  146722. computePath(start: Vector3, end: Vector3): Vector3[];
  146723. /**
  146724. * Create a new Crowd so you can add agents
  146725. * @param maxAgents the maximum agent count in the crowd
  146726. * @param maxAgentRadius the maximum radius an agent can have
  146727. * @param scene to attach the crowd to
  146728. * @returns the crowd you can add agents to
  146729. */
  146730. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146731. /**
  146732. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146733. * The queries will try to find a solution within those bounds
  146734. * default is (1,1,1)
  146735. * @param extent x,y,z value that define the extent around the queries point of reference
  146736. */
  146737. setDefaultQueryExtent(extent: Vector3): void;
  146738. /**
  146739. * Get the Bounding box extent specified by setDefaultQueryExtent
  146740. * @returns the box extent values
  146741. */
  146742. getDefaultQueryExtent(): Vector3;
  146743. /**
  146744. * build the navmesh from a previously saved state using getNavmeshData
  146745. * @param data the Uint8Array returned by getNavmeshData
  146746. */
  146747. buildFromNavmeshData(data: Uint8Array): void;
  146748. /**
  146749. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146750. * @returns data the Uint8Array that can be saved and reused
  146751. */
  146752. getNavmeshData(): Uint8Array;
  146753. /**
  146754. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146755. * @param result output the box extent values
  146756. */
  146757. getDefaultQueryExtentToRef(result: Vector3): void;
  146758. /**
  146759. * Disposes
  146760. */
  146761. dispose(): void;
  146762. /**
  146763. * If this plugin is supported
  146764. * @returns true if plugin is supported
  146765. */
  146766. isSupported(): boolean;
  146767. }
  146768. /**
  146769. * Recast detour crowd implementation
  146770. */
  146771. export class RecastJSCrowd implements ICrowd {
  146772. /**
  146773. * Recast/detour plugin
  146774. */
  146775. bjsRECASTPlugin: RecastJSPlugin;
  146776. /**
  146777. * Link to the detour crowd
  146778. */
  146779. recastCrowd: any;
  146780. /**
  146781. * One transform per agent
  146782. */
  146783. transforms: TransformNode[];
  146784. /**
  146785. * All agents created
  146786. */
  146787. agents: number[];
  146788. /**
  146789. * Link to the scene is kept to unregister the crowd from the scene
  146790. */
  146791. private _scene;
  146792. /**
  146793. * Observer for crowd updates
  146794. */
  146795. private _onBeforeAnimationsObserver;
  146796. /**
  146797. * Constructor
  146798. * @param plugin recastJS plugin
  146799. * @param maxAgents the maximum agent count in the crowd
  146800. * @param maxAgentRadius the maximum radius an agent can have
  146801. * @param scene to attach the crowd to
  146802. * @returns the crowd you can add agents to
  146803. */
  146804. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146805. /**
  146806. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146807. * You can attach anything to that node. The node position is updated in the scene update tick.
  146808. * @param pos world position that will be constrained by the navigation mesh
  146809. * @param parameters agent parameters
  146810. * @param transform hooked to the agent that will be update by the scene
  146811. * @returns agent index
  146812. */
  146813. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146814. /**
  146815. * Returns the agent position in world space
  146816. * @param index agent index returned by addAgent
  146817. * @returns world space position
  146818. */
  146819. getAgentPosition(index: number): Vector3;
  146820. /**
  146821. * Returns the agent position result in world space
  146822. * @param index agent index returned by addAgent
  146823. * @param result output world space position
  146824. */
  146825. getAgentPositionToRef(index: number, result: Vector3): void;
  146826. /**
  146827. * Returns the agent velocity in world space
  146828. * @param index agent index returned by addAgent
  146829. * @returns world space velocity
  146830. */
  146831. getAgentVelocity(index: number): Vector3;
  146832. /**
  146833. * Returns the agent velocity result in world space
  146834. * @param index agent index returned by addAgent
  146835. * @param result output world space velocity
  146836. */
  146837. getAgentVelocityToRef(index: number, result: Vector3): void;
  146838. /**
  146839. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146840. * @param index agent index returned by addAgent
  146841. * @param destination targeted world position
  146842. */
  146843. agentGoto(index: number, destination: Vector3): void;
  146844. /**
  146845. * Teleport the agent to a new position
  146846. * @param index agent index returned by addAgent
  146847. * @param destination targeted world position
  146848. */
  146849. agentTeleport(index: number, destination: Vector3): void;
  146850. /**
  146851. * Update agent parameters
  146852. * @param index agent index returned by addAgent
  146853. * @param parameters agent parameters
  146854. */
  146855. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146856. /**
  146857. * remove a particular agent previously created
  146858. * @param index agent index returned by addAgent
  146859. */
  146860. removeAgent(index: number): void;
  146861. /**
  146862. * get the list of all agents attached to this crowd
  146863. * @returns list of agent indices
  146864. */
  146865. getAgents(): number[];
  146866. /**
  146867. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146868. * @param deltaTime in seconds
  146869. */
  146870. update(deltaTime: number): void;
  146871. /**
  146872. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146873. * The queries will try to find a solution within those bounds
  146874. * default is (1,1,1)
  146875. * @param extent x,y,z value that define the extent around the queries point of reference
  146876. */
  146877. setDefaultQueryExtent(extent: Vector3): void;
  146878. /**
  146879. * Get the Bounding box extent specified by setDefaultQueryExtent
  146880. * @returns the box extent values
  146881. */
  146882. getDefaultQueryExtent(): Vector3;
  146883. /**
  146884. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146885. * @param result output the box extent values
  146886. */
  146887. getDefaultQueryExtentToRef(result: Vector3): void;
  146888. /**
  146889. * Release all resources
  146890. */
  146891. dispose(): void;
  146892. }
  146893. }
  146894. declare module BABYLON {
  146895. /**
  146896. * Class used to enable access to IndexedDB
  146897. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146898. */
  146899. export class Database implements IOfflineProvider {
  146900. private _callbackManifestChecked;
  146901. private _currentSceneUrl;
  146902. private _db;
  146903. private _enableSceneOffline;
  146904. private _enableTexturesOffline;
  146905. private _manifestVersionFound;
  146906. private _mustUpdateRessources;
  146907. private _hasReachedQuota;
  146908. private _isSupported;
  146909. private _idbFactory;
  146910. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146911. private static IsUASupportingBlobStorage;
  146912. /**
  146913. * Gets a boolean indicating if Database storate is enabled (off by default)
  146914. */
  146915. static IDBStorageEnabled: boolean;
  146916. /**
  146917. * Gets a boolean indicating if scene must be saved in the database
  146918. */
  146919. get enableSceneOffline(): boolean;
  146920. /**
  146921. * Gets a boolean indicating if textures must be saved in the database
  146922. */
  146923. get enableTexturesOffline(): boolean;
  146924. /**
  146925. * Creates a new Database
  146926. * @param urlToScene defines the url to load the scene
  146927. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146928. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146929. */
  146930. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146931. private static _ParseURL;
  146932. private static _ReturnFullUrlLocation;
  146933. private _checkManifestFile;
  146934. /**
  146935. * Open the database and make it available
  146936. * @param successCallback defines the callback to call on success
  146937. * @param errorCallback defines the callback to call on error
  146938. */
  146939. open(successCallback: () => void, errorCallback: () => void): void;
  146940. /**
  146941. * Loads an image from the database
  146942. * @param url defines the url to load from
  146943. * @param image defines the target DOM image
  146944. */
  146945. loadImage(url: string, image: HTMLImageElement): void;
  146946. private _loadImageFromDBAsync;
  146947. private _saveImageIntoDBAsync;
  146948. private _checkVersionFromDB;
  146949. private _loadVersionFromDBAsync;
  146950. private _saveVersionIntoDBAsync;
  146951. /**
  146952. * Loads a file from database
  146953. * @param url defines the URL to load from
  146954. * @param sceneLoaded defines a callback to call on success
  146955. * @param progressCallBack defines a callback to call when progress changed
  146956. * @param errorCallback defines a callback to call on error
  146957. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146958. */
  146959. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146960. private _loadFileAsync;
  146961. private _saveFileAsync;
  146962. /**
  146963. * Validates if xhr data is correct
  146964. * @param xhr defines the request to validate
  146965. * @param dataType defines the expected data type
  146966. * @returns true if data is correct
  146967. */
  146968. private static _ValidateXHRData;
  146969. }
  146970. }
  146971. declare module BABYLON {
  146972. /** @hidden */
  146973. export var gpuUpdateParticlesPixelShader: {
  146974. name: string;
  146975. shader: string;
  146976. };
  146977. }
  146978. declare module BABYLON {
  146979. /** @hidden */
  146980. export var gpuUpdateParticlesVertexShader: {
  146981. name: string;
  146982. shader: string;
  146983. };
  146984. }
  146985. declare module BABYLON {
  146986. /** @hidden */
  146987. export var clipPlaneFragmentDeclaration2: {
  146988. name: string;
  146989. shader: string;
  146990. };
  146991. }
  146992. declare module BABYLON {
  146993. /** @hidden */
  146994. export var gpuRenderParticlesPixelShader: {
  146995. name: string;
  146996. shader: string;
  146997. };
  146998. }
  146999. declare module BABYLON {
  147000. /** @hidden */
  147001. export var clipPlaneVertexDeclaration2: {
  147002. name: string;
  147003. shader: string;
  147004. };
  147005. }
  147006. declare module BABYLON {
  147007. /** @hidden */
  147008. export var gpuRenderParticlesVertexShader: {
  147009. name: string;
  147010. shader: string;
  147011. };
  147012. }
  147013. declare module BABYLON {
  147014. /**
  147015. * This represents a GPU particle system in Babylon
  147016. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  147017. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  147018. */
  147019. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  147020. /**
  147021. * The layer mask we are rendering the particles through.
  147022. */
  147023. layerMask: number;
  147024. private _capacity;
  147025. private _activeCount;
  147026. private _currentActiveCount;
  147027. private _accumulatedCount;
  147028. private _renderEffect;
  147029. private _updateEffect;
  147030. private _buffer0;
  147031. private _buffer1;
  147032. private _spriteBuffer;
  147033. private _updateVAO;
  147034. private _renderVAO;
  147035. private _targetIndex;
  147036. private _sourceBuffer;
  147037. private _targetBuffer;
  147038. private _currentRenderId;
  147039. private _started;
  147040. private _stopped;
  147041. private _timeDelta;
  147042. private _randomTexture;
  147043. private _randomTexture2;
  147044. private _attributesStrideSize;
  147045. private _updateEffectOptions;
  147046. private _randomTextureSize;
  147047. private _actualFrame;
  147048. private _customEffect;
  147049. private readonly _rawTextureWidth;
  147050. /**
  147051. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147052. */
  147053. static get IsSupported(): boolean;
  147054. /**
  147055. * An event triggered when the system is disposed.
  147056. */
  147057. onDisposeObservable: Observable<IParticleSystem>;
  147058. /**
  147059. * Gets the maximum number of particles active at the same time.
  147060. * @returns The max number of active particles.
  147061. */
  147062. getCapacity(): number;
  147063. /**
  147064. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147065. * to override the particles.
  147066. */
  147067. forceDepthWrite: boolean;
  147068. /**
  147069. * Gets or set the number of active particles
  147070. */
  147071. get activeParticleCount(): number;
  147072. set activeParticleCount(value: number);
  147073. private _preWarmDone;
  147074. /**
  147075. * Specifies if the particles are updated in emitter local space or world space.
  147076. */
  147077. isLocal: boolean;
  147078. /** Gets or sets a matrix to use to compute projection */
  147079. defaultProjectionMatrix: Matrix;
  147080. /**
  147081. * Is this system ready to be used/rendered
  147082. * @return true if the system is ready
  147083. */
  147084. isReady(): boolean;
  147085. /**
  147086. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147087. * @returns True if it has been started, otherwise false.
  147088. */
  147089. isStarted(): boolean;
  147090. /**
  147091. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147092. * @returns True if it has been stopped, otherwise false.
  147093. */
  147094. isStopped(): boolean;
  147095. /**
  147096. * Gets a boolean indicating that the system is stopping
  147097. * @returns true if the system is currently stopping
  147098. */
  147099. isStopping(): boolean;
  147100. /**
  147101. * Gets the number of particles active at the same time.
  147102. * @returns The number of active particles.
  147103. */
  147104. getActiveCount(): number;
  147105. /**
  147106. * Starts the particle system and begins to emit
  147107. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147108. */
  147109. start(delay?: number): void;
  147110. /**
  147111. * Stops the particle system.
  147112. */
  147113. stop(): void;
  147114. /**
  147115. * Remove all active particles
  147116. */
  147117. reset(): void;
  147118. /**
  147119. * Returns the string "GPUParticleSystem"
  147120. * @returns a string containing the class name
  147121. */
  147122. getClassName(): string;
  147123. /**
  147124. * Gets the custom effect used to render the particles
  147125. * @param blendMode Blend mode for which the effect should be retrieved
  147126. * @returns The effect
  147127. */
  147128. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147129. /**
  147130. * Sets the custom effect used to render the particles
  147131. * @param effect The effect to set
  147132. * @param blendMode Blend mode for which the effect should be set
  147133. */
  147134. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147135. /** @hidden */
  147136. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147137. /**
  147138. * Observable that will be called just before the particles are drawn
  147139. */
  147140. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147141. /**
  147142. * Gets the name of the particle vertex shader
  147143. */
  147144. get vertexShaderName(): string;
  147145. private _colorGradientsTexture;
  147146. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147147. /**
  147148. * Adds a new color gradient
  147149. * @param gradient defines the gradient to use (between 0 and 1)
  147150. * @param color1 defines the color to affect to the specified gradient
  147151. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147152. * @returns the current particle system
  147153. */
  147154. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147155. private _refreshColorGradient;
  147156. /** Force the system to rebuild all gradients that need to be resync */
  147157. forceRefreshGradients(): void;
  147158. /**
  147159. * Remove a specific color gradient
  147160. * @param gradient defines the gradient to remove
  147161. * @returns the current particle system
  147162. */
  147163. removeColorGradient(gradient: number): GPUParticleSystem;
  147164. private _angularSpeedGradientsTexture;
  147165. private _sizeGradientsTexture;
  147166. private _velocityGradientsTexture;
  147167. private _limitVelocityGradientsTexture;
  147168. private _dragGradientsTexture;
  147169. private _addFactorGradient;
  147170. /**
  147171. * Adds a new size gradient
  147172. * @param gradient defines the gradient to use (between 0 and 1)
  147173. * @param factor defines the size factor to affect to the specified gradient
  147174. * @returns the current particle system
  147175. */
  147176. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147177. /**
  147178. * Remove a specific size gradient
  147179. * @param gradient defines the gradient to remove
  147180. * @returns the current particle system
  147181. */
  147182. removeSizeGradient(gradient: number): GPUParticleSystem;
  147183. private _refreshFactorGradient;
  147184. /**
  147185. * Adds a new angular speed gradient
  147186. * @param gradient defines the gradient to use (between 0 and 1)
  147187. * @param factor defines the angular speed to affect to the specified gradient
  147188. * @returns the current particle system
  147189. */
  147190. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147191. /**
  147192. * Remove a specific angular speed gradient
  147193. * @param gradient defines the gradient to remove
  147194. * @returns the current particle system
  147195. */
  147196. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147197. /**
  147198. * Adds a new velocity gradient
  147199. * @param gradient defines the gradient to use (between 0 and 1)
  147200. * @param factor defines the velocity to affect to the specified gradient
  147201. * @returns the current particle system
  147202. */
  147203. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147204. /**
  147205. * Remove a specific velocity gradient
  147206. * @param gradient defines the gradient to remove
  147207. * @returns the current particle system
  147208. */
  147209. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147210. /**
  147211. * Adds a new limit velocity gradient
  147212. * @param gradient defines the gradient to use (between 0 and 1)
  147213. * @param factor defines the limit velocity value to affect to the specified gradient
  147214. * @returns the current particle system
  147215. */
  147216. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147217. /**
  147218. * Remove a specific limit velocity gradient
  147219. * @param gradient defines the gradient to remove
  147220. * @returns the current particle system
  147221. */
  147222. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147223. /**
  147224. * Adds a new drag gradient
  147225. * @param gradient defines the gradient to use (between 0 and 1)
  147226. * @param factor defines the drag value to affect to the specified gradient
  147227. * @returns the current particle system
  147228. */
  147229. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147230. /**
  147231. * Remove a specific drag gradient
  147232. * @param gradient defines the gradient to remove
  147233. * @returns the current particle system
  147234. */
  147235. removeDragGradient(gradient: number): GPUParticleSystem;
  147236. /**
  147237. * Not supported by GPUParticleSystem
  147238. * @param gradient defines the gradient to use (between 0 and 1)
  147239. * @param factor defines the emit rate value to affect to the specified gradient
  147240. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147241. * @returns the current particle system
  147242. */
  147243. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147244. /**
  147245. * Not supported by GPUParticleSystem
  147246. * @param gradient defines the gradient to remove
  147247. * @returns the current particle system
  147248. */
  147249. removeEmitRateGradient(gradient: number): IParticleSystem;
  147250. /**
  147251. * Not supported by GPUParticleSystem
  147252. * @param gradient defines the gradient to use (between 0 and 1)
  147253. * @param factor defines the start size value to affect to the specified gradient
  147254. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147255. * @returns the current particle system
  147256. */
  147257. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147258. /**
  147259. * Not supported by GPUParticleSystem
  147260. * @param gradient defines the gradient to remove
  147261. * @returns the current particle system
  147262. */
  147263. removeStartSizeGradient(gradient: number): IParticleSystem;
  147264. /**
  147265. * Not supported by GPUParticleSystem
  147266. * @param gradient defines the gradient to use (between 0 and 1)
  147267. * @param min defines the color remap minimal range
  147268. * @param max defines the color remap maximal range
  147269. * @returns the current particle system
  147270. */
  147271. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147272. /**
  147273. * Not supported by GPUParticleSystem
  147274. * @param gradient defines the gradient to remove
  147275. * @returns the current particle system
  147276. */
  147277. removeColorRemapGradient(): IParticleSystem;
  147278. /**
  147279. * Not supported by GPUParticleSystem
  147280. * @param gradient defines the gradient to use (between 0 and 1)
  147281. * @param min defines the alpha remap minimal range
  147282. * @param max defines the alpha remap maximal range
  147283. * @returns the current particle system
  147284. */
  147285. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147286. /**
  147287. * Not supported by GPUParticleSystem
  147288. * @param gradient defines the gradient to remove
  147289. * @returns the current particle system
  147290. */
  147291. removeAlphaRemapGradient(): IParticleSystem;
  147292. /**
  147293. * Not supported by GPUParticleSystem
  147294. * @param gradient defines the gradient to use (between 0 and 1)
  147295. * @param color defines the color to affect to the specified gradient
  147296. * @returns the current particle system
  147297. */
  147298. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147299. /**
  147300. * Not supported by GPUParticleSystem
  147301. * @param gradient defines the gradient to remove
  147302. * @returns the current particle system
  147303. */
  147304. removeRampGradient(): IParticleSystem;
  147305. /**
  147306. * Not supported by GPUParticleSystem
  147307. * @returns the list of ramp gradients
  147308. */
  147309. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147310. /**
  147311. * Not supported by GPUParticleSystem
  147312. * Gets or sets a boolean indicating that ramp gradients must be used
  147313. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147314. */
  147315. get useRampGradients(): boolean;
  147316. set useRampGradients(value: boolean);
  147317. /**
  147318. * Not supported by GPUParticleSystem
  147319. * @param gradient defines the gradient to use (between 0 and 1)
  147320. * @param factor defines the life time factor to affect to the specified gradient
  147321. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147322. * @returns the current particle system
  147323. */
  147324. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147325. /**
  147326. * Not supported by GPUParticleSystem
  147327. * @param gradient defines the gradient to remove
  147328. * @returns the current particle system
  147329. */
  147330. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147331. /**
  147332. * Instantiates a GPU particle system.
  147333. * 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.
  147334. * @param name The name of the particle system
  147335. * @param options The options used to create the system
  147336. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147337. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147338. * @param customEffect a custom effect used to change the way particles are rendered by default
  147339. */
  147340. constructor(name: string, options: Partial<{
  147341. capacity: number;
  147342. randomTextureSize: number;
  147343. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147344. protected _reset(): void;
  147345. private _createUpdateVAO;
  147346. private _createRenderVAO;
  147347. private _initialize;
  147348. /** @hidden */
  147349. _recreateUpdateEffect(): void;
  147350. private _getEffect;
  147351. /**
  147352. * Fill the defines array according to the current settings of the particle system
  147353. * @param defines Array to be updated
  147354. * @param blendMode blend mode to take into account when updating the array
  147355. */
  147356. fillDefines(defines: Array<string>, blendMode?: number): void;
  147357. /**
  147358. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147359. * @param uniforms Uniforms array to fill
  147360. * @param attributes Attributes array to fill
  147361. * @param samplers Samplers array to fill
  147362. */
  147363. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147364. /** @hidden */
  147365. _recreateRenderEffect(): Effect;
  147366. /**
  147367. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147368. * @param preWarm defines if we are in the pre-warmimg phase
  147369. */
  147370. animate(preWarm?: boolean): void;
  147371. private _createFactorGradientTexture;
  147372. private _createSizeGradientTexture;
  147373. private _createAngularSpeedGradientTexture;
  147374. private _createVelocityGradientTexture;
  147375. private _createLimitVelocityGradientTexture;
  147376. private _createDragGradientTexture;
  147377. private _createColorGradientTexture;
  147378. /**
  147379. * Renders the particle system in its current state
  147380. * @param preWarm defines if the system should only update the particles but not render them
  147381. * @returns the current number of particles
  147382. */
  147383. render(preWarm?: boolean): number;
  147384. /**
  147385. * Rebuilds the particle system
  147386. */
  147387. rebuild(): void;
  147388. private _releaseBuffers;
  147389. private _releaseVAOs;
  147390. /**
  147391. * Disposes the particle system and free the associated resources
  147392. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147393. */
  147394. dispose(disposeTexture?: boolean): void;
  147395. /**
  147396. * Clones the particle system.
  147397. * @param name The name of the cloned object
  147398. * @param newEmitter The new emitter to use
  147399. * @returns the cloned particle system
  147400. */
  147401. clone(name: string, newEmitter: any): GPUParticleSystem;
  147402. /**
  147403. * Serializes the particle system to a JSON object
  147404. * @param serializeTexture defines if the texture must be serialized as well
  147405. * @returns the JSON object
  147406. */
  147407. serialize(serializeTexture?: boolean): any;
  147408. /**
  147409. * Parses a JSON object to create a GPU particle system.
  147410. * @param parsedParticleSystem The JSON object to parse
  147411. * @param sceneOrEngine The scene or the engine to create the particle system in
  147412. * @param rootUrl The root url to use to load external dependencies like texture
  147413. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147414. * @returns the parsed GPU particle system
  147415. */
  147416. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147417. }
  147418. }
  147419. declare module BABYLON {
  147420. /**
  147421. * Represents a set of particle systems working together to create a specific effect
  147422. */
  147423. export class ParticleSystemSet implements IDisposable {
  147424. /**
  147425. * Gets or sets base Assets URL
  147426. */
  147427. static BaseAssetsUrl: string;
  147428. private _emitterCreationOptions;
  147429. private _emitterNode;
  147430. /**
  147431. * Gets the particle system list
  147432. */
  147433. systems: IParticleSystem[];
  147434. /**
  147435. * Gets the emitter node used with this set
  147436. */
  147437. get emitterNode(): Nullable<TransformNode>;
  147438. /**
  147439. * Creates a new emitter mesh as a sphere
  147440. * @param options defines the options used to create the sphere
  147441. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147442. * @param scene defines the hosting scene
  147443. */
  147444. setEmitterAsSphere(options: {
  147445. diameter: number;
  147446. segments: number;
  147447. color: Color3;
  147448. }, renderingGroupId: number, scene: Scene): void;
  147449. /**
  147450. * Starts all particle systems of the set
  147451. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147452. */
  147453. start(emitter?: AbstractMesh): void;
  147454. /**
  147455. * Release all associated resources
  147456. */
  147457. dispose(): void;
  147458. /**
  147459. * Serialize the set into a JSON compatible object
  147460. * @param serializeTexture defines if the texture must be serialized as well
  147461. * @returns a JSON compatible representation of the set
  147462. */
  147463. serialize(serializeTexture?: boolean): any;
  147464. /**
  147465. * Parse a new ParticleSystemSet from a serialized source
  147466. * @param data defines a JSON compatible representation of the set
  147467. * @param scene defines the hosting scene
  147468. * @param gpu defines if we want GPU particles or CPU particles
  147469. * @returns a new ParticleSystemSet
  147470. */
  147471. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147472. }
  147473. }
  147474. declare module BABYLON {
  147475. /**
  147476. * This class is made for on one-liner static method to help creating particle system set.
  147477. */
  147478. export class ParticleHelper {
  147479. /**
  147480. * Gets or sets base Assets URL
  147481. */
  147482. static BaseAssetsUrl: string;
  147483. /** Define the Url to load snippets */
  147484. static SnippetUrl: string;
  147485. /**
  147486. * Create a default particle system that you can tweak
  147487. * @param emitter defines the emitter to use
  147488. * @param capacity defines the system capacity (default is 500 particles)
  147489. * @param scene defines the hosting scene
  147490. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147491. * @returns the new Particle system
  147492. */
  147493. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147494. /**
  147495. * This is the main static method (one-liner) of this helper to create different particle systems
  147496. * @param type This string represents the type to the particle system to create
  147497. * @param scene The scene where the particle system should live
  147498. * @param gpu If the system will use gpu
  147499. * @returns the ParticleSystemSet created
  147500. */
  147501. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147502. /**
  147503. * Static function used to export a particle system to a ParticleSystemSet variable.
  147504. * Please note that the emitter shape is not exported
  147505. * @param systems defines the particle systems to export
  147506. * @returns the created particle system set
  147507. */
  147508. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147509. /**
  147510. * Creates a particle system from a snippet saved in a remote file
  147511. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147512. * @param url defines the url to load from
  147513. * @param scene defines the hosting scene
  147514. * @param gpu If the system will use gpu
  147515. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147516. * @returns a promise that will resolve to the new particle system
  147517. */
  147518. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147519. /**
  147520. * Creates a particle system from a snippet saved by the particle system editor
  147521. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147522. * @param scene defines the hosting scene
  147523. * @param gpu If the system will use gpu
  147524. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147525. * @returns a promise that will resolve to the new particle system
  147526. */
  147527. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147528. }
  147529. }
  147530. declare module BABYLON {
  147531. interface Engine {
  147532. /**
  147533. * Create an effect to use with particle systems.
  147534. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147535. * the particle system for which you want to create a custom effect in the last parameter
  147536. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147537. * @param uniformsNames defines a list of attribute names
  147538. * @param samplers defines an array of string used to represent textures
  147539. * @param defines defines the string containing the defines to use to compile the shaders
  147540. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147541. * @param onCompiled defines a function to call when the effect creation is successful
  147542. * @param onError defines a function to call when the effect creation has failed
  147543. * @param particleSystem the particle system you want to create the effect for
  147544. * @returns the new Effect
  147545. */
  147546. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147547. }
  147548. interface Mesh {
  147549. /**
  147550. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147551. * @returns an array of IParticleSystem
  147552. */
  147553. getEmittedParticleSystems(): IParticleSystem[];
  147554. /**
  147555. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147556. * @returns an array of IParticleSystem
  147557. */
  147558. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147559. }
  147560. }
  147561. declare module BABYLON {
  147562. /** Defines the 4 color options */
  147563. export enum PointColor {
  147564. /** color value */
  147565. Color = 2,
  147566. /** uv value */
  147567. UV = 1,
  147568. /** random value */
  147569. Random = 0,
  147570. /** stated value */
  147571. Stated = 3
  147572. }
  147573. /**
  147574. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147575. * 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.
  147576. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147577. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147578. *
  147579. * Full documentation here : TO BE ENTERED
  147580. */
  147581. export class PointsCloudSystem implements IDisposable {
  147582. /**
  147583. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147584. * Example : var p = SPS.particles[i];
  147585. */
  147586. particles: CloudPoint[];
  147587. /**
  147588. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147589. */
  147590. nbParticles: number;
  147591. /**
  147592. * This a counter for your own usage. It's not set by any SPS functions.
  147593. */
  147594. counter: number;
  147595. /**
  147596. * The PCS name. This name is also given to the underlying mesh.
  147597. */
  147598. name: string;
  147599. /**
  147600. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147601. */
  147602. mesh: Mesh;
  147603. /**
  147604. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147605. * Please read :
  147606. */
  147607. vars: any;
  147608. /**
  147609. * @hidden
  147610. */
  147611. _size: number;
  147612. private _scene;
  147613. private _promises;
  147614. private _positions;
  147615. private _indices;
  147616. private _normals;
  147617. private _colors;
  147618. private _uvs;
  147619. private _indices32;
  147620. private _positions32;
  147621. private _colors32;
  147622. private _uvs32;
  147623. private _updatable;
  147624. private _isVisibilityBoxLocked;
  147625. private _alwaysVisible;
  147626. private _groups;
  147627. private _groupCounter;
  147628. private _computeParticleColor;
  147629. private _computeParticleTexture;
  147630. private _computeParticleRotation;
  147631. private _computeBoundingBox;
  147632. private _isReady;
  147633. /**
  147634. * Creates a PCS (Points Cloud System) object
  147635. * @param name (String) is the PCS name, this will be the underlying mesh name
  147636. * @param pointSize (number) is the size for each point
  147637. * @param scene (Scene) is the scene in which the PCS is added
  147638. * @param options defines the options of the PCS e.g.
  147639. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147640. */
  147641. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147642. updatable?: boolean;
  147643. });
  147644. /**
  147645. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147646. * If no points were added to the PCS, the returned mesh is just a single point.
  147647. * @returns a promise for the created mesh
  147648. */
  147649. buildMeshAsync(): Promise<Mesh>;
  147650. /**
  147651. * @hidden
  147652. */
  147653. private _buildMesh;
  147654. private _addParticle;
  147655. private _randomUnitVector;
  147656. private _getColorIndicesForCoord;
  147657. private _setPointsColorOrUV;
  147658. private _colorFromTexture;
  147659. private _calculateDensity;
  147660. /**
  147661. * Adds points to the PCS in random positions within a unit sphere
  147662. * @param nb (positive integer) the number of particles to be created from this model
  147663. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147664. * @returns the number of groups in the system
  147665. */
  147666. addPoints(nb: number, pointFunction?: any): number;
  147667. /**
  147668. * Adds points to the PCS from the surface of the model shape
  147669. * @param mesh is any Mesh object that will be used as a surface model for the points
  147670. * @param nb (positive integer) the number of particles to be created from this model
  147671. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147672. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147673. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147674. * @returns the number of groups in the system
  147675. */
  147676. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147677. /**
  147678. * Adds points to the PCS inside the model shape
  147679. * @param mesh is any Mesh object that will be used as a surface model for the points
  147680. * @param nb (positive integer) the number of particles to be created from this model
  147681. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147682. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147683. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147684. * @returns the number of groups in the system
  147685. */
  147686. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147687. /**
  147688. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147689. * This method calls `updateParticle()` for each particle of the SPS.
  147690. * For an animated SPS, it is usually called within the render loop.
  147691. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147692. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147693. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147694. * @returns the PCS.
  147695. */
  147696. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147697. /**
  147698. * Disposes the PCS.
  147699. */
  147700. dispose(): void;
  147701. /**
  147702. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147703. * doc :
  147704. * @returns the PCS.
  147705. */
  147706. refreshVisibleSize(): PointsCloudSystem;
  147707. /**
  147708. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147709. * @param size the size (float) of the visibility box
  147710. * note : this doesn't lock the PCS mesh bounding box.
  147711. * doc :
  147712. */
  147713. setVisibilityBox(size: number): void;
  147714. /**
  147715. * Gets whether the PCS is always visible or not
  147716. * doc :
  147717. */
  147718. get isAlwaysVisible(): boolean;
  147719. /**
  147720. * Sets the PCS as always visible or not
  147721. * doc :
  147722. */
  147723. set isAlwaysVisible(val: boolean);
  147724. /**
  147725. * Tells to `setParticles()` to compute the particle rotations or not
  147726. * Default value : false. The PCS is faster when it's set to false
  147727. * Note : particle rotations are only applied to parent particles
  147728. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147729. */
  147730. set computeParticleRotation(val: boolean);
  147731. /**
  147732. * Tells to `setParticles()` to compute the particle colors or not.
  147733. * Default value : true. The PCS is faster when it's set to false.
  147734. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147735. */
  147736. set computeParticleColor(val: boolean);
  147737. set computeParticleTexture(val: boolean);
  147738. /**
  147739. * Gets if `setParticles()` computes the particle colors or not.
  147740. * Default value : false. The PCS is faster when it's set to false.
  147741. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147742. */
  147743. get computeParticleColor(): boolean;
  147744. /**
  147745. * Gets if `setParticles()` computes the particle textures or not.
  147746. * Default value : false. The PCS is faster when it's set to false.
  147747. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147748. */
  147749. get computeParticleTexture(): boolean;
  147750. /**
  147751. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147752. */
  147753. set computeBoundingBox(val: boolean);
  147754. /**
  147755. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147756. */
  147757. get computeBoundingBox(): boolean;
  147758. /**
  147759. * This function does nothing. It may be overwritten to set all the particle first values.
  147760. * The PCS doesn't call this function, you may have to call it by your own.
  147761. * doc :
  147762. */
  147763. initParticles(): void;
  147764. /**
  147765. * This function does nothing. It may be overwritten to recycle a particle
  147766. * The PCS doesn't call this function, you can to call it
  147767. * doc :
  147768. * @param particle The particle to recycle
  147769. * @returns the recycled particle
  147770. */
  147771. recycleParticle(particle: CloudPoint): CloudPoint;
  147772. /**
  147773. * Updates a particle : this function should be overwritten by the user.
  147774. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147775. * doc :
  147776. * @example : just set a particle position or velocity and recycle conditions
  147777. * @param particle The particle to update
  147778. * @returns the updated particle
  147779. */
  147780. updateParticle(particle: CloudPoint): CloudPoint;
  147781. /**
  147782. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147783. * This does nothing and may be overwritten by the user.
  147784. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147785. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147786. * @param update the boolean update value actually passed to setParticles()
  147787. */
  147788. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147789. /**
  147790. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147791. * This will be passed three parameters.
  147792. * This does nothing and may be overwritten by the user.
  147793. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147794. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147795. * @param update the boolean update value actually passed to setParticles()
  147796. */
  147797. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147798. }
  147799. }
  147800. declare module BABYLON {
  147801. /**
  147802. * Represents one particle of a points cloud system.
  147803. */
  147804. export class CloudPoint {
  147805. /**
  147806. * particle global index
  147807. */
  147808. idx: number;
  147809. /**
  147810. * The color of the particle
  147811. */
  147812. color: Nullable<Color4>;
  147813. /**
  147814. * The world space position of the particle.
  147815. */
  147816. position: Vector3;
  147817. /**
  147818. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147819. */
  147820. rotation: Vector3;
  147821. /**
  147822. * The world space rotation quaternion of the particle.
  147823. */
  147824. rotationQuaternion: Nullable<Quaternion>;
  147825. /**
  147826. * The uv of the particle.
  147827. */
  147828. uv: Nullable<Vector2>;
  147829. /**
  147830. * The current speed of the particle.
  147831. */
  147832. velocity: Vector3;
  147833. /**
  147834. * The pivot point in the particle local space.
  147835. */
  147836. pivot: Vector3;
  147837. /**
  147838. * Must the particle be translated from its pivot point in its local space ?
  147839. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147840. * Default : false
  147841. */
  147842. translateFromPivot: boolean;
  147843. /**
  147844. * Index of this particle in the global "positions" array (Internal use)
  147845. * @hidden
  147846. */
  147847. _pos: number;
  147848. /**
  147849. * @hidden Index of this particle in the global "indices" array (Internal use)
  147850. */
  147851. _ind: number;
  147852. /**
  147853. * Group this particle belongs to
  147854. */
  147855. _group: PointsGroup;
  147856. /**
  147857. * Group id of this particle
  147858. */
  147859. groupId: number;
  147860. /**
  147861. * Index of the particle in its group id (Internal use)
  147862. */
  147863. idxInGroup: number;
  147864. /**
  147865. * @hidden Particle BoundingInfo object (Internal use)
  147866. */
  147867. _boundingInfo: BoundingInfo;
  147868. /**
  147869. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147870. */
  147871. _pcs: PointsCloudSystem;
  147872. /**
  147873. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147874. */
  147875. _stillInvisible: boolean;
  147876. /**
  147877. * @hidden Last computed particle rotation matrix
  147878. */
  147879. _rotationMatrix: number[];
  147880. /**
  147881. * Parent particle Id, if any.
  147882. * Default null.
  147883. */
  147884. parentId: Nullable<number>;
  147885. /**
  147886. * @hidden Internal global position in the PCS.
  147887. */
  147888. _globalPosition: Vector3;
  147889. /**
  147890. * Creates a Point Cloud object.
  147891. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147892. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147893. * @param group (PointsGroup) is the group the particle belongs to
  147894. * @param groupId (integer) is the group identifier in the PCS.
  147895. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147896. * @param pcs defines the PCS it is associated to
  147897. */
  147898. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147899. /**
  147900. * get point size
  147901. */
  147902. get size(): Vector3;
  147903. /**
  147904. * Set point size
  147905. */
  147906. set size(scale: Vector3);
  147907. /**
  147908. * Legacy support, changed quaternion to rotationQuaternion
  147909. */
  147910. get quaternion(): Nullable<Quaternion>;
  147911. /**
  147912. * Legacy support, changed quaternion to rotationQuaternion
  147913. */
  147914. set quaternion(q: Nullable<Quaternion>);
  147915. /**
  147916. * Returns a boolean. True if the particle intersects a mesh, else false
  147917. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147918. * @param target is the object (point or mesh) what the intersection is computed against
  147919. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147920. * @returns true if it intersects
  147921. */
  147922. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147923. /**
  147924. * get the rotation matrix of the particle
  147925. * @hidden
  147926. */
  147927. getRotationMatrix(m: Matrix): void;
  147928. }
  147929. /**
  147930. * Represents a group of points in a points cloud system
  147931. * * PCS internal tool, don't use it manually.
  147932. */
  147933. export class PointsGroup {
  147934. /**
  147935. * The group id
  147936. * @hidden
  147937. */
  147938. groupID: number;
  147939. /**
  147940. * image data for group (internal use)
  147941. * @hidden
  147942. */
  147943. _groupImageData: Nullable<ArrayBufferView>;
  147944. /**
  147945. * Image Width (internal use)
  147946. * @hidden
  147947. */
  147948. _groupImgWidth: number;
  147949. /**
  147950. * Image Height (internal use)
  147951. * @hidden
  147952. */
  147953. _groupImgHeight: number;
  147954. /**
  147955. * Custom position function (internal use)
  147956. * @hidden
  147957. */
  147958. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147959. /**
  147960. * density per facet for surface points
  147961. * @hidden
  147962. */
  147963. _groupDensity: number[];
  147964. /**
  147965. * Only when points are colored by texture carries pointer to texture list array
  147966. * @hidden
  147967. */
  147968. _textureNb: number;
  147969. /**
  147970. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147971. * PCS internal tool, don't use it manually.
  147972. * @hidden
  147973. */
  147974. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147975. }
  147976. }
  147977. declare module BABYLON {
  147978. interface Scene {
  147979. /** @hidden (Backing field) */
  147980. _physicsEngine: Nullable<IPhysicsEngine>;
  147981. /** @hidden */
  147982. _physicsTimeAccumulator: number;
  147983. /**
  147984. * Gets the current physics engine
  147985. * @returns a IPhysicsEngine or null if none attached
  147986. */
  147987. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147988. /**
  147989. * Enables physics to the current scene
  147990. * @param gravity defines the scene's gravity for the physics engine
  147991. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147992. * @return a boolean indicating if the physics engine was initialized
  147993. */
  147994. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147995. /**
  147996. * Disables and disposes the physics engine associated with the scene
  147997. */
  147998. disablePhysicsEngine(): void;
  147999. /**
  148000. * Gets a boolean indicating if there is an active physics engine
  148001. * @returns a boolean indicating if there is an active physics engine
  148002. */
  148003. isPhysicsEnabled(): boolean;
  148004. /**
  148005. * Deletes a physics compound impostor
  148006. * @param compound defines the compound to delete
  148007. */
  148008. deleteCompoundImpostor(compound: any): void;
  148009. /**
  148010. * An event triggered when physic simulation is about to be run
  148011. */
  148012. onBeforePhysicsObservable: Observable<Scene>;
  148013. /**
  148014. * An event triggered when physic simulation has been done
  148015. */
  148016. onAfterPhysicsObservable: Observable<Scene>;
  148017. }
  148018. interface AbstractMesh {
  148019. /** @hidden */
  148020. _physicsImpostor: Nullable<PhysicsImpostor>;
  148021. /**
  148022. * Gets or sets impostor used for physic simulation
  148023. * @see https://doc.babylonjs.com/features/physics_engine
  148024. */
  148025. physicsImpostor: Nullable<PhysicsImpostor>;
  148026. /**
  148027. * Gets the current physics impostor
  148028. * @see https://doc.babylonjs.com/features/physics_engine
  148029. * @returns a physics impostor or null
  148030. */
  148031. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148032. /** Apply a physic impulse to the mesh
  148033. * @param force defines the force to apply
  148034. * @param contactPoint defines where to apply the force
  148035. * @returns the current mesh
  148036. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148037. */
  148038. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148039. /**
  148040. * Creates a physic joint between two meshes
  148041. * @param otherMesh defines the other mesh to use
  148042. * @param pivot1 defines the pivot to use on this mesh
  148043. * @param pivot2 defines the pivot to use on the other mesh
  148044. * @param options defines additional options (can be plugin dependent)
  148045. * @returns the current mesh
  148046. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148047. */
  148048. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148049. /** @hidden */
  148050. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148051. }
  148052. /**
  148053. * Defines the physics engine scene component responsible to manage a physics engine
  148054. */
  148055. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148056. /**
  148057. * The component name helpful to identify the component in the list of scene components.
  148058. */
  148059. readonly name: string;
  148060. /**
  148061. * The scene the component belongs to.
  148062. */
  148063. scene: Scene;
  148064. /**
  148065. * Creates a new instance of the component for the given scene
  148066. * @param scene Defines the scene to register the component in
  148067. */
  148068. constructor(scene: Scene);
  148069. /**
  148070. * Registers the component in a given scene
  148071. */
  148072. register(): void;
  148073. /**
  148074. * Rebuilds the elements related to this component in case of
  148075. * context lost for instance.
  148076. */
  148077. rebuild(): void;
  148078. /**
  148079. * Disposes the component and the associated ressources
  148080. */
  148081. dispose(): void;
  148082. }
  148083. }
  148084. declare module BABYLON {
  148085. /**
  148086. * A helper for physics simulations
  148087. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148088. */
  148089. export class PhysicsHelper {
  148090. private _scene;
  148091. private _physicsEngine;
  148092. /**
  148093. * Initializes the Physics helper
  148094. * @param scene Babylon.js scene
  148095. */
  148096. constructor(scene: Scene);
  148097. /**
  148098. * Applies a radial explosion impulse
  148099. * @param origin the origin of the explosion
  148100. * @param radiusOrEventOptions the radius or the options of radial explosion
  148101. * @param strength the explosion strength
  148102. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148103. * @returns A physics radial explosion event, or null
  148104. */
  148105. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148106. /**
  148107. * Applies a radial explosion force
  148108. * @param origin the origin of the explosion
  148109. * @param radiusOrEventOptions the radius or the options of radial explosion
  148110. * @param strength the explosion strength
  148111. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148112. * @returns A physics radial explosion event, or null
  148113. */
  148114. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148115. /**
  148116. * Creates a gravitational field
  148117. * @param origin the origin of the explosion
  148118. * @param radiusOrEventOptions the radius or the options of radial explosion
  148119. * @param strength the explosion strength
  148120. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148121. * @returns A physics gravitational field event, or null
  148122. */
  148123. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148124. /**
  148125. * Creates a physics updraft event
  148126. * @param origin the origin of the updraft
  148127. * @param radiusOrEventOptions the radius or the options of the updraft
  148128. * @param strength the strength of the updraft
  148129. * @param height the height of the updraft
  148130. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148131. * @returns A physics updraft event, or null
  148132. */
  148133. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148134. /**
  148135. * Creates a physics vortex event
  148136. * @param origin the of the vortex
  148137. * @param radiusOrEventOptions the radius or the options of the vortex
  148138. * @param strength the strength of the vortex
  148139. * @param height the height of the vortex
  148140. * @returns a Physics vortex event, or null
  148141. * A physics vortex event or null
  148142. */
  148143. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148144. }
  148145. /**
  148146. * Represents a physics radial explosion event
  148147. */
  148148. class PhysicsRadialExplosionEvent {
  148149. private _scene;
  148150. private _options;
  148151. private _sphere;
  148152. private _dataFetched;
  148153. /**
  148154. * Initializes a radial explosioin event
  148155. * @param _scene BabylonJS scene
  148156. * @param _options The options for the vortex event
  148157. */
  148158. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148159. /**
  148160. * Returns the data related to the radial explosion event (sphere).
  148161. * @returns The radial explosion event data
  148162. */
  148163. getData(): PhysicsRadialExplosionEventData;
  148164. /**
  148165. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148166. * @param impostor A physics imposter
  148167. * @param origin the origin of the explosion
  148168. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148169. */
  148170. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148171. /**
  148172. * Triggers affecterd impostors callbacks
  148173. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148174. */
  148175. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148176. /**
  148177. * Disposes the sphere.
  148178. * @param force Specifies if the sphere should be disposed by force
  148179. */
  148180. dispose(force?: boolean): void;
  148181. /*** Helpers ***/
  148182. private _prepareSphere;
  148183. private _intersectsWithSphere;
  148184. }
  148185. /**
  148186. * Represents a gravitational field event
  148187. */
  148188. class PhysicsGravitationalFieldEvent {
  148189. private _physicsHelper;
  148190. private _scene;
  148191. private _origin;
  148192. private _options;
  148193. private _tickCallback;
  148194. private _sphere;
  148195. private _dataFetched;
  148196. /**
  148197. * Initializes the physics gravitational field event
  148198. * @param _physicsHelper A physics helper
  148199. * @param _scene BabylonJS scene
  148200. * @param _origin The origin position of the gravitational field event
  148201. * @param _options The options for the vortex event
  148202. */
  148203. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148204. /**
  148205. * Returns the data related to the gravitational field event (sphere).
  148206. * @returns A gravitational field event
  148207. */
  148208. getData(): PhysicsGravitationalFieldEventData;
  148209. /**
  148210. * Enables the gravitational field.
  148211. */
  148212. enable(): void;
  148213. /**
  148214. * Disables the gravitational field.
  148215. */
  148216. disable(): void;
  148217. /**
  148218. * Disposes the sphere.
  148219. * @param force The force to dispose from the gravitational field event
  148220. */
  148221. dispose(force?: boolean): void;
  148222. private _tick;
  148223. }
  148224. /**
  148225. * Represents a physics updraft event
  148226. */
  148227. class PhysicsUpdraftEvent {
  148228. private _scene;
  148229. private _origin;
  148230. private _options;
  148231. private _physicsEngine;
  148232. private _originTop;
  148233. private _originDirection;
  148234. private _tickCallback;
  148235. private _cylinder;
  148236. private _cylinderPosition;
  148237. private _dataFetched;
  148238. /**
  148239. * Initializes the physics updraft event
  148240. * @param _scene BabylonJS scene
  148241. * @param _origin The origin position of the updraft
  148242. * @param _options The options for the updraft event
  148243. */
  148244. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148245. /**
  148246. * Returns the data related to the updraft event (cylinder).
  148247. * @returns A physics updraft event
  148248. */
  148249. getData(): PhysicsUpdraftEventData;
  148250. /**
  148251. * Enables the updraft.
  148252. */
  148253. enable(): void;
  148254. /**
  148255. * Disables the updraft.
  148256. */
  148257. disable(): void;
  148258. /**
  148259. * Disposes the cylinder.
  148260. * @param force Specifies if the updraft should be disposed by force
  148261. */
  148262. dispose(force?: boolean): void;
  148263. private getImpostorHitData;
  148264. private _tick;
  148265. /*** Helpers ***/
  148266. private _prepareCylinder;
  148267. private _intersectsWithCylinder;
  148268. }
  148269. /**
  148270. * Represents a physics vortex event
  148271. */
  148272. class PhysicsVortexEvent {
  148273. private _scene;
  148274. private _origin;
  148275. private _options;
  148276. private _physicsEngine;
  148277. private _originTop;
  148278. private _tickCallback;
  148279. private _cylinder;
  148280. private _cylinderPosition;
  148281. private _dataFetched;
  148282. /**
  148283. * Initializes the physics vortex event
  148284. * @param _scene The BabylonJS scene
  148285. * @param _origin The origin position of the vortex
  148286. * @param _options The options for the vortex event
  148287. */
  148288. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148289. /**
  148290. * Returns the data related to the vortex event (cylinder).
  148291. * @returns The physics vortex event data
  148292. */
  148293. getData(): PhysicsVortexEventData;
  148294. /**
  148295. * Enables the vortex.
  148296. */
  148297. enable(): void;
  148298. /**
  148299. * Disables the cortex.
  148300. */
  148301. disable(): void;
  148302. /**
  148303. * Disposes the sphere.
  148304. * @param force
  148305. */
  148306. dispose(force?: boolean): void;
  148307. private getImpostorHitData;
  148308. private _tick;
  148309. /*** Helpers ***/
  148310. private _prepareCylinder;
  148311. private _intersectsWithCylinder;
  148312. }
  148313. /**
  148314. * Options fot the radial explosion event
  148315. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148316. */
  148317. export class PhysicsRadialExplosionEventOptions {
  148318. /**
  148319. * The radius of the sphere for the radial explosion.
  148320. */
  148321. radius: number;
  148322. /**
  148323. * The strenth of the explosion.
  148324. */
  148325. strength: number;
  148326. /**
  148327. * The strenght of the force in correspondence to the distance of the affected object
  148328. */
  148329. falloff: PhysicsRadialImpulseFalloff;
  148330. /**
  148331. * Sphere options for the radial explosion.
  148332. */
  148333. sphere: {
  148334. segments: number;
  148335. diameter: number;
  148336. };
  148337. /**
  148338. * Sphere options for the radial explosion.
  148339. */
  148340. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148341. }
  148342. /**
  148343. * Options fot the updraft event
  148344. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148345. */
  148346. export class PhysicsUpdraftEventOptions {
  148347. /**
  148348. * The radius of the cylinder for the vortex
  148349. */
  148350. radius: number;
  148351. /**
  148352. * The strenth of the updraft.
  148353. */
  148354. strength: number;
  148355. /**
  148356. * The height of the cylinder for the updraft.
  148357. */
  148358. height: number;
  148359. /**
  148360. * The mode for the the updraft.
  148361. */
  148362. updraftMode: PhysicsUpdraftMode;
  148363. }
  148364. /**
  148365. * Options fot the vortex event
  148366. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148367. */
  148368. export class PhysicsVortexEventOptions {
  148369. /**
  148370. * The radius of the cylinder for the vortex
  148371. */
  148372. radius: number;
  148373. /**
  148374. * The strenth of the vortex.
  148375. */
  148376. strength: number;
  148377. /**
  148378. * The height of the cylinder for the vortex.
  148379. */
  148380. height: number;
  148381. /**
  148382. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148383. */
  148384. centripetalForceThreshold: number;
  148385. /**
  148386. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148387. */
  148388. centripetalForceMultiplier: number;
  148389. /**
  148390. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148391. */
  148392. centrifugalForceMultiplier: number;
  148393. /**
  148394. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148395. */
  148396. updraftForceMultiplier: number;
  148397. }
  148398. /**
  148399. * The strenght of the force in correspondence to the distance of the affected object
  148400. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148401. */
  148402. export enum PhysicsRadialImpulseFalloff {
  148403. /** Defines that impulse is constant in strength across it's whole radius */
  148404. Constant = 0,
  148405. /** Defines that impulse gets weaker if it's further from the origin */
  148406. Linear = 1
  148407. }
  148408. /**
  148409. * The strength of the force in correspondence to the distance of the affected object
  148410. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148411. */
  148412. export enum PhysicsUpdraftMode {
  148413. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148414. Center = 0,
  148415. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148416. Perpendicular = 1
  148417. }
  148418. /**
  148419. * Interface for a physics hit data
  148420. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148421. */
  148422. export interface PhysicsHitData {
  148423. /**
  148424. * The force applied at the contact point
  148425. */
  148426. force: Vector3;
  148427. /**
  148428. * The contact point
  148429. */
  148430. contactPoint: Vector3;
  148431. /**
  148432. * The distance from the origin to the contact point
  148433. */
  148434. distanceFromOrigin: number;
  148435. }
  148436. /**
  148437. * Interface for radial explosion event data
  148438. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148439. */
  148440. export interface PhysicsRadialExplosionEventData {
  148441. /**
  148442. * A sphere used for the radial explosion event
  148443. */
  148444. sphere: Mesh;
  148445. }
  148446. /**
  148447. * Interface for gravitational field event data
  148448. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148449. */
  148450. export interface PhysicsGravitationalFieldEventData {
  148451. /**
  148452. * A sphere mesh used for the gravitational field event
  148453. */
  148454. sphere: Mesh;
  148455. }
  148456. /**
  148457. * Interface for updraft event data
  148458. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148459. */
  148460. export interface PhysicsUpdraftEventData {
  148461. /**
  148462. * A cylinder used for the updraft event
  148463. */
  148464. cylinder: Mesh;
  148465. }
  148466. /**
  148467. * Interface for vortex event data
  148468. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148469. */
  148470. export interface PhysicsVortexEventData {
  148471. /**
  148472. * A cylinder used for the vortex event
  148473. */
  148474. cylinder: Mesh;
  148475. }
  148476. /**
  148477. * Interface for an affected physics impostor
  148478. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148479. */
  148480. export interface PhysicsAffectedImpostorWithData {
  148481. /**
  148482. * The impostor affected by the effect
  148483. */
  148484. impostor: PhysicsImpostor;
  148485. /**
  148486. * The data about the hit/horce from the explosion
  148487. */
  148488. hitData: PhysicsHitData;
  148489. }
  148490. }
  148491. declare module BABYLON {
  148492. /** @hidden */
  148493. export var blackAndWhitePixelShader: {
  148494. name: string;
  148495. shader: string;
  148496. };
  148497. }
  148498. declare module BABYLON {
  148499. /**
  148500. * Post process used to render in black and white
  148501. */
  148502. export class BlackAndWhitePostProcess extends PostProcess {
  148503. /**
  148504. * Linear about to convert he result to black and white (default: 1)
  148505. */
  148506. degree: number;
  148507. /**
  148508. * Gets a string identifying the name of the class
  148509. * @returns "BlackAndWhitePostProcess" string
  148510. */
  148511. getClassName(): string;
  148512. /**
  148513. * Creates a black and white post process
  148514. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148515. * @param name The name of the effect.
  148516. * @param options The required width/height ratio to downsize to before computing the render pass.
  148517. * @param camera The camera to apply the render pass to.
  148518. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148519. * @param engine The engine which the post process will be applied. (default: current engine)
  148520. * @param reusable If the post process can be reused on the same frame. (default: false)
  148521. */
  148522. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148523. /** @hidden */
  148524. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148525. }
  148526. }
  148527. declare module BABYLON {
  148528. /**
  148529. * This represents a set of one or more post processes in Babylon.
  148530. * A post process can be used to apply a shader to a texture after it is rendered.
  148531. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148532. */
  148533. export class PostProcessRenderEffect {
  148534. private _postProcesses;
  148535. private _getPostProcesses;
  148536. private _singleInstance;
  148537. private _cameras;
  148538. private _indicesForCamera;
  148539. /**
  148540. * Name of the effect
  148541. * @hidden
  148542. */
  148543. _name: string;
  148544. /**
  148545. * Instantiates a post process render effect.
  148546. * A post process can be used to apply a shader to a texture after it is rendered.
  148547. * @param engine The engine the effect is tied to
  148548. * @param name The name of the effect
  148549. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148550. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148551. */
  148552. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148553. /**
  148554. * Checks if all the post processes in the effect are supported.
  148555. */
  148556. get isSupported(): boolean;
  148557. /**
  148558. * Updates the current state of the effect
  148559. * @hidden
  148560. */
  148561. _update(): void;
  148562. /**
  148563. * Attaches the effect on cameras
  148564. * @param cameras The camera to attach to.
  148565. * @hidden
  148566. */
  148567. _attachCameras(cameras: Camera): void;
  148568. /**
  148569. * Attaches the effect on cameras
  148570. * @param cameras The camera to attach to.
  148571. * @hidden
  148572. */
  148573. _attachCameras(cameras: Camera[]): void;
  148574. /**
  148575. * Detaches the effect on cameras
  148576. * @param cameras The camera to detatch from.
  148577. * @hidden
  148578. */
  148579. _detachCameras(cameras: Camera): void;
  148580. /**
  148581. * Detatches the effect on cameras
  148582. * @param cameras The camera to detatch from.
  148583. * @hidden
  148584. */
  148585. _detachCameras(cameras: Camera[]): void;
  148586. /**
  148587. * Enables the effect on given cameras
  148588. * @param cameras The camera to enable.
  148589. * @hidden
  148590. */
  148591. _enable(cameras: Camera): void;
  148592. /**
  148593. * Enables the effect on given cameras
  148594. * @param cameras The camera to enable.
  148595. * @hidden
  148596. */
  148597. _enable(cameras: Nullable<Camera[]>): void;
  148598. /**
  148599. * Disables the effect on the given cameras
  148600. * @param cameras The camera to disable.
  148601. * @hidden
  148602. */
  148603. _disable(cameras: Camera): void;
  148604. /**
  148605. * Disables the effect on the given cameras
  148606. * @param cameras The camera to disable.
  148607. * @hidden
  148608. */
  148609. _disable(cameras: Nullable<Camera[]>): void;
  148610. /**
  148611. * Gets a list of the post processes contained in the effect.
  148612. * @param camera The camera to get the post processes on.
  148613. * @returns The list of the post processes in the effect.
  148614. */
  148615. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148616. }
  148617. }
  148618. declare module BABYLON {
  148619. /** @hidden */
  148620. export var extractHighlightsPixelShader: {
  148621. name: string;
  148622. shader: string;
  148623. };
  148624. }
  148625. declare module BABYLON {
  148626. /**
  148627. * 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.
  148628. */
  148629. export class ExtractHighlightsPostProcess extends PostProcess {
  148630. /**
  148631. * The luminance threshold, pixels below this value will be set to black.
  148632. */
  148633. threshold: number;
  148634. /** @hidden */
  148635. _exposure: number;
  148636. /**
  148637. * Post process which has the input texture to be used when performing highlight extraction
  148638. * @hidden
  148639. */
  148640. _inputPostProcess: Nullable<PostProcess>;
  148641. /**
  148642. * Gets a string identifying the name of the class
  148643. * @returns "ExtractHighlightsPostProcess" string
  148644. */
  148645. getClassName(): string;
  148646. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148647. }
  148648. }
  148649. declare module BABYLON {
  148650. /** @hidden */
  148651. export var bloomMergePixelShader: {
  148652. name: string;
  148653. shader: string;
  148654. };
  148655. }
  148656. declare module BABYLON {
  148657. /**
  148658. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148659. */
  148660. export class BloomMergePostProcess extends PostProcess {
  148661. /** Weight of the bloom to be added to the original input. */
  148662. weight: number;
  148663. /**
  148664. * Gets a string identifying the name of the class
  148665. * @returns "BloomMergePostProcess" string
  148666. */
  148667. getClassName(): string;
  148668. /**
  148669. * Creates a new instance of @see BloomMergePostProcess
  148670. * @param name The name of the effect.
  148671. * @param originalFromInput Post process which's input will be used for the merge.
  148672. * @param blurred Blurred highlights post process which's output will be used.
  148673. * @param weight Weight of the bloom to be added to the original input.
  148674. * @param options The required width/height ratio to downsize to before computing the render pass.
  148675. * @param camera The camera to apply the render pass to.
  148676. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148677. * @param engine The engine which the post process will be applied. (default: current engine)
  148678. * @param reusable If the post process can be reused on the same frame. (default: false)
  148679. * @param textureType Type of textures used when performing the post process. (default: 0)
  148680. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  148681. */
  148682. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148683. /** Weight of the bloom to be added to the original input. */
  148684. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148685. }
  148686. }
  148687. declare module BABYLON {
  148688. /**
  148689. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148690. */
  148691. export class BloomEffect extends PostProcessRenderEffect {
  148692. private bloomScale;
  148693. /**
  148694. * @hidden Internal
  148695. */
  148696. _effects: Array<PostProcess>;
  148697. /**
  148698. * @hidden Internal
  148699. */
  148700. _downscale: ExtractHighlightsPostProcess;
  148701. private _blurX;
  148702. private _blurY;
  148703. private _merge;
  148704. /**
  148705. * The luminance threshold to find bright areas of the image to bloom.
  148706. */
  148707. get threshold(): number;
  148708. set threshold(value: number);
  148709. /**
  148710. * The strength of the bloom.
  148711. */
  148712. get weight(): number;
  148713. set weight(value: number);
  148714. /**
  148715. * Specifies the size of the bloom blur kernel, relative to the final output size
  148716. */
  148717. get kernel(): number;
  148718. set kernel(value: number);
  148719. /**
  148720. * Creates a new instance of @see BloomEffect
  148721. * @param scene The scene the effect belongs to.
  148722. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148723. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148724. * @param bloomWeight The the strength of bloom.
  148725. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148726. * @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)
  148727. */
  148728. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148729. /**
  148730. * Disposes each of the internal effects for a given camera.
  148731. * @param camera The camera to dispose the effect on.
  148732. */
  148733. disposeEffects(camera: Camera): void;
  148734. /**
  148735. * @hidden Internal
  148736. */
  148737. _updateEffects(): void;
  148738. /**
  148739. * Internal
  148740. * @returns if all the contained post processes are ready.
  148741. * @hidden
  148742. */
  148743. _isReady(): boolean;
  148744. }
  148745. }
  148746. declare module BABYLON {
  148747. /** @hidden */
  148748. export var chromaticAberrationPixelShader: {
  148749. name: string;
  148750. shader: string;
  148751. };
  148752. }
  148753. declare module BABYLON {
  148754. /**
  148755. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148756. */
  148757. export class ChromaticAberrationPostProcess extends PostProcess {
  148758. /**
  148759. * The amount of seperation of rgb channels (default: 30)
  148760. */
  148761. aberrationAmount: number;
  148762. /**
  148763. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148764. */
  148765. radialIntensity: number;
  148766. /**
  148767. * 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))
  148768. */
  148769. direction: Vector2;
  148770. /**
  148771. * 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))
  148772. */
  148773. centerPosition: Vector2;
  148774. /** The width of the screen to apply the effect on */
  148775. screenWidth: number;
  148776. /** The height of the screen to apply the effect on */
  148777. screenHeight: number;
  148778. /**
  148779. * Gets a string identifying the name of the class
  148780. * @returns "ChromaticAberrationPostProcess" string
  148781. */
  148782. getClassName(): string;
  148783. /**
  148784. * Creates a new instance ChromaticAberrationPostProcess
  148785. * @param name The name of the effect.
  148786. * @param screenWidth The width of the screen to apply the effect on.
  148787. * @param screenHeight The height of the screen to apply the effect on.
  148788. * @param options The required width/height ratio to downsize to before computing the render pass.
  148789. * @param camera The camera to apply the render pass to.
  148790. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148791. * @param engine The engine which the post process will be applied. (default: current engine)
  148792. * @param reusable If the post process can be reused on the same frame. (default: false)
  148793. * @param textureType Type of textures used when performing the post process. (default: 0)
  148794. * @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)
  148795. */
  148796. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148797. /** @hidden */
  148798. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148799. }
  148800. }
  148801. declare module BABYLON {
  148802. /** @hidden */
  148803. export var circleOfConfusionPixelShader: {
  148804. name: string;
  148805. shader: string;
  148806. };
  148807. }
  148808. declare module BABYLON {
  148809. /**
  148810. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148811. */
  148812. export class CircleOfConfusionPostProcess extends PostProcess {
  148813. /**
  148814. * 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.
  148815. */
  148816. lensSize: number;
  148817. /**
  148818. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148819. */
  148820. fStop: number;
  148821. /**
  148822. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148823. */
  148824. focusDistance: number;
  148825. /**
  148826. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148827. */
  148828. focalLength: number;
  148829. /**
  148830. * Gets a string identifying the name of the class
  148831. * @returns "CircleOfConfusionPostProcess" string
  148832. */
  148833. getClassName(): string;
  148834. private _depthTexture;
  148835. /**
  148836. * Creates a new instance CircleOfConfusionPostProcess
  148837. * @param name The name of the effect.
  148838. * @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.
  148839. * @param options The required width/height ratio to downsize to before computing the render pass.
  148840. * @param camera The camera to apply the render pass to.
  148841. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148842. * @param engine The engine which the post process will be applied. (default: current engine)
  148843. * @param reusable If the post process can be reused on the same frame. (default: false)
  148844. * @param textureType Type of textures used when performing the post process. (default: 0)
  148845. * @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)
  148846. */
  148847. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148848. /**
  148849. * 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.
  148850. */
  148851. set depthTexture(value: RenderTargetTexture);
  148852. }
  148853. }
  148854. declare module BABYLON {
  148855. /** @hidden */
  148856. export var colorCorrectionPixelShader: {
  148857. name: string;
  148858. shader: string;
  148859. };
  148860. }
  148861. declare module BABYLON {
  148862. /**
  148863. *
  148864. * This post-process allows the modification of rendered colors by using
  148865. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148866. *
  148867. * The object needs to be provided an url to a texture containing the color
  148868. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148869. * Use an image editing software to tweak the LUT to match your needs.
  148870. *
  148871. * For an example of a color LUT, see here:
  148872. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148873. * For explanations on color grading, see here:
  148874. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148875. *
  148876. */
  148877. export class ColorCorrectionPostProcess extends PostProcess {
  148878. private _colorTableTexture;
  148879. /**
  148880. * Gets the color table url used to create the LUT texture
  148881. */
  148882. colorTableUrl: string;
  148883. /**
  148884. * Gets a string identifying the name of the class
  148885. * @returns "ColorCorrectionPostProcess" string
  148886. */
  148887. getClassName(): string;
  148888. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148889. /** @hidden */
  148890. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148891. }
  148892. }
  148893. declare module BABYLON {
  148894. /** @hidden */
  148895. export var convolutionPixelShader: {
  148896. name: string;
  148897. shader: string;
  148898. };
  148899. }
  148900. declare module BABYLON {
  148901. /**
  148902. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148903. * input texture to perform effects such as edge detection or sharpening
  148904. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148905. */
  148906. export class ConvolutionPostProcess extends PostProcess {
  148907. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148908. kernel: number[];
  148909. /**
  148910. * Gets a string identifying the name of the class
  148911. * @returns "ConvolutionPostProcess" string
  148912. */
  148913. getClassName(): string;
  148914. /**
  148915. * Creates a new instance ConvolutionPostProcess
  148916. * @param name The name of the effect.
  148917. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148918. * @param options The required width/height ratio to downsize to before computing the render pass.
  148919. * @param camera The camera to apply the render pass to.
  148920. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148921. * @param engine The engine which the post process will be applied. (default: current engine)
  148922. * @param reusable If the post process can be reused on the same frame. (default: false)
  148923. * @param textureType Type of textures used when performing the post process. (default: 0)
  148924. */
  148925. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148926. /** @hidden */
  148927. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148928. /**
  148929. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148930. */
  148931. static EdgeDetect0Kernel: number[];
  148932. /**
  148933. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148934. */
  148935. static EdgeDetect1Kernel: number[];
  148936. /**
  148937. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148938. */
  148939. static EdgeDetect2Kernel: number[];
  148940. /**
  148941. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148942. */
  148943. static SharpenKernel: number[];
  148944. /**
  148945. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148946. */
  148947. static EmbossKernel: number[];
  148948. /**
  148949. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148950. */
  148951. static GaussianKernel: number[];
  148952. }
  148953. }
  148954. declare module BABYLON {
  148955. /**
  148956. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148957. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148958. * based on samples that have a large difference in distance than the center pixel.
  148959. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148960. */
  148961. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148962. /**
  148963. * The direction the blur should be applied
  148964. */
  148965. direction: Vector2;
  148966. /**
  148967. * Gets a string identifying the name of the class
  148968. * @returns "DepthOfFieldBlurPostProcess" string
  148969. */
  148970. getClassName(): string;
  148971. /**
  148972. * Creates a new instance CircleOfConfusionPostProcess
  148973. * @param name The name of the effect.
  148974. * @param scene The scene the effect belongs to.
  148975. * @param direction The direction the blur should be applied.
  148976. * @param kernel The size of the kernel used to blur.
  148977. * @param options The required width/height ratio to downsize to before computing the render pass.
  148978. * @param camera The camera to apply the render pass to.
  148979. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148980. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148981. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148982. * @param engine The engine which the post process will be applied. (default: current engine)
  148983. * @param reusable If the post process can be reused on the same frame. (default: false)
  148984. * @param textureType Type of textures used when performing the post process. (default: 0)
  148985. * @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)
  148986. */
  148987. 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);
  148988. }
  148989. }
  148990. declare module BABYLON {
  148991. /** @hidden */
  148992. export var depthOfFieldMergePixelShader: {
  148993. name: string;
  148994. shader: string;
  148995. };
  148996. }
  148997. declare module BABYLON {
  148998. /**
  148999. * Options to be set when merging outputs from the default pipeline.
  149000. */
  149001. export class DepthOfFieldMergePostProcessOptions {
  149002. /**
  149003. * The original image to merge on top of
  149004. */
  149005. originalFromInput: PostProcess;
  149006. /**
  149007. * Parameters to perform the merge of the depth of field effect
  149008. */
  149009. depthOfField?: {
  149010. circleOfConfusion: PostProcess;
  149011. blurSteps: Array<PostProcess>;
  149012. };
  149013. /**
  149014. * Parameters to perform the merge of bloom effect
  149015. */
  149016. bloom?: {
  149017. blurred: PostProcess;
  149018. weight: number;
  149019. };
  149020. }
  149021. /**
  149022. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149023. */
  149024. export class DepthOfFieldMergePostProcess extends PostProcess {
  149025. private blurSteps;
  149026. /**
  149027. * Gets a string identifying the name of the class
  149028. * @returns "DepthOfFieldMergePostProcess" string
  149029. */
  149030. getClassName(): string;
  149031. /**
  149032. * Creates a new instance of DepthOfFieldMergePostProcess
  149033. * @param name The name of the effect.
  149034. * @param originalFromInput Post process which's input will be used for the merge.
  149035. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149036. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149037. * @param options The required width/height ratio to downsize to before computing the render pass.
  149038. * @param camera The camera to apply the render pass to.
  149039. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149040. * @param engine The engine which the post process will be applied. (default: current engine)
  149041. * @param reusable If the post process can be reused on the same frame. (default: false)
  149042. * @param textureType Type of textures used when performing the post process. (default: 0)
  149043. * @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)
  149044. */
  149045. 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);
  149046. /**
  149047. * Updates the effect with the current post process compile time values and recompiles the shader.
  149048. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149049. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149050. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149051. * @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
  149052. * @param onCompiled Called when the shader has been compiled.
  149053. * @param onError Called if there is an error when compiling a shader.
  149054. */
  149055. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149056. }
  149057. }
  149058. declare module BABYLON {
  149059. /**
  149060. * Specifies the level of max blur that should be applied when using the depth of field effect
  149061. */
  149062. export enum DepthOfFieldEffectBlurLevel {
  149063. /**
  149064. * Subtle blur
  149065. */
  149066. Low = 0,
  149067. /**
  149068. * Medium blur
  149069. */
  149070. Medium = 1,
  149071. /**
  149072. * Large blur
  149073. */
  149074. High = 2
  149075. }
  149076. /**
  149077. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149078. */
  149079. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149080. private _circleOfConfusion;
  149081. /**
  149082. * @hidden Internal, blurs from high to low
  149083. */
  149084. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149085. private _depthOfFieldBlurY;
  149086. private _dofMerge;
  149087. /**
  149088. * @hidden Internal post processes in depth of field effect
  149089. */
  149090. _effects: Array<PostProcess>;
  149091. /**
  149092. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149093. */
  149094. set focalLength(value: number);
  149095. get focalLength(): number;
  149096. /**
  149097. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149098. */
  149099. set fStop(value: number);
  149100. get fStop(): number;
  149101. /**
  149102. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149103. */
  149104. set focusDistance(value: number);
  149105. get focusDistance(): number;
  149106. /**
  149107. * 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.
  149108. */
  149109. set lensSize(value: number);
  149110. get lensSize(): number;
  149111. /**
  149112. * Creates a new instance DepthOfFieldEffect
  149113. * @param scene The scene the effect belongs to.
  149114. * @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.
  149115. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149116. * @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)
  149117. */
  149118. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149119. /**
  149120. * Get the current class name of the current effet
  149121. * @returns "DepthOfFieldEffect"
  149122. */
  149123. getClassName(): string;
  149124. /**
  149125. * 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.
  149126. */
  149127. set depthTexture(value: RenderTargetTexture);
  149128. /**
  149129. * Disposes each of the internal effects for a given camera.
  149130. * @param camera The camera to dispose the effect on.
  149131. */
  149132. disposeEffects(camera: Camera): void;
  149133. /**
  149134. * @hidden Internal
  149135. */
  149136. _updateEffects(): void;
  149137. /**
  149138. * Internal
  149139. * @returns if all the contained post processes are ready.
  149140. * @hidden
  149141. */
  149142. _isReady(): boolean;
  149143. }
  149144. }
  149145. declare module BABYLON {
  149146. /** @hidden */
  149147. export var displayPassPixelShader: {
  149148. name: string;
  149149. shader: string;
  149150. };
  149151. }
  149152. declare module BABYLON {
  149153. /**
  149154. * DisplayPassPostProcess which produces an output the same as it's input
  149155. */
  149156. export class DisplayPassPostProcess extends PostProcess {
  149157. /**
  149158. * Gets a string identifying the name of the class
  149159. * @returns "DisplayPassPostProcess" string
  149160. */
  149161. getClassName(): string;
  149162. /**
  149163. * Creates the DisplayPassPostProcess
  149164. * @param name The name of the effect.
  149165. * @param options The required width/height ratio to downsize to before computing the render pass.
  149166. * @param camera The camera to apply the render pass to.
  149167. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149168. * @param engine The engine which the post process will be applied. (default: current engine)
  149169. * @param reusable If the post process can be reused on the same frame. (default: false)
  149170. */
  149171. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149172. /** @hidden */
  149173. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149174. }
  149175. }
  149176. declare module BABYLON {
  149177. /** @hidden */
  149178. export var filterPixelShader: {
  149179. name: string;
  149180. shader: string;
  149181. };
  149182. }
  149183. declare module BABYLON {
  149184. /**
  149185. * Applies a kernel filter to the image
  149186. */
  149187. export class FilterPostProcess extends PostProcess {
  149188. /** The matrix to be applied to the image */
  149189. kernelMatrix: Matrix;
  149190. /**
  149191. * Gets a string identifying the name of the class
  149192. * @returns "FilterPostProcess" string
  149193. */
  149194. getClassName(): string;
  149195. /**
  149196. *
  149197. * @param name The name of the effect.
  149198. * @param kernelMatrix The matrix to be applied to the image
  149199. * @param options The required width/height ratio to downsize to before computing the render pass.
  149200. * @param camera The camera to apply the render pass to.
  149201. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149202. * @param engine The engine which the post process will be applied. (default: current engine)
  149203. * @param reusable If the post process can be reused on the same frame. (default: false)
  149204. */
  149205. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149206. /** @hidden */
  149207. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149208. }
  149209. }
  149210. declare module BABYLON {
  149211. /** @hidden */
  149212. export var fxaaPixelShader: {
  149213. name: string;
  149214. shader: string;
  149215. };
  149216. }
  149217. declare module BABYLON {
  149218. /** @hidden */
  149219. export var fxaaVertexShader: {
  149220. name: string;
  149221. shader: string;
  149222. };
  149223. }
  149224. declare module BABYLON {
  149225. /**
  149226. * Fxaa post process
  149227. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149228. */
  149229. export class FxaaPostProcess extends PostProcess {
  149230. /**
  149231. * Gets a string identifying the name of the class
  149232. * @returns "FxaaPostProcess" string
  149233. */
  149234. getClassName(): string;
  149235. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149236. private _getDefines;
  149237. /** @hidden */
  149238. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149239. }
  149240. }
  149241. declare module BABYLON {
  149242. /** @hidden */
  149243. export var grainPixelShader: {
  149244. name: string;
  149245. shader: string;
  149246. };
  149247. }
  149248. declare module BABYLON {
  149249. /**
  149250. * The GrainPostProcess adds noise to the image at mid luminance levels
  149251. */
  149252. export class GrainPostProcess extends PostProcess {
  149253. /**
  149254. * The intensity of the grain added (default: 30)
  149255. */
  149256. intensity: number;
  149257. /**
  149258. * If the grain should be randomized on every frame
  149259. */
  149260. animated: boolean;
  149261. /**
  149262. * Gets a string identifying the name of the class
  149263. * @returns "GrainPostProcess" string
  149264. */
  149265. getClassName(): string;
  149266. /**
  149267. * Creates a new instance of @see GrainPostProcess
  149268. * @param name The name of the effect.
  149269. * @param options The required width/height ratio to downsize to before computing the render pass.
  149270. * @param camera The camera to apply the render pass to.
  149271. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149272. * @param engine The engine which the post process will be applied. (default: current engine)
  149273. * @param reusable If the post process can be reused on the same frame. (default: false)
  149274. * @param textureType Type of textures used when performing the post process. (default: 0)
  149275. * @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)
  149276. */
  149277. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149278. /** @hidden */
  149279. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149280. }
  149281. }
  149282. declare module BABYLON {
  149283. /** @hidden */
  149284. export var highlightsPixelShader: {
  149285. name: string;
  149286. shader: string;
  149287. };
  149288. }
  149289. declare module BABYLON {
  149290. /**
  149291. * Extracts highlights from the image
  149292. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149293. */
  149294. export class HighlightsPostProcess extends PostProcess {
  149295. /**
  149296. * Gets a string identifying the name of the class
  149297. * @returns "HighlightsPostProcess" string
  149298. */
  149299. getClassName(): string;
  149300. /**
  149301. * Extracts highlights from the image
  149302. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149303. * @param name The name of the effect.
  149304. * @param options The required width/height ratio to downsize to before computing the render pass.
  149305. * @param camera The camera to apply the render pass to.
  149306. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149307. * @param engine The engine which the post process will be applied. (default: current engine)
  149308. * @param reusable If the post process can be reused on the same frame. (default: false)
  149309. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149310. */
  149311. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149312. }
  149313. }
  149314. declare module BABYLON {
  149315. /** @hidden */
  149316. export var mrtFragmentDeclaration: {
  149317. name: string;
  149318. shader: string;
  149319. };
  149320. }
  149321. declare module BABYLON {
  149322. /** @hidden */
  149323. export var geometryPixelShader: {
  149324. name: string;
  149325. shader: string;
  149326. };
  149327. }
  149328. declare module BABYLON {
  149329. /** @hidden */
  149330. export var geometryVertexShader: {
  149331. name: string;
  149332. shader: string;
  149333. };
  149334. }
  149335. declare module BABYLON {
  149336. /** @hidden */
  149337. interface ISavedTransformationMatrix {
  149338. world: Matrix;
  149339. viewProjection: Matrix;
  149340. }
  149341. /**
  149342. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149343. */
  149344. export class GeometryBufferRenderer {
  149345. /**
  149346. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149347. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149348. */
  149349. static readonly POSITION_TEXTURE_TYPE: number;
  149350. /**
  149351. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149352. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149353. */
  149354. static readonly VELOCITY_TEXTURE_TYPE: number;
  149355. /**
  149356. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149357. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149358. */
  149359. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149360. /**
  149361. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149362. * in order to compute objects velocities when enableVelocity is set to "true"
  149363. * @hidden
  149364. */
  149365. _previousTransformationMatrices: {
  149366. [index: number]: ISavedTransformationMatrix;
  149367. };
  149368. /**
  149369. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149370. * in order to compute objects velocities when enableVelocity is set to "true"
  149371. * @hidden
  149372. */
  149373. _previousBonesTransformationMatrices: {
  149374. [index: number]: Float32Array;
  149375. };
  149376. /**
  149377. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149378. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149379. */
  149380. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149381. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149382. renderTransparentMeshes: boolean;
  149383. private _scene;
  149384. private _resizeObserver;
  149385. private _multiRenderTarget;
  149386. private _ratio;
  149387. private _enablePosition;
  149388. private _enableVelocity;
  149389. private _enableReflectivity;
  149390. private _positionIndex;
  149391. private _velocityIndex;
  149392. private _reflectivityIndex;
  149393. protected _effect: Effect;
  149394. protected _cachedDefines: string;
  149395. /**
  149396. * Set the render list (meshes to be rendered) used in the G buffer.
  149397. */
  149398. set renderList(meshes: Mesh[]);
  149399. /**
  149400. * Gets wether or not G buffer are supported by the running hardware.
  149401. * This requires draw buffer supports
  149402. */
  149403. get isSupported(): boolean;
  149404. /**
  149405. * Returns the index of the given texture type in the G-Buffer textures array
  149406. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149407. * @returns the index of the given texture type in the G-Buffer textures array
  149408. */
  149409. getTextureIndex(textureType: number): number;
  149410. /**
  149411. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149412. */
  149413. get enablePosition(): boolean;
  149414. /**
  149415. * Sets whether or not objects positions are enabled for the G buffer.
  149416. */
  149417. set enablePosition(enable: boolean);
  149418. /**
  149419. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149420. */
  149421. get enableVelocity(): boolean;
  149422. /**
  149423. * Sets wether or not objects velocities are enabled for the G buffer.
  149424. */
  149425. set enableVelocity(enable: boolean);
  149426. /**
  149427. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149428. */
  149429. get enableReflectivity(): boolean;
  149430. /**
  149431. * Sets wether or not objects roughness are enabled for the G buffer.
  149432. */
  149433. set enableReflectivity(enable: boolean);
  149434. /**
  149435. * Gets the scene associated with the buffer.
  149436. */
  149437. get scene(): Scene;
  149438. /**
  149439. * Gets the ratio used by the buffer during its creation.
  149440. * How big is the buffer related to the main canvas.
  149441. */
  149442. get ratio(): number;
  149443. /** @hidden */
  149444. static _SceneComponentInitialization: (scene: Scene) => void;
  149445. /**
  149446. * Creates a new G Buffer for the scene
  149447. * @param scene The scene the buffer belongs to
  149448. * @param ratio How big is the buffer related to the main canvas.
  149449. */
  149450. constructor(scene: Scene, ratio?: number);
  149451. /**
  149452. * Checks wether everything is ready to render a submesh to the G buffer.
  149453. * @param subMesh the submesh to check readiness for
  149454. * @param useInstances is the mesh drawn using instance or not
  149455. * @returns true if ready otherwise false
  149456. */
  149457. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149458. /**
  149459. * Gets the current underlying G Buffer.
  149460. * @returns the buffer
  149461. */
  149462. getGBuffer(): MultiRenderTarget;
  149463. /**
  149464. * Gets the number of samples used to render the buffer (anti aliasing).
  149465. */
  149466. get samples(): number;
  149467. /**
  149468. * Sets the number of samples used to render the buffer (anti aliasing).
  149469. */
  149470. set samples(value: number);
  149471. /**
  149472. * Disposes the renderer and frees up associated resources.
  149473. */
  149474. dispose(): void;
  149475. protected _createRenderTargets(): void;
  149476. private _copyBonesTransformationMatrices;
  149477. }
  149478. }
  149479. declare module BABYLON {
  149480. interface Scene {
  149481. /** @hidden (Backing field) */
  149482. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149483. /**
  149484. * Gets or Sets the current geometry buffer associated to the scene.
  149485. */
  149486. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149487. /**
  149488. * Enables a GeometryBufferRender and associates it with the scene
  149489. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149490. * @returns the GeometryBufferRenderer
  149491. */
  149492. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149493. /**
  149494. * Disables the GeometryBufferRender associated with the scene
  149495. */
  149496. disableGeometryBufferRenderer(): void;
  149497. }
  149498. /**
  149499. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149500. * in several rendering techniques.
  149501. */
  149502. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149503. /**
  149504. * The component name helpful to identify the component in the list of scene components.
  149505. */
  149506. readonly name: string;
  149507. /**
  149508. * The scene the component belongs to.
  149509. */
  149510. scene: Scene;
  149511. /**
  149512. * Creates a new instance of the component for the given scene
  149513. * @param scene Defines the scene to register the component in
  149514. */
  149515. constructor(scene: Scene);
  149516. /**
  149517. * Registers the component in a given scene
  149518. */
  149519. register(): void;
  149520. /**
  149521. * Rebuilds the elements related to this component in case of
  149522. * context lost for instance.
  149523. */
  149524. rebuild(): void;
  149525. /**
  149526. * Disposes the component and the associated ressources
  149527. */
  149528. dispose(): void;
  149529. private _gatherRenderTargets;
  149530. }
  149531. }
  149532. declare module BABYLON {
  149533. /** @hidden */
  149534. export var motionBlurPixelShader: {
  149535. name: string;
  149536. shader: string;
  149537. };
  149538. }
  149539. declare module BABYLON {
  149540. /**
  149541. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149542. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149543. * As an example, all you have to do is to create the post-process:
  149544. * var mb = new BABYLON.MotionBlurPostProcess(
  149545. * 'mb', // The name of the effect.
  149546. * scene, // The scene containing the objects to blur according to their velocity.
  149547. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149548. * camera // The camera to apply the render pass to.
  149549. * );
  149550. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149551. */
  149552. export class MotionBlurPostProcess extends PostProcess {
  149553. /**
  149554. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149555. */
  149556. motionStrength: number;
  149557. /**
  149558. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149559. */
  149560. get motionBlurSamples(): number;
  149561. /**
  149562. * Sets the number of iterations to be used for motion blur quality
  149563. */
  149564. set motionBlurSamples(samples: number);
  149565. private _motionBlurSamples;
  149566. private _geometryBufferRenderer;
  149567. /**
  149568. * Gets a string identifying the name of the class
  149569. * @returns "MotionBlurPostProcess" string
  149570. */
  149571. getClassName(): string;
  149572. /**
  149573. * Creates a new instance MotionBlurPostProcess
  149574. * @param name The name of the effect.
  149575. * @param scene The scene containing the objects to blur according to their velocity.
  149576. * @param options The required width/height ratio to downsize to before computing the render pass.
  149577. * @param camera The camera to apply the render pass to.
  149578. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149579. * @param engine The engine which the post process will be applied. (default: current engine)
  149580. * @param reusable If the post process can be reused on the same frame. (default: false)
  149581. * @param textureType Type of textures used when performing the post process. (default: 0)
  149582. * @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)
  149583. */
  149584. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149585. /**
  149586. * Excludes the given skinned mesh from computing bones velocities.
  149587. * 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.
  149588. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149589. */
  149590. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149591. /**
  149592. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149593. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149594. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149595. */
  149596. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149597. /**
  149598. * Disposes the post process.
  149599. * @param camera The camera to dispose the post process on.
  149600. */
  149601. dispose(camera?: Camera): void;
  149602. /** @hidden */
  149603. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149604. }
  149605. }
  149606. declare module BABYLON {
  149607. /** @hidden */
  149608. export var refractionPixelShader: {
  149609. name: string;
  149610. shader: string;
  149611. };
  149612. }
  149613. declare module BABYLON {
  149614. /**
  149615. * Post process which applies a refractin texture
  149616. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149617. */
  149618. export class RefractionPostProcess extends PostProcess {
  149619. private _refTexture;
  149620. private _ownRefractionTexture;
  149621. /** the base color of the refraction (used to taint the rendering) */
  149622. color: Color3;
  149623. /** simulated refraction depth */
  149624. depth: number;
  149625. /** the coefficient of the base color (0 to remove base color tainting) */
  149626. colorLevel: number;
  149627. /** Gets the url used to load the refraction texture */
  149628. refractionTextureUrl: string;
  149629. /**
  149630. * Gets or sets the refraction texture
  149631. * Please note that you are responsible for disposing the texture if you set it manually
  149632. */
  149633. get refractionTexture(): Texture;
  149634. set refractionTexture(value: Texture);
  149635. /**
  149636. * Gets a string identifying the name of the class
  149637. * @returns "RefractionPostProcess" string
  149638. */
  149639. getClassName(): string;
  149640. /**
  149641. * Initializes the RefractionPostProcess
  149642. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149643. * @param name The name of the effect.
  149644. * @param refractionTextureUrl Url of the refraction texture to use
  149645. * @param color the base color of the refraction (used to taint the rendering)
  149646. * @param depth simulated refraction depth
  149647. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149648. * @param camera The camera to apply the render pass to.
  149649. * @param options The required width/height ratio to downsize to before computing the render pass.
  149650. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149651. * @param engine The engine which the post process will be applied. (default: current engine)
  149652. * @param reusable If the post process can be reused on the same frame. (default: false)
  149653. */
  149654. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149655. /**
  149656. * Disposes of the post process
  149657. * @param camera Camera to dispose post process on
  149658. */
  149659. dispose(camera: Camera): void;
  149660. /** @hidden */
  149661. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149662. }
  149663. }
  149664. declare module BABYLON {
  149665. /** @hidden */
  149666. export var sharpenPixelShader: {
  149667. name: string;
  149668. shader: string;
  149669. };
  149670. }
  149671. declare module BABYLON {
  149672. /**
  149673. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149674. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149675. */
  149676. export class SharpenPostProcess extends PostProcess {
  149677. /**
  149678. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149679. */
  149680. colorAmount: number;
  149681. /**
  149682. * How much sharpness should be applied (default: 0.3)
  149683. */
  149684. edgeAmount: number;
  149685. /**
  149686. * Gets a string identifying the name of the class
  149687. * @returns "SharpenPostProcess" string
  149688. */
  149689. getClassName(): string;
  149690. /**
  149691. * Creates a new instance ConvolutionPostProcess
  149692. * @param name The name of the effect.
  149693. * @param options The required width/height ratio to downsize to before computing the render pass.
  149694. * @param camera The camera to apply the render pass to.
  149695. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149696. * @param engine The engine which the post process will be applied. (default: current engine)
  149697. * @param reusable If the post process can be reused on the same frame. (default: false)
  149698. * @param textureType Type of textures used when performing the post process. (default: 0)
  149699. * @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)
  149700. */
  149701. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149702. /** @hidden */
  149703. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149704. }
  149705. }
  149706. declare module BABYLON {
  149707. /**
  149708. * PostProcessRenderPipeline
  149709. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149710. */
  149711. export class PostProcessRenderPipeline {
  149712. private engine;
  149713. private _renderEffects;
  149714. private _renderEffectsForIsolatedPass;
  149715. /**
  149716. * List of inspectable custom properties (used by the Inspector)
  149717. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149718. */
  149719. inspectableCustomProperties: IInspectable[];
  149720. /**
  149721. * @hidden
  149722. */
  149723. protected _cameras: Camera[];
  149724. /** @hidden */
  149725. _name: string;
  149726. /**
  149727. * Gets pipeline name
  149728. */
  149729. get name(): string;
  149730. /** Gets the list of attached cameras */
  149731. get cameras(): Camera[];
  149732. /**
  149733. * Initializes a PostProcessRenderPipeline
  149734. * @param engine engine to add the pipeline to
  149735. * @param name name of the pipeline
  149736. */
  149737. constructor(engine: Engine, name: string);
  149738. /**
  149739. * Gets the class name
  149740. * @returns "PostProcessRenderPipeline"
  149741. */
  149742. getClassName(): string;
  149743. /**
  149744. * If all the render effects in the pipeline are supported
  149745. */
  149746. get isSupported(): boolean;
  149747. /**
  149748. * Adds an effect to the pipeline
  149749. * @param renderEffect the effect to add
  149750. */
  149751. addEffect(renderEffect: PostProcessRenderEffect): void;
  149752. /** @hidden */
  149753. _rebuild(): void;
  149754. /** @hidden */
  149755. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149756. /** @hidden */
  149757. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149758. /** @hidden */
  149759. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149760. /** @hidden */
  149761. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149762. /** @hidden */
  149763. _attachCameras(cameras: Camera, unique: boolean): void;
  149764. /** @hidden */
  149765. _attachCameras(cameras: Camera[], unique: boolean): void;
  149766. /** @hidden */
  149767. _detachCameras(cameras: Camera): void;
  149768. /** @hidden */
  149769. _detachCameras(cameras: Nullable<Camera[]>): void;
  149770. /** @hidden */
  149771. _update(): void;
  149772. /** @hidden */
  149773. _reset(): void;
  149774. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149775. /**
  149776. * Sets the required values to the prepass renderer.
  149777. * @param prePassRenderer defines the prepass renderer to setup.
  149778. * @returns true if the pre pass is needed.
  149779. */
  149780. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149781. /**
  149782. * Disposes of the pipeline
  149783. */
  149784. dispose(): void;
  149785. }
  149786. }
  149787. declare module BABYLON {
  149788. /**
  149789. * PostProcessRenderPipelineManager class
  149790. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149791. */
  149792. export class PostProcessRenderPipelineManager {
  149793. private _renderPipelines;
  149794. /**
  149795. * Initializes a PostProcessRenderPipelineManager
  149796. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149797. */
  149798. constructor();
  149799. /**
  149800. * Gets the list of supported render pipelines
  149801. */
  149802. get supportedPipelines(): PostProcessRenderPipeline[];
  149803. /**
  149804. * Adds a pipeline to the manager
  149805. * @param renderPipeline The pipeline to add
  149806. */
  149807. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149808. /**
  149809. * Attaches a camera to the pipeline
  149810. * @param renderPipelineName The name of the pipeline to attach to
  149811. * @param cameras the camera to attach
  149812. * @param unique if the camera can be attached multiple times to the pipeline
  149813. */
  149814. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149815. /**
  149816. * Detaches a camera from the pipeline
  149817. * @param renderPipelineName The name of the pipeline to detach from
  149818. * @param cameras the camera to detach
  149819. */
  149820. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149821. /**
  149822. * Enables an effect by name on a pipeline
  149823. * @param renderPipelineName the name of the pipeline to enable the effect in
  149824. * @param renderEffectName the name of the effect to enable
  149825. * @param cameras the cameras that the effect should be enabled on
  149826. */
  149827. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149828. /**
  149829. * Disables an effect by name on a pipeline
  149830. * @param renderPipelineName the name of the pipeline to disable the effect in
  149831. * @param renderEffectName the name of the effect to disable
  149832. * @param cameras the cameras that the effect should be disabled on
  149833. */
  149834. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149835. /**
  149836. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149837. */
  149838. update(): void;
  149839. /** @hidden */
  149840. _rebuild(): void;
  149841. /**
  149842. * Disposes of the manager and pipelines
  149843. */
  149844. dispose(): void;
  149845. }
  149846. }
  149847. declare module BABYLON {
  149848. interface Scene {
  149849. /** @hidden (Backing field) */
  149850. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149851. /**
  149852. * Gets the postprocess render pipeline manager
  149853. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149854. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149855. */
  149856. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149857. }
  149858. /**
  149859. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149860. */
  149861. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149862. /**
  149863. * The component name helpfull to identify the component in the list of scene components.
  149864. */
  149865. readonly name: string;
  149866. /**
  149867. * The scene the component belongs to.
  149868. */
  149869. scene: Scene;
  149870. /**
  149871. * Creates a new instance of the component for the given scene
  149872. * @param scene Defines the scene to register the component in
  149873. */
  149874. constructor(scene: Scene);
  149875. /**
  149876. * Registers the component in a given scene
  149877. */
  149878. register(): void;
  149879. /**
  149880. * Rebuilds the elements related to this component in case of
  149881. * context lost for instance.
  149882. */
  149883. rebuild(): void;
  149884. /**
  149885. * Disposes the component and the associated ressources
  149886. */
  149887. dispose(): void;
  149888. private _gatherRenderTargets;
  149889. }
  149890. }
  149891. declare module BABYLON {
  149892. /**
  149893. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149894. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149895. */
  149896. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149897. private _scene;
  149898. private _camerasToBeAttached;
  149899. /**
  149900. * ID of the sharpen post process,
  149901. */
  149902. private readonly SharpenPostProcessId;
  149903. /**
  149904. * @ignore
  149905. * ID of the image processing post process;
  149906. */
  149907. readonly ImageProcessingPostProcessId: string;
  149908. /**
  149909. * @ignore
  149910. * ID of the Fast Approximate Anti-Aliasing post process;
  149911. */
  149912. readonly FxaaPostProcessId: string;
  149913. /**
  149914. * ID of the chromatic aberration post process,
  149915. */
  149916. private readonly ChromaticAberrationPostProcessId;
  149917. /**
  149918. * ID of the grain post process
  149919. */
  149920. private readonly GrainPostProcessId;
  149921. /**
  149922. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149923. */
  149924. sharpen: SharpenPostProcess;
  149925. private _sharpenEffect;
  149926. private bloom;
  149927. /**
  149928. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149929. */
  149930. depthOfField: DepthOfFieldEffect;
  149931. /**
  149932. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149933. */
  149934. fxaa: FxaaPostProcess;
  149935. /**
  149936. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149937. */
  149938. imageProcessing: ImageProcessingPostProcess;
  149939. /**
  149940. * Chromatic aberration post process which will shift rgb colors in the image
  149941. */
  149942. chromaticAberration: ChromaticAberrationPostProcess;
  149943. private _chromaticAberrationEffect;
  149944. /**
  149945. * Grain post process which add noise to the image
  149946. */
  149947. grain: GrainPostProcess;
  149948. private _grainEffect;
  149949. /**
  149950. * Glow post process which adds a glow to emissive areas of the image
  149951. */
  149952. private _glowLayer;
  149953. /**
  149954. * Animations which can be used to tweak settings over a period of time
  149955. */
  149956. animations: Animation[];
  149957. private _imageProcessingConfigurationObserver;
  149958. private _sharpenEnabled;
  149959. private _bloomEnabled;
  149960. private _depthOfFieldEnabled;
  149961. private _depthOfFieldBlurLevel;
  149962. private _fxaaEnabled;
  149963. private _imageProcessingEnabled;
  149964. private _defaultPipelineTextureType;
  149965. private _bloomScale;
  149966. private _chromaticAberrationEnabled;
  149967. private _grainEnabled;
  149968. private _buildAllowed;
  149969. /**
  149970. * Gets active scene
  149971. */
  149972. get scene(): Scene;
  149973. /**
  149974. * Enable or disable the sharpen process from the pipeline
  149975. */
  149976. set sharpenEnabled(enabled: boolean);
  149977. get sharpenEnabled(): boolean;
  149978. private _resizeObserver;
  149979. private _hardwareScaleLevel;
  149980. private _bloomKernel;
  149981. /**
  149982. * Specifies the size of the bloom blur kernel, relative to the final output size
  149983. */
  149984. get bloomKernel(): number;
  149985. set bloomKernel(value: number);
  149986. /**
  149987. * Specifies the weight of the bloom in the final rendering
  149988. */
  149989. private _bloomWeight;
  149990. /**
  149991. * Specifies the luma threshold for the area that will be blurred by the bloom
  149992. */
  149993. private _bloomThreshold;
  149994. private _hdr;
  149995. /**
  149996. * The strength of the bloom.
  149997. */
  149998. set bloomWeight(value: number);
  149999. get bloomWeight(): number;
  150000. /**
  150001. * The strength of the bloom.
  150002. */
  150003. set bloomThreshold(value: number);
  150004. get bloomThreshold(): number;
  150005. /**
  150006. * The scale of the bloom, lower value will provide better performance.
  150007. */
  150008. set bloomScale(value: number);
  150009. get bloomScale(): number;
  150010. /**
  150011. * Enable or disable the bloom from the pipeline
  150012. */
  150013. set bloomEnabled(enabled: boolean);
  150014. get bloomEnabled(): boolean;
  150015. private _rebuildBloom;
  150016. /**
  150017. * If the depth of field is enabled.
  150018. */
  150019. get depthOfFieldEnabled(): boolean;
  150020. set depthOfFieldEnabled(enabled: boolean);
  150021. /**
  150022. * Blur level of the depth of field effect. (Higher blur will effect performance)
  150023. */
  150024. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  150025. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  150026. /**
  150027. * If the anti aliasing is enabled.
  150028. */
  150029. set fxaaEnabled(enabled: boolean);
  150030. get fxaaEnabled(): boolean;
  150031. private _samples;
  150032. /**
  150033. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150034. */
  150035. set samples(sampleCount: number);
  150036. get samples(): number;
  150037. /**
  150038. * If image processing is enabled.
  150039. */
  150040. set imageProcessingEnabled(enabled: boolean);
  150041. get imageProcessingEnabled(): boolean;
  150042. /**
  150043. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150044. */
  150045. set glowLayerEnabled(enabled: boolean);
  150046. get glowLayerEnabled(): boolean;
  150047. /**
  150048. * Gets the glow layer (or null if not defined)
  150049. */
  150050. get glowLayer(): Nullable<GlowLayer>;
  150051. /**
  150052. * Enable or disable the chromaticAberration process from the pipeline
  150053. */
  150054. set chromaticAberrationEnabled(enabled: boolean);
  150055. get chromaticAberrationEnabled(): boolean;
  150056. /**
  150057. * Enable or disable the grain process from the pipeline
  150058. */
  150059. set grainEnabled(enabled: boolean);
  150060. get grainEnabled(): boolean;
  150061. /**
  150062. * @constructor
  150063. * @param name - The rendering pipeline name (default: "")
  150064. * @param hdr - If high dynamic range textures should be used (default: true)
  150065. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150066. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150067. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150068. */
  150069. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150070. /**
  150071. * Get the class name
  150072. * @returns "DefaultRenderingPipeline"
  150073. */
  150074. getClassName(): string;
  150075. /**
  150076. * Force the compilation of the entire pipeline.
  150077. */
  150078. prepare(): void;
  150079. private _hasCleared;
  150080. private _prevPostProcess;
  150081. private _prevPrevPostProcess;
  150082. private _setAutoClearAndTextureSharing;
  150083. private _depthOfFieldSceneObserver;
  150084. private _buildPipeline;
  150085. private _disposePostProcesses;
  150086. /**
  150087. * Adds a camera to the pipeline
  150088. * @param camera the camera to be added
  150089. */
  150090. addCamera(camera: Camera): void;
  150091. /**
  150092. * Removes a camera from the pipeline
  150093. * @param camera the camera to remove
  150094. */
  150095. removeCamera(camera: Camera): void;
  150096. /**
  150097. * Dispose of the pipeline and stop all post processes
  150098. */
  150099. dispose(): void;
  150100. /**
  150101. * Serialize the rendering pipeline (Used when exporting)
  150102. * @returns the serialized object
  150103. */
  150104. serialize(): any;
  150105. /**
  150106. * Parse the serialized pipeline
  150107. * @param source Source pipeline.
  150108. * @param scene The scene to load the pipeline to.
  150109. * @param rootUrl The URL of the serialized pipeline.
  150110. * @returns An instantiated pipeline from the serialized object.
  150111. */
  150112. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150113. }
  150114. }
  150115. declare module BABYLON {
  150116. /** @hidden */
  150117. export var lensHighlightsPixelShader: {
  150118. name: string;
  150119. shader: string;
  150120. };
  150121. }
  150122. declare module BABYLON {
  150123. /** @hidden */
  150124. export var depthOfFieldPixelShader: {
  150125. name: string;
  150126. shader: string;
  150127. };
  150128. }
  150129. declare module BABYLON {
  150130. /**
  150131. * BABYLON.JS Chromatic Aberration GLSL Shader
  150132. * Author: Olivier Guyot
  150133. * Separates very slightly R, G and B colors on the edges of the screen
  150134. * Inspired by Francois Tarlier & Martins Upitis
  150135. */
  150136. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150137. /**
  150138. * @ignore
  150139. * The chromatic aberration PostProcess id in the pipeline
  150140. */
  150141. LensChromaticAberrationEffect: string;
  150142. /**
  150143. * @ignore
  150144. * The highlights enhancing PostProcess id in the pipeline
  150145. */
  150146. HighlightsEnhancingEffect: string;
  150147. /**
  150148. * @ignore
  150149. * The depth-of-field PostProcess id in the pipeline
  150150. */
  150151. LensDepthOfFieldEffect: string;
  150152. private _scene;
  150153. private _depthTexture;
  150154. private _grainTexture;
  150155. private _chromaticAberrationPostProcess;
  150156. private _highlightsPostProcess;
  150157. private _depthOfFieldPostProcess;
  150158. private _edgeBlur;
  150159. private _grainAmount;
  150160. private _chromaticAberration;
  150161. private _distortion;
  150162. private _highlightsGain;
  150163. private _highlightsThreshold;
  150164. private _dofDistance;
  150165. private _dofAperture;
  150166. private _dofDarken;
  150167. private _dofPentagon;
  150168. private _blurNoise;
  150169. /**
  150170. * @constructor
  150171. *
  150172. * Effect parameters are as follow:
  150173. * {
  150174. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150175. * edge_blur: number; // from 0 to x (1 for realism)
  150176. * distortion: number; // from 0 to x (1 for realism)
  150177. * grain_amount: number; // from 0 to 1
  150178. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150179. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150180. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150181. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150182. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150183. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150184. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150185. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150186. * }
  150187. * Note: if an effect parameter is unset, effect is disabled
  150188. *
  150189. * @param name The rendering pipeline name
  150190. * @param parameters - An object containing all parameters (see above)
  150191. * @param scene The scene linked to this pipeline
  150192. * @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)
  150193. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150194. */
  150195. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150196. /**
  150197. * Get the class name
  150198. * @returns "LensRenderingPipeline"
  150199. */
  150200. getClassName(): string;
  150201. /**
  150202. * Gets associated scene
  150203. */
  150204. get scene(): Scene;
  150205. /**
  150206. * Gets or sets the edge blur
  150207. */
  150208. get edgeBlur(): number;
  150209. set edgeBlur(value: number);
  150210. /**
  150211. * Gets or sets the grain amount
  150212. */
  150213. get grainAmount(): number;
  150214. set grainAmount(value: number);
  150215. /**
  150216. * Gets or sets the chromatic aberration amount
  150217. */
  150218. get chromaticAberration(): number;
  150219. set chromaticAberration(value: number);
  150220. /**
  150221. * Gets or sets the depth of field aperture
  150222. */
  150223. get dofAperture(): number;
  150224. set dofAperture(value: number);
  150225. /**
  150226. * Gets or sets the edge distortion
  150227. */
  150228. get edgeDistortion(): number;
  150229. set edgeDistortion(value: number);
  150230. /**
  150231. * Gets or sets the depth of field distortion
  150232. */
  150233. get dofDistortion(): number;
  150234. set dofDistortion(value: number);
  150235. /**
  150236. * Gets or sets the darken out of focus amount
  150237. */
  150238. get darkenOutOfFocus(): number;
  150239. set darkenOutOfFocus(value: number);
  150240. /**
  150241. * Gets or sets a boolean indicating if blur noise is enabled
  150242. */
  150243. get blurNoise(): boolean;
  150244. set blurNoise(value: boolean);
  150245. /**
  150246. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150247. */
  150248. get pentagonBokeh(): boolean;
  150249. set pentagonBokeh(value: boolean);
  150250. /**
  150251. * Gets or sets the highlight grain amount
  150252. */
  150253. get highlightsGain(): number;
  150254. set highlightsGain(value: number);
  150255. /**
  150256. * Gets or sets the highlight threshold
  150257. */
  150258. get highlightsThreshold(): number;
  150259. set highlightsThreshold(value: number);
  150260. /**
  150261. * Sets the amount of blur at the edges
  150262. * @param amount blur amount
  150263. */
  150264. setEdgeBlur(amount: number): void;
  150265. /**
  150266. * Sets edge blur to 0
  150267. */
  150268. disableEdgeBlur(): void;
  150269. /**
  150270. * Sets the amout of grain
  150271. * @param amount Amount of grain
  150272. */
  150273. setGrainAmount(amount: number): void;
  150274. /**
  150275. * Set grain amount to 0
  150276. */
  150277. disableGrain(): void;
  150278. /**
  150279. * Sets the chromatic aberration amount
  150280. * @param amount amount of chromatic aberration
  150281. */
  150282. setChromaticAberration(amount: number): void;
  150283. /**
  150284. * Sets chromatic aberration amount to 0
  150285. */
  150286. disableChromaticAberration(): void;
  150287. /**
  150288. * Sets the EdgeDistortion amount
  150289. * @param amount amount of EdgeDistortion
  150290. */
  150291. setEdgeDistortion(amount: number): void;
  150292. /**
  150293. * Sets edge distortion to 0
  150294. */
  150295. disableEdgeDistortion(): void;
  150296. /**
  150297. * Sets the FocusDistance amount
  150298. * @param amount amount of FocusDistance
  150299. */
  150300. setFocusDistance(amount: number): void;
  150301. /**
  150302. * Disables depth of field
  150303. */
  150304. disableDepthOfField(): void;
  150305. /**
  150306. * Sets the Aperture amount
  150307. * @param amount amount of Aperture
  150308. */
  150309. setAperture(amount: number): void;
  150310. /**
  150311. * Sets the DarkenOutOfFocus amount
  150312. * @param amount amount of DarkenOutOfFocus
  150313. */
  150314. setDarkenOutOfFocus(amount: number): void;
  150315. private _pentagonBokehIsEnabled;
  150316. /**
  150317. * Creates a pentagon bokeh effect
  150318. */
  150319. enablePentagonBokeh(): void;
  150320. /**
  150321. * Disables the pentagon bokeh effect
  150322. */
  150323. disablePentagonBokeh(): void;
  150324. /**
  150325. * Enables noise blur
  150326. */
  150327. enableNoiseBlur(): void;
  150328. /**
  150329. * Disables noise blur
  150330. */
  150331. disableNoiseBlur(): void;
  150332. /**
  150333. * Sets the HighlightsGain amount
  150334. * @param amount amount of HighlightsGain
  150335. */
  150336. setHighlightsGain(amount: number): void;
  150337. /**
  150338. * Sets the HighlightsThreshold amount
  150339. * @param amount amount of HighlightsThreshold
  150340. */
  150341. setHighlightsThreshold(amount: number): void;
  150342. /**
  150343. * Disables highlights
  150344. */
  150345. disableHighlights(): void;
  150346. /**
  150347. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150348. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150349. */
  150350. dispose(disableDepthRender?: boolean): void;
  150351. private _createChromaticAberrationPostProcess;
  150352. private _createHighlightsPostProcess;
  150353. private _createDepthOfFieldPostProcess;
  150354. private _createGrainTexture;
  150355. }
  150356. }
  150357. declare module BABYLON {
  150358. /** @hidden */
  150359. export var ssao2PixelShader: {
  150360. name: string;
  150361. shader: string;
  150362. };
  150363. }
  150364. declare module BABYLON {
  150365. /** @hidden */
  150366. export var ssaoCombinePixelShader: {
  150367. name: string;
  150368. shader: string;
  150369. };
  150370. }
  150371. declare module BABYLON {
  150372. /**
  150373. * Render pipeline to produce ssao effect
  150374. */
  150375. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150376. /**
  150377. * @ignore
  150378. * The PassPostProcess id in the pipeline that contains the original scene color
  150379. */
  150380. SSAOOriginalSceneColorEffect: string;
  150381. /**
  150382. * @ignore
  150383. * The SSAO PostProcess id in the pipeline
  150384. */
  150385. SSAORenderEffect: string;
  150386. /**
  150387. * @ignore
  150388. * The horizontal blur PostProcess id in the pipeline
  150389. */
  150390. SSAOBlurHRenderEffect: string;
  150391. /**
  150392. * @ignore
  150393. * The vertical blur PostProcess id in the pipeline
  150394. */
  150395. SSAOBlurVRenderEffect: string;
  150396. /**
  150397. * @ignore
  150398. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150399. */
  150400. SSAOCombineRenderEffect: string;
  150401. /**
  150402. * The output strength of the SSAO post-process. Default value is 1.0.
  150403. */
  150404. totalStrength: number;
  150405. /**
  150406. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150407. */
  150408. maxZ: number;
  150409. /**
  150410. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150411. */
  150412. minZAspect: number;
  150413. private _samples;
  150414. /**
  150415. * Number of samples used for the SSAO calculations. Default value is 8
  150416. */
  150417. set samples(n: number);
  150418. get samples(): number;
  150419. private _textureSamples;
  150420. /**
  150421. * Number of samples to use for antialiasing
  150422. */
  150423. set textureSamples(n: number);
  150424. get textureSamples(): number;
  150425. /**
  150426. * Force rendering the geometry through geometry buffer
  150427. */
  150428. private _forceGeometryBuffer;
  150429. /**
  150430. * Ratio object used for SSAO ratio and blur ratio
  150431. */
  150432. private _ratio;
  150433. /**
  150434. * Dynamically generated sphere sampler.
  150435. */
  150436. private _sampleSphere;
  150437. /**
  150438. * Blur filter offsets
  150439. */
  150440. private _samplerOffsets;
  150441. private _expensiveBlur;
  150442. /**
  150443. * If bilateral blur should be used
  150444. */
  150445. set expensiveBlur(b: boolean);
  150446. get expensiveBlur(): boolean;
  150447. /**
  150448. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150449. */
  150450. radius: number;
  150451. /**
  150452. * The base color of the SSAO post-process
  150453. * The final result is "base + ssao" between [0, 1]
  150454. */
  150455. base: number;
  150456. /**
  150457. * Support test.
  150458. */
  150459. static get IsSupported(): boolean;
  150460. private _scene;
  150461. private _randomTexture;
  150462. private _originalColorPostProcess;
  150463. private _ssaoPostProcess;
  150464. private _blurHPostProcess;
  150465. private _blurVPostProcess;
  150466. private _ssaoCombinePostProcess;
  150467. private _prePassRenderer;
  150468. /**
  150469. * Gets active scene
  150470. */
  150471. get scene(): Scene;
  150472. /**
  150473. * @constructor
  150474. * @param name The rendering pipeline name
  150475. * @param scene The scene linked to this pipeline
  150476. * @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 }
  150477. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150478. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150479. */
  150480. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150481. /**
  150482. * Get the class name
  150483. * @returns "SSAO2RenderingPipeline"
  150484. */
  150485. getClassName(): string;
  150486. /**
  150487. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150488. */
  150489. dispose(disableGeometryBufferRenderer?: boolean): void;
  150490. private _createBlurPostProcess;
  150491. /** @hidden */
  150492. _rebuild(): void;
  150493. private _bits;
  150494. private _radicalInverse_VdC;
  150495. private _hammersley;
  150496. private _hemisphereSample_uniform;
  150497. private _generateHemisphere;
  150498. private _getDefinesForSSAO;
  150499. private _createSSAOPostProcess;
  150500. private _createSSAOCombinePostProcess;
  150501. private _createRandomTexture;
  150502. /**
  150503. * Serialize the rendering pipeline (Used when exporting)
  150504. * @returns the serialized object
  150505. */
  150506. serialize(): any;
  150507. /**
  150508. * Parse the serialized pipeline
  150509. * @param source Source pipeline.
  150510. * @param scene The scene to load the pipeline to.
  150511. * @param rootUrl The URL of the serialized pipeline.
  150512. * @returns An instantiated pipeline from the serialized object.
  150513. */
  150514. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150515. /**
  150516. * Sets the required values to the prepass renderer.
  150517. * @param prePassRenderer defines the prepass renderer to setup
  150518. * @returns true if the pre pass is needed.
  150519. */
  150520. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150521. }
  150522. }
  150523. declare module BABYLON {
  150524. /** @hidden */
  150525. export var ssaoPixelShader: {
  150526. name: string;
  150527. shader: string;
  150528. };
  150529. }
  150530. declare module BABYLON {
  150531. /**
  150532. * Render pipeline to produce ssao effect
  150533. */
  150534. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150535. /**
  150536. * @ignore
  150537. * The PassPostProcess id in the pipeline that contains the original scene color
  150538. */
  150539. SSAOOriginalSceneColorEffect: string;
  150540. /**
  150541. * @ignore
  150542. * The SSAO PostProcess id in the pipeline
  150543. */
  150544. SSAORenderEffect: string;
  150545. /**
  150546. * @ignore
  150547. * The horizontal blur PostProcess id in the pipeline
  150548. */
  150549. SSAOBlurHRenderEffect: string;
  150550. /**
  150551. * @ignore
  150552. * The vertical blur PostProcess id in the pipeline
  150553. */
  150554. SSAOBlurVRenderEffect: string;
  150555. /**
  150556. * @ignore
  150557. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150558. */
  150559. SSAOCombineRenderEffect: string;
  150560. /**
  150561. * The output strength of the SSAO post-process. Default value is 1.0.
  150562. */
  150563. totalStrength: number;
  150564. /**
  150565. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150566. */
  150567. radius: number;
  150568. /**
  150569. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150570. * Must not be equal to fallOff and superior to fallOff.
  150571. * Default value is 0.0075
  150572. */
  150573. area: number;
  150574. /**
  150575. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150576. * Must not be equal to area and inferior to area.
  150577. * Default value is 0.000001
  150578. */
  150579. fallOff: number;
  150580. /**
  150581. * The base color of the SSAO post-process
  150582. * The final result is "base + ssao" between [0, 1]
  150583. */
  150584. base: number;
  150585. private _scene;
  150586. private _depthTexture;
  150587. private _randomTexture;
  150588. private _originalColorPostProcess;
  150589. private _ssaoPostProcess;
  150590. private _blurHPostProcess;
  150591. private _blurVPostProcess;
  150592. private _ssaoCombinePostProcess;
  150593. private _firstUpdate;
  150594. /**
  150595. * Gets active scene
  150596. */
  150597. get scene(): Scene;
  150598. /**
  150599. * @constructor
  150600. * @param name - The rendering pipeline name
  150601. * @param scene - The scene linked to this pipeline
  150602. * @param ratio - The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, combineRatio: 1.0 }
  150603. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150604. */
  150605. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150606. /**
  150607. * Get the class name
  150608. * @returns "SSAORenderingPipeline"
  150609. */
  150610. getClassName(): string;
  150611. /**
  150612. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150613. */
  150614. dispose(disableDepthRender?: boolean): void;
  150615. private _createBlurPostProcess;
  150616. /** @hidden */
  150617. _rebuild(): void;
  150618. private _createSSAOPostProcess;
  150619. private _createSSAOCombinePostProcess;
  150620. private _createRandomTexture;
  150621. }
  150622. }
  150623. declare module BABYLON {
  150624. /** @hidden */
  150625. export var screenSpaceReflectionPixelShader: {
  150626. name: string;
  150627. shader: string;
  150628. };
  150629. }
  150630. declare module BABYLON {
  150631. /**
  150632. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150633. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150634. */
  150635. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150636. /**
  150637. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150638. */
  150639. threshold: number;
  150640. /**
  150641. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150642. */
  150643. strength: number;
  150644. /**
  150645. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150646. */
  150647. reflectionSpecularFalloffExponent: number;
  150648. /**
  150649. * 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]
  150650. */
  150651. step: number;
  150652. /**
  150653. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150654. */
  150655. roughnessFactor: number;
  150656. private _geometryBufferRenderer;
  150657. private _enableSmoothReflections;
  150658. private _reflectionSamples;
  150659. private _smoothSteps;
  150660. /**
  150661. * Gets a string identifying the name of the class
  150662. * @returns "ScreenSpaceReflectionPostProcess" string
  150663. */
  150664. getClassName(): string;
  150665. /**
  150666. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150667. * @param name The name of the effect.
  150668. * @param scene The scene containing the objects to calculate reflections.
  150669. * @param options The required width/height ratio to downsize to before computing the render pass.
  150670. * @param camera The camera to apply the render pass to.
  150671. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150672. * @param engine The engine which the post process will be applied. (default: current engine)
  150673. * @param reusable If the post process can be reused on the same frame. (default: false)
  150674. * @param textureType Type of textures used when performing the post process. (default: 0)
  150675. * @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)
  150676. */
  150677. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150678. /**
  150679. * Gets wether or not smoothing reflections is enabled.
  150680. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150681. */
  150682. get enableSmoothReflections(): boolean;
  150683. /**
  150684. * Sets wether or not smoothing reflections is enabled.
  150685. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150686. */
  150687. set enableSmoothReflections(enabled: boolean);
  150688. /**
  150689. * Gets the number of samples taken while computing reflections. More samples count is high,
  150690. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150691. */
  150692. get reflectionSamples(): number;
  150693. /**
  150694. * Sets the number of samples taken while computing reflections. More samples count is high,
  150695. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150696. */
  150697. set reflectionSamples(samples: number);
  150698. /**
  150699. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150700. * more the post-process will require GPU power and can generate a drop in FPS.
  150701. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150702. */
  150703. get smoothSteps(): number;
  150704. set smoothSteps(steps: number);
  150705. private _updateEffectDefines;
  150706. /** @hidden */
  150707. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150708. }
  150709. }
  150710. declare module BABYLON {
  150711. /** @hidden */
  150712. export var standardPixelShader: {
  150713. name: string;
  150714. shader: string;
  150715. };
  150716. }
  150717. declare module BABYLON {
  150718. /**
  150719. * Standard rendering pipeline
  150720. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150721. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150722. */
  150723. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150724. /**
  150725. * Public members
  150726. */
  150727. /**
  150728. * Post-process which contains the original scene color before the pipeline applies all the effects
  150729. */
  150730. originalPostProcess: Nullable<PostProcess>;
  150731. /**
  150732. * Post-process used to down scale an image x4
  150733. */
  150734. downSampleX4PostProcess: Nullable<PostProcess>;
  150735. /**
  150736. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150737. */
  150738. brightPassPostProcess: Nullable<PostProcess>;
  150739. /**
  150740. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150741. */
  150742. blurHPostProcesses: PostProcess[];
  150743. /**
  150744. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150745. */
  150746. blurVPostProcesses: PostProcess[];
  150747. /**
  150748. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150749. */
  150750. textureAdderPostProcess: Nullable<PostProcess>;
  150751. /**
  150752. * Post-process used to create volumetric lighting effect
  150753. */
  150754. volumetricLightPostProcess: Nullable<PostProcess>;
  150755. /**
  150756. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150757. */
  150758. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150759. /**
  150760. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150761. */
  150762. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150763. /**
  150764. * Post-process used to merge the volumetric light effect and the real scene color
  150765. */
  150766. volumetricLightMergePostProces: Nullable<PostProcess>;
  150767. /**
  150768. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150769. */
  150770. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150771. /**
  150772. * Base post-process used to calculate the average luminance of the final image for HDR
  150773. */
  150774. luminancePostProcess: Nullable<PostProcess>;
  150775. /**
  150776. * Post-processes used to create down sample post-processes in order to get
  150777. * the average luminance of the final image for HDR
  150778. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150779. */
  150780. luminanceDownSamplePostProcesses: PostProcess[];
  150781. /**
  150782. * Post-process used to create a HDR effect (light adaptation)
  150783. */
  150784. hdrPostProcess: Nullable<PostProcess>;
  150785. /**
  150786. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150787. */
  150788. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150789. /**
  150790. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150791. */
  150792. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150793. /**
  150794. * Post-process used to merge the final HDR post-process and the real scene color
  150795. */
  150796. hdrFinalPostProcess: Nullable<PostProcess>;
  150797. /**
  150798. * Post-process used to create a lens flare effect
  150799. */
  150800. lensFlarePostProcess: Nullable<PostProcess>;
  150801. /**
  150802. * Post-process that merges the result of the lens flare post-process and the real scene color
  150803. */
  150804. lensFlareComposePostProcess: Nullable<PostProcess>;
  150805. /**
  150806. * Post-process used to create a motion blur effect
  150807. */
  150808. motionBlurPostProcess: Nullable<PostProcess>;
  150809. /**
  150810. * Post-process used to create a depth of field effect
  150811. */
  150812. depthOfFieldPostProcess: Nullable<PostProcess>;
  150813. /**
  150814. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150815. */
  150816. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150817. /**
  150818. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150819. */
  150820. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150821. /**
  150822. * Represents the brightness threshold in order to configure the illuminated surfaces
  150823. */
  150824. brightThreshold: number;
  150825. /**
  150826. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150827. */
  150828. blurWidth: number;
  150829. /**
  150830. * Sets if the blur for highlighted surfaces must be only horizontal
  150831. */
  150832. horizontalBlur: boolean;
  150833. /**
  150834. * Gets the overall exposure used by the pipeline
  150835. */
  150836. get exposure(): number;
  150837. /**
  150838. * Sets the overall exposure used by the pipeline
  150839. */
  150840. set exposure(value: number);
  150841. /**
  150842. * Texture used typically to simulate "dirty" on camera lens
  150843. */
  150844. lensTexture: Nullable<Texture>;
  150845. /**
  150846. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150847. */
  150848. volumetricLightCoefficient: number;
  150849. /**
  150850. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150851. */
  150852. volumetricLightPower: number;
  150853. /**
  150854. * Used the set the blur intensity to smooth the volumetric lights
  150855. */
  150856. volumetricLightBlurScale: number;
  150857. /**
  150858. * Light (spot or directional) used to generate the volumetric lights rays
  150859. * The source light must have a shadow generate so the pipeline can get its
  150860. * depth map
  150861. */
  150862. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150863. /**
  150864. * For eye adaptation, represents the minimum luminance the eye can see
  150865. */
  150866. hdrMinimumLuminance: number;
  150867. /**
  150868. * For eye adaptation, represents the decrease luminance speed
  150869. */
  150870. hdrDecreaseRate: number;
  150871. /**
  150872. * For eye adaptation, represents the increase luminance speed
  150873. */
  150874. hdrIncreaseRate: number;
  150875. /**
  150876. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150877. */
  150878. get hdrAutoExposure(): boolean;
  150879. /**
  150880. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150881. */
  150882. set hdrAutoExposure(value: boolean);
  150883. /**
  150884. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150885. */
  150886. lensColorTexture: Nullable<Texture>;
  150887. /**
  150888. * The overall strengh for the lens flare effect
  150889. */
  150890. lensFlareStrength: number;
  150891. /**
  150892. * Dispersion coefficient for lens flare ghosts
  150893. */
  150894. lensFlareGhostDispersal: number;
  150895. /**
  150896. * Main lens flare halo width
  150897. */
  150898. lensFlareHaloWidth: number;
  150899. /**
  150900. * Based on the lens distortion effect, defines how much the lens flare result
  150901. * is distorted
  150902. */
  150903. lensFlareDistortionStrength: number;
  150904. /**
  150905. * Configures the blur intensity used for for lens flare (halo)
  150906. */
  150907. lensFlareBlurWidth: number;
  150908. /**
  150909. * Lens star texture must be used to simulate rays on the flares and is available
  150910. * in the documentation
  150911. */
  150912. lensStarTexture: Nullable<Texture>;
  150913. /**
  150914. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150915. * flare effect by taking account of the dirt texture
  150916. */
  150917. lensFlareDirtTexture: Nullable<Texture>;
  150918. /**
  150919. * Represents the focal length for the depth of field effect
  150920. */
  150921. depthOfFieldDistance: number;
  150922. /**
  150923. * Represents the blur intensity for the blurred part of the depth of field effect
  150924. */
  150925. depthOfFieldBlurWidth: number;
  150926. /**
  150927. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150928. */
  150929. get motionStrength(): number;
  150930. /**
  150931. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150932. */
  150933. set motionStrength(strength: number);
  150934. /**
  150935. * Gets wether or not the motion blur post-process is object based or screen based.
  150936. */
  150937. get objectBasedMotionBlur(): boolean;
  150938. /**
  150939. * Sets wether or not the motion blur post-process should be object based or screen based
  150940. */
  150941. set objectBasedMotionBlur(value: boolean);
  150942. /**
  150943. * List of animations for the pipeline (IAnimatable implementation)
  150944. */
  150945. animations: Animation[];
  150946. /**
  150947. * Private members
  150948. */
  150949. private _scene;
  150950. private _currentDepthOfFieldSource;
  150951. private _basePostProcess;
  150952. private _fixedExposure;
  150953. private _currentExposure;
  150954. private _hdrAutoExposure;
  150955. private _hdrCurrentLuminance;
  150956. private _motionStrength;
  150957. private _isObjectBasedMotionBlur;
  150958. private _floatTextureType;
  150959. private _camerasToBeAttached;
  150960. private _ratio;
  150961. private _bloomEnabled;
  150962. private _depthOfFieldEnabled;
  150963. private _vlsEnabled;
  150964. private _lensFlareEnabled;
  150965. private _hdrEnabled;
  150966. private _motionBlurEnabled;
  150967. private _fxaaEnabled;
  150968. private _screenSpaceReflectionsEnabled;
  150969. private _motionBlurSamples;
  150970. private _volumetricLightStepsCount;
  150971. private _samples;
  150972. /**
  150973. * @ignore
  150974. * Specifies if the bloom pipeline is enabled
  150975. */
  150976. get BloomEnabled(): boolean;
  150977. set BloomEnabled(enabled: boolean);
  150978. /**
  150979. * @ignore
  150980. * Specifies if the depth of field pipeline is enabed
  150981. */
  150982. get DepthOfFieldEnabled(): boolean;
  150983. set DepthOfFieldEnabled(enabled: boolean);
  150984. /**
  150985. * @ignore
  150986. * Specifies if the lens flare pipeline is enabed
  150987. */
  150988. get LensFlareEnabled(): boolean;
  150989. set LensFlareEnabled(enabled: boolean);
  150990. /**
  150991. * @ignore
  150992. * Specifies if the HDR pipeline is enabled
  150993. */
  150994. get HDREnabled(): boolean;
  150995. set HDREnabled(enabled: boolean);
  150996. /**
  150997. * @ignore
  150998. * Specifies if the volumetric lights scattering effect is enabled
  150999. */
  151000. get VLSEnabled(): boolean;
  151001. set VLSEnabled(enabled: boolean);
  151002. /**
  151003. * @ignore
  151004. * Specifies if the motion blur effect is enabled
  151005. */
  151006. get MotionBlurEnabled(): boolean;
  151007. set MotionBlurEnabled(enabled: boolean);
  151008. /**
  151009. * Specifies if anti-aliasing is enabled
  151010. */
  151011. get fxaaEnabled(): boolean;
  151012. set fxaaEnabled(enabled: boolean);
  151013. /**
  151014. * Specifies if screen space reflections are enabled.
  151015. */
  151016. get screenSpaceReflectionsEnabled(): boolean;
  151017. set screenSpaceReflectionsEnabled(enabled: boolean);
  151018. /**
  151019. * Specifies the number of steps used to calculate the volumetric lights
  151020. * Typically in interval [50, 200]
  151021. */
  151022. get volumetricLightStepsCount(): number;
  151023. set volumetricLightStepsCount(count: number);
  151024. /**
  151025. * Specifies the number of samples used for the motion blur effect
  151026. * Typically in interval [16, 64]
  151027. */
  151028. get motionBlurSamples(): number;
  151029. set motionBlurSamples(samples: number);
  151030. /**
  151031. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151032. */
  151033. get samples(): number;
  151034. set samples(sampleCount: number);
  151035. /**
  151036. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151037. * @constructor
  151038. * @param name The rendering pipeline name
  151039. * @param scene The scene linked to this pipeline
  151040. * @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)
  151041. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151042. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151043. */
  151044. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151045. private _buildPipeline;
  151046. private _createDownSampleX4PostProcess;
  151047. private _createBrightPassPostProcess;
  151048. private _createBlurPostProcesses;
  151049. private _createTextureAdderPostProcess;
  151050. private _createVolumetricLightPostProcess;
  151051. private _createLuminancePostProcesses;
  151052. private _createHdrPostProcess;
  151053. private _createLensFlarePostProcess;
  151054. private _createDepthOfFieldPostProcess;
  151055. private _createMotionBlurPostProcess;
  151056. private _getDepthTexture;
  151057. private _disposePostProcesses;
  151058. /**
  151059. * Dispose of the pipeline and stop all post processes
  151060. */
  151061. dispose(): void;
  151062. /**
  151063. * Serialize the rendering pipeline (Used when exporting)
  151064. * @returns the serialized object
  151065. */
  151066. serialize(): any;
  151067. /**
  151068. * Parse the serialized pipeline
  151069. * @param source Source pipeline.
  151070. * @param scene The scene to load the pipeline to.
  151071. * @param rootUrl The URL of the serialized pipeline.
  151072. * @returns An instantiated pipeline from the serialized object.
  151073. */
  151074. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151075. /**
  151076. * Luminance steps
  151077. */
  151078. static LuminanceSteps: number;
  151079. }
  151080. }
  151081. declare module BABYLON {
  151082. /** @hidden */
  151083. export var stereoscopicInterlacePixelShader: {
  151084. name: string;
  151085. shader: string;
  151086. };
  151087. }
  151088. declare module BABYLON {
  151089. /**
  151090. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151091. */
  151092. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151093. private _stepSize;
  151094. private _passedProcess;
  151095. /**
  151096. * Gets a string identifying the name of the class
  151097. * @returns "StereoscopicInterlacePostProcessI" string
  151098. */
  151099. getClassName(): string;
  151100. /**
  151101. * Initializes a StereoscopicInterlacePostProcessI
  151102. * @param name The name of the effect.
  151103. * @param rigCameras The rig cameras to be appled to the post process
  151104. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151105. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151106. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151107. * @param engine The engine which the post process will be applied. (default: current engine)
  151108. * @param reusable If the post process can be reused on the same frame. (default: false)
  151109. */
  151110. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151111. }
  151112. /**
  151113. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151114. */
  151115. export class StereoscopicInterlacePostProcess extends PostProcess {
  151116. private _stepSize;
  151117. private _passedProcess;
  151118. /**
  151119. * Gets a string identifying the name of the class
  151120. * @returns "StereoscopicInterlacePostProcess" string
  151121. */
  151122. getClassName(): string;
  151123. /**
  151124. * Initializes a StereoscopicInterlacePostProcess
  151125. * @param name The name of the effect.
  151126. * @param rigCameras The rig cameras to be appled to the post process
  151127. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151128. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151129. * @param engine The engine which the post process will be applied. (default: current engine)
  151130. * @param reusable If the post process can be reused on the same frame. (default: false)
  151131. */
  151132. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151133. }
  151134. }
  151135. declare module BABYLON {
  151136. /** @hidden */
  151137. export var tonemapPixelShader: {
  151138. name: string;
  151139. shader: string;
  151140. };
  151141. }
  151142. declare module BABYLON {
  151143. /** Defines operator used for tonemapping */
  151144. export enum TonemappingOperator {
  151145. /** Hable */
  151146. Hable = 0,
  151147. /** Reinhard */
  151148. Reinhard = 1,
  151149. /** HejiDawson */
  151150. HejiDawson = 2,
  151151. /** Photographic */
  151152. Photographic = 3
  151153. }
  151154. /**
  151155. * Defines a post process to apply tone mapping
  151156. */
  151157. export class TonemapPostProcess extends PostProcess {
  151158. private _operator;
  151159. /** Defines the required exposure adjustement */
  151160. exposureAdjustment: number;
  151161. /**
  151162. * Gets a string identifying the name of the class
  151163. * @returns "TonemapPostProcess" string
  151164. */
  151165. getClassName(): string;
  151166. /**
  151167. * Creates a new TonemapPostProcess
  151168. * @param name defines the name of the postprocess
  151169. * @param _operator defines the operator to use
  151170. * @param exposureAdjustment defines the required exposure adjustement
  151171. * @param camera defines the camera to use (can be null)
  151172. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151173. * @param engine defines the hosting engine (can be ignore if camera is set)
  151174. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151175. */
  151176. constructor(name: string, _operator: TonemappingOperator,
  151177. /** Defines the required exposure adjustement */
  151178. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151179. }
  151180. }
  151181. declare module BABYLON {
  151182. /** @hidden */
  151183. export var volumetricLightScatteringPixelShader: {
  151184. name: string;
  151185. shader: string;
  151186. };
  151187. }
  151188. declare module BABYLON {
  151189. /** @hidden */
  151190. export var volumetricLightScatteringPassVertexShader: {
  151191. name: string;
  151192. shader: string;
  151193. };
  151194. }
  151195. declare module BABYLON {
  151196. /** @hidden */
  151197. export var volumetricLightScatteringPassPixelShader: {
  151198. name: string;
  151199. shader: string;
  151200. };
  151201. }
  151202. declare module BABYLON {
  151203. /**
  151204. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151205. */
  151206. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151207. private _volumetricLightScatteringPass;
  151208. private _volumetricLightScatteringRTT;
  151209. private _viewPort;
  151210. private _screenCoordinates;
  151211. private _cachedDefines;
  151212. /**
  151213. * If not undefined, the mesh position is computed from the attached node position
  151214. */
  151215. attachedNode: {
  151216. position: Vector3;
  151217. };
  151218. /**
  151219. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151220. */
  151221. customMeshPosition: Vector3;
  151222. /**
  151223. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151224. */
  151225. useCustomMeshPosition: boolean;
  151226. /**
  151227. * If the post-process should inverse the light scattering direction
  151228. */
  151229. invert: boolean;
  151230. /**
  151231. * The internal mesh used by the post-process
  151232. */
  151233. mesh: Mesh;
  151234. /**
  151235. * @hidden
  151236. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151237. */
  151238. get useDiffuseColor(): boolean;
  151239. set useDiffuseColor(useDiffuseColor: boolean);
  151240. /**
  151241. * Array containing the excluded meshes not rendered in the internal pass
  151242. */
  151243. excludedMeshes: AbstractMesh[];
  151244. /**
  151245. * Controls the overall intensity of the post-process
  151246. */
  151247. exposure: number;
  151248. /**
  151249. * Dissipates each sample's contribution in range [0, 1]
  151250. */
  151251. decay: number;
  151252. /**
  151253. * Controls the overall intensity of each sample
  151254. */
  151255. weight: number;
  151256. /**
  151257. * Controls the density of each sample
  151258. */
  151259. density: number;
  151260. /**
  151261. * @constructor
  151262. * @param name The post-process name
  151263. * @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)
  151264. * @param camera The camera that the post-process will be attached to
  151265. * @param mesh The mesh used to create the light scattering
  151266. * @param samples The post-process quality, default 100
  151267. * @param samplingModeThe post-process filtering mode
  151268. * @param engine The babylon engine
  151269. * @param reusable If the post-process is reusable
  151270. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151271. */
  151272. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151273. /**
  151274. * Returns the string "VolumetricLightScatteringPostProcess"
  151275. * @returns "VolumetricLightScatteringPostProcess"
  151276. */
  151277. getClassName(): string;
  151278. private _isReady;
  151279. /**
  151280. * Sets the new light position for light scattering effect
  151281. * @param position The new custom light position
  151282. */
  151283. setCustomMeshPosition(position: Vector3): void;
  151284. /**
  151285. * Returns the light position for light scattering effect
  151286. * @return Vector3 The custom light position
  151287. */
  151288. getCustomMeshPosition(): Vector3;
  151289. /**
  151290. * Disposes the internal assets and detaches the post-process from the camera
  151291. */
  151292. dispose(camera: Camera): void;
  151293. /**
  151294. * Returns the render target texture used by the post-process
  151295. * @return the render target texture used by the post-process
  151296. */
  151297. getPass(): RenderTargetTexture;
  151298. private _meshExcluded;
  151299. private _createPass;
  151300. private _updateMeshScreenCoordinates;
  151301. /**
  151302. * Creates a default mesh for the Volumeric Light Scattering post-process
  151303. * @param name The mesh name
  151304. * @param scene The scene where to create the mesh
  151305. * @return the default mesh
  151306. */
  151307. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151308. }
  151309. }
  151310. declare module BABYLON {
  151311. /** @hidden */
  151312. export var screenSpaceCurvaturePixelShader: {
  151313. name: string;
  151314. shader: string;
  151315. };
  151316. }
  151317. declare module BABYLON {
  151318. /**
  151319. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151320. */
  151321. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151322. /**
  151323. * Defines how much ridge the curvature effect displays.
  151324. */
  151325. ridge: number;
  151326. /**
  151327. * Defines how much valley the curvature effect displays.
  151328. */
  151329. valley: number;
  151330. private _geometryBufferRenderer;
  151331. /**
  151332. * Gets a string identifying the name of the class
  151333. * @returns "ScreenSpaceCurvaturePostProcess" string
  151334. */
  151335. getClassName(): string;
  151336. /**
  151337. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151338. * @param name The name of the effect.
  151339. * @param scene The scene containing the objects to blur according to their velocity.
  151340. * @param options The required width/height ratio to downsize to before computing the render pass.
  151341. * @param camera The camera to apply the render pass to.
  151342. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151343. * @param engine The engine which the post process will be applied. (default: current engine)
  151344. * @param reusable If the post process can be reused on the same frame. (default: false)
  151345. * @param textureType Type of textures used when performing the post process. (default: 0)
  151346. * @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)
  151347. */
  151348. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151349. /**
  151350. * Support test.
  151351. */
  151352. static get IsSupported(): boolean;
  151353. /** @hidden */
  151354. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151355. }
  151356. }
  151357. declare module BABYLON {
  151358. interface Scene {
  151359. /** @hidden (Backing field) */
  151360. _boundingBoxRenderer: BoundingBoxRenderer;
  151361. /** @hidden (Backing field) */
  151362. _forceShowBoundingBoxes: boolean;
  151363. /**
  151364. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151365. */
  151366. forceShowBoundingBoxes: boolean;
  151367. /**
  151368. * Gets the bounding box renderer associated with the scene
  151369. * @returns a BoundingBoxRenderer
  151370. */
  151371. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151372. }
  151373. interface AbstractMesh {
  151374. /** @hidden (Backing field) */
  151375. _showBoundingBox: boolean;
  151376. /**
  151377. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151378. */
  151379. showBoundingBox: boolean;
  151380. }
  151381. /**
  151382. * Component responsible of rendering the bounding box of the meshes in a scene.
  151383. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151384. */
  151385. export class BoundingBoxRenderer implements ISceneComponent {
  151386. /**
  151387. * The component name helpfull to identify the component in the list of scene components.
  151388. */
  151389. readonly name: string;
  151390. /**
  151391. * The scene the component belongs to.
  151392. */
  151393. scene: Scene;
  151394. /**
  151395. * Color of the bounding box lines placed in front of an object
  151396. */
  151397. frontColor: Color3;
  151398. /**
  151399. * Color of the bounding box lines placed behind an object
  151400. */
  151401. backColor: Color3;
  151402. /**
  151403. * Defines if the renderer should show the back lines or not
  151404. */
  151405. showBackLines: boolean;
  151406. /**
  151407. * Observable raised before rendering a bounding box
  151408. */
  151409. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151410. /**
  151411. * Observable raised after rendering a bounding box
  151412. */
  151413. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151414. /**
  151415. * @hidden
  151416. */
  151417. renderList: SmartArray<BoundingBox>;
  151418. private _colorShader;
  151419. private _vertexBuffers;
  151420. private _indexBuffer;
  151421. private _fillIndexBuffer;
  151422. private _fillIndexData;
  151423. /**
  151424. * Instantiates a new bounding box renderer in a scene.
  151425. * @param scene the scene the renderer renders in
  151426. */
  151427. constructor(scene: Scene);
  151428. /**
  151429. * Registers the component in a given scene
  151430. */
  151431. register(): void;
  151432. private _evaluateSubMesh;
  151433. private _activeMesh;
  151434. private _prepareRessources;
  151435. private _createIndexBuffer;
  151436. /**
  151437. * Rebuilds the elements related to this component in case of
  151438. * context lost for instance.
  151439. */
  151440. rebuild(): void;
  151441. /**
  151442. * @hidden
  151443. */
  151444. reset(): void;
  151445. /**
  151446. * Render the bounding boxes of a specific rendering group
  151447. * @param renderingGroupId defines the rendering group to render
  151448. */
  151449. render(renderingGroupId: number): void;
  151450. /**
  151451. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151452. * @param mesh Define the mesh to render the occlusion bounding box for
  151453. */
  151454. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151455. /**
  151456. * Dispose and release the resources attached to this renderer.
  151457. */
  151458. dispose(): void;
  151459. }
  151460. }
  151461. declare module BABYLON {
  151462. interface Scene {
  151463. /** @hidden (Backing field) */
  151464. _depthRenderer: {
  151465. [id: string]: DepthRenderer;
  151466. };
  151467. /**
  151468. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151469. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151470. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151471. * @returns the created depth renderer
  151472. */
  151473. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151474. /**
  151475. * Disables a depth renderer for a given camera
  151476. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151477. */
  151478. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151479. }
  151480. /**
  151481. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151482. * in several rendering techniques.
  151483. */
  151484. export class DepthRendererSceneComponent implements ISceneComponent {
  151485. /**
  151486. * The component name helpfull to identify the component in the list of scene components.
  151487. */
  151488. readonly name: string;
  151489. /**
  151490. * The scene the component belongs to.
  151491. */
  151492. scene: Scene;
  151493. /**
  151494. * Creates a new instance of the component for the given scene
  151495. * @param scene Defines the scene to register the component in
  151496. */
  151497. constructor(scene: Scene);
  151498. /**
  151499. * Registers the component in a given scene
  151500. */
  151501. register(): void;
  151502. /**
  151503. * Rebuilds the elements related to this component in case of
  151504. * context lost for instance.
  151505. */
  151506. rebuild(): void;
  151507. /**
  151508. * Disposes the component and the associated ressources
  151509. */
  151510. dispose(): void;
  151511. private _gatherRenderTargets;
  151512. private _gatherActiveCameraRenderTargets;
  151513. }
  151514. }
  151515. declare module BABYLON {
  151516. interface AbstractScene {
  151517. /** @hidden (Backing field) */
  151518. _prePassRenderer: Nullable<PrePassRenderer>;
  151519. /**
  151520. * Gets or Sets the current prepass renderer associated to the scene.
  151521. */
  151522. prePassRenderer: Nullable<PrePassRenderer>;
  151523. /**
  151524. * Enables the prepass and associates it with the scene
  151525. * @returns the PrePassRenderer
  151526. */
  151527. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151528. /**
  151529. * Disables the prepass associated with the scene
  151530. */
  151531. disablePrePassRenderer(): void;
  151532. }
  151533. /**
  151534. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151535. * in several rendering techniques.
  151536. */
  151537. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151538. /**
  151539. * The component name helpful to identify the component in the list of scene components.
  151540. */
  151541. readonly name: string;
  151542. /**
  151543. * The scene the component belongs to.
  151544. */
  151545. scene: Scene;
  151546. /**
  151547. * Creates a new instance of the component for the given scene
  151548. * @param scene Defines the scene to register the component in
  151549. */
  151550. constructor(scene: Scene);
  151551. /**
  151552. * Registers the component in a given scene
  151553. */
  151554. register(): void;
  151555. private _beforeCameraDraw;
  151556. private _afterCameraDraw;
  151557. private _beforeClearStage;
  151558. /**
  151559. * Serializes the component data to the specified json object
  151560. * @param serializationObject The object to serialize to
  151561. */
  151562. serialize(serializationObject: any): void;
  151563. /**
  151564. * Adds all the elements from the container to the scene
  151565. * @param container the container holding the elements
  151566. */
  151567. addFromContainer(container: AbstractScene): void;
  151568. /**
  151569. * Removes all the elements in the container from the scene
  151570. * @param container contains the elements to remove
  151571. * @param dispose if the removed element should be disposed (default: false)
  151572. */
  151573. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151574. /**
  151575. * Rebuilds the elements related to this component in case of
  151576. * context lost for instance.
  151577. */
  151578. rebuild(): void;
  151579. /**
  151580. * Disposes the component and the associated ressources
  151581. */
  151582. dispose(): void;
  151583. }
  151584. }
  151585. declare module BABYLON {
  151586. /** @hidden */
  151587. export var outlinePixelShader: {
  151588. name: string;
  151589. shader: string;
  151590. };
  151591. }
  151592. declare module BABYLON {
  151593. /** @hidden */
  151594. export var outlineVertexShader: {
  151595. name: string;
  151596. shader: string;
  151597. };
  151598. }
  151599. declare module BABYLON {
  151600. interface Scene {
  151601. /** @hidden */
  151602. _outlineRenderer: OutlineRenderer;
  151603. /**
  151604. * Gets the outline renderer associated with the scene
  151605. * @returns a OutlineRenderer
  151606. */
  151607. getOutlineRenderer(): OutlineRenderer;
  151608. }
  151609. interface AbstractMesh {
  151610. /** @hidden (Backing field) */
  151611. _renderOutline: boolean;
  151612. /**
  151613. * Gets or sets a boolean indicating if the outline must be rendered as well
  151614. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151615. */
  151616. renderOutline: boolean;
  151617. /** @hidden (Backing field) */
  151618. _renderOverlay: boolean;
  151619. /**
  151620. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151621. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151622. */
  151623. renderOverlay: boolean;
  151624. }
  151625. /**
  151626. * This class is responsible to draw bothe outline/overlay of meshes.
  151627. * It should not be used directly but through the available method on mesh.
  151628. */
  151629. export class OutlineRenderer implements ISceneComponent {
  151630. /**
  151631. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151632. */
  151633. private static _StencilReference;
  151634. /**
  151635. * The name of the component. Each component must have a unique name.
  151636. */
  151637. name: string;
  151638. /**
  151639. * The scene the component belongs to.
  151640. */
  151641. scene: Scene;
  151642. /**
  151643. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151644. */
  151645. zOffset: number;
  151646. private _engine;
  151647. private _effect;
  151648. private _cachedDefines;
  151649. private _savedDepthWrite;
  151650. /**
  151651. * Instantiates a new outline renderer. (There could be only one per scene).
  151652. * @param scene Defines the scene it belongs to
  151653. */
  151654. constructor(scene: Scene);
  151655. /**
  151656. * Register the component to one instance of a scene.
  151657. */
  151658. register(): void;
  151659. /**
  151660. * Rebuilds the elements related to this component in case of
  151661. * context lost for instance.
  151662. */
  151663. rebuild(): void;
  151664. /**
  151665. * Disposes the component and the associated ressources.
  151666. */
  151667. dispose(): void;
  151668. /**
  151669. * Renders the outline in the canvas.
  151670. * @param subMesh Defines the sumesh to render
  151671. * @param batch Defines the batch of meshes in case of instances
  151672. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151673. */
  151674. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151675. /**
  151676. * Returns whether or not the outline renderer is ready for a given submesh.
  151677. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151678. * @param subMesh Defines the submesh to check readyness for
  151679. * @param useInstances Defines wheter wee are trying to render instances or not
  151680. * @returns true if ready otherwise false
  151681. */
  151682. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151683. private _beforeRenderingMesh;
  151684. private _afterRenderingMesh;
  151685. }
  151686. }
  151687. declare module BABYLON {
  151688. /**
  151689. * Defines the basic options interface of a Sprite Frame Source Size.
  151690. */
  151691. export interface ISpriteJSONSpriteSourceSize {
  151692. /**
  151693. * number of the original width of the Frame
  151694. */
  151695. w: number;
  151696. /**
  151697. * number of the original height of the Frame
  151698. */
  151699. h: number;
  151700. }
  151701. /**
  151702. * Defines the basic options interface of a Sprite Frame Data.
  151703. */
  151704. export interface ISpriteJSONSpriteFrameData {
  151705. /**
  151706. * number of the x offset of the Frame
  151707. */
  151708. x: number;
  151709. /**
  151710. * number of the y offset of the Frame
  151711. */
  151712. y: number;
  151713. /**
  151714. * number of the width of the Frame
  151715. */
  151716. w: number;
  151717. /**
  151718. * number of the height of the Frame
  151719. */
  151720. h: number;
  151721. }
  151722. /**
  151723. * Defines the basic options interface of a JSON Sprite.
  151724. */
  151725. export interface ISpriteJSONSprite {
  151726. /**
  151727. * string name of the Frame
  151728. */
  151729. filename: string;
  151730. /**
  151731. * ISpriteJSONSpriteFrame basic object of the frame data
  151732. */
  151733. frame: ISpriteJSONSpriteFrameData;
  151734. /**
  151735. * boolean to flag is the frame was rotated.
  151736. */
  151737. rotated: boolean;
  151738. /**
  151739. * boolean to flag is the frame was trimmed.
  151740. */
  151741. trimmed: boolean;
  151742. /**
  151743. * ISpriteJSONSpriteFrame basic object of the source data
  151744. */
  151745. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151746. /**
  151747. * ISpriteJSONSpriteFrame basic object of the source data
  151748. */
  151749. sourceSize: ISpriteJSONSpriteSourceSize;
  151750. }
  151751. /**
  151752. * Defines the basic options interface of a JSON atlas.
  151753. */
  151754. export interface ISpriteJSONAtlas {
  151755. /**
  151756. * Array of objects that contain the frame data.
  151757. */
  151758. frames: Array<ISpriteJSONSprite>;
  151759. /**
  151760. * object basic object containing the sprite meta data.
  151761. */
  151762. meta?: object;
  151763. }
  151764. }
  151765. declare module BABYLON {
  151766. /** @hidden */
  151767. export var spriteMapPixelShader: {
  151768. name: string;
  151769. shader: string;
  151770. };
  151771. }
  151772. declare module BABYLON {
  151773. /** @hidden */
  151774. export var spriteMapVertexShader: {
  151775. name: string;
  151776. shader: string;
  151777. };
  151778. }
  151779. declare module BABYLON {
  151780. /**
  151781. * Defines the basic options interface of a SpriteMap
  151782. */
  151783. export interface ISpriteMapOptions {
  151784. /**
  151785. * Vector2 of the number of cells in the grid.
  151786. */
  151787. stageSize?: Vector2;
  151788. /**
  151789. * Vector2 of the size of the output plane in World Units.
  151790. */
  151791. outputSize?: Vector2;
  151792. /**
  151793. * Vector3 of the position of the output plane in World Units.
  151794. */
  151795. outputPosition?: Vector3;
  151796. /**
  151797. * Vector3 of the rotation of the output plane.
  151798. */
  151799. outputRotation?: Vector3;
  151800. /**
  151801. * number of layers that the system will reserve in resources.
  151802. */
  151803. layerCount?: number;
  151804. /**
  151805. * number of max animation frames a single cell will reserve in resources.
  151806. */
  151807. maxAnimationFrames?: number;
  151808. /**
  151809. * number cell index of the base tile when the system compiles.
  151810. */
  151811. baseTile?: number;
  151812. /**
  151813. * boolean flip the sprite after its been repositioned by the framing data.
  151814. */
  151815. flipU?: boolean;
  151816. /**
  151817. * Vector3 scalar of the global RGB values of the SpriteMap.
  151818. */
  151819. colorMultiply?: Vector3;
  151820. }
  151821. /**
  151822. * Defines the IDisposable interface in order to be cleanable from resources.
  151823. */
  151824. export interface ISpriteMap extends IDisposable {
  151825. /**
  151826. * String name of the SpriteMap.
  151827. */
  151828. name: string;
  151829. /**
  151830. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151831. */
  151832. atlasJSON: ISpriteJSONAtlas;
  151833. /**
  151834. * Texture of the SpriteMap.
  151835. */
  151836. spriteSheet: Texture;
  151837. /**
  151838. * The parameters to initialize the SpriteMap with.
  151839. */
  151840. options: ISpriteMapOptions;
  151841. }
  151842. /**
  151843. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151844. */
  151845. export class SpriteMap implements ISpriteMap {
  151846. /** The Name of the spriteMap */
  151847. name: string;
  151848. /** The JSON file with the frame and meta data */
  151849. atlasJSON: ISpriteJSONAtlas;
  151850. /** The systems Sprite Sheet Texture */
  151851. spriteSheet: Texture;
  151852. /** Arguments passed with the Constructor */
  151853. options: ISpriteMapOptions;
  151854. /** Public Sprite Storage array, parsed from atlasJSON */
  151855. sprites: Array<ISpriteJSONSprite>;
  151856. /** Returns the Number of Sprites in the System */
  151857. get spriteCount(): number;
  151858. /** Returns the Position of Output Plane*/
  151859. get position(): Vector3;
  151860. /** Returns the Position of Output Plane*/
  151861. set position(v: Vector3);
  151862. /** Returns the Rotation of Output Plane*/
  151863. get rotation(): Vector3;
  151864. /** Returns the Rotation of Output Plane*/
  151865. set rotation(v: Vector3);
  151866. /** Sets the AnimationMap*/
  151867. get animationMap(): RawTexture;
  151868. /** Sets the AnimationMap*/
  151869. set animationMap(v: RawTexture);
  151870. /** Scene that the SpriteMap was created in */
  151871. private _scene;
  151872. /** Texture Buffer of Float32 that holds tile frame data*/
  151873. private _frameMap;
  151874. /** Texture Buffers of Float32 that holds tileMap data*/
  151875. private _tileMaps;
  151876. /** Texture Buffer of Float32 that holds Animation Data*/
  151877. private _animationMap;
  151878. /** Custom ShaderMaterial Central to the System*/
  151879. private _material;
  151880. /** Custom ShaderMaterial Central to the System*/
  151881. private _output;
  151882. /** Systems Time Ticker*/
  151883. private _time;
  151884. /**
  151885. * Creates a new SpriteMap
  151886. * @param name defines the SpriteMaps Name
  151887. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151888. * @param spriteSheet is the Texture that the Sprites are on.
  151889. * @param options a basic deployment configuration
  151890. * @param scene The Scene that the map is deployed on
  151891. */
  151892. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151893. /**
  151894. * Returns tileID location
  151895. * @returns Vector2 the cell position ID
  151896. */
  151897. getTileID(): Vector2;
  151898. /**
  151899. * Gets the UV location of the mouse over the SpriteMap.
  151900. * @returns Vector2 the UV position of the mouse interaction
  151901. */
  151902. getMousePosition(): Vector2;
  151903. /**
  151904. * Creates the "frame" texture Buffer
  151905. * -------------------------------------
  151906. * Structure of frames
  151907. * "filename": "Falling-Water-2.png",
  151908. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151909. * "rotated": true,
  151910. * "trimmed": true,
  151911. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151912. * "sourceSize": {"w":32,"h":32}
  151913. * @returns RawTexture of the frameMap
  151914. */
  151915. private _createFrameBuffer;
  151916. /**
  151917. * Creates the tileMap texture Buffer
  151918. * @param buffer normally and array of numbers, or a false to generate from scratch
  151919. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151920. * @returns RawTexture of the tileMap
  151921. */
  151922. private _createTileBuffer;
  151923. /**
  151924. * Modifies the data of the tileMaps
  151925. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151926. * @param pos is the iVector2 Coordinates of the Tile
  151927. * @param tile The SpriteIndex of the new Tile
  151928. */
  151929. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151930. /**
  151931. * Creates the animationMap texture Buffer
  151932. * @param buffer normally and array of numbers, or a false to generate from scratch
  151933. * @returns RawTexture of the animationMap
  151934. */
  151935. private _createTileAnimationBuffer;
  151936. /**
  151937. * Modifies the data of the animationMap
  151938. * @param cellID is the Index of the Sprite
  151939. * @param _frame is the target Animation frame
  151940. * @param toCell is the Target Index of the next frame of the animation
  151941. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151942. * @param speed is a global scalar of the time variable on the map.
  151943. */
  151944. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151945. /**
  151946. * Exports the .tilemaps file
  151947. */
  151948. saveTileMaps(): void;
  151949. /**
  151950. * Imports the .tilemaps file
  151951. * @param url of the .tilemaps file
  151952. */
  151953. loadTileMaps(url: string): void;
  151954. /**
  151955. * Release associated resources
  151956. */
  151957. dispose(): void;
  151958. }
  151959. }
  151960. declare module BABYLON {
  151961. /**
  151962. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151963. * @see https://doc.babylonjs.com/babylon101/sprites
  151964. */
  151965. export class SpritePackedManager extends SpriteManager {
  151966. /** defines the packed manager's name */
  151967. name: string;
  151968. /**
  151969. * Creates a new sprite manager from a packed sprite sheet
  151970. * @param name defines the manager's name
  151971. * @param imgUrl defines the sprite sheet url
  151972. * @param capacity defines the maximum allowed number of sprites
  151973. * @param scene defines the hosting scene
  151974. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151975. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151976. * @param samplingMode defines the smapling mode to use with spritesheet
  151977. * @param fromPacked set to true; do not alter
  151978. */
  151979. constructor(
  151980. /** defines the packed manager's name */
  151981. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151982. }
  151983. }
  151984. declare module BABYLON {
  151985. /**
  151986. * Defines the list of states available for a task inside a AssetsManager
  151987. */
  151988. export enum AssetTaskState {
  151989. /**
  151990. * Initialization
  151991. */
  151992. INIT = 0,
  151993. /**
  151994. * Running
  151995. */
  151996. RUNNING = 1,
  151997. /**
  151998. * Done
  151999. */
  152000. DONE = 2,
  152001. /**
  152002. * Error
  152003. */
  152004. ERROR = 3
  152005. }
  152006. /**
  152007. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  152008. */
  152009. export abstract class AbstractAssetTask {
  152010. /**
  152011. * Task name
  152012. */ name: string;
  152013. /**
  152014. * Callback called when the task is successful
  152015. */
  152016. onSuccess: (task: any) => void;
  152017. /**
  152018. * Callback called when the task is not successful
  152019. */
  152020. onError: (task: any, message?: string, exception?: any) => void;
  152021. /**
  152022. * Creates a new AssetsManager
  152023. * @param name defines the name of the task
  152024. */
  152025. constructor(
  152026. /**
  152027. * Task name
  152028. */ name: string);
  152029. private _isCompleted;
  152030. private _taskState;
  152031. private _errorObject;
  152032. /**
  152033. * Get if the task is completed
  152034. */
  152035. get isCompleted(): boolean;
  152036. /**
  152037. * Gets the current state of the task
  152038. */
  152039. get taskState(): AssetTaskState;
  152040. /**
  152041. * Gets the current error object (if task is in error)
  152042. */
  152043. get errorObject(): {
  152044. message?: string;
  152045. exception?: any;
  152046. };
  152047. /**
  152048. * Internal only
  152049. * @hidden
  152050. */
  152051. _setErrorObject(message?: string, exception?: any): void;
  152052. /**
  152053. * Execute the current task
  152054. * @param scene defines the scene where you want your assets to be loaded
  152055. * @param onSuccess is a callback called when the task is successfully executed
  152056. * @param onError is a callback called if an error occurs
  152057. */
  152058. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152059. /**
  152060. * Execute the current task
  152061. * @param scene defines the scene where you want your assets to be loaded
  152062. * @param onSuccess is a callback called when the task is successfully executed
  152063. * @param onError is a callback called if an error occurs
  152064. */
  152065. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152066. /**
  152067. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152068. * This can be used with failed tasks that have the reason for failure fixed.
  152069. */
  152070. reset(): void;
  152071. private onErrorCallback;
  152072. private onDoneCallback;
  152073. }
  152074. /**
  152075. * Define the interface used by progress events raised during assets loading
  152076. */
  152077. export interface IAssetsProgressEvent {
  152078. /**
  152079. * Defines the number of remaining tasks to process
  152080. */
  152081. remainingCount: number;
  152082. /**
  152083. * Defines the total number of tasks
  152084. */
  152085. totalCount: number;
  152086. /**
  152087. * Defines the task that was just processed
  152088. */
  152089. task: AbstractAssetTask;
  152090. }
  152091. /**
  152092. * Class used to share progress information about assets loading
  152093. */
  152094. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152095. /**
  152096. * Defines the number of remaining tasks to process
  152097. */
  152098. remainingCount: number;
  152099. /**
  152100. * Defines the total number of tasks
  152101. */
  152102. totalCount: number;
  152103. /**
  152104. * Defines the task that was just processed
  152105. */
  152106. task: AbstractAssetTask;
  152107. /**
  152108. * Creates a AssetsProgressEvent
  152109. * @param remainingCount defines the number of remaining tasks to process
  152110. * @param totalCount defines the total number of tasks
  152111. * @param task defines the task that was just processed
  152112. */
  152113. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152114. }
  152115. /**
  152116. * Define a task used by AssetsManager to load assets into a container
  152117. */
  152118. export class ContainerAssetTask extends AbstractAssetTask {
  152119. /**
  152120. * Defines the name of the task
  152121. */
  152122. name: string;
  152123. /**
  152124. * Defines the list of mesh's names you want to load
  152125. */
  152126. meshesNames: any;
  152127. /**
  152128. * Defines the root url to use as a base to load your meshes and associated resources
  152129. */
  152130. rootUrl: string;
  152131. /**
  152132. * Defines the filename or File of the scene to load from
  152133. */
  152134. sceneFilename: string | File;
  152135. /**
  152136. * Get the loaded asset container
  152137. */
  152138. loadedContainer: AssetContainer;
  152139. /**
  152140. * Gets the list of loaded meshes
  152141. */
  152142. loadedMeshes: Array<AbstractMesh>;
  152143. /**
  152144. * Gets the list of loaded particle systems
  152145. */
  152146. loadedParticleSystems: Array<IParticleSystem>;
  152147. /**
  152148. * Gets the list of loaded skeletons
  152149. */
  152150. loadedSkeletons: Array<Skeleton>;
  152151. /**
  152152. * Gets the list of loaded animation groups
  152153. */
  152154. loadedAnimationGroups: Array<AnimationGroup>;
  152155. /**
  152156. * Callback called when the task is successful
  152157. */
  152158. onSuccess: (task: ContainerAssetTask) => void;
  152159. /**
  152160. * Callback called when the task is successful
  152161. */
  152162. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152163. /**
  152164. * Creates a new ContainerAssetTask
  152165. * @param name defines the name of the task
  152166. * @param meshesNames defines the list of mesh's names you want to load
  152167. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152168. * @param sceneFilename defines the filename or File of the scene to load from
  152169. */
  152170. constructor(
  152171. /**
  152172. * Defines the name of the task
  152173. */
  152174. name: string,
  152175. /**
  152176. * Defines the list of mesh's names you want to load
  152177. */
  152178. meshesNames: any,
  152179. /**
  152180. * Defines the root url to use as a base to load your meshes and associated resources
  152181. */
  152182. rootUrl: string,
  152183. /**
  152184. * Defines the filename or File of the scene to load from
  152185. */
  152186. sceneFilename: string | File);
  152187. /**
  152188. * Execute the current task
  152189. * @param scene defines the scene where you want your assets to be loaded
  152190. * @param onSuccess is a callback called when the task is successfully executed
  152191. * @param onError is a callback called if an error occurs
  152192. */
  152193. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152194. }
  152195. /**
  152196. * Define a task used by AssetsManager to load meshes
  152197. */
  152198. export class MeshAssetTask extends AbstractAssetTask {
  152199. /**
  152200. * Defines the name of the task
  152201. */
  152202. name: string;
  152203. /**
  152204. * Defines the list of mesh's names you want to load
  152205. */
  152206. meshesNames: any;
  152207. /**
  152208. * Defines the root url to use as a base to load your meshes and associated resources
  152209. */
  152210. rootUrl: string;
  152211. /**
  152212. * Defines the filename or File of the scene to load from
  152213. */
  152214. sceneFilename: string | File;
  152215. /**
  152216. * Gets the list of loaded meshes
  152217. */
  152218. loadedMeshes: Array<AbstractMesh>;
  152219. /**
  152220. * Gets the list of loaded particle systems
  152221. */
  152222. loadedParticleSystems: Array<IParticleSystem>;
  152223. /**
  152224. * Gets the list of loaded skeletons
  152225. */
  152226. loadedSkeletons: Array<Skeleton>;
  152227. /**
  152228. * Gets the list of loaded animation groups
  152229. */
  152230. loadedAnimationGroups: Array<AnimationGroup>;
  152231. /**
  152232. * Callback called when the task is successful
  152233. */
  152234. onSuccess: (task: MeshAssetTask) => void;
  152235. /**
  152236. * Callback called when the task is successful
  152237. */
  152238. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152239. /**
  152240. * Creates a new MeshAssetTask
  152241. * @param name defines the name of the task
  152242. * @param meshesNames defines the list of mesh's names you want to load
  152243. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152244. * @param sceneFilename defines the filename or File of the scene to load from
  152245. */
  152246. constructor(
  152247. /**
  152248. * Defines the name of the task
  152249. */
  152250. name: string,
  152251. /**
  152252. * Defines the list of mesh's names you want to load
  152253. */
  152254. meshesNames: any,
  152255. /**
  152256. * Defines the root url to use as a base to load your meshes and associated resources
  152257. */
  152258. rootUrl: string,
  152259. /**
  152260. * Defines the filename or File of the scene to load from
  152261. */
  152262. sceneFilename: string | File);
  152263. /**
  152264. * Execute the current task
  152265. * @param scene defines the scene where you want your assets to be loaded
  152266. * @param onSuccess is a callback called when the task is successfully executed
  152267. * @param onError is a callback called if an error occurs
  152268. */
  152269. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152270. }
  152271. /**
  152272. * Define a task used by AssetsManager to load text content
  152273. */
  152274. export class TextFileAssetTask extends AbstractAssetTask {
  152275. /**
  152276. * Defines the name of the task
  152277. */
  152278. name: string;
  152279. /**
  152280. * Defines the location of the file to load
  152281. */
  152282. url: string;
  152283. /**
  152284. * Gets the loaded text string
  152285. */
  152286. text: string;
  152287. /**
  152288. * Callback called when the task is successful
  152289. */
  152290. onSuccess: (task: TextFileAssetTask) => void;
  152291. /**
  152292. * Callback called when the task is successful
  152293. */
  152294. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152295. /**
  152296. * Creates a new TextFileAssetTask object
  152297. * @param name defines the name of the task
  152298. * @param url defines the location of the file to load
  152299. */
  152300. constructor(
  152301. /**
  152302. * Defines the name of the task
  152303. */
  152304. name: string,
  152305. /**
  152306. * Defines the location of the file to load
  152307. */
  152308. url: string);
  152309. /**
  152310. * Execute the current task
  152311. * @param scene defines the scene where you want your assets to be loaded
  152312. * @param onSuccess is a callback called when the task is successfully executed
  152313. * @param onError is a callback called if an error occurs
  152314. */
  152315. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152316. }
  152317. /**
  152318. * Define a task used by AssetsManager to load binary data
  152319. */
  152320. export class BinaryFileAssetTask extends AbstractAssetTask {
  152321. /**
  152322. * Defines the name of the task
  152323. */
  152324. name: string;
  152325. /**
  152326. * Defines the location of the file to load
  152327. */
  152328. url: string;
  152329. /**
  152330. * Gets the lodaded data (as an array buffer)
  152331. */
  152332. data: ArrayBuffer;
  152333. /**
  152334. * Callback called when the task is successful
  152335. */
  152336. onSuccess: (task: BinaryFileAssetTask) => void;
  152337. /**
  152338. * Callback called when the task is successful
  152339. */
  152340. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152341. /**
  152342. * Creates a new BinaryFileAssetTask object
  152343. * @param name defines the name of the new task
  152344. * @param url defines the location of the file to load
  152345. */
  152346. constructor(
  152347. /**
  152348. * Defines the name of the task
  152349. */
  152350. name: string,
  152351. /**
  152352. * Defines the location of the file to load
  152353. */
  152354. url: string);
  152355. /**
  152356. * Execute the current task
  152357. * @param scene defines the scene where you want your assets to be loaded
  152358. * @param onSuccess is a callback called when the task is successfully executed
  152359. * @param onError is a callback called if an error occurs
  152360. */
  152361. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152362. }
  152363. /**
  152364. * Define a task used by AssetsManager to load images
  152365. */
  152366. export class ImageAssetTask extends AbstractAssetTask {
  152367. /**
  152368. * Defines the name of the task
  152369. */
  152370. name: string;
  152371. /**
  152372. * Defines the location of the image to load
  152373. */
  152374. url: string;
  152375. /**
  152376. * Gets the loaded images
  152377. */
  152378. image: HTMLImageElement;
  152379. /**
  152380. * Callback called when the task is successful
  152381. */
  152382. onSuccess: (task: ImageAssetTask) => void;
  152383. /**
  152384. * Callback called when the task is successful
  152385. */
  152386. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152387. /**
  152388. * Creates a new ImageAssetTask
  152389. * @param name defines the name of the task
  152390. * @param url defines the location of the image to load
  152391. */
  152392. constructor(
  152393. /**
  152394. * Defines the name of the task
  152395. */
  152396. name: string,
  152397. /**
  152398. * Defines the location of the image to load
  152399. */
  152400. url: string);
  152401. /**
  152402. * Execute the current task
  152403. * @param scene defines the scene where you want your assets to be loaded
  152404. * @param onSuccess is a callback called when the task is successfully executed
  152405. * @param onError is a callback called if an error occurs
  152406. */
  152407. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152408. }
  152409. /**
  152410. * Defines the interface used by texture loading tasks
  152411. */
  152412. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152413. /**
  152414. * Gets the loaded texture
  152415. */
  152416. texture: TEX;
  152417. }
  152418. /**
  152419. * Define a task used by AssetsManager to load 2D textures
  152420. */
  152421. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152422. /**
  152423. * Defines the name of the task
  152424. */
  152425. name: string;
  152426. /**
  152427. * Defines the location of the file to load
  152428. */
  152429. url: string;
  152430. /**
  152431. * Defines if mipmap should not be generated (default is false)
  152432. */
  152433. noMipmap?: boolean | undefined;
  152434. /**
  152435. * Defines if texture must be inverted on Y axis (default is true)
  152436. */
  152437. invertY: boolean;
  152438. /**
  152439. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152440. */
  152441. samplingMode: number;
  152442. /**
  152443. * Gets the loaded texture
  152444. */
  152445. texture: Texture;
  152446. /**
  152447. * Callback called when the task is successful
  152448. */
  152449. onSuccess: (task: TextureAssetTask) => void;
  152450. /**
  152451. * Callback called when the task is successful
  152452. */
  152453. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152454. /**
  152455. * Creates a new TextureAssetTask object
  152456. * @param name defines the name of the task
  152457. * @param url defines the location of the file to load
  152458. * @param noMipmap defines if mipmap should not be generated (default is false)
  152459. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152460. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152461. */
  152462. constructor(
  152463. /**
  152464. * Defines the name of the task
  152465. */
  152466. name: string,
  152467. /**
  152468. * Defines the location of the file to load
  152469. */
  152470. url: string,
  152471. /**
  152472. * Defines if mipmap should not be generated (default is false)
  152473. */
  152474. noMipmap?: boolean | undefined,
  152475. /**
  152476. * Defines if texture must be inverted on Y axis (default is true)
  152477. */
  152478. invertY?: boolean,
  152479. /**
  152480. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152481. */
  152482. samplingMode?: number);
  152483. /**
  152484. * Execute the current task
  152485. * @param scene defines the scene where you want your assets to be loaded
  152486. * @param onSuccess is a callback called when the task is successfully executed
  152487. * @param onError is a callback called if an error occurs
  152488. */
  152489. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152490. }
  152491. /**
  152492. * Define a task used by AssetsManager to load cube textures
  152493. */
  152494. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152495. /**
  152496. * Defines the name of the task
  152497. */
  152498. name: string;
  152499. /**
  152500. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152501. */
  152502. url: string;
  152503. /**
  152504. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152505. */
  152506. extensions?: string[] | undefined;
  152507. /**
  152508. * Defines if mipmaps should not be generated (default is false)
  152509. */
  152510. noMipmap?: boolean | undefined;
  152511. /**
  152512. * Defines the explicit list of files (undefined by default)
  152513. */
  152514. files?: string[] | undefined;
  152515. /**
  152516. * Gets the loaded texture
  152517. */
  152518. texture: CubeTexture;
  152519. /**
  152520. * Callback called when the task is successful
  152521. */
  152522. onSuccess: (task: CubeTextureAssetTask) => void;
  152523. /**
  152524. * Callback called when the task is successful
  152525. */
  152526. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152527. /**
  152528. * Creates a new CubeTextureAssetTask
  152529. * @param name defines the name of the task
  152530. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152531. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152532. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152533. * @param files defines the explicit list of files (undefined by default)
  152534. */
  152535. constructor(
  152536. /**
  152537. * Defines the name of the task
  152538. */
  152539. name: string,
  152540. /**
  152541. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152542. */
  152543. url: string,
  152544. /**
  152545. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152546. */
  152547. extensions?: string[] | undefined,
  152548. /**
  152549. * Defines if mipmaps should not be generated (default is false)
  152550. */
  152551. noMipmap?: boolean | undefined,
  152552. /**
  152553. * Defines the explicit list of files (undefined by default)
  152554. */
  152555. files?: string[] | undefined);
  152556. /**
  152557. * Execute the current task
  152558. * @param scene defines the scene where you want your assets to be loaded
  152559. * @param onSuccess is a callback called when the task is successfully executed
  152560. * @param onError is a callback called if an error occurs
  152561. */
  152562. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152563. }
  152564. /**
  152565. * Define a task used by AssetsManager to load HDR cube textures
  152566. */
  152567. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152568. /**
  152569. * Defines the name of the task
  152570. */
  152571. name: string;
  152572. /**
  152573. * Defines the location of the file to load
  152574. */
  152575. url: string;
  152576. /**
  152577. * Defines the desired size (the more it increases the longer the generation will be)
  152578. */
  152579. size: number;
  152580. /**
  152581. * Defines if mipmaps should not be generated (default is false)
  152582. */
  152583. noMipmap: boolean;
  152584. /**
  152585. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152586. */
  152587. generateHarmonics: boolean;
  152588. /**
  152589. * 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)
  152590. */
  152591. gammaSpace: boolean;
  152592. /**
  152593. * Internal Use Only
  152594. */
  152595. reserved: boolean;
  152596. /**
  152597. * Gets the loaded texture
  152598. */
  152599. texture: HDRCubeTexture;
  152600. /**
  152601. * Callback called when the task is successful
  152602. */
  152603. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152604. /**
  152605. * Callback called when the task is successful
  152606. */
  152607. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152608. /**
  152609. * Creates a new HDRCubeTextureAssetTask object
  152610. * @param name defines the name of the task
  152611. * @param url defines the location of the file to load
  152612. * @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.
  152613. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152614. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152615. * @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)
  152616. * @param reserved Internal use only
  152617. */
  152618. constructor(
  152619. /**
  152620. * Defines the name of the task
  152621. */
  152622. name: string,
  152623. /**
  152624. * Defines the location of the file to load
  152625. */
  152626. url: string,
  152627. /**
  152628. * Defines the desired size (the more it increases the longer the generation will be)
  152629. */
  152630. size: number,
  152631. /**
  152632. * Defines if mipmaps should not be generated (default is false)
  152633. */
  152634. noMipmap?: boolean,
  152635. /**
  152636. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152637. */
  152638. generateHarmonics?: boolean,
  152639. /**
  152640. * 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)
  152641. */
  152642. gammaSpace?: boolean,
  152643. /**
  152644. * Internal Use Only
  152645. */
  152646. reserved?: boolean);
  152647. /**
  152648. * Execute the current task
  152649. * @param scene defines the scene where you want your assets to be loaded
  152650. * @param onSuccess is a callback called when the task is successfully executed
  152651. * @param onError is a callback called if an error occurs
  152652. */
  152653. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152654. }
  152655. /**
  152656. * Define a task used by AssetsManager to load Equirectangular cube textures
  152657. */
  152658. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152659. /**
  152660. * Defines the name of the task
  152661. */
  152662. name: string;
  152663. /**
  152664. * Defines the location of the file to load
  152665. */
  152666. url: string;
  152667. /**
  152668. * Defines the desired size (the more it increases the longer the generation will be)
  152669. */
  152670. size: number;
  152671. /**
  152672. * Defines if mipmaps should not be generated (default is false)
  152673. */
  152674. noMipmap: boolean;
  152675. /**
  152676. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152677. * but the standard material would require them in Gamma space) (default is true)
  152678. */
  152679. gammaSpace: boolean;
  152680. /**
  152681. * Gets the loaded texture
  152682. */
  152683. texture: EquiRectangularCubeTexture;
  152684. /**
  152685. * Callback called when the task is successful
  152686. */
  152687. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152688. /**
  152689. * Callback called when the task is successful
  152690. */
  152691. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152692. /**
  152693. * Creates a new EquiRectangularCubeTextureAssetTask object
  152694. * @param name defines the name of the task
  152695. * @param url defines the location of the file to load
  152696. * @param size defines the desired size (the more it increases the longer the generation will be)
  152697. * If the size is omitted this implies you are using a preprocessed cubemap.
  152698. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152699. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152700. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152701. * (default is true)
  152702. */
  152703. constructor(
  152704. /**
  152705. * Defines the name of the task
  152706. */
  152707. name: string,
  152708. /**
  152709. * Defines the location of the file to load
  152710. */
  152711. url: string,
  152712. /**
  152713. * Defines the desired size (the more it increases the longer the generation will be)
  152714. */
  152715. size: number,
  152716. /**
  152717. * Defines if mipmaps should not be generated (default is false)
  152718. */
  152719. noMipmap?: boolean,
  152720. /**
  152721. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152722. * but the standard material would require them in Gamma space) (default is true)
  152723. */
  152724. gammaSpace?: boolean);
  152725. /**
  152726. * Execute the current task
  152727. * @param scene defines the scene where you want your assets to be loaded
  152728. * @param onSuccess is a callback called when the task is successfully executed
  152729. * @param onError is a callback called if an error occurs
  152730. */
  152731. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152732. }
  152733. /**
  152734. * This class can be used to easily import assets into a scene
  152735. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152736. */
  152737. export class AssetsManager {
  152738. private _scene;
  152739. private _isLoading;
  152740. protected _tasks: AbstractAssetTask[];
  152741. protected _waitingTasksCount: number;
  152742. protected _totalTasksCount: number;
  152743. /**
  152744. * Callback called when all tasks are processed
  152745. */
  152746. onFinish: (tasks: AbstractAssetTask[]) => void;
  152747. /**
  152748. * Callback called when a task is successful
  152749. */
  152750. onTaskSuccess: (task: AbstractAssetTask) => void;
  152751. /**
  152752. * Callback called when a task had an error
  152753. */
  152754. onTaskError: (task: AbstractAssetTask) => void;
  152755. /**
  152756. * Callback called when a task is done (whatever the result is)
  152757. */
  152758. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152759. /**
  152760. * Observable called when all tasks are processed
  152761. */
  152762. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152763. /**
  152764. * Observable called when a task had an error
  152765. */
  152766. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152767. /**
  152768. * Observable called when all tasks were executed
  152769. */
  152770. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152771. /**
  152772. * Observable called when a task is done (whatever the result is)
  152773. */
  152774. onProgressObservable: Observable<IAssetsProgressEvent>;
  152775. /**
  152776. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152777. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152778. */
  152779. useDefaultLoadingScreen: boolean;
  152780. /**
  152781. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152782. * when all assets have been downloaded.
  152783. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152784. */
  152785. autoHideLoadingUI: boolean;
  152786. /**
  152787. * Creates a new AssetsManager
  152788. * @param scene defines the scene to work on
  152789. */
  152790. constructor(scene: Scene);
  152791. /**
  152792. * Add a ContainerAssetTask to the list of active tasks
  152793. * @param taskName defines the name of the new task
  152794. * @param meshesNames defines the name of meshes to load
  152795. * @param rootUrl defines the root url to use to locate files
  152796. * @param sceneFilename defines the filename of the scene file
  152797. * @returns a new ContainerAssetTask object
  152798. */
  152799. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152800. /**
  152801. * Add a MeshAssetTask to the list of active tasks
  152802. * @param taskName defines the name of the new task
  152803. * @param meshesNames defines the name of meshes to load
  152804. * @param rootUrl defines the root url to use to locate files
  152805. * @param sceneFilename defines the filename of the scene file
  152806. * @returns a new MeshAssetTask object
  152807. */
  152808. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152809. /**
  152810. * Add a TextFileAssetTask to the list of active tasks
  152811. * @param taskName defines the name of the new task
  152812. * @param url defines the url of the file to load
  152813. * @returns a new TextFileAssetTask object
  152814. */
  152815. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152816. /**
  152817. * Add a BinaryFileAssetTask to the list of active tasks
  152818. * @param taskName defines the name of the new task
  152819. * @param url defines the url of the file to load
  152820. * @returns a new BinaryFileAssetTask object
  152821. */
  152822. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152823. /**
  152824. * Add a ImageAssetTask to the list of active tasks
  152825. * @param taskName defines the name of the new task
  152826. * @param url defines the url of the file to load
  152827. * @returns a new ImageAssetTask object
  152828. */
  152829. addImageTask(taskName: string, url: string): ImageAssetTask;
  152830. /**
  152831. * Add a TextureAssetTask to the list of active tasks
  152832. * @param taskName defines the name of the new task
  152833. * @param url defines the url of the file to load
  152834. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152835. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152836. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152837. * @returns a new TextureAssetTask object
  152838. */
  152839. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152840. /**
  152841. * Add a CubeTextureAssetTask to the list of active tasks
  152842. * @param taskName defines the name of the new task
  152843. * @param url defines the url of the file to load
  152844. * @param extensions defines the extension to use to load the cube map (can be null)
  152845. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152846. * @param files defines the list of files to load (can be null)
  152847. * @returns a new CubeTextureAssetTask object
  152848. */
  152849. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152850. /**
  152851. *
  152852. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152853. * @param taskName defines the name of the new task
  152854. * @param url defines the url of the file to load
  152855. * @param size defines the size you want for the cubemap (can be null)
  152856. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152857. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152858. * @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)
  152859. * @param reserved Internal use only
  152860. * @returns a new HDRCubeTextureAssetTask object
  152861. */
  152862. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152863. /**
  152864. *
  152865. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152866. * @param taskName defines the name of the new task
  152867. * @param url defines the url of the file to load
  152868. * @param size defines the size you want for the cubemap (can be null)
  152869. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152870. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152871. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152872. * @returns a new EquiRectangularCubeTextureAssetTask object
  152873. */
  152874. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152875. /**
  152876. * Remove a task from the assets manager.
  152877. * @param task the task to remove
  152878. */
  152879. removeTask(task: AbstractAssetTask): void;
  152880. private _decreaseWaitingTasksCount;
  152881. private _runTask;
  152882. /**
  152883. * Reset the AssetsManager and remove all tasks
  152884. * @return the current instance of the AssetsManager
  152885. */
  152886. reset(): AssetsManager;
  152887. /**
  152888. * Start the loading process
  152889. * @return the current instance of the AssetsManager
  152890. */
  152891. load(): AssetsManager;
  152892. /**
  152893. * Start the loading process as an async operation
  152894. * @return a promise returning the list of failed tasks
  152895. */
  152896. loadAsync(): Promise<void>;
  152897. }
  152898. }
  152899. declare module BABYLON {
  152900. /**
  152901. * Wrapper class for promise with external resolve and reject.
  152902. */
  152903. export class Deferred<T> {
  152904. /**
  152905. * The promise associated with this deferred object.
  152906. */
  152907. readonly promise: Promise<T>;
  152908. private _resolve;
  152909. private _reject;
  152910. /**
  152911. * The resolve method of the promise associated with this deferred object.
  152912. */
  152913. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152914. /**
  152915. * The reject method of the promise associated with this deferred object.
  152916. */
  152917. get reject(): (reason?: any) => void;
  152918. /**
  152919. * Constructor for this deferred object.
  152920. */
  152921. constructor();
  152922. }
  152923. }
  152924. declare module BABYLON {
  152925. /**
  152926. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152927. */
  152928. export class MeshExploder {
  152929. private _centerMesh;
  152930. private _meshes;
  152931. private _meshesOrigins;
  152932. private _toCenterVectors;
  152933. private _scaledDirection;
  152934. private _newPosition;
  152935. private _centerPosition;
  152936. /**
  152937. * Explodes meshes from a center mesh.
  152938. * @param meshes The meshes to explode.
  152939. * @param centerMesh The mesh to be center of explosion.
  152940. */
  152941. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152942. private _setCenterMesh;
  152943. /**
  152944. * Get class name
  152945. * @returns "MeshExploder"
  152946. */
  152947. getClassName(): string;
  152948. /**
  152949. * "Exploded meshes"
  152950. * @returns Array of meshes with the centerMesh at index 0.
  152951. */
  152952. getMeshes(): Array<Mesh>;
  152953. /**
  152954. * Explodes meshes giving a specific direction
  152955. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152956. */
  152957. explode(direction?: number): void;
  152958. }
  152959. }
  152960. declare module BABYLON {
  152961. /**
  152962. * Class used to help managing file picking and drag'n'drop
  152963. */
  152964. export class FilesInput {
  152965. /**
  152966. * List of files ready to be loaded
  152967. */
  152968. static get FilesToLoad(): {
  152969. [key: string]: File;
  152970. };
  152971. /**
  152972. * Callback called when a file is processed
  152973. */
  152974. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152975. private _engine;
  152976. private _currentScene;
  152977. private _sceneLoadedCallback;
  152978. private _progressCallback;
  152979. private _additionalRenderLoopLogicCallback;
  152980. private _textureLoadingCallback;
  152981. private _startingProcessingFilesCallback;
  152982. private _onReloadCallback;
  152983. private _errorCallback;
  152984. private _elementToMonitor;
  152985. private _sceneFileToLoad;
  152986. private _filesToLoad;
  152987. /**
  152988. * Creates a new FilesInput
  152989. * @param engine defines the rendering engine
  152990. * @param scene defines the hosting scene
  152991. * @param sceneLoadedCallback callback called when scene is loaded
  152992. * @param progressCallback callback called to track progress
  152993. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152994. * @param textureLoadingCallback callback called when a texture is loading
  152995. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152996. * @param onReloadCallback callback called when a reload is requested
  152997. * @param errorCallback callback call if an error occurs
  152998. */
  152999. 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>);
  153000. private _dragEnterHandler;
  153001. private _dragOverHandler;
  153002. private _dropHandler;
  153003. /**
  153004. * Calls this function to listen to drag'n'drop events on a specific DOM element
  153005. * @param elementToMonitor defines the DOM element to track
  153006. */
  153007. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  153008. /** Gets the current list of files to load */
  153009. get filesToLoad(): File[];
  153010. /**
  153011. * Release all associated resources
  153012. */
  153013. dispose(): void;
  153014. private renderFunction;
  153015. private drag;
  153016. private drop;
  153017. private _traverseFolder;
  153018. private _processFiles;
  153019. /**
  153020. * Load files from a drop event
  153021. * @param event defines the drop event to use as source
  153022. */
  153023. loadFiles(event: any): void;
  153024. private _processReload;
  153025. /**
  153026. * Reload the current scene from the loaded files
  153027. */
  153028. reload(): void;
  153029. }
  153030. }
  153031. declare module BABYLON {
  153032. /**
  153033. * Defines the root class used to create scene optimization to use with SceneOptimizer
  153034. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153035. */
  153036. export class SceneOptimization {
  153037. /**
  153038. * Defines the priority of this optimization (0 by default which means first in the list)
  153039. */
  153040. priority: number;
  153041. /**
  153042. * Gets a string describing the action executed by the current optimization
  153043. * @returns description string
  153044. */
  153045. getDescription(): string;
  153046. /**
  153047. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153048. * @param scene defines the current scene where to apply this optimization
  153049. * @param optimizer defines the current optimizer
  153050. * @returns true if everything that can be done was applied
  153051. */
  153052. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153053. /**
  153054. * Creates the SceneOptimization object
  153055. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153056. * @param desc defines the description associated with the optimization
  153057. */
  153058. constructor(
  153059. /**
  153060. * Defines the priority of this optimization (0 by default which means first in the list)
  153061. */
  153062. priority?: number);
  153063. }
  153064. /**
  153065. * Defines an optimization used to reduce the size of render target textures
  153066. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153067. */
  153068. export class TextureOptimization extends SceneOptimization {
  153069. /**
  153070. * Defines the priority of this optimization (0 by default which means first in the list)
  153071. */
  153072. priority: number;
  153073. /**
  153074. * 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
  153075. */
  153076. maximumSize: number;
  153077. /**
  153078. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153079. */
  153080. step: number;
  153081. /**
  153082. * Gets a string describing the action executed by the current optimization
  153083. * @returns description string
  153084. */
  153085. getDescription(): string;
  153086. /**
  153087. * Creates the TextureOptimization object
  153088. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153089. * @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
  153090. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153091. */
  153092. constructor(
  153093. /**
  153094. * Defines the priority of this optimization (0 by default which means first in the list)
  153095. */
  153096. priority?: number,
  153097. /**
  153098. * 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
  153099. */
  153100. maximumSize?: number,
  153101. /**
  153102. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153103. */
  153104. step?: number);
  153105. /**
  153106. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153107. * @param scene defines the current scene where to apply this optimization
  153108. * @param optimizer defines the current optimizer
  153109. * @returns true if everything that can be done was applied
  153110. */
  153111. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153112. }
  153113. /**
  153114. * Defines an optimization used to increase or decrease the rendering resolution
  153115. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153116. */
  153117. export class HardwareScalingOptimization extends SceneOptimization {
  153118. /**
  153119. * Defines the priority of this optimization (0 by default which means first in the list)
  153120. */
  153121. priority: number;
  153122. /**
  153123. * Defines the maximum scale to use (2 by default)
  153124. */
  153125. maximumScale: number;
  153126. /**
  153127. * Defines the step to use between two passes (0.5 by default)
  153128. */
  153129. step: number;
  153130. private _currentScale;
  153131. private _directionOffset;
  153132. /**
  153133. * Gets a string describing the action executed by the current optimization
  153134. * @return description string
  153135. */
  153136. getDescription(): string;
  153137. /**
  153138. * Creates the HardwareScalingOptimization object
  153139. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153140. * @param maximumScale defines the maximum scale to use (2 by default)
  153141. * @param step defines the step to use between two passes (0.5 by default)
  153142. */
  153143. constructor(
  153144. /**
  153145. * Defines the priority of this optimization (0 by default which means first in the list)
  153146. */
  153147. priority?: number,
  153148. /**
  153149. * Defines the maximum scale to use (2 by default)
  153150. */
  153151. maximumScale?: number,
  153152. /**
  153153. * Defines the step to use between two passes (0.5 by default)
  153154. */
  153155. step?: number);
  153156. /**
  153157. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153158. * @param scene defines the current scene where to apply this optimization
  153159. * @param optimizer defines the current optimizer
  153160. * @returns true if everything that can be done was applied
  153161. */
  153162. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153163. }
  153164. /**
  153165. * Defines an optimization used to remove shadows
  153166. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153167. */
  153168. export class ShadowsOptimization extends SceneOptimization {
  153169. /**
  153170. * Gets a string describing the action executed by the current optimization
  153171. * @return description string
  153172. */
  153173. getDescription(): string;
  153174. /**
  153175. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153176. * @param scene defines the current scene where to apply this optimization
  153177. * @param optimizer defines the current optimizer
  153178. * @returns true if everything that can be done was applied
  153179. */
  153180. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153181. }
  153182. /**
  153183. * Defines an optimization used to turn post-processes off
  153184. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153185. */
  153186. export class PostProcessesOptimization extends SceneOptimization {
  153187. /**
  153188. * Gets a string describing the action executed by the current optimization
  153189. * @return description string
  153190. */
  153191. getDescription(): string;
  153192. /**
  153193. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153194. * @param scene defines the current scene where to apply this optimization
  153195. * @param optimizer defines the current optimizer
  153196. * @returns true if everything that can be done was applied
  153197. */
  153198. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153199. }
  153200. /**
  153201. * Defines an optimization used to turn lens flares off
  153202. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153203. */
  153204. export class LensFlaresOptimization extends SceneOptimization {
  153205. /**
  153206. * Gets a string describing the action executed by the current optimization
  153207. * @return description string
  153208. */
  153209. getDescription(): string;
  153210. /**
  153211. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153212. * @param scene defines the current scene where to apply this optimization
  153213. * @param optimizer defines the current optimizer
  153214. * @returns true if everything that can be done was applied
  153215. */
  153216. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153217. }
  153218. /**
  153219. * Defines an optimization based on user defined callback.
  153220. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153221. */
  153222. export class CustomOptimization extends SceneOptimization {
  153223. /**
  153224. * Callback called to apply the custom optimization.
  153225. */
  153226. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153227. /**
  153228. * Callback called to get custom description
  153229. */
  153230. onGetDescription: () => string;
  153231. /**
  153232. * Gets a string describing the action executed by the current optimization
  153233. * @returns description string
  153234. */
  153235. getDescription(): string;
  153236. /**
  153237. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153238. * @param scene defines the current scene where to apply this optimization
  153239. * @param optimizer defines the current optimizer
  153240. * @returns true if everything that can be done was applied
  153241. */
  153242. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153243. }
  153244. /**
  153245. * Defines an optimization used to turn particles off
  153246. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153247. */
  153248. export class ParticlesOptimization extends SceneOptimization {
  153249. /**
  153250. * Gets a string describing the action executed by the current optimization
  153251. * @return description string
  153252. */
  153253. getDescription(): string;
  153254. /**
  153255. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153256. * @param scene defines the current scene where to apply this optimization
  153257. * @param optimizer defines the current optimizer
  153258. * @returns true if everything that can be done was applied
  153259. */
  153260. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153261. }
  153262. /**
  153263. * Defines an optimization used to turn render targets off
  153264. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153265. */
  153266. export class RenderTargetsOptimization extends SceneOptimization {
  153267. /**
  153268. * Gets a string describing the action executed by the current optimization
  153269. * @return description string
  153270. */
  153271. getDescription(): string;
  153272. /**
  153273. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153274. * @param scene defines the current scene where to apply this optimization
  153275. * @param optimizer defines the current optimizer
  153276. * @returns true if everything that can be done was applied
  153277. */
  153278. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153279. }
  153280. /**
  153281. * Defines an optimization used to merge meshes with compatible materials
  153282. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153283. */
  153284. export class MergeMeshesOptimization extends SceneOptimization {
  153285. private static _UpdateSelectionTree;
  153286. /**
  153287. * Gets or sets a boolean which defines if optimization octree has to be updated
  153288. */
  153289. static get UpdateSelectionTree(): boolean;
  153290. /**
  153291. * Gets or sets a boolean which defines if optimization octree has to be updated
  153292. */
  153293. static set UpdateSelectionTree(value: boolean);
  153294. /**
  153295. * Gets a string describing the action executed by the current optimization
  153296. * @return description string
  153297. */
  153298. getDescription(): string;
  153299. private _canBeMerged;
  153300. /**
  153301. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153302. * @param scene defines the current scene where to apply this optimization
  153303. * @param optimizer defines the current optimizer
  153304. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153305. * @returns true if everything that can be done was applied
  153306. */
  153307. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153308. }
  153309. /**
  153310. * Defines a list of options used by SceneOptimizer
  153311. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153312. */
  153313. export class SceneOptimizerOptions {
  153314. /**
  153315. * Defines the target frame rate to reach (60 by default)
  153316. */
  153317. targetFrameRate: number;
  153318. /**
  153319. * Defines the interval between two checkes (2000ms by default)
  153320. */
  153321. trackerDuration: number;
  153322. /**
  153323. * Gets the list of optimizations to apply
  153324. */
  153325. optimizations: SceneOptimization[];
  153326. /**
  153327. * Creates a new list of options used by SceneOptimizer
  153328. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153329. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153330. */
  153331. constructor(
  153332. /**
  153333. * Defines the target frame rate to reach (60 by default)
  153334. */
  153335. targetFrameRate?: number,
  153336. /**
  153337. * Defines the interval between two checkes (2000ms by default)
  153338. */
  153339. trackerDuration?: number);
  153340. /**
  153341. * Add a new optimization
  153342. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153343. * @returns the current SceneOptimizerOptions
  153344. */
  153345. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153346. /**
  153347. * Add a new custom optimization
  153348. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153349. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153350. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153351. * @returns the current SceneOptimizerOptions
  153352. */
  153353. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153354. /**
  153355. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153356. * @param targetFrameRate defines the target frame rate (60 by default)
  153357. * @returns a SceneOptimizerOptions object
  153358. */
  153359. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153360. /**
  153361. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153362. * @param targetFrameRate defines the target frame rate (60 by default)
  153363. * @returns a SceneOptimizerOptions object
  153364. */
  153365. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153366. /**
  153367. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153368. * @param targetFrameRate defines the target frame rate (60 by default)
  153369. * @returns a SceneOptimizerOptions object
  153370. */
  153371. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153372. }
  153373. /**
  153374. * Class used to run optimizations in order to reach a target frame rate
  153375. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153376. */
  153377. export class SceneOptimizer implements IDisposable {
  153378. private _isRunning;
  153379. private _options;
  153380. private _scene;
  153381. private _currentPriorityLevel;
  153382. private _targetFrameRate;
  153383. private _trackerDuration;
  153384. private _currentFrameRate;
  153385. private _sceneDisposeObserver;
  153386. private _improvementMode;
  153387. /**
  153388. * Defines an observable called when the optimizer reaches the target frame rate
  153389. */
  153390. onSuccessObservable: Observable<SceneOptimizer>;
  153391. /**
  153392. * Defines an observable called when the optimizer enables an optimization
  153393. */
  153394. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153395. /**
  153396. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153397. */
  153398. onFailureObservable: Observable<SceneOptimizer>;
  153399. /**
  153400. * Gets a boolean indicating if the optimizer is in improvement mode
  153401. */
  153402. get isInImprovementMode(): boolean;
  153403. /**
  153404. * Gets the current priority level (0 at start)
  153405. */
  153406. get currentPriorityLevel(): number;
  153407. /**
  153408. * Gets the current frame rate checked by the SceneOptimizer
  153409. */
  153410. get currentFrameRate(): number;
  153411. /**
  153412. * Gets or sets the current target frame rate (60 by default)
  153413. */
  153414. get targetFrameRate(): number;
  153415. /**
  153416. * Gets or sets the current target frame rate (60 by default)
  153417. */
  153418. set targetFrameRate(value: number);
  153419. /**
  153420. * Gets or sets the current interval between two checks (every 2000ms by default)
  153421. */
  153422. get trackerDuration(): number;
  153423. /**
  153424. * Gets or sets the current interval between two checks (every 2000ms by default)
  153425. */
  153426. set trackerDuration(value: number);
  153427. /**
  153428. * Gets the list of active optimizations
  153429. */
  153430. get optimizations(): SceneOptimization[];
  153431. /**
  153432. * Creates a new SceneOptimizer
  153433. * @param scene defines the scene to work on
  153434. * @param options defines the options to use with the SceneOptimizer
  153435. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153436. * @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)
  153437. */
  153438. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153439. /**
  153440. * Stops the current optimizer
  153441. */
  153442. stop(): void;
  153443. /**
  153444. * Reset the optimizer to initial step (current priority level = 0)
  153445. */
  153446. reset(): void;
  153447. /**
  153448. * Start the optimizer. By default it will try to reach a specific framerate
  153449. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153450. */
  153451. start(): void;
  153452. private _checkCurrentState;
  153453. /**
  153454. * Release all resources
  153455. */
  153456. dispose(): void;
  153457. /**
  153458. * Helper function to create a SceneOptimizer with one single line of code
  153459. * @param scene defines the scene to work on
  153460. * @param options defines the options to use with the SceneOptimizer
  153461. * @param onSuccess defines a callback to call on success
  153462. * @param onFailure defines a callback to call on failure
  153463. * @returns the new SceneOptimizer object
  153464. */
  153465. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153466. }
  153467. }
  153468. declare module BABYLON {
  153469. /**
  153470. * Class used to serialize a scene into a string
  153471. */
  153472. export class SceneSerializer {
  153473. /**
  153474. * Clear cache used by a previous serialization
  153475. */
  153476. static ClearCache(): void;
  153477. /**
  153478. * Serialize a scene into a JSON compatible object
  153479. * @param scene defines the scene to serialize
  153480. * @returns a JSON compatible object
  153481. */
  153482. static Serialize(scene: Scene): any;
  153483. /**
  153484. * Serialize a mesh into a JSON compatible object
  153485. * @param toSerialize defines the mesh to serialize
  153486. * @param withParents defines if parents must be serialized as well
  153487. * @param withChildren defines if children must be serialized as well
  153488. * @returns a JSON compatible object
  153489. */
  153490. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153491. }
  153492. }
  153493. declare module BABYLON {
  153494. /**
  153495. * Class used to host texture specific utilities
  153496. */
  153497. export class TextureTools {
  153498. /**
  153499. * Uses the GPU to create a copy texture rescaled at a given size
  153500. * @param texture Texture to copy from
  153501. * @param width defines the desired width
  153502. * @param height defines the desired height
  153503. * @param useBilinearMode defines if bilinear mode has to be used
  153504. * @return the generated texture
  153505. */
  153506. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153507. }
  153508. }
  153509. declare module BABYLON {
  153510. /**
  153511. * This represents the different options available for the video capture.
  153512. */
  153513. export interface VideoRecorderOptions {
  153514. /** Defines the mime type of the video. */
  153515. mimeType: string;
  153516. /** Defines the FPS the video should be recorded at. */
  153517. fps: number;
  153518. /** Defines the chunk size for the recording data. */
  153519. recordChunckSize: number;
  153520. /** The audio tracks to attach to the recording. */
  153521. audioTracks?: MediaStreamTrack[];
  153522. }
  153523. /**
  153524. * This can help with recording videos from BabylonJS.
  153525. * This is based on the available WebRTC functionalities of the browser.
  153526. *
  153527. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153528. */
  153529. export class VideoRecorder {
  153530. private static readonly _defaultOptions;
  153531. /**
  153532. * Returns whether or not the VideoRecorder is available in your browser.
  153533. * @param engine Defines the Babylon Engine.
  153534. * @returns true if supported otherwise false.
  153535. */
  153536. static IsSupported(engine: Engine): boolean;
  153537. private readonly _options;
  153538. private _canvas;
  153539. private _mediaRecorder;
  153540. private _recordedChunks;
  153541. private _fileName;
  153542. private _resolve;
  153543. private _reject;
  153544. /**
  153545. * True when a recording is already in progress.
  153546. */
  153547. get isRecording(): boolean;
  153548. /**
  153549. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153550. * @param engine Defines the BabylonJS Engine you wish to record.
  153551. * @param options Defines options that can be used to customize the capture.
  153552. */
  153553. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153554. /**
  153555. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153556. */
  153557. stopRecording(): void;
  153558. /**
  153559. * Starts recording the canvas for a max duration specified in parameters.
  153560. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153561. * If null no automatic download will start and you can rely on the promise to get the data back.
  153562. * @param maxDuration Defines the maximum recording time in seconds.
  153563. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153564. * @return A promise callback at the end of the recording with the video data in Blob.
  153565. */
  153566. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153567. /**
  153568. * Releases internal resources used during the recording.
  153569. */
  153570. dispose(): void;
  153571. private _handleDataAvailable;
  153572. private _handleError;
  153573. private _handleStop;
  153574. }
  153575. }
  153576. declare module BABYLON {
  153577. /**
  153578. * Class containing a set of static utilities functions for screenshots
  153579. */
  153580. export class ScreenshotTools {
  153581. /**
  153582. * Captures a screenshot of the current rendering
  153583. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153584. * @param engine defines the rendering engine
  153585. * @param camera defines the source camera
  153586. * @param size This parameter can be set to a single number or to an object with the
  153587. * following (optional) properties: precision, width, height. If a single number is passed,
  153588. * it will be used for both width and height. If an object is passed, the screenshot size
  153589. * will be derived from the parameters. The precision property is a multiplier allowing
  153590. * rendering at a higher or lower resolution
  153591. * @param successCallback defines the callback receives a single parameter which contains the
  153592. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153593. * src parameter of an <img> to display it
  153594. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153595. * Check your browser for supported MIME types
  153596. */
  153597. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153598. /**
  153599. * Captures a screenshot of the current rendering
  153600. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153601. * @param engine defines the rendering engine
  153602. * @param camera defines the source camera
  153603. * @param size This parameter can be set to a single number or to an object with the
  153604. * following (optional) properties: precision, width, height. If a single number is passed,
  153605. * it will be used for both width and height. If an object is passed, the screenshot size
  153606. * will be derived from the parameters. The precision property is a multiplier allowing
  153607. * rendering at a higher or lower resolution
  153608. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153609. * Check your browser for supported MIME types
  153610. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153611. * to the src parameter of an <img> to display it
  153612. */
  153613. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153614. /**
  153615. * Generates an image screenshot from the specified camera.
  153616. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153617. * @param engine The engine to use for rendering
  153618. * @param camera The camera to use for rendering
  153619. * @param size This parameter can be set to a single number or to an object with the
  153620. * following (optional) properties: precision, width, height. If a single number is passed,
  153621. * it will be used for both width and height. If an object is passed, the screenshot size
  153622. * will be derived from the parameters. The precision property is a multiplier allowing
  153623. * rendering at a higher or lower resolution
  153624. * @param successCallback The callback receives a single parameter which contains the
  153625. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153626. * src parameter of an <img> to display it
  153627. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153628. * Check your browser for supported MIME types
  153629. * @param samples Texture samples (default: 1)
  153630. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153631. * @param fileName A name for for the downloaded file.
  153632. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153633. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153634. */
  153635. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  153636. /**
  153637. * Generates an image screenshot from the specified camera.
  153638. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153639. * @param engine The engine to use for rendering
  153640. * @param camera The camera to use for rendering
  153641. * @param size This parameter can be set to a single number or to an object with the
  153642. * following (optional) properties: precision, width, height. If a single number is passed,
  153643. * it will be used for both width and height. If an object is passed, the screenshot size
  153644. * will be derived from the parameters. The precision property is a multiplier allowing
  153645. * rendering at a higher or lower resolution
  153646. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153647. * Check your browser for supported MIME types
  153648. * @param samples Texture samples (default: 1)
  153649. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153650. * @param fileName A name for for the downloaded file.
  153651. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153652. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153653. * to the src parameter of an <img> to display it
  153654. */
  153655. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153656. /**
  153657. * Gets height and width for screenshot size
  153658. * @private
  153659. */
  153660. private static _getScreenshotSize;
  153661. }
  153662. }
  153663. declare module BABYLON {
  153664. /**
  153665. * Interface for a data buffer
  153666. */
  153667. export interface IDataBuffer {
  153668. /**
  153669. * Reads bytes from the data buffer.
  153670. * @param byteOffset The byte offset to read
  153671. * @param byteLength The byte length to read
  153672. * @returns A promise that resolves when the bytes are read
  153673. */
  153674. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153675. /**
  153676. * The byte length of the buffer.
  153677. */
  153678. readonly byteLength: number;
  153679. }
  153680. /**
  153681. * Utility class for reading from a data buffer
  153682. */
  153683. export class DataReader {
  153684. /**
  153685. * The data buffer associated with this data reader.
  153686. */
  153687. readonly buffer: IDataBuffer;
  153688. /**
  153689. * The current byte offset from the beginning of the data buffer.
  153690. */
  153691. byteOffset: number;
  153692. private _dataView;
  153693. private _dataByteOffset;
  153694. /**
  153695. * Constructor
  153696. * @param buffer The buffer to read
  153697. */
  153698. constructor(buffer: IDataBuffer);
  153699. /**
  153700. * Loads the given byte length.
  153701. * @param byteLength The byte length to load
  153702. * @returns A promise that resolves when the load is complete
  153703. */
  153704. loadAsync(byteLength: number): Promise<void>;
  153705. /**
  153706. * Read a unsigned 32-bit integer from the currently loaded data range.
  153707. * @returns The 32-bit integer read
  153708. */
  153709. readUint32(): number;
  153710. /**
  153711. * Read a byte array from the currently loaded data range.
  153712. * @param byteLength The byte length to read
  153713. * @returns The byte array read
  153714. */
  153715. readUint8Array(byteLength: number): Uint8Array;
  153716. /**
  153717. * Read a string from the currently loaded data range.
  153718. * @param byteLength The byte length to read
  153719. * @returns The string read
  153720. */
  153721. readString(byteLength: number): string;
  153722. /**
  153723. * Skips the given byte length the currently loaded data range.
  153724. * @param byteLength The byte length to skip
  153725. */
  153726. skipBytes(byteLength: number): void;
  153727. }
  153728. }
  153729. declare module BABYLON {
  153730. /**
  153731. * Class for storing data to local storage if available or in-memory storage otherwise
  153732. */
  153733. export class DataStorage {
  153734. private static _Storage;
  153735. private static _GetStorage;
  153736. /**
  153737. * Reads a string from the data storage
  153738. * @param key The key to read
  153739. * @param defaultValue The value if the key doesn't exist
  153740. * @returns The string value
  153741. */
  153742. static ReadString(key: string, defaultValue: string): string;
  153743. /**
  153744. * Writes a string to the data storage
  153745. * @param key The key to write
  153746. * @param value The value to write
  153747. */
  153748. static WriteString(key: string, value: string): void;
  153749. /**
  153750. * Reads a boolean from the data storage
  153751. * @param key The key to read
  153752. * @param defaultValue The value if the key doesn't exist
  153753. * @returns The boolean value
  153754. */
  153755. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153756. /**
  153757. * Writes a boolean to the data storage
  153758. * @param key The key to write
  153759. * @param value The value to write
  153760. */
  153761. static WriteBoolean(key: string, value: boolean): void;
  153762. /**
  153763. * Reads a number from the data storage
  153764. * @param key The key to read
  153765. * @param defaultValue The value if the key doesn't exist
  153766. * @returns The number value
  153767. */
  153768. static ReadNumber(key: string, defaultValue: number): number;
  153769. /**
  153770. * Writes a number to the data storage
  153771. * @param key The key to write
  153772. * @param value The value to write
  153773. */
  153774. static WriteNumber(key: string, value: number): void;
  153775. }
  153776. }
  153777. declare module BABYLON {
  153778. /**
  153779. * Class used to record delta files between 2 scene states
  153780. */
  153781. export class SceneRecorder {
  153782. private _trackedScene;
  153783. private _savedJSON;
  153784. /**
  153785. * Track a given scene. This means the current scene state will be considered the original state
  153786. * @param scene defines the scene to track
  153787. */
  153788. track(scene: Scene): void;
  153789. /**
  153790. * Get the delta between current state and original state
  153791. * @returns a string containing the delta
  153792. */
  153793. getDelta(): any;
  153794. private _compareArray;
  153795. private _compareObjects;
  153796. private _compareCollections;
  153797. private static GetShadowGeneratorById;
  153798. /**
  153799. * Apply a given delta to a given scene
  153800. * @param deltaJSON defines the JSON containing the delta
  153801. * @param scene defines the scene to apply the delta to
  153802. */
  153803. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153804. private static _ApplyPropertiesToEntity;
  153805. private static _ApplyDeltaForEntity;
  153806. }
  153807. }
  153808. declare module BABYLON {
  153809. /**
  153810. * An interface for all Hit test features
  153811. */
  153812. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153813. /**
  153814. * Triggered when new babylon (transformed) hit test results are available
  153815. */
  153816. onHitTestResultObservable: Observable<T[]>;
  153817. }
  153818. /**
  153819. * Options used for hit testing
  153820. */
  153821. export interface IWebXRLegacyHitTestOptions {
  153822. /**
  153823. * Only test when user interacted with the scene. Default - hit test every frame
  153824. */
  153825. testOnPointerDownOnly?: boolean;
  153826. /**
  153827. * The node to use to transform the local results to world coordinates
  153828. */
  153829. worldParentNode?: TransformNode;
  153830. }
  153831. /**
  153832. * Interface defining the babylon result of raycasting/hit-test
  153833. */
  153834. export interface IWebXRLegacyHitResult {
  153835. /**
  153836. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153837. */
  153838. transformationMatrix: Matrix;
  153839. /**
  153840. * The native hit test result
  153841. */
  153842. xrHitResult: XRHitResult | XRHitTestResult;
  153843. }
  153844. /**
  153845. * The currently-working hit-test module.
  153846. * Hit test (or Ray-casting) is used to interact with the real world.
  153847. * For further information read here - https://github.com/immersive-web/hit-test
  153848. */
  153849. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153850. /**
  153851. * options to use when constructing this feature
  153852. */
  153853. readonly options: IWebXRLegacyHitTestOptions;
  153854. private _direction;
  153855. private _mat;
  153856. private _onSelectEnabled;
  153857. private _origin;
  153858. /**
  153859. * The module's name
  153860. */
  153861. static readonly Name: string;
  153862. /**
  153863. * The (Babylon) version of this module.
  153864. * This is an integer representing the implementation version.
  153865. * This number does not correspond to the WebXR specs version
  153866. */
  153867. static readonly Version: number;
  153868. /**
  153869. * Populated with the last native XR Hit Results
  153870. */
  153871. lastNativeXRHitResults: XRHitResult[];
  153872. /**
  153873. * Triggered when new babylon (transformed) hit test results are available
  153874. */
  153875. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153876. /**
  153877. * Creates a new instance of the (legacy version) hit test feature
  153878. * @param _xrSessionManager an instance of WebXRSessionManager
  153879. * @param options options to use when constructing this feature
  153880. */
  153881. constructor(_xrSessionManager: WebXRSessionManager,
  153882. /**
  153883. * options to use when constructing this feature
  153884. */
  153885. options?: IWebXRLegacyHitTestOptions);
  153886. /**
  153887. * execute a hit test with an XR Ray
  153888. *
  153889. * @param xrSession a native xrSession that will execute this hit test
  153890. * @param xrRay the ray (position and direction) to use for ray-casting
  153891. * @param referenceSpace native XR reference space to use for the hit-test
  153892. * @param filter filter function that will filter the results
  153893. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153894. */
  153895. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153896. /**
  153897. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153898. * @param event the (select) event to use to select with
  153899. * @param referenceSpace the reference space to use for this hit test
  153900. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153901. */
  153902. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153903. /**
  153904. * attach this feature
  153905. * Will usually be called by the features manager
  153906. *
  153907. * @returns true if successful.
  153908. */
  153909. attach(): boolean;
  153910. /**
  153911. * detach this feature.
  153912. * Will usually be called by the features manager
  153913. *
  153914. * @returns true if successful.
  153915. */
  153916. detach(): boolean;
  153917. /**
  153918. * Dispose this feature and all of the resources attached
  153919. */
  153920. dispose(): void;
  153921. protected _onXRFrame(frame: XRFrame): void;
  153922. private _onHitTestResults;
  153923. private _onSelect;
  153924. }
  153925. }
  153926. declare module BABYLON {
  153927. /**
  153928. * Options used for hit testing (version 2)
  153929. */
  153930. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153931. /**
  153932. * Do not create a permanent hit test. Will usually be used when only
  153933. * transient inputs are needed.
  153934. */
  153935. disablePermanentHitTest?: boolean;
  153936. /**
  153937. * Enable transient (for example touch-based) hit test inspections
  153938. */
  153939. enableTransientHitTest?: boolean;
  153940. /**
  153941. * Offset ray for the permanent hit test
  153942. */
  153943. offsetRay?: Vector3;
  153944. /**
  153945. * Offset ray for the transient hit test
  153946. */
  153947. transientOffsetRay?: Vector3;
  153948. /**
  153949. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153950. */
  153951. useReferenceSpace?: boolean;
  153952. /**
  153953. * Override the default entity type(s) of the hit-test result
  153954. */
  153955. entityTypes?: XRHitTestTrackableType[];
  153956. }
  153957. /**
  153958. * Interface defining the babylon result of hit-test
  153959. */
  153960. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153961. /**
  153962. * The input source that generated this hit test (if transient)
  153963. */
  153964. inputSource?: XRInputSource;
  153965. /**
  153966. * Is this a transient hit test
  153967. */
  153968. isTransient?: boolean;
  153969. /**
  153970. * Position of the hit test result
  153971. */
  153972. position: Vector3;
  153973. /**
  153974. * Rotation of the hit test result
  153975. */
  153976. rotationQuaternion: Quaternion;
  153977. /**
  153978. * The native hit test result
  153979. */
  153980. xrHitResult: XRHitTestResult;
  153981. }
  153982. /**
  153983. * The currently-working hit-test module.
  153984. * Hit test (or Ray-casting) is used to interact with the real world.
  153985. * For further information read here - https://github.com/immersive-web/hit-test
  153986. *
  153987. * Tested on chrome (mobile) 80.
  153988. */
  153989. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153990. /**
  153991. * options to use when constructing this feature
  153992. */
  153993. readonly options: IWebXRHitTestOptions;
  153994. private _tmpMat;
  153995. private _tmpPos;
  153996. private _tmpQuat;
  153997. private _transientXrHitTestSource;
  153998. private _xrHitTestSource;
  153999. private initHitTestSource;
  154000. /**
  154001. * The module's name
  154002. */
  154003. static readonly Name: string;
  154004. /**
  154005. * The (Babylon) version of this module.
  154006. * This is an integer representing the implementation version.
  154007. * This number does not correspond to the WebXR specs version
  154008. */
  154009. static readonly Version: number;
  154010. /**
  154011. * When set to true, each hit test will have its own position/rotation objects
  154012. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  154013. * the developers will clone them or copy them as they see fit.
  154014. */
  154015. autoCloneTransformation: boolean;
  154016. /**
  154017. * Triggered when new babylon (transformed) hit test results are available
  154018. */
  154019. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  154020. /**
  154021. * Use this to temporarily pause hit test checks.
  154022. */
  154023. paused: boolean;
  154024. /**
  154025. * Creates a new instance of the hit test feature
  154026. * @param _xrSessionManager an instance of WebXRSessionManager
  154027. * @param options options to use when constructing this feature
  154028. */
  154029. constructor(_xrSessionManager: WebXRSessionManager,
  154030. /**
  154031. * options to use when constructing this feature
  154032. */
  154033. options?: IWebXRHitTestOptions);
  154034. /**
  154035. * attach this feature
  154036. * Will usually be called by the features manager
  154037. *
  154038. * @returns true if successful.
  154039. */
  154040. attach(): boolean;
  154041. /**
  154042. * detach this feature.
  154043. * Will usually be called by the features manager
  154044. *
  154045. * @returns true if successful.
  154046. */
  154047. detach(): boolean;
  154048. /**
  154049. * Dispose this feature and all of the resources attached
  154050. */
  154051. dispose(): void;
  154052. protected _onXRFrame(frame: XRFrame): void;
  154053. private _processWebXRHitTestResult;
  154054. }
  154055. }
  154056. declare module BABYLON {
  154057. /**
  154058. * Configuration options of the anchor system
  154059. */
  154060. export interface IWebXRAnchorSystemOptions {
  154061. /**
  154062. * a node that will be used to convert local to world coordinates
  154063. */
  154064. worldParentNode?: TransformNode;
  154065. /**
  154066. * If set to true a reference of the created anchors will be kept until the next session starts
  154067. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154068. */
  154069. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154070. }
  154071. /**
  154072. * A babylon container for an XR Anchor
  154073. */
  154074. export interface IWebXRAnchor {
  154075. /**
  154076. * A babylon-assigned ID for this anchor
  154077. */
  154078. id: number;
  154079. /**
  154080. * Transformation matrix to apply to an object attached to this anchor
  154081. */
  154082. transformationMatrix: Matrix;
  154083. /**
  154084. * The native anchor object
  154085. */
  154086. xrAnchor: XRAnchor;
  154087. /**
  154088. * if defined, this object will be constantly updated by the anchor's position and rotation
  154089. */
  154090. attachedNode?: TransformNode;
  154091. }
  154092. /**
  154093. * An implementation of the anchor system for WebXR.
  154094. * For further information see https://github.com/immersive-web/anchors/
  154095. */
  154096. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154097. private _options;
  154098. private _lastFrameDetected;
  154099. private _trackedAnchors;
  154100. private _referenceSpaceForFrameAnchors;
  154101. private _futureAnchors;
  154102. /**
  154103. * The module's name
  154104. */
  154105. static readonly Name: string;
  154106. /**
  154107. * The (Babylon) version of this module.
  154108. * This is an integer representing the implementation version.
  154109. * This number does not correspond to the WebXR specs version
  154110. */
  154111. static readonly Version: number;
  154112. /**
  154113. * Observers registered here will be executed when a new anchor was added to the session
  154114. */
  154115. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154116. /**
  154117. * Observers registered here will be executed when an anchor was removed from the session
  154118. */
  154119. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154120. /**
  154121. * Observers registered here will be executed when an existing anchor updates
  154122. * This can execute N times every frame
  154123. */
  154124. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154125. /**
  154126. * Set the reference space to use for anchor creation, when not using a hit test.
  154127. * Will default to the session's reference space if not defined
  154128. */
  154129. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154130. /**
  154131. * constructs a new anchor system
  154132. * @param _xrSessionManager an instance of WebXRSessionManager
  154133. * @param _options configuration object for this feature
  154134. */
  154135. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154136. private _tmpVector;
  154137. private _tmpQuaternion;
  154138. private _populateTmpTransformation;
  154139. /**
  154140. * Create a new anchor point using a hit test result at a specific point in the scene
  154141. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154142. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154143. *
  154144. * @param hitTestResult The hit test result to use for this anchor creation
  154145. * @param position an optional position offset for this anchor
  154146. * @param rotationQuaternion an optional rotation offset for this anchor
  154147. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154148. */
  154149. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154150. /**
  154151. * Add a new anchor at a specific position and rotation
  154152. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154153. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154154. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154155. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154156. *
  154157. * @param position the position in which to add an anchor
  154158. * @param rotationQuaternion an optional rotation for the anchor transformation
  154159. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154160. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154161. */
  154162. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154163. /**
  154164. * detach this feature.
  154165. * Will usually be called by the features manager
  154166. *
  154167. * @returns true if successful.
  154168. */
  154169. detach(): boolean;
  154170. /**
  154171. * Dispose this feature and all of the resources attached
  154172. */
  154173. dispose(): void;
  154174. protected _onXRFrame(frame: XRFrame): void;
  154175. /**
  154176. * avoiding using Array.find for global support.
  154177. * @param xrAnchor the plane to find in the array
  154178. */
  154179. private _findIndexInAnchorArray;
  154180. private _updateAnchorWithXRFrame;
  154181. private _createAnchorAtTransformation;
  154182. }
  154183. }
  154184. declare module BABYLON {
  154185. /**
  154186. * Options used in the plane detector module
  154187. */
  154188. export interface IWebXRPlaneDetectorOptions {
  154189. /**
  154190. * The node to use to transform the local results to world coordinates
  154191. */
  154192. worldParentNode?: TransformNode;
  154193. /**
  154194. * If set to true a reference of the created planes will be kept until the next session starts
  154195. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154196. */
  154197. doNotRemovePlanesOnSessionEnded?: boolean;
  154198. }
  154199. /**
  154200. * A babylon interface for a WebXR plane.
  154201. * A Plane is actually a polygon, built from N points in space
  154202. *
  154203. * Supported in chrome 79, not supported in canary 81 ATM
  154204. */
  154205. export interface IWebXRPlane {
  154206. /**
  154207. * a babylon-assigned ID for this polygon
  154208. */
  154209. id: number;
  154210. /**
  154211. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154212. */
  154213. polygonDefinition: Array<Vector3>;
  154214. /**
  154215. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154216. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154217. */
  154218. transformationMatrix: Matrix;
  154219. /**
  154220. * the native xr-plane object
  154221. */
  154222. xrPlane: XRPlane;
  154223. }
  154224. /**
  154225. * The plane detector is used to detect planes in the real world when in AR
  154226. * For more information see https://github.com/immersive-web/real-world-geometry/
  154227. */
  154228. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154229. private _options;
  154230. private _detectedPlanes;
  154231. private _enabled;
  154232. private _lastFrameDetected;
  154233. /**
  154234. * The module's name
  154235. */
  154236. static readonly Name: string;
  154237. /**
  154238. * The (Babylon) version of this module.
  154239. * This is an integer representing the implementation version.
  154240. * This number does not correspond to the WebXR specs version
  154241. */
  154242. static readonly Version: number;
  154243. /**
  154244. * Observers registered here will be executed when a new plane was added to the session
  154245. */
  154246. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154247. /**
  154248. * Observers registered here will be executed when a plane is no longer detected in the session
  154249. */
  154250. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154251. /**
  154252. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154253. * This can execute N times every frame
  154254. */
  154255. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154256. /**
  154257. * construct a new Plane Detector
  154258. * @param _xrSessionManager an instance of xr Session manager
  154259. * @param _options configuration to use when constructing this feature
  154260. */
  154261. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154262. /**
  154263. * detach this feature.
  154264. * Will usually be called by the features manager
  154265. *
  154266. * @returns true if successful.
  154267. */
  154268. detach(): boolean;
  154269. /**
  154270. * Dispose this feature and all of the resources attached
  154271. */
  154272. dispose(): void;
  154273. protected _onXRFrame(frame: XRFrame): void;
  154274. private _init;
  154275. private _updatePlaneWithXRPlane;
  154276. /**
  154277. * avoiding using Array.find for global support.
  154278. * @param xrPlane the plane to find in the array
  154279. */
  154280. private findIndexInPlaneArray;
  154281. }
  154282. }
  154283. declare module BABYLON {
  154284. /**
  154285. * Options interface for the background remover plugin
  154286. */
  154287. export interface IWebXRBackgroundRemoverOptions {
  154288. /**
  154289. * Further background meshes to disable when entering AR
  154290. */
  154291. backgroundMeshes?: AbstractMesh[];
  154292. /**
  154293. * flags to configure the removal of the environment helper.
  154294. * If not set, the entire background will be removed. If set, flags should be set as well.
  154295. */
  154296. environmentHelperRemovalFlags?: {
  154297. /**
  154298. * Should the skybox be removed (default false)
  154299. */
  154300. skyBox?: boolean;
  154301. /**
  154302. * Should the ground be removed (default false)
  154303. */
  154304. ground?: boolean;
  154305. };
  154306. /**
  154307. * don't disable the environment helper
  154308. */
  154309. ignoreEnvironmentHelper?: boolean;
  154310. }
  154311. /**
  154312. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154313. */
  154314. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154315. /**
  154316. * read-only options to be used in this module
  154317. */
  154318. readonly options: IWebXRBackgroundRemoverOptions;
  154319. /**
  154320. * The module's name
  154321. */
  154322. static readonly Name: string;
  154323. /**
  154324. * The (Babylon) version of this module.
  154325. * This is an integer representing the implementation version.
  154326. * This number does not correspond to the WebXR specs version
  154327. */
  154328. static readonly Version: number;
  154329. /**
  154330. * registered observers will be triggered when the background state changes
  154331. */
  154332. onBackgroundStateChangedObservable: Observable<boolean>;
  154333. /**
  154334. * constructs a new background remover module
  154335. * @param _xrSessionManager the session manager for this module
  154336. * @param options read-only options to be used in this module
  154337. */
  154338. constructor(_xrSessionManager: WebXRSessionManager,
  154339. /**
  154340. * read-only options to be used in this module
  154341. */
  154342. options?: IWebXRBackgroundRemoverOptions);
  154343. /**
  154344. * attach this feature
  154345. * Will usually be called by the features manager
  154346. *
  154347. * @returns true if successful.
  154348. */
  154349. attach(): boolean;
  154350. /**
  154351. * detach this feature.
  154352. * Will usually be called by the features manager
  154353. *
  154354. * @returns true if successful.
  154355. */
  154356. detach(): boolean;
  154357. /**
  154358. * Dispose this feature and all of the resources attached
  154359. */
  154360. dispose(): void;
  154361. protected _onXRFrame(_xrFrame: XRFrame): void;
  154362. private _setBackgroundState;
  154363. }
  154364. }
  154365. declare module BABYLON {
  154366. /**
  154367. * Options for the controller physics feature
  154368. */
  154369. export class IWebXRControllerPhysicsOptions {
  154370. /**
  154371. * Should the headset get its own impostor
  154372. */
  154373. enableHeadsetImpostor?: boolean;
  154374. /**
  154375. * Optional parameters for the headset impostor
  154376. */
  154377. headsetImpostorParams?: {
  154378. /**
  154379. * The type of impostor to create. Default is sphere
  154380. */
  154381. impostorType: number;
  154382. /**
  154383. * the size of the impostor. Defaults to 10cm
  154384. */
  154385. impostorSize?: number | {
  154386. width: number;
  154387. height: number;
  154388. depth: number;
  154389. };
  154390. /**
  154391. * Friction definitions
  154392. */
  154393. friction?: number;
  154394. /**
  154395. * Restitution
  154396. */
  154397. restitution?: number;
  154398. };
  154399. /**
  154400. * The physics properties of the future impostors
  154401. */
  154402. physicsProperties?: {
  154403. /**
  154404. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154405. * Note that this requires a physics engine that supports mesh impostors!
  154406. */
  154407. useControllerMesh?: boolean;
  154408. /**
  154409. * The type of impostor to create. Default is sphere
  154410. */
  154411. impostorType?: number;
  154412. /**
  154413. * the size of the impostor. Defaults to 10cm
  154414. */
  154415. impostorSize?: number | {
  154416. width: number;
  154417. height: number;
  154418. depth: number;
  154419. };
  154420. /**
  154421. * Friction definitions
  154422. */
  154423. friction?: number;
  154424. /**
  154425. * Restitution
  154426. */
  154427. restitution?: number;
  154428. };
  154429. /**
  154430. * the xr input to use with this pointer selection
  154431. */
  154432. xrInput: WebXRInput;
  154433. }
  154434. /**
  154435. * Add physics impostor to your webxr controllers,
  154436. * including naive calculation of their linear and angular velocity
  154437. */
  154438. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154439. private readonly _options;
  154440. private _attachController;
  154441. private _controllers;
  154442. private _debugMode;
  154443. private _delta;
  154444. private _headsetImpostor?;
  154445. private _headsetMesh?;
  154446. private _lastTimestamp;
  154447. private _tmpQuaternion;
  154448. private _tmpVector;
  154449. /**
  154450. * The module's name
  154451. */
  154452. static readonly Name: string;
  154453. /**
  154454. * The (Babylon) version of this module.
  154455. * This is an integer representing the implementation version.
  154456. * This number does not correspond to the webxr specs version
  154457. */
  154458. static readonly Version: number;
  154459. /**
  154460. * Construct a new Controller Physics Feature
  154461. * @param _xrSessionManager the corresponding xr session manager
  154462. * @param _options options to create this feature with
  154463. */
  154464. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154465. /**
  154466. * @hidden
  154467. * enable debugging - will show console outputs and the impostor mesh
  154468. */
  154469. _enablePhysicsDebug(): void;
  154470. /**
  154471. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154472. * @param xrController the controller to add
  154473. */
  154474. addController(xrController: WebXRInputSource): void;
  154475. /**
  154476. * attach this feature
  154477. * Will usually be called by the features manager
  154478. *
  154479. * @returns true if successful.
  154480. */
  154481. attach(): boolean;
  154482. /**
  154483. * detach this feature.
  154484. * Will usually be called by the features manager
  154485. *
  154486. * @returns true if successful.
  154487. */
  154488. detach(): boolean;
  154489. /**
  154490. * Get the headset impostor, if enabled
  154491. * @returns the impostor
  154492. */
  154493. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154494. /**
  154495. * Get the physics impostor of a specific controller.
  154496. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154497. * @param controller the controller or the controller id of which to get the impostor
  154498. * @returns the impostor or null
  154499. */
  154500. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154501. /**
  154502. * Update the physics properties provided in the constructor
  154503. * @param newProperties the new properties object
  154504. */
  154505. setPhysicsProperties(newProperties: {
  154506. impostorType?: number;
  154507. impostorSize?: number | {
  154508. width: number;
  154509. height: number;
  154510. depth: number;
  154511. };
  154512. friction?: number;
  154513. restitution?: number;
  154514. }): void;
  154515. protected _onXRFrame(_xrFrame: any): void;
  154516. private _detachController;
  154517. }
  154518. }
  154519. declare module BABYLON {
  154520. /**
  154521. * A babylon interface for a "WebXR" feature point.
  154522. * Represents the position and confidence value of a given feature point.
  154523. */
  154524. export interface IWebXRFeaturePoint {
  154525. /**
  154526. * Represents the position of the feature point in world space.
  154527. */
  154528. position: Vector3;
  154529. /**
  154530. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154531. */
  154532. confidenceValue: number;
  154533. }
  154534. /**
  154535. * The feature point system is used to detect feature points from real world geometry.
  154536. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154537. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154538. */
  154539. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154540. private _enabled;
  154541. private _featurePointCloud;
  154542. /**
  154543. * The module's name
  154544. */
  154545. static readonly Name: string;
  154546. /**
  154547. * The (Babylon) version of this module.
  154548. * This is an integer representing the implementation version.
  154549. * This number does not correspond to the WebXR specs version
  154550. */
  154551. static readonly Version: number;
  154552. /**
  154553. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154554. * Will notify the observers about which feature points have been added.
  154555. */
  154556. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154557. /**
  154558. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154559. * Will notify the observers about which feature points have been updated.
  154560. */
  154561. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154562. /**
  154563. * The current feature point cloud maintained across frames.
  154564. */
  154565. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154566. /**
  154567. * construct the feature point system
  154568. * @param _xrSessionManager an instance of xr Session manager
  154569. */
  154570. constructor(_xrSessionManager: WebXRSessionManager);
  154571. /**
  154572. * Detach this feature.
  154573. * Will usually be called by the features manager
  154574. *
  154575. * @returns true if successful.
  154576. */
  154577. detach(): boolean;
  154578. /**
  154579. * Dispose this feature and all of the resources attached
  154580. */
  154581. dispose(): void;
  154582. /**
  154583. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154584. */
  154585. protected _onXRFrame(frame: XRFrame): void;
  154586. /**
  154587. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154588. */
  154589. private _init;
  154590. }
  154591. }
  154592. declare module BABYLON {
  154593. /**
  154594. * Configuration interface for the hand tracking feature
  154595. */
  154596. export interface IWebXRHandTrackingOptions {
  154597. /**
  154598. * The xrInput that will be used as source for new hands
  154599. */
  154600. xrInput: WebXRInput;
  154601. /**
  154602. * Configuration object for the joint meshes
  154603. */
  154604. jointMeshes?: {
  154605. /**
  154606. * Should the meshes created be invisible (defaults to false)
  154607. */
  154608. invisible?: boolean;
  154609. /**
  154610. * A source mesh to be used to create instances. Defaults to a sphere.
  154611. * This mesh will be the source for all other (25) meshes.
  154612. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154613. */
  154614. sourceMesh?: Mesh;
  154615. /**
  154616. * Should the source mesh stay visible. Defaults to false
  154617. */
  154618. keepOriginalVisible?: boolean;
  154619. /**
  154620. * Scale factor for all instances (defaults to 2)
  154621. */
  154622. scaleFactor?: number;
  154623. /**
  154624. * Should each instance have its own physics impostor
  154625. */
  154626. enablePhysics?: boolean;
  154627. /**
  154628. * If enabled, override default physics properties
  154629. */
  154630. physicsProps?: {
  154631. friction?: number;
  154632. restitution?: number;
  154633. impostorType?: number;
  154634. };
  154635. /**
  154636. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154637. */
  154638. handMesh?: AbstractMesh;
  154639. };
  154640. }
  154641. /**
  154642. * Parts of the hands divided to writs and finger names
  154643. */
  154644. export const enum HandPart {
  154645. /**
  154646. * HandPart - Wrist
  154647. */
  154648. WRIST = "wrist",
  154649. /**
  154650. * HandPart - The THumb
  154651. */
  154652. THUMB = "thumb",
  154653. /**
  154654. * HandPart - Index finger
  154655. */
  154656. INDEX = "index",
  154657. /**
  154658. * HandPart - Middle finger
  154659. */
  154660. MIDDLE = "middle",
  154661. /**
  154662. * HandPart - Ring finger
  154663. */
  154664. RING = "ring",
  154665. /**
  154666. * HandPart - Little finger
  154667. */
  154668. LITTLE = "little"
  154669. }
  154670. /**
  154671. * Representing a single hand (with its corresponding native XRHand object)
  154672. */
  154673. export class WebXRHand implements IDisposable {
  154674. /** the controller to which the hand correlates */
  154675. readonly xrController: WebXRInputSource;
  154676. /** the meshes to be used to track the hand joints */
  154677. readonly trackedMeshes: AbstractMesh[];
  154678. /**
  154679. * Hand-parts definition (key is HandPart)
  154680. */
  154681. static HandPartsDefinition: {
  154682. [key: string]: number[];
  154683. };
  154684. /**
  154685. * Populate the HandPartsDefinition object.
  154686. * This is called as a side effect since certain browsers don't have XRHand defined.
  154687. */
  154688. static _PopulateHandPartsDefinition(): void;
  154689. /**
  154690. * Construct a new hand object
  154691. * @param xrController the controller to which the hand correlates
  154692. * @param trackedMeshes the meshes to be used to track the hand joints
  154693. */
  154694. constructor(
  154695. /** the controller to which the hand correlates */
  154696. xrController: WebXRInputSource,
  154697. /** the meshes to be used to track the hand joints */
  154698. trackedMeshes: AbstractMesh[]);
  154699. /**
  154700. * Update this hand from the latest xr frame
  154701. * @param xrFrame xrFrame to update from
  154702. * @param referenceSpace The current viewer reference space
  154703. * @param scaleFactor optional scale factor for the meshes
  154704. */
  154705. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154706. /**
  154707. * Get meshes of part of the hand
  154708. * @param part the part of hand to get
  154709. * @returns An array of meshes that correlate to the hand part requested
  154710. */
  154711. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154712. /**
  154713. * Dispose this Hand object
  154714. */
  154715. dispose(): void;
  154716. }
  154717. /**
  154718. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154719. */
  154720. export class WebXRHandTracking extends WebXRAbstractFeature {
  154721. /**
  154722. * options to use when constructing this feature
  154723. */
  154724. readonly options: IWebXRHandTrackingOptions;
  154725. private static _idCounter;
  154726. /**
  154727. * The module's name
  154728. */
  154729. static readonly Name: string;
  154730. /**
  154731. * The (Babylon) version of this module.
  154732. * This is an integer representing the implementation version.
  154733. * This number does not correspond to the WebXR specs version
  154734. */
  154735. static readonly Version: number;
  154736. /**
  154737. * This observable will notify registered observers when a new hand object was added and initialized
  154738. */
  154739. onHandAddedObservable: Observable<WebXRHand>;
  154740. /**
  154741. * This observable will notify its observers right before the hand object is disposed
  154742. */
  154743. onHandRemovedObservable: Observable<WebXRHand>;
  154744. private _hands;
  154745. /**
  154746. * Creates a new instance of the hit test feature
  154747. * @param _xrSessionManager an instance of WebXRSessionManager
  154748. * @param options options to use when constructing this feature
  154749. */
  154750. constructor(_xrSessionManager: WebXRSessionManager,
  154751. /**
  154752. * options to use when constructing this feature
  154753. */
  154754. options: IWebXRHandTrackingOptions);
  154755. /**
  154756. * Check if the needed objects are defined.
  154757. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154758. */
  154759. isCompatible(): boolean;
  154760. /**
  154761. * attach this feature
  154762. * Will usually be called by the features manager
  154763. *
  154764. * @returns true if successful.
  154765. */
  154766. attach(): boolean;
  154767. /**
  154768. * detach this feature.
  154769. * Will usually be called by the features manager
  154770. *
  154771. * @returns true if successful.
  154772. */
  154773. detach(): boolean;
  154774. /**
  154775. * Dispose this feature and all of the resources attached
  154776. */
  154777. dispose(): void;
  154778. /**
  154779. * Get the hand object according to the controller id
  154780. * @param controllerId the controller id to which we want to get the hand
  154781. * @returns null if not found or the WebXRHand object if found
  154782. */
  154783. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154784. /**
  154785. * Get a hand object according to the requested handedness
  154786. * @param handedness the handedness to request
  154787. * @returns null if not found or the WebXRHand object if found
  154788. */
  154789. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154790. protected _onXRFrame(_xrFrame: XRFrame): void;
  154791. private _attachHand;
  154792. private _detachHand;
  154793. }
  154794. }
  154795. declare module BABYLON {
  154796. /**
  154797. * The motion controller class for all microsoft mixed reality controllers
  154798. */
  154799. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154800. protected readonly _mapping: {
  154801. defaultButton: {
  154802. valueNodeName: string;
  154803. unpressedNodeName: string;
  154804. pressedNodeName: string;
  154805. };
  154806. defaultAxis: {
  154807. valueNodeName: string;
  154808. minNodeName: string;
  154809. maxNodeName: string;
  154810. };
  154811. buttons: {
  154812. "xr-standard-trigger": {
  154813. rootNodeName: string;
  154814. componentProperty: string;
  154815. states: string[];
  154816. };
  154817. "xr-standard-squeeze": {
  154818. rootNodeName: string;
  154819. componentProperty: string;
  154820. states: string[];
  154821. };
  154822. "xr-standard-touchpad": {
  154823. rootNodeName: string;
  154824. labelAnchorNodeName: string;
  154825. touchPointNodeName: string;
  154826. };
  154827. "xr-standard-thumbstick": {
  154828. rootNodeName: string;
  154829. componentProperty: string;
  154830. states: string[];
  154831. };
  154832. };
  154833. axes: {
  154834. "xr-standard-touchpad": {
  154835. "x-axis": {
  154836. rootNodeName: string;
  154837. };
  154838. "y-axis": {
  154839. rootNodeName: string;
  154840. };
  154841. };
  154842. "xr-standard-thumbstick": {
  154843. "x-axis": {
  154844. rootNodeName: string;
  154845. };
  154846. "y-axis": {
  154847. rootNodeName: string;
  154848. };
  154849. };
  154850. };
  154851. };
  154852. /**
  154853. * The base url used to load the left and right controller models
  154854. */
  154855. static MODEL_BASE_URL: string;
  154856. /**
  154857. * The name of the left controller model file
  154858. */
  154859. static MODEL_LEFT_FILENAME: string;
  154860. /**
  154861. * The name of the right controller model file
  154862. */
  154863. static MODEL_RIGHT_FILENAME: string;
  154864. profileId: string;
  154865. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154866. protected _getFilenameAndPath(): {
  154867. filename: string;
  154868. path: string;
  154869. };
  154870. protected _getModelLoadingConstraints(): boolean;
  154871. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154872. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154873. protected _updateModel(): void;
  154874. }
  154875. }
  154876. declare module BABYLON {
  154877. /**
  154878. * The motion controller class for oculus touch (quest, rift).
  154879. * This class supports legacy mapping as well the standard xr mapping
  154880. */
  154881. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154882. private _forceLegacyControllers;
  154883. private _modelRootNode;
  154884. /**
  154885. * The base url used to load the left and right controller models
  154886. */
  154887. static MODEL_BASE_URL: string;
  154888. /**
  154889. * The name of the left controller model file
  154890. */
  154891. static MODEL_LEFT_FILENAME: string;
  154892. /**
  154893. * The name of the right controller model file
  154894. */
  154895. static MODEL_RIGHT_FILENAME: string;
  154896. /**
  154897. * Base Url for the Quest controller model.
  154898. */
  154899. static QUEST_MODEL_BASE_URL: string;
  154900. profileId: string;
  154901. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154902. protected _getFilenameAndPath(): {
  154903. filename: string;
  154904. path: string;
  154905. };
  154906. protected _getModelLoadingConstraints(): boolean;
  154907. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154908. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154909. protected _updateModel(): void;
  154910. /**
  154911. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154912. * between the touch and touch 2.
  154913. */
  154914. private _isQuest;
  154915. }
  154916. }
  154917. declare module BABYLON {
  154918. /**
  154919. * The motion controller class for the standard HTC-Vive controllers
  154920. */
  154921. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154922. private _modelRootNode;
  154923. /**
  154924. * The base url used to load the left and right controller models
  154925. */
  154926. static MODEL_BASE_URL: string;
  154927. /**
  154928. * File name for the controller model.
  154929. */
  154930. static MODEL_FILENAME: string;
  154931. profileId: string;
  154932. /**
  154933. * Create a new Vive motion controller object
  154934. * @param scene the scene to use to create this controller
  154935. * @param gamepadObject the corresponding gamepad object
  154936. * @param handedness the handedness of the controller
  154937. */
  154938. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154939. protected _getFilenameAndPath(): {
  154940. filename: string;
  154941. path: string;
  154942. };
  154943. protected _getModelLoadingConstraints(): boolean;
  154944. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154945. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154946. protected _updateModel(): void;
  154947. }
  154948. }
  154949. declare module BABYLON {
  154950. /**
  154951. * A cursor which tracks a point on a path
  154952. */
  154953. export class PathCursor {
  154954. private path;
  154955. /**
  154956. * Stores path cursor callbacks for when an onchange event is triggered
  154957. */
  154958. private _onchange;
  154959. /**
  154960. * The value of the path cursor
  154961. */
  154962. value: number;
  154963. /**
  154964. * The animation array of the path cursor
  154965. */
  154966. animations: Animation[];
  154967. /**
  154968. * Initializes the path cursor
  154969. * @param path The path to track
  154970. */
  154971. constructor(path: Path2);
  154972. /**
  154973. * Gets the cursor point on the path
  154974. * @returns A point on the path cursor at the cursor location
  154975. */
  154976. getPoint(): Vector3;
  154977. /**
  154978. * Moves the cursor ahead by the step amount
  154979. * @param step The amount to move the cursor forward
  154980. * @returns This path cursor
  154981. */
  154982. moveAhead(step?: number): PathCursor;
  154983. /**
  154984. * Moves the cursor behind by the step amount
  154985. * @param step The amount to move the cursor back
  154986. * @returns This path cursor
  154987. */
  154988. moveBack(step?: number): PathCursor;
  154989. /**
  154990. * Moves the cursor by the step amount
  154991. * If the step amount is greater than one, an exception is thrown
  154992. * @param step The amount to move the cursor
  154993. * @returns This path cursor
  154994. */
  154995. move(step: number): PathCursor;
  154996. /**
  154997. * Ensures that the value is limited between zero and one
  154998. * @returns This path cursor
  154999. */
  155000. private ensureLimits;
  155001. /**
  155002. * Runs onchange callbacks on change (used by the animation engine)
  155003. * @returns This path cursor
  155004. */
  155005. private raiseOnChange;
  155006. /**
  155007. * Executes a function on change
  155008. * @param f A path cursor onchange callback
  155009. * @returns This path cursor
  155010. */
  155011. onchange(f: (cursor: PathCursor) => void): PathCursor;
  155012. }
  155013. }
  155014. declare module BABYLON {
  155015. /** @hidden */
  155016. export var blurPixelShader: {
  155017. name: string;
  155018. shader: string;
  155019. };
  155020. }
  155021. declare module BABYLON {
  155022. /** @hidden */
  155023. export var pointCloudVertexDeclaration: {
  155024. name: string;
  155025. shader: string;
  155026. };
  155027. }
  155028. // Mixins
  155029. interface Window {
  155030. mozIndexedDB: IDBFactory;
  155031. webkitIndexedDB: IDBFactory;
  155032. msIndexedDB: IDBFactory;
  155033. webkitURL: typeof URL;
  155034. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  155035. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  155036. WebGLRenderingContext: WebGLRenderingContext;
  155037. MSGesture: MSGesture;
  155038. CANNON: any;
  155039. AudioContext: AudioContext;
  155040. webkitAudioContext: AudioContext;
  155041. PointerEvent: any;
  155042. Math: Math;
  155043. Uint8Array: Uint8ArrayConstructor;
  155044. Float32Array: Float32ArrayConstructor;
  155045. mozURL: typeof URL;
  155046. msURL: typeof URL;
  155047. VRFrameData: any; // WebVR, from specs 1.1
  155048. DracoDecoderModule: any;
  155049. setImmediate(handler: (...args: any[]) => void): number;
  155050. }
  155051. interface HTMLCanvasElement {
  155052. requestPointerLock(): void;
  155053. msRequestPointerLock?(): void;
  155054. mozRequestPointerLock?(): void;
  155055. webkitRequestPointerLock?(): void;
  155056. /** Track wether a record is in progress */
  155057. isRecording: boolean;
  155058. /** Capture Stream method defined by some browsers */
  155059. captureStream(fps?: number): MediaStream;
  155060. }
  155061. interface CanvasRenderingContext2D {
  155062. msImageSmoothingEnabled: boolean;
  155063. }
  155064. interface MouseEvent {
  155065. mozMovementX: number;
  155066. mozMovementY: number;
  155067. webkitMovementX: number;
  155068. webkitMovementY: number;
  155069. msMovementX: number;
  155070. msMovementY: number;
  155071. }
  155072. interface Navigator {
  155073. mozGetVRDevices: (any: any) => any;
  155074. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155075. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155076. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155077. webkitGetGamepads(): Gamepad[];
  155078. msGetGamepads(): Gamepad[];
  155079. webkitGamepads(): Gamepad[];
  155080. }
  155081. interface HTMLVideoElement {
  155082. mozSrcObject: any;
  155083. }
  155084. interface Math {
  155085. fround(x: number): number;
  155086. imul(a: number, b: number): number;
  155087. }
  155088. interface WebGLRenderingContext {
  155089. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155090. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155091. vertexAttribDivisor(index: number, divisor: number): void;
  155092. createVertexArray(): any;
  155093. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155094. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155095. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155096. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155097. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155098. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155099. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155100. // Queries
  155101. createQuery(): WebGLQuery;
  155102. deleteQuery(query: WebGLQuery): void;
  155103. beginQuery(target: number, query: WebGLQuery): void;
  155104. endQuery(target: number): void;
  155105. getQueryParameter(query: WebGLQuery, pname: number): any;
  155106. getQuery(target: number, pname: number): any;
  155107. MAX_SAMPLES: number;
  155108. RGBA8: number;
  155109. READ_FRAMEBUFFER: number;
  155110. DRAW_FRAMEBUFFER: number;
  155111. UNIFORM_BUFFER: number;
  155112. HALF_FLOAT_OES: number;
  155113. RGBA16F: number;
  155114. RGBA32F: number;
  155115. R32F: number;
  155116. RG32F: number;
  155117. RGB32F: number;
  155118. R16F: number;
  155119. RG16F: number;
  155120. RGB16F: number;
  155121. RED: number;
  155122. RG: number;
  155123. R8: number;
  155124. RG8: number;
  155125. UNSIGNED_INT_24_8: number;
  155126. DEPTH24_STENCIL8: number;
  155127. MIN: number;
  155128. MAX: number;
  155129. /* Multiple Render Targets */
  155130. drawBuffers(buffers: number[]): void;
  155131. readBuffer(src: number): void;
  155132. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155133. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155134. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155135. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155136. // Occlusion Query
  155137. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155138. ANY_SAMPLES_PASSED: number;
  155139. QUERY_RESULT_AVAILABLE: number;
  155140. QUERY_RESULT: number;
  155141. }
  155142. interface WebGLProgram {
  155143. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155144. }
  155145. interface EXT_disjoint_timer_query {
  155146. QUERY_COUNTER_BITS_EXT: number;
  155147. TIME_ELAPSED_EXT: number;
  155148. TIMESTAMP_EXT: number;
  155149. GPU_DISJOINT_EXT: number;
  155150. QUERY_RESULT_EXT: number;
  155151. QUERY_RESULT_AVAILABLE_EXT: number;
  155152. queryCounterEXT(query: WebGLQuery, target: number): void;
  155153. createQueryEXT(): WebGLQuery;
  155154. beginQueryEXT(target: number, query: WebGLQuery): void;
  155155. endQueryEXT(target: number): void;
  155156. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155157. deleteQueryEXT(query: WebGLQuery): void;
  155158. }
  155159. interface WebGLUniformLocation {
  155160. _currentState: any;
  155161. }
  155162. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155163. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155164. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155165. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155166. interface WebGLRenderingContext {
  155167. readonly RASTERIZER_DISCARD: number;
  155168. readonly DEPTH_COMPONENT24: number;
  155169. readonly TEXTURE_3D: number;
  155170. readonly TEXTURE_2D_ARRAY: number;
  155171. readonly TEXTURE_COMPARE_FUNC: number;
  155172. readonly TEXTURE_COMPARE_MODE: number;
  155173. readonly COMPARE_REF_TO_TEXTURE: number;
  155174. readonly TEXTURE_WRAP_R: number;
  155175. readonly HALF_FLOAT: number;
  155176. readonly RGB8: number;
  155177. readonly RED_INTEGER: number;
  155178. readonly RG_INTEGER: number;
  155179. readonly RGB_INTEGER: number;
  155180. readonly RGBA_INTEGER: number;
  155181. readonly R8_SNORM: number;
  155182. readonly RG8_SNORM: number;
  155183. readonly RGB8_SNORM: number;
  155184. readonly RGBA8_SNORM: number;
  155185. readonly R8I: number;
  155186. readonly RG8I: number;
  155187. readonly RGB8I: number;
  155188. readonly RGBA8I: number;
  155189. readonly R8UI: number;
  155190. readonly RG8UI: number;
  155191. readonly RGB8UI: number;
  155192. readonly RGBA8UI: number;
  155193. readonly R16I: number;
  155194. readonly RG16I: number;
  155195. readonly RGB16I: number;
  155196. readonly RGBA16I: number;
  155197. readonly R16UI: number;
  155198. readonly RG16UI: number;
  155199. readonly RGB16UI: number;
  155200. readonly RGBA16UI: number;
  155201. readonly R32I: number;
  155202. readonly RG32I: number;
  155203. readonly RGB32I: number;
  155204. readonly RGBA32I: number;
  155205. readonly R32UI: number;
  155206. readonly RG32UI: number;
  155207. readonly RGB32UI: number;
  155208. readonly RGBA32UI: number;
  155209. readonly RGB10_A2UI: number;
  155210. readonly R11F_G11F_B10F: number;
  155211. readonly RGB9_E5: number;
  155212. readonly RGB10_A2: number;
  155213. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155214. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155215. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155216. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155217. readonly DEPTH_COMPONENT32F: number;
  155218. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155219. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155220. 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;
  155221. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155222. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155223. readonly TRANSFORM_FEEDBACK: number;
  155224. readonly INTERLEAVED_ATTRIBS: number;
  155225. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155226. createTransformFeedback(): WebGLTransformFeedback;
  155227. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155228. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155229. beginTransformFeedback(primitiveMode: number): void;
  155230. endTransformFeedback(): void;
  155231. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155232. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155233. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155234. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155235. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155236. }
  155237. interface ImageBitmap {
  155238. readonly width: number;
  155239. readonly height: number;
  155240. close(): void;
  155241. }
  155242. interface WebGLQuery extends WebGLObject {
  155243. }
  155244. declare var WebGLQuery: {
  155245. prototype: WebGLQuery;
  155246. new(): WebGLQuery;
  155247. };
  155248. interface WebGLSampler extends WebGLObject {
  155249. }
  155250. declare var WebGLSampler: {
  155251. prototype: WebGLSampler;
  155252. new(): WebGLSampler;
  155253. };
  155254. interface WebGLSync extends WebGLObject {
  155255. }
  155256. declare var WebGLSync: {
  155257. prototype: WebGLSync;
  155258. new(): WebGLSync;
  155259. };
  155260. interface WebGLTransformFeedback extends WebGLObject {
  155261. }
  155262. declare var WebGLTransformFeedback: {
  155263. prototype: WebGLTransformFeedback;
  155264. new(): WebGLTransformFeedback;
  155265. };
  155266. interface WebGLVertexArrayObject extends WebGLObject {
  155267. }
  155268. declare var WebGLVertexArrayObject: {
  155269. prototype: WebGLVertexArrayObject;
  155270. new(): WebGLVertexArrayObject;
  155271. };
  155272. // Type definitions for WebVR API
  155273. // Project: https://w3c.github.io/webvr/
  155274. // Definitions by: six a <https://github.com/lostfictions>
  155275. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155276. interface VRDisplay extends EventTarget {
  155277. /**
  155278. * Dictionary of capabilities describing the VRDisplay.
  155279. */
  155280. readonly capabilities: VRDisplayCapabilities;
  155281. /**
  155282. * z-depth defining the far plane of the eye view frustum
  155283. * enables mapping of values in the render target depth
  155284. * attachment to scene coordinates. Initially set to 10000.0.
  155285. */
  155286. depthFar: number;
  155287. /**
  155288. * z-depth defining the near plane of the eye view frustum
  155289. * enables mapping of values in the render target depth
  155290. * attachment to scene coordinates. Initially set to 0.01.
  155291. */
  155292. depthNear: number;
  155293. /**
  155294. * An identifier for this distinct VRDisplay. Used as an
  155295. * association point in the Gamepad API.
  155296. */
  155297. readonly displayId: number;
  155298. /**
  155299. * A display name, a user-readable name identifying it.
  155300. */
  155301. readonly displayName: string;
  155302. readonly isConnected: boolean;
  155303. readonly isPresenting: boolean;
  155304. /**
  155305. * If this VRDisplay supports room-scale experiences, the optional
  155306. * stage attribute contains details on the room-scale parameters.
  155307. */
  155308. readonly stageParameters: VRStageParameters | null;
  155309. /**
  155310. * Passing the value returned by `requestAnimationFrame` to
  155311. * `cancelAnimationFrame` will unregister the callback.
  155312. * @param handle Define the hanle of the request to cancel
  155313. */
  155314. cancelAnimationFrame(handle: number): void;
  155315. /**
  155316. * Stops presenting to the VRDisplay.
  155317. * @returns a promise to know when it stopped
  155318. */
  155319. exitPresent(): Promise<void>;
  155320. /**
  155321. * Return the current VREyeParameters for the given eye.
  155322. * @param whichEye Define the eye we want the parameter for
  155323. * @returns the eye parameters
  155324. */
  155325. getEyeParameters(whichEye: string): VREyeParameters;
  155326. /**
  155327. * Populates the passed VRFrameData with the information required to render
  155328. * the current frame.
  155329. * @param frameData Define the data structure to populate
  155330. * @returns true if ok otherwise false
  155331. */
  155332. getFrameData(frameData: VRFrameData): boolean;
  155333. /**
  155334. * Get the layers currently being presented.
  155335. * @returns the list of VR layers
  155336. */
  155337. getLayers(): VRLayer[];
  155338. /**
  155339. * Return a VRPose containing the future predicted pose of the VRDisplay
  155340. * when the current frame will be presented. The value returned will not
  155341. * change until JavaScript has returned control to the browser.
  155342. *
  155343. * The VRPose will contain the position, orientation, velocity,
  155344. * and acceleration of each of these properties.
  155345. * @returns the pose object
  155346. */
  155347. getPose(): VRPose;
  155348. /**
  155349. * Return the current instantaneous pose of the VRDisplay, with no
  155350. * prediction applied.
  155351. * @returns the current instantaneous pose
  155352. */
  155353. getImmediatePose(): VRPose;
  155354. /**
  155355. * The callback passed to `requestAnimationFrame` will be called
  155356. * any time a new frame should be rendered. When the VRDisplay is
  155357. * presenting the callback will be called at the native refresh
  155358. * rate of the HMD. When not presenting this function acts
  155359. * identically to how window.requestAnimationFrame acts. Content should
  155360. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155361. * asynchronously from other displays and at differing refresh rates.
  155362. * @param callback Define the eaction to run next frame
  155363. * @returns the request handle it
  155364. */
  155365. requestAnimationFrame(callback: FrameRequestCallback): number;
  155366. /**
  155367. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155368. * Repeat calls while already presenting will update the VRLayers being displayed.
  155369. * @param layers Define the list of layer to present
  155370. * @returns a promise to know when the request has been fulfilled
  155371. */
  155372. requestPresent(layers: VRLayer[]): Promise<void>;
  155373. /**
  155374. * Reset the pose for this display, treating its current position and
  155375. * orientation as the "origin/zero" values. VRPose.position,
  155376. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155377. * updated when calling resetPose(). This should be called in only
  155378. * sitting-space experiences.
  155379. */
  155380. resetPose(): void;
  155381. /**
  155382. * The VRLayer provided to the VRDisplay will be captured and presented
  155383. * in the HMD. Calling this function has the same effect on the source
  155384. * canvas as any other operation that uses its source image, and canvases
  155385. * created without preserveDrawingBuffer set to true will be cleared.
  155386. * @param pose Define the pose to submit
  155387. */
  155388. submitFrame(pose?: VRPose): void;
  155389. }
  155390. declare var VRDisplay: {
  155391. prototype: VRDisplay;
  155392. new(): VRDisplay;
  155393. };
  155394. interface VRLayer {
  155395. leftBounds?: number[] | Float32Array | null;
  155396. rightBounds?: number[] | Float32Array | null;
  155397. source?: HTMLCanvasElement | null;
  155398. }
  155399. interface VRDisplayCapabilities {
  155400. readonly canPresent: boolean;
  155401. readonly hasExternalDisplay: boolean;
  155402. readonly hasOrientation: boolean;
  155403. readonly hasPosition: boolean;
  155404. readonly maxLayers: number;
  155405. }
  155406. interface VREyeParameters {
  155407. /** @deprecated */
  155408. readonly fieldOfView: VRFieldOfView;
  155409. readonly offset: Float32Array;
  155410. readonly renderHeight: number;
  155411. readonly renderWidth: number;
  155412. }
  155413. interface VRFieldOfView {
  155414. readonly downDegrees: number;
  155415. readonly leftDegrees: number;
  155416. readonly rightDegrees: number;
  155417. readonly upDegrees: number;
  155418. }
  155419. interface VRFrameData {
  155420. readonly leftProjectionMatrix: Float32Array;
  155421. readonly leftViewMatrix: Float32Array;
  155422. readonly pose: VRPose;
  155423. readonly rightProjectionMatrix: Float32Array;
  155424. readonly rightViewMatrix: Float32Array;
  155425. readonly timestamp: number;
  155426. }
  155427. interface VRPose {
  155428. readonly angularAcceleration: Float32Array | null;
  155429. readonly angularVelocity: Float32Array | null;
  155430. readonly linearAcceleration: Float32Array | null;
  155431. readonly linearVelocity: Float32Array | null;
  155432. readonly orientation: Float32Array | null;
  155433. readonly position: Float32Array | null;
  155434. readonly timestamp: number;
  155435. }
  155436. interface VRStageParameters {
  155437. sittingToStandingTransform?: Float32Array;
  155438. sizeX?: number;
  155439. sizeY?: number;
  155440. }
  155441. interface Navigator {
  155442. getVRDisplays(): Promise<VRDisplay[]>;
  155443. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155444. }
  155445. interface Window {
  155446. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155447. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155448. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155449. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155450. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155451. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155452. }
  155453. interface Gamepad {
  155454. readonly displayId: number;
  155455. }
  155456. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155457. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155458. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155459. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155460. type XRHandedness = "none" | "left" | "right";
  155461. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155462. type XREye = "none" | "left" | "right";
  155463. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155464. interface XRSpace extends EventTarget {}
  155465. interface XRRenderState {
  155466. depthNear?: number;
  155467. depthFar?: number;
  155468. inlineVerticalFieldOfView?: number;
  155469. baseLayer?: XRWebGLLayer;
  155470. }
  155471. interface XRInputSource {
  155472. handedness: XRHandedness;
  155473. targetRayMode: XRTargetRayMode;
  155474. targetRaySpace: XRSpace;
  155475. gripSpace: XRSpace | undefined;
  155476. gamepad: Gamepad | undefined;
  155477. profiles: Array<string>;
  155478. hand: XRHand | undefined;
  155479. }
  155480. interface XRSessionInit {
  155481. optionalFeatures?: string[];
  155482. requiredFeatures?: string[];
  155483. }
  155484. interface XRSession {
  155485. addEventListener: Function;
  155486. removeEventListener: Function;
  155487. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155488. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155489. requestAnimationFrame: Function;
  155490. end(): Promise<void>;
  155491. renderState: XRRenderState;
  155492. inputSources: Array<XRInputSource>;
  155493. // hit test
  155494. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155495. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155496. // legacy AR hit test
  155497. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155498. // legacy plane detection
  155499. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155500. }
  155501. interface XRReferenceSpace extends XRSpace {
  155502. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155503. onreset: any;
  155504. }
  155505. type XRPlaneSet = Set<XRPlane>;
  155506. type XRAnchorSet = Set<XRAnchor>;
  155507. interface XRFrame {
  155508. session: XRSession;
  155509. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155510. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155511. // AR
  155512. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155513. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155514. // Anchors
  155515. trackedAnchors?: XRAnchorSet;
  155516. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155517. // Planes
  155518. worldInformation: {
  155519. detectedPlanes?: XRPlaneSet;
  155520. };
  155521. // Hand tracking
  155522. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155523. }
  155524. interface XRViewerPose extends XRPose {
  155525. views: Array<XRView>;
  155526. }
  155527. interface XRPose {
  155528. transform: XRRigidTransform;
  155529. emulatedPosition: boolean;
  155530. }
  155531. interface XRWebGLLayerOptions {
  155532. antialias?: boolean;
  155533. depth?: boolean;
  155534. stencil?: boolean;
  155535. alpha?: boolean;
  155536. multiview?: boolean;
  155537. framebufferScaleFactor?: number;
  155538. }
  155539. declare var XRWebGLLayer: {
  155540. prototype: XRWebGLLayer;
  155541. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155542. };
  155543. interface XRWebGLLayer {
  155544. framebuffer: WebGLFramebuffer;
  155545. framebufferWidth: number;
  155546. framebufferHeight: number;
  155547. getViewport: Function;
  155548. }
  155549. declare class XRRigidTransform {
  155550. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155551. position: DOMPointReadOnly;
  155552. orientation: DOMPointReadOnly;
  155553. matrix: Float32Array;
  155554. inverse: XRRigidTransform;
  155555. }
  155556. interface XRView {
  155557. eye: XREye;
  155558. projectionMatrix: Float32Array;
  155559. transform: XRRigidTransform;
  155560. }
  155561. interface XRInputSourceChangeEvent {
  155562. session: XRSession;
  155563. removed: Array<XRInputSource>;
  155564. added: Array<XRInputSource>;
  155565. }
  155566. interface XRInputSourceEvent extends Event {
  155567. readonly frame: XRFrame;
  155568. readonly inputSource: XRInputSource;
  155569. }
  155570. // Experimental(er) features
  155571. declare class XRRay {
  155572. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155573. origin: DOMPointReadOnly;
  155574. direction: DOMPointReadOnly;
  155575. matrix: Float32Array;
  155576. }
  155577. declare enum XRHitTestTrackableType {
  155578. "point",
  155579. "plane",
  155580. "mesh",
  155581. }
  155582. interface XRHitResult {
  155583. hitMatrix: Float32Array;
  155584. }
  155585. interface XRTransientInputHitTestResult {
  155586. readonly inputSource: XRInputSource;
  155587. readonly results: Array<XRHitTestResult>;
  155588. }
  155589. interface XRHitTestResult {
  155590. getPose(baseSpace: XRSpace): XRPose | undefined;
  155591. // When anchor system is enabled
  155592. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155593. }
  155594. interface XRHitTestSource {
  155595. cancel(): void;
  155596. }
  155597. interface XRTransientInputHitTestSource {
  155598. cancel(): void;
  155599. }
  155600. interface XRHitTestOptionsInit {
  155601. space: XRSpace;
  155602. entityTypes?: Array<XRHitTestTrackableType>;
  155603. offsetRay?: XRRay;
  155604. }
  155605. interface XRTransientInputHitTestOptionsInit {
  155606. profile: string;
  155607. entityTypes?: Array<XRHitTestTrackableType>;
  155608. offsetRay?: XRRay;
  155609. }
  155610. interface XRAnchor {
  155611. anchorSpace: XRSpace;
  155612. delete(): void;
  155613. }
  155614. interface XRPlane {
  155615. orientation: "Horizontal" | "Vertical";
  155616. planeSpace: XRSpace;
  155617. polygon: Array<DOMPointReadOnly>;
  155618. lastChangedTime: number;
  155619. }
  155620. interface XRJointSpace extends XRSpace {}
  155621. interface XRJointPose extends XRPose {
  155622. radius: number | undefined;
  155623. }
  155624. declare class XRHand extends Array<XRJointSpace> {
  155625. readonly length: number;
  155626. static readonly WRIST = 0;
  155627. static readonly THUMB_METACARPAL = 1;
  155628. static readonly THUMB_PHALANX_PROXIMAL = 2;
  155629. static readonly THUMB_PHALANX_DISTAL = 3;
  155630. static readonly THUMB_PHALANX_TIP = 4;
  155631. static readonly INDEX_METACARPAL = 5;
  155632. static readonly INDEX_PHALANX_PROXIMAL = 6;
  155633. static readonly INDEX_PHALANX_INTERMEDIATE = 7;
  155634. static readonly INDEX_PHALANX_DISTAL = 8;
  155635. static readonly INDEX_PHALANX_TIP = 9;
  155636. static readonly MIDDLE_METACARPAL = 10;
  155637. static readonly MIDDLE_PHALANX_PROXIMAL = 11;
  155638. static readonly MIDDLE_PHALANX_INTERMEDIATE = 12;
  155639. static readonly MIDDLE_PHALANX_DISTAL = 13;
  155640. static readonly MIDDLE_PHALANX_TIP = 14;
  155641. static readonly RING_METACARPAL = 15;
  155642. static readonly RING_PHALANX_PROXIMAL = 16;
  155643. static readonly RING_PHALANX_INTERMEDIATE = 17;
  155644. static readonly RING_PHALANX_DISTAL = 18;
  155645. static readonly RING_PHALANX_TIP = 19;
  155646. static readonly LITTLE_METACARPAL = 20;
  155647. static readonly LITTLE_PHALANX_PROXIMAL = 21;
  155648. static readonly LITTLE_PHALANX_INTERMEDIATE = 22;
  155649. static readonly LITTLE_PHALANX_DISTAL = 23;
  155650. static readonly LITTLE_PHALANX_TIP = 24;
  155651. }
  155652. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155653. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155654. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155655. interface XRSession {
  155656. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155657. }
  155658. interface XRFrame {
  155659. featurePointCloud? : Array<number>;
  155660. }